orb-billing 0.12.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +28 -0
- data/README.md +1 -1
- data/lib/orb/internal/type/base_model.rb +5 -5
- data/lib/orb/models/accounting_provider_config.rb +21 -0
- data/lib/orb/models/address.rb +45 -0
- data/lib/orb/models/address_input.rb +45 -0
- data/lib/orb/models/adjustment_interval.rb +66 -0
- data/lib/orb/models/aggregated_cost.rb +45 -0
- data/lib/orb/models/alert.rb +9 -60
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -24
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -24
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -23
- data/lib/orb/models/alert_update_params.rb +3 -22
- data/lib/orb/models/allocation.rb +27 -0
- data/lib/orb/models/amount_discount.rb +3 -59
- data/lib/orb/models/amount_discount_interval.rb +65 -0
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +193 -19201
- data/lib/orb/models/beta_create_plan_version_params.rb +183 -19025
- data/lib/orb/models/billable_metric_tiny.rb +15 -0
- data/lib/orb/models/billing_cycle_anchor_configuration.rb +41 -0
- data/lib/orb/models/billing_cycle_configuration.rb +32 -0
- data/lib/orb/models/bps_config.rb +24 -0
- data/lib/orb/models/bps_tier.rb +40 -0
- data/lib/orb/models/bulk_bps_config.rb +20 -0
- data/lib/orb/models/bulk_bps_tier.rb +32 -0
- data/lib/orb/models/bulk_config.rb +16 -0
- data/lib/orb/models/bulk_tier.rb +24 -0
- data/lib/orb/models/changed_subscription_resources.rb +40 -0
- data/lib/orb/models/conversion_rate_tier.rb +32 -0
- data/lib/orb/models/conversion_rate_tiered_config.rb +16 -0
- data/lib/orb/models/conversion_rate_unit_config.rb +16 -0
- data/lib/orb/models/coupon_redemption.rb +27 -0
- data/lib/orb/models/credit_note.rb +6 -51
- data/lib/orb/models/credit_note_tiny.rb +16 -0
- data/lib/orb/models/custom_expiration.rb +32 -0
- data/lib/orb/models/customer.rb +15 -426
- data/lib/orb/models/customer_create_params.rb +24 -527
- data/lib/orb/models/customer_hierarchy_config.rb +29 -0
- data/lib/orb/models/customer_minified.rb +21 -0
- data/lib/orb/models/customer_tax_id.rb +300 -0
- data/lib/orb/models/customer_update_by_external_id_params.rb +24 -529
- data/lib/orb/models/customer_update_params.rb +24 -527
- data/lib/orb/models/customers/balance_transaction_create_response.rb +6 -32
- data/lib/orb/models/customers/balance_transaction_list_response.rb +6 -32
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -88
- data/lib/orb/models/customers/cost_list_response.rb +3 -87
- data/lib/orb/models/customers/credits/affected_block.rb +31 -0
- data/lib/orb/models/customers/credits/amendment_ledger_entry.rb +131 -0
- data/lib/orb/models/customers/credits/credit_block_expiry_ledger_entry.rb +137 -0
- data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +152 -0
- data/lib/orb/models/customers/credits/expiration_change_ledger_entry.rb +141 -0
- data/lib/orb/models/customers/credits/increment_ledger_entry.rb +139 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +8 -1177
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +8 -1169
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +8 -1173
- data/lib/orb/models/customers/credits/ledger_list_response.rb +8 -1161
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +3 -52
- data/lib/orb/models/customers/credits/top_up_create_response.rb +3 -51
- data/lib/orb/models/customers/credits/top_up_invoice_settings.rb +53 -0
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +3 -52
- data/lib/orb/models/customers/credits/top_up_list_response.rb +3 -51
- data/lib/orb/models/customers/credits/void_initiated_ledger_entry.rb +152 -0
- data/lib/orb/models/customers/credits/void_ledger_entry.rb +145 -0
- data/lib/orb/models/dimensional_price_configuration.rb +21 -0
- data/lib/orb/models/discount_override.rb +56 -0
- data/lib/orb/models/fixed_fee_quantity_schedule_entry.rb +33 -0
- data/lib/orb/models/fixed_fee_quantity_transition.rb +27 -0
- data/lib/orb/models/invoice.rb +56 -1777
- data/lib/orb/models/invoice_create_params.rb +3 -15
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +56 -1794
- data/lib/orb/models/invoice_line_item_create_response.rb +25 -1142
- data/lib/orb/models/invoice_tiny.rb +16 -0
- data/lib/orb/models/item_slim.rb +21 -0
- data/lib/orb/models/matrix_config.rb +32 -0
- data/lib/orb/models/matrix_sub_line_item.rb +61 -0
- data/lib/orb/models/matrix_value.rb +29 -0
- data/lib/orb/models/matrix_with_allocation_config.rb +40 -0
- data/lib/orb/models/maximum.rb +38 -0
- data/lib/orb/models/maximum_interval.rb +52 -0
- data/lib/orb/models/minimum.rb +38 -0
- data/lib/orb/models/minimum_interval.rb +52 -0
- data/lib/orb/models/monetary_amount_discount_adjustment.rb +87 -0
- data/lib/orb/models/monetary_maximum_adjustment.rb +87 -0
- data/lib/orb/models/monetary_minimum_adjustment.rb +95 -0
- data/lib/orb/models/monetary_percentage_discount_adjustment.rb +87 -0
- data/lib/orb/models/monetary_usage_discount_adjustment.rb +87 -0
- data/lib/orb/models/mutated_subscription.rb +302 -0
- data/lib/orb/models/new_accounting_sync_configuration.rb +23 -0
- data/lib/orb/models/new_allocation_price.rb +70 -0
- data/lib/orb/models/new_amount_discount.rb +120 -0
- data/lib/orb/models/new_avalara_tax_configuration.rb +37 -0
- data/lib/orb/models/new_billing_cycle_configuration.rb +37 -0
- data/lib/orb/models/new_dimensional_price_configuration.rb +36 -0
- data/lib/orb/models/new_floating_bps_price.rb +199 -0
- data/lib/orb/models/new_floating_bulk_bps_price.rb +197 -0
- data/lib/orb/models/new_floating_bulk_price.rb +197 -0
- data/lib/orb/models/new_floating_bulk_with_proration_price.rb +197 -0
- data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_allocation_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_tiered_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +197 -0
- data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +198 -0
- data/lib/orb/models/new_floating_matrix_price.rb +197 -0
- data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +197 -0
- data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +197 -0
- data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +197 -0
- data/lib/orb/models/new_floating_package_price.rb +197 -0
- data/lib/orb/models/new_floating_package_with_allocation_price.rb +197 -0
- data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +198 -0
- data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +198 -0
- data/lib/orb/models/new_floating_threshold_total_amount_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_bps_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_package_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +197 -0
- data/lib/orb/models/new_floating_tiered_with_proration_price.rb +197 -0
- data/lib/orb/models/new_floating_unit_price.rb +197 -0
- data/lib/orb/models/new_floating_unit_with_percent_price.rb +197 -0
- data/lib/orb/models/new_floating_unit_with_proration_price.rb +197 -0
- data/lib/orb/models/new_maximum.rb +120 -0
- data/lib/orb/models/new_minimum.rb +128 -0
- data/lib/orb/models/new_percentage_discount.rb +120 -0
- data/lib/orb/models/new_plan_bps_price.rb +196 -0
- data/lib/orb/models/new_plan_bulk_bps_price.rb +200 -0
- data/lib/orb/models/new_plan_bulk_price.rb +196 -0
- data/lib/orb/models/new_plan_bulk_with_proration_price.rb +198 -0
- data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_allocation_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_tiered_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +198 -0
- data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +199 -0
- data/lib/orb/models/new_plan_matrix_price.rb +200 -0
- data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +198 -0
- data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +198 -0
- data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +198 -0
- data/lib/orb/models/new_plan_package_price.rb +200 -0
- data/lib/orb/models/new_plan_package_with_allocation_price.rb +198 -0
- data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +199 -0
- data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +199 -0
- data/lib/orb/models/new_plan_threshold_total_amount_price.rb +198 -0
- data/lib/orb/models/new_plan_tier_with_proration_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_bps_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_package_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +198 -0
- data/lib/orb/models/new_plan_tiered_price.rb +200 -0
- data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +198 -0
- data/lib/orb/models/new_plan_unit_price.rb +196 -0
- data/lib/orb/models/new_plan_unit_with_percent_price.rb +198 -0
- data/lib/orb/models/new_plan_unit_with_proration_price.rb +198 -0
- data/lib/orb/models/new_reporting_configuration.rb +15 -0
- data/lib/orb/models/new_sphere_configuration.rb +31 -0
- data/lib/orb/models/new_subscription_bps_price.rb +207 -0
- data/lib/orb/models/new_subscription_bulk_bps_price.rb +207 -0
- data/lib/orb/models/new_subscription_bulk_price.rb +207 -0
- data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +207 -0
- data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_allocation_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_tiered_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +207 -0
- data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +208 -0
- data/lib/orb/models/new_subscription_matrix_price.rb +207 -0
- data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +207 -0
- data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +207 -0
- data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_package_with_allocation_price.rb +207 -0
- data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +209 -0
- data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +209 -0
- data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +207 -0
- data/lib/orb/models/new_subscription_tier_with_proration_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_bps_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_package_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_price.rb +207 -0
- data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +207 -0
- data/lib/orb/models/new_subscription_unit_price.rb +207 -0
- data/lib/orb/models/new_subscription_unit_with_percent_price.rb +207 -0
- data/lib/orb/models/new_subscription_unit_with_proration_price.rb +207 -0
- data/lib/orb/models/new_tax_jar_configuration.rb +31 -0
- data/lib/orb/models/new_usage_discount.rb +120 -0
- data/lib/orb/models/other_sub_line_item.rb +54 -0
- data/lib/orb/models/package_config.rb +28 -0
- data/lib/orb/models/per_price_cost.rb +48 -0
- data/lib/orb/models/percentage_discount.rb +3 -59
- data/lib/orb/models/percentage_discount_interval.rb +69 -0
- data/lib/orb/models/plan.rb +22 -1040
- data/lib/orb/models/plan_create_params.rb +31 -8145
- data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +87 -0
- data/lib/orb/models/plan_phase_maximum_adjustment.rb +87 -0
- data/lib/orb/models/plan_phase_minimum_adjustment.rb +95 -0
- data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +87 -0
- data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +87 -0
- data/lib/orb/models/plan_version.rb +10 -672
- data/lib/orb/models/price.rb +1225 -10817
- data/lib/orb/models/price_create_params.rb +53 -472
- data/lib/orb/models/price_evaluate_multiple_params.rb +32 -8479
- data/lib/orb/models/price_evaluate_preview_events_params.rb +236 -0
- data/lib/orb/models/price_evaluate_preview_events_response.rb +51 -0
- data/lib/orb/models/price_interval.rb +113 -0
- data/lib/orb/models/sub_line_item_grouping.rb +23 -0
- data/lib/orb/models/sub_line_item_matrix_config.rb +16 -0
- data/lib/orb/models/subscription.rb +33 -1581
- data/lib/orb/models/subscription_change_apply_response.rb +3 -1904
- data/lib/orb/models/subscription_change_cancel_response.rb +3 -1905
- data/lib/orb/models/subscription_change_minified.rb +15 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +3 -1906
- data/lib/orb/models/subscription_create_params.rb +232 -19698
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -87
- data/lib/orb/models/subscription_minified.rb +15 -0
- data/lib/orb/models/subscription_price_intervals_params.rb +86 -9468
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +238 -19792
- data/lib/orb/models/subscription_trial_info.rb +15 -0
- data/lib/orb/models/tax_amount.rb +32 -0
- data/lib/orb/models/threshold.rb +24 -0
- data/lib/orb/models/tier.rb +32 -0
- data/lib/orb/models/tier_config.rb +27 -0
- data/lib/orb/models/tier_sub_line_item.rb +61 -0
- data/lib/orb/models/tiered_bps_config.rb +20 -0
- data/lib/orb/models/tiered_config.rb +16 -0
- data/lib/orb/models/tiered_conversion_rate_config.rb +31 -0
- data/lib/orb/models/transform_price_filter.rb +61 -0
- data/lib/orb/models/trial_discount.rb +3 -59
- data/lib/orb/models/unit_config.rb +16 -0
- data/lib/orb/models/unit_conversion_rate_config.rb +31 -0
- data/lib/orb/models/usage_discount.rb +3 -59
- data/lib/orb/models/usage_discount_interval.rb +69 -0
- data/lib/orb/models.rb +348 -0
- data/lib/orb/resources/alerts.rb +4 -4
- data/lib/orb/resources/customers/credits/ledger.rb +4 -4
- data/lib/orb/resources/customers.rb +21 -21
- data/lib/orb/resources/plans.rb +1 -1
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +82 -34
- data/lib/orb/resources/subscriptions.rb +24 -24
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +181 -11
- data/rbi/orb/models/accounting_provider_config.rbi +34 -0
- data/rbi/orb/models/address.rbi +55 -0
- data/rbi/orb/models/address_input.rbi +62 -0
- data/rbi/orb/models/adjustment_interval.rbi +93 -0
- data/rbi/orb/models/aggregated_cost.rbi +61 -0
- data/rbi/orb/models/alert.rbi +11 -84
- data/rbi/orb/models/alert_create_for_customer_params.rbi +3 -42
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +3 -48
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +3 -38
- data/rbi/orb/models/alert_update_params.rbi +3 -31
- data/rbi/orb/models/allocation.rbi +45 -0
- data/rbi/orb/models/amount_discount.rbi +3 -112
- data/rbi/orb/models/amount_discount_interval.rbi +100 -0
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +558 -35618
- data/rbi/orb/models/beta_create_plan_version_params.rbi +558 -35610
- data/rbi/orb/models/billable_metric_tiny.rbi +21 -0
- data/rbi/orb/models/billing_cycle_anchor_configuration.rbi +61 -0
- data/rbi/orb/models/billing_cycle_configuration.rbi +70 -0
- data/rbi/orb/models/bps_config.rbi +36 -0
- data/rbi/orb/models/bps_tier.rbi +58 -0
- data/rbi/orb/models/bulk_bps_config.rbi +31 -0
- data/rbi/orb/models/bulk_bps_tier.rbi +50 -0
- data/rbi/orb/models/bulk_config.rbi +26 -0
- data/rbi/orb/models/bulk_tier.rbi +38 -0
- data/rbi/orb/models/changed_subscription_resources.rbi +61 -0
- data/rbi/orb/models/conversion_rate_tier.rbi +51 -0
- data/rbi/orb/models/conversion_rate_tiered_config.rbi +31 -0
- data/rbi/orb/models/conversion_rate_unit_config.rbi +27 -0
- data/rbi/orb/models/coupon_redemption.rbi +37 -0
- data/rbi/orb/models/credit_note.rbi +7 -87
- data/rbi/orb/models/credit_note_tiny.rbi +25 -0
- data/rbi/orb/models/custom_expiration.rbi +55 -0
- data/rbi/orb/models/customer.rbi +19 -522
- data/rbi/orb/models/customer_create_params.rbi +36 -957
- data/rbi/orb/models/customer_hierarchy_config.rbi +52 -0
- data/rbi/orb/models/customer_minified.rbi +32 -0
- data/rbi/orb/models/customer_tax_id.rbi +324 -0
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +36 -1436
- data/rbi/orb/models/customer_update_params.rbi +36 -957
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +8 -96
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +8 -96
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +5 -191
- data/rbi/orb/models/customers/cost_list_response.rbi +5 -182
- data/rbi/orb/models/customers/credits/affected_block.rbi +50 -0
- data/rbi/orb/models/customers/credits/amendment_ledger_entry.rbi +207 -0
- data/rbi/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbi +209 -0
- data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +225 -0
- data/rbi/orb/models/customers/credits/expiration_change_ledger_entry.rbi +213 -0
- data/rbi/orb/models/customers/credits/increment_ledger_entry.rbi +215 -0
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +7 -1854
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/top_up_invoice_settings.rbi +83 -0
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +4 -84
- data/rbi/orb/models/customers/credits/void_initiated_ledger_entry.rbi +225 -0
- data/rbi/orb/models/customers/credits/void_ledger_entry.rbi +219 -0
- data/rbi/orb/models/dimensional_price_configuration.rbi +38 -0
- data/rbi/orb/models/discount_override.rbi +83 -0
- data/rbi/orb/models/fixed_fee_quantity_schedule_entry.rbi +48 -0
- data/rbi/orb/models/fixed_fee_quantity_transition.rbi +39 -0
- data/rbi/orb/models/invoice.rbi +212 -3345
- data/rbi/orb/models/invoice_create_params.rbi +4 -33
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +355 -4329
- data/rbi/orb/models/invoice_line_item_create_response.rbi +30 -2260
- data/rbi/orb/models/invoice_tiny.rbi +24 -0
- data/rbi/orb/models/item_slim.rbi +23 -0
- data/rbi/orb/models/matrix_config.rbi +50 -0
- data/rbi/orb/models/matrix_sub_line_item.rbi +87 -0
- data/rbi/orb/models/matrix_value.rbi +43 -0
- data/rbi/orb/models/matrix_with_allocation_config.rbi +61 -0
- data/rbi/orb/models/maximum.rbi +52 -0
- data/rbi/orb/models/maximum_interval.rbi +69 -0
- data/rbi/orb/models/minimum.rbi +52 -0
- data/rbi/orb/models/minimum_interval.rbi +69 -0
- data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +125 -0
- data/rbi/orb/models/monetary_maximum_adjustment.rbi +123 -0
- data/rbi/orb/models/monetary_minimum_adjustment.rbi +131 -0
- data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +131 -0
- data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +125 -0
- data/rbi/orb/models/mutated_subscription.rbi +412 -0
- data/rbi/orb/models/new_accounting_sync_configuration.rbi +40 -0
- data/rbi/orb/models/new_allocation_price.rbi +104 -0
- data/rbi/orb/models/new_amount_discount.rbi +179 -0
- data/rbi/orb/models/new_avalara_tax_configuration.rbi +68 -0
- data/rbi/orb/models/new_billing_cycle_configuration.rbi +79 -0
- data/rbi/orb/models/new_dimensional_price_configuration.rbi +55 -0
- data/rbi/orb/models/new_floating_bps_price.rbi +294 -0
- data/rbi/orb/models/new_floating_bulk_bps_price.rbi +309 -0
- data/rbi/orb/models/new_floating_bulk_price.rbi +298 -0
- data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +331 -0
- data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +338 -0
- data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +331 -0
- data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +337 -0
- data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +325 -0
- data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +348 -0
- data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +348 -0
- data/rbi/orb/models/new_floating_matrix_price.rbi +304 -0
- data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +345 -0
- data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +338 -0
- data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +338 -0
- data/rbi/orb/models/new_floating_package_price.rbi +306 -0
- data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +338 -0
- data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +350 -0
- data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +349 -0
- data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +337 -0
- data/rbi/orb/models/new_floating_tiered_bps_price.rbi +317 -0
- data/rbi/orb/models/new_floating_tiered_package_price.rbi +325 -0
- data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +348 -0
- data/rbi/orb/models/new_floating_tiered_price.rbi +304 -0
- data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +331 -0
- data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +337 -0
- data/rbi/orb/models/new_floating_unit_price.rbi +298 -0
- data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +328 -0
- data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +331 -0
- data/rbi/orb/models/new_maximum.rbi +160 -0
- data/rbi/orb/models/new_minimum.rbi +168 -0
- data/rbi/orb/models/new_percentage_discount.rbi +193 -0
- data/rbi/orb/models/new_plan_bps_price.rbi +294 -0
- data/rbi/orb/models/new_plan_bulk_bps_price.rbi +297 -0
- data/rbi/orb/models/new_plan_bulk_price.rbi +295 -0
- data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +327 -0
- data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +333 -0
- data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +327 -0
- data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +333 -0
- data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +316 -0
- data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +340 -0
- data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +345 -0
- data/rbi/orb/models/new_plan_matrix_price.rbi +297 -0
- data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +341 -0
- data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +333 -0
- data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +333 -0
- data/rbi/orb/models/new_plan_package_price.rbi +297 -0
- data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +333 -0
- data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +352 -0
- data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +351 -0
- data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +333 -0
- data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +327 -0
- data/rbi/orb/models/new_plan_tiered_bps_price.rbi +304 -0
- data/rbi/orb/models/new_plan_tiered_package_price.rbi +316 -0
- data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +339 -0
- data/rbi/orb/models/new_plan_tiered_price.rbi +297 -0
- data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +327 -0
- data/rbi/orb/models/new_plan_unit_price.rbi +295 -0
- data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +325 -0
- data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +327 -0
- data/rbi/orb/models/new_reporting_configuration.rbi +23 -0
- data/rbi/orb/models/new_sphere_configuration.rbi +59 -0
- data/rbi/orb/models/new_subscription_bps_price.rbi +317 -0
- data/rbi/orb/models/new_subscription_bulk_bps_price.rbi +338 -0
- data/rbi/orb/models/new_subscription_bulk_price.rbi +321 -0
- data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +343 -0
- data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_matrix_price.rbi +332 -0
- data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +368 -0
- data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_package_price.rbi +338 -0
- data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +362 -0
- data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +361 -0
- data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_tier_with_proration_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_tiered_bps_price.rbi +340 -0
- data/rbi/orb/models/new_subscription_tiered_package_price.rbi +343 -0
- data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +360 -0
- data/rbi/orb/models/new_subscription_tiered_price.rbi +332 -0
- data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +350 -0
- data/rbi/orb/models/new_subscription_unit_price.rbi +321 -0
- data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +349 -0
- data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +350 -0
- data/rbi/orb/models/new_tax_jar_configuration.rbi +59 -0
- data/rbi/orb/models/new_usage_discount.rbi +177 -0
- data/rbi/orb/models/other_sub_line_item.rbi +78 -0
- data/rbi/orb/models/package_config.rbi +39 -0
- data/rbi/orb/models/per_price_cost.rbi +96 -0
- data/rbi/orb/models/percentage_discount.rbi +3 -126
- data/rbi/orb/models/percentage_discount_interval.rbi +107 -0
- data/rbi/orb/models/plan.rbi +29 -1937
- data/rbi/orb/models/plan_create_params.rbi +112 -15428
- data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +128 -0
- data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +123 -0
- data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +131 -0
- data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +131 -0
- data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +125 -0
- data/rbi/orb/models/plan_version.rbi +13 -1252
- data/rbi/orb/models/price.rbi +3518 -26097
- data/rbi/orb/models/price_create_params.rbi +81 -937
- data/rbi/orb/models/price_evaluate_multiple_params.rbi +112 -15566
- data/rbi/orb/models/price_evaluate_preview_events_params.rbi +411 -0
- data/rbi/orb/models/price_evaluate_preview_events_response.rbi +101 -0
- data/rbi/orb/models/price_interval.rbi +174 -0
- data/rbi/orb/models/sub_line_item_grouping.rbi +31 -0
- data/rbi/orb/models/sub_line_item_matrix_config.rbi +33 -0
- data/rbi/orb/models/subscription.rbi +51 -2939
- data/rbi/orb/models/subscription_change_apply_response.rbi +4 -3580
- data/rbi/orb/models/subscription_change_cancel_response.rbi +4 -3580
- data/rbi/orb/models/subscription_change_minified.rbi +23 -0
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +4 -3582
- data/rbi/orb/models/subscription_create_params.rbi +686 -36613
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +5 -182
- data/rbi/orb/models/subscription_minified.rbi +23 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +224 -17694
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +696 -36631
- data/rbi/orb/models/subscription_trial_info.rbi +23 -0
- data/rbi/orb/models/tax_amount.rbi +50 -0
- data/rbi/orb/models/threshold.rbi +30 -0
- data/rbi/orb/models/tier.rbi +50 -0
- data/rbi/orb/models/tier_config.rbi +40 -0
- data/rbi/orb/models/tier_sub_line_item.rbi +87 -0
- data/rbi/orb/models/tiered_bps_config.rbi +29 -0
- data/rbi/orb/models/tiered_config.rbi +26 -0
- data/rbi/orb/models/tiered_conversion_rate_config.rbi +73 -0
- data/rbi/orb/models/transform_price_filter.rbi +106 -0
- data/rbi/orb/models/trial_discount.rbi +3 -104
- data/rbi/orb/models/unit_config.rbi +24 -0
- data/rbi/orb/models/unit_conversion_rate_config.rbi +71 -0
- data/rbi/orb/models/usage_discount.rbi +3 -104
- data/rbi/orb/models/usage_discount_interval.rbi +99 -0
- data/rbi/orb/models.rbi +398 -0
- data/rbi/orb/resources/alerts.rbi +4 -13
- data/rbi/orb/resources/customers.rbi +27 -51
- data/rbi/orb/resources/plans.rbi +28 -28
- data/rbi/orb/resources/prices.rbi +82 -36
- data/rbi/orb/resources/subscriptions.rbi +13 -19
- data/sig/orb/models/accounting_provider_config.rbs +19 -0
- data/sig/orb/models/address.rbs +45 -0
- data/sig/orb/models/address_input.rbs +45 -0
- data/sig/orb/models/adjustment_interval.rbs +53 -0
- data/sig/orb/models/aggregated_cost.rbs +40 -0
- data/sig/orb/models/alert.rbs +12 -44
- data/sig/orb/models/alert_create_for_customer_params.rbs +4 -14
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +4 -14
- data/sig/orb/models/alert_create_for_subscription_params.rbs +4 -14
- data/sig/orb/models/alert_update_params.rbs +4 -14
- data/sig/orb/models/allocation.rbs +30 -0
- data/sig/orb/models/amount_discount.rbs +4 -57
- data/sig/orb/models/amount_discount_interval.rbs +55 -0
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +149 -13933
- data/sig/orb/models/beta_create_plan_version_params.rbs +146 -13914
- data/sig/orb/models/billable_metric_tiny.rbs +13 -0
- data/sig/orb/models/billing_cycle_anchor_configuration.rbs +18 -0
- data/sig/orb/models/billing_cycle_configuration.rbs +36 -0
- data/sig/orb/models/bps_config.rbs +15 -0
- data/sig/orb/models/bps_tier.rbs +35 -0
- data/sig/orb/models/bulk_bps_config.rbs +13 -0
- data/sig/orb/models/bulk_bps_tier.rbs +26 -0
- data/sig/orb/models/bulk_config.rbs +13 -0
- data/sig/orb/models/bulk_tier.rbs +15 -0
- data/sig/orb/models/changed_subscription_resources.rbs +35 -0
- data/sig/orb/models/conversion_rate_tier.rbs +26 -0
- data/sig/orb/models/conversion_rate_tiered_config.rbs +14 -0
- data/sig/orb/models/conversion_rate_unit_config.rbs +13 -0
- data/sig/orb/models/coupon_redemption.rbs +22 -0
- data/sig/orb/models/credit_note.rbs +8 -47
- data/sig/orb/models/credit_note_tiny.rbs +13 -0
- data/sig/orb/models/custom_expiration.rbs +36 -0
- data/sig/orb/models/customer.rbs +20 -471
- data/sig/orb/models/customer_create_params.rbs +27 -577
- data/sig/orb/models/customer_hierarchy_config.rbs +24 -0
- data/sig/orb/models/customer_minified.rbs +15 -0
- data/sig/orb/models/customer_tax_id.rbs +346 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +27 -577
- data/sig/orb/models/customer_update_params.rbs +27 -577
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +8 -28
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +8 -28
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +4 -84
- data/sig/orb/models/customers/cost_list_response.rbs +4 -83
- data/sig/orb/models/customers/credits/affected_block.rbs +30 -0
- data/sig/orb/models/customers/credits/amendment_ledger_entry.rbs +105 -0
- data/sig/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbs +107 -0
- data/sig/orb/models/customers/credits/decrement_ledger_entry.rbs +120 -0
- data/sig/orb/models/customers/credits/expiration_change_ledger_entry.rbs +110 -0
- data/sig/orb/models/customers/credits/increment_ledger_entry.rbs +110 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -939
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -939
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -939
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -939
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +4 -38
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +4 -38
- data/sig/orb/models/customers/credits/top_up_invoice_settings.rbs +41 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +4 -38
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +4 -38
- data/sig/orb/models/customers/credits/void_initiated_ledger_entry.rbs +120 -0
- data/sig/orb/models/customers/credits/void_ledger_entry.rbs +115 -0
- data/sig/orb/models/dimensional_price_configuration.rbs +22 -0
- data/sig/orb/models/discount_override.rbs +47 -0
- data/sig/orb/models/fixed_fee_quantity_schedule_entry.rbs +30 -0
- data/sig/orb/models/fixed_fee_quantity_transition.rbs +26 -0
- data/sig/orb/models/invoice.rbs +54 -1612
- data/sig/orb/models/invoice_create_params.rbs +4 -14
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -1612
- data/sig/orb/models/invoice_line_item_create_response.rbs +18 -927
- data/sig/orb/models/invoice_tiny.rbs +13 -0
- data/sig/orb/models/item_slim.rbs +15 -0
- data/sig/orb/models/matrix_config.rbs +30 -0
- data/sig/orb/models/matrix_sub_line_item.rbs +55 -0
- data/sig/orb/models/matrix_value.rbs +22 -0
- data/sig/orb/models/matrix_with_allocation_config.rbs +35 -0
- data/sig/orb/models/maximum.rbs +30 -0
- data/sig/orb/models/maximum_interval.rbs +40 -0
- data/sig/orb/models/minimum.rbs +30 -0
- data/sig/orb/models/minimum_interval.rbs +40 -0
- data/sig/orb/models/monetary_amount_discount_adjustment.rbs +65 -0
- data/sig/orb/models/monetary_maximum_adjustment.rbs +65 -0
- data/sig/orb/models/monetary_minimum_adjustment.rbs +70 -0
- data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/monetary_usage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/mutated_subscription.rbs +178 -0
- data/sig/orb/models/new_accounting_sync_configuration.rbs +25 -0
- data/sig/orb/models/new_allocation_price.rbs +56 -0
- data/sig/orb/models/new_amount_discount.rbs +97 -0
- data/sig/orb/models/new_avalara_tax_configuration.rbs +40 -0
- data/sig/orb/models/new_billing_cycle_configuration.rbs +36 -0
- data/sig/orb/models/new_dimensional_price_configuration.rbs +30 -0
- data/sig/orb/models/new_floating_bps_price.rbs +135 -0
- data/sig/orb/models/new_floating_bulk_bps_price.rbs +135 -0
- data/sig/orb/models/new_floating_bulk_price.rbs +135 -0
- data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_allocation_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_tiered_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_matrix_price.rbs +135 -0
- data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +135 -0
- data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_package_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
- data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +135 -0
- data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_bps_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_floating_unit_price.rbs +135 -0
- data/sig/orb/models/new_floating_unit_with_percent_price.rbs +135 -0
- data/sig/orb/models/new_floating_unit_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_maximum.rbs +97 -0
- data/sig/orb/models/new_minimum.rbs +102 -0
- data/sig/orb/models/new_percentage_discount.rbs +97 -0
- data/sig/orb/models/new_plan_bps_price.rbs +135 -0
- data/sig/orb/models/new_plan_bulk_bps_price.rbs +135 -0
- data/sig/orb/models/new_plan_bulk_price.rbs +135 -0
- data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_allocation_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_tiered_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_matrix_price.rbs +135 -0
- data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +135 -0
- data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_package_with_allocation_price.rbs +135 -0
- data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
- data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +135 -0
- data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +135 -0
- data/sig/orb/models/new_plan_tier_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_bps_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_package_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_price.rbs +135 -0
- data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +135 -0
- data/sig/orb/models/new_plan_unit_price.rbs +135 -0
- data/sig/orb/models/new_plan_unit_with_percent_price.rbs +135 -0
- data/sig/orb/models/new_plan_unit_with_proration_price.rbs +135 -0
- data/sig/orb/models/new_reporting_configuration.rbs +13 -0
- data/sig/orb/models/new_sphere_configuration.rbs +35 -0
- data/sig/orb/models/new_subscription_bps_price.rbs +140 -0
- data/sig/orb/models/new_subscription_bulk_bps_price.rbs +140 -0
- data/sig/orb/models/new_subscription_bulk_price.rbs +140 -0
- data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +140 -0
- data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_matrix_price.rbs +140 -0
- data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +140 -0
- data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +140 -0
- data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +140 -0
- data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +140 -0
- data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +140 -0
- data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tier_with_proration_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_bps_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_package_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_price.rbs +140 -0
- data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +140 -0
- data/sig/orb/models/new_subscription_unit_price.rbs +140 -0
- data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +140 -0
- data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +140 -0
- data/sig/orb/models/new_tax_jar_configuration.rbs +35 -0
- data/sig/orb/models/new_usage_discount.rbs +97 -0
- data/sig/orb/models/other_sub_line_item.rbs +50 -0
- data/sig/orb/models/package_config.rbs +15 -0
- data/sig/orb/models/per_price_cost.rbs +40 -0
- data/sig/orb/models/percentage_discount.rbs +4 -57
- data/sig/orb/models/percentage_discount_interval.rbs +55 -0
- data/sig/orb/models/plan.rbs +21 -871
- data/sig/orb/models/plan_create_params.rbs +28 -5952
- data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +65 -0
- data/sig/orb/models/plan_phase_maximum_adjustment.rbs +65 -0
- data/sig/orb/models/plan_phase_minimum_adjustment.rbs +70 -0
- data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +65 -0
- data/sig/orb/models/plan_version.rbs +5 -535
- data/sig/orb/models/price.rbs +2164 -11297
- data/sig/orb/models/price_create_params.rbs +58 -418
- data/sig/orb/models/price_evaluate_multiple_params.rbs +28 -6138
- data/sig/orb/models/price_evaluate_preview_events_params.rbs +166 -0
- data/sig/orb/models/price_evaluate_preview_events_response.rbs +50 -0
- data/sig/orb/models/price_interval.rbs +65 -0
- data/sig/orb/models/sub_line_item_grouping.rbs +15 -0
- data/sig/orb/models/sub_line_item_matrix_config.rbs +13 -0
- data/sig/orb/models/subscription.rbs +39 -1274
- data/sig/orb/models/subscription_change_apply_response.rbs +4 -1467
- data/sig/orb/models/subscription_change_cancel_response.rbs +4 -1467
- data/sig/orb/models/subscription_change_minified.rbs +13 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +4 -1467
- data/sig/orb/models/subscription_create_params.rbs +176 -14331
- data/sig/orb/models/subscription_fetch_costs_response.rbs +4 -82
- data/sig/orb/models/subscription_minified.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +61 -6945
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +178 -14333
- data/sig/orb/models/subscription_trial_info.rbs +13 -0
- data/sig/orb/models/tax_amount.rbs +30 -0
- data/sig/orb/models/threshold.rbs +13 -0
- data/sig/orb/models/tier.rbs +25 -0
- data/sig/orb/models/tier_config.rbs +26 -0
- data/sig/orb/models/tier_sub_line_item.rbs +55 -0
- data/sig/orb/models/tiered_bps_config.rbs +13 -0
- data/sig/orb/models/tiered_config.rbs +13 -0
- data/sig/orb/models/tiered_conversion_rate_config.rbs +35 -0
- data/sig/orb/models/transform_price_filter.rbs +56 -0
- data/sig/orb/models/trial_discount.rbs +4 -57
- data/sig/orb/models/unit_config.rbs +13 -0
- data/sig/orb/models/unit_conversion_rate_config.rbs +35 -0
- data/sig/orb/models/usage_discount.rbs +4 -57
- data/sig/orb/models/usage_discount_interval.rbs +55 -0
- data/sig/orb/models.rbs +342 -0
- data/sig/orb/resources/alerts.rbs +4 -4
- data/sig/orb/resources/customers.rbs +18 -18
- data/sig/orb/resources/prices.rbs +23 -13
- data/sig/orb/resources/subscriptions.rbs +13 -13
- metadata +545 -35
- data/lib/orb/models/subscription_cancel_response.rb +0 -1873
- data/lib/orb/models/subscription_create_response.rb +0 -1873
- data/lib/orb/models/subscription_price_intervals_response.rb +0 -1888
- data/lib/orb/models/subscription_redeem_coupon_response.rb +0 -1883
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +0 -1893
- data/lib/orb/models/subscription_trigger_phase_response.rb +0 -1883
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +0 -1897
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +0 -1912
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +0 -1908
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +0 -1897
- data/lib/orb/models/subscription_update_trial_response.rb +0 -1879
- data/rbi/orb/models/subscription_cancel_response.rbi +0 -3537
- data/rbi/orb/models/subscription_create_response.rbi +0 -3537
- data/rbi/orb/models/subscription_price_intervals_response.rbi +0 -3564
- data/rbi/orb/models/subscription_redeem_coupon_response.rbi +0 -3557
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +0 -3564
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +0 -3557
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +0 -3566
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +0 -3566
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +0 -3566
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +0 -3566
- data/rbi/orb/models/subscription_update_trial_response.rbi +0 -3556
- data/sig/orb/models/subscription_cancel_response.rbs +0 -1445
- data/sig/orb/models/subscription_create_response.rbs +0 -1445
- data/sig/orb/models/subscription_price_intervals_response.rbs +0 -1445
- data/sig/orb/models/subscription_redeem_coupon_response.rbs +0 -1445
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +0 -1445
- data/sig/orb/models/subscription_trigger_phase_response.rbs +0 -1445
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +0 -1445
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +0 -1445
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +0 -1445
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +0 -1445
- data/sig/orb/models/subscription_update_trial_response.rbs +0 -1445
@@ -0,0 +1,197 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
class NewFloatingBulkPrice < Orb::Internal::Type::BaseModel
|
6
|
+
# @!attribute bulk_config
|
7
|
+
#
|
8
|
+
# @return [Orb::Models::BulkConfig]
|
9
|
+
required :bulk_config, -> { Orb::BulkConfig }
|
10
|
+
|
11
|
+
# @!attribute cadence
|
12
|
+
# The cadence to bill for this price on.
|
13
|
+
#
|
14
|
+
# @return [Symbol, Orb::Models::NewFloatingBulkPrice::Cadence]
|
15
|
+
required :cadence, enum: -> { Orb::NewFloatingBulkPrice::Cadence }
|
16
|
+
|
17
|
+
# @!attribute currency
|
18
|
+
# An ISO 4217 currency string for which this price is billed in.
|
19
|
+
#
|
20
|
+
# @return [String]
|
21
|
+
required :currency, String
|
22
|
+
|
23
|
+
# @!attribute item_id
|
24
|
+
# The id of the item the price will be associated with.
|
25
|
+
#
|
26
|
+
# @return [String]
|
27
|
+
required :item_id, String
|
28
|
+
|
29
|
+
# @!attribute model_type
|
30
|
+
#
|
31
|
+
# @return [Symbol, Orb::Models::NewFloatingBulkPrice::ModelType]
|
32
|
+
required :model_type, enum: -> { Orb::NewFloatingBulkPrice::ModelType }
|
33
|
+
|
34
|
+
# @!attribute name
|
35
|
+
# The name of the price.
|
36
|
+
#
|
37
|
+
# @return [String]
|
38
|
+
required :name, String
|
39
|
+
|
40
|
+
# @!attribute billable_metric_id
|
41
|
+
# The id of the billable metric for the price. Only needed if the price is
|
42
|
+
# usage-based.
|
43
|
+
#
|
44
|
+
# @return [String, nil]
|
45
|
+
optional :billable_metric_id, String, nil?: true
|
46
|
+
|
47
|
+
# @!attribute billed_in_advance
|
48
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
49
|
+
# this is true, and in-arrears if this is false.
|
50
|
+
#
|
51
|
+
# @return [Boolean, nil]
|
52
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
53
|
+
|
54
|
+
# @!attribute billing_cycle_configuration
|
55
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
56
|
+
# months.
|
57
|
+
#
|
58
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
59
|
+
optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
60
|
+
|
61
|
+
# @!attribute conversion_rate
|
62
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
63
|
+
#
|
64
|
+
# @return [Float, nil]
|
65
|
+
optional :conversion_rate, Float, nil?: true
|
66
|
+
|
67
|
+
# @!attribute conversion_rate_config
|
68
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
69
|
+
#
|
70
|
+
# @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
|
71
|
+
optional :conversion_rate_config,
|
72
|
+
union: -> { Orb::NewFloatingBulkPrice::ConversionRateConfig },
|
73
|
+
nil?: true
|
74
|
+
|
75
|
+
# @!attribute dimensional_price_configuration
|
76
|
+
# For dimensional price: specifies a price group and dimension values
|
77
|
+
#
|
78
|
+
# @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
|
79
|
+
optional :dimensional_price_configuration, -> { Orb::NewDimensionalPriceConfiguration }, nil?: true
|
80
|
+
|
81
|
+
# @!attribute external_price_id
|
82
|
+
# An alias for the price.
|
83
|
+
#
|
84
|
+
# @return [String, nil]
|
85
|
+
optional :external_price_id, String, nil?: true
|
86
|
+
|
87
|
+
# @!attribute fixed_price_quantity
|
88
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
89
|
+
# applied.
|
90
|
+
#
|
91
|
+
# @return [Float, nil]
|
92
|
+
optional :fixed_price_quantity, Float, nil?: true
|
93
|
+
|
94
|
+
# @!attribute invoice_grouping_key
|
95
|
+
# The property used to group this price on an invoice
|
96
|
+
#
|
97
|
+
# @return [String, nil]
|
98
|
+
optional :invoice_grouping_key, String, nil?: true
|
99
|
+
|
100
|
+
# @!attribute invoicing_cycle_configuration
|
101
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
102
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
103
|
+
#
|
104
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
105
|
+
optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
106
|
+
|
107
|
+
# @!attribute metadata
|
108
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
109
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
110
|
+
# by setting `metadata` to `null`.
|
111
|
+
#
|
112
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
113
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
114
|
+
|
115
|
+
# @!method initialize(bulk_config:, cadence:, currency:, item_id:, model_type:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
|
116
|
+
# Some parameter documentations has been truncated, see
|
117
|
+
# {Orb::Models::NewFloatingBulkPrice} for more details.
|
118
|
+
#
|
119
|
+
# @param bulk_config [Orb::Models::BulkConfig]
|
120
|
+
#
|
121
|
+
# @param cadence [Symbol, Orb::Models::NewFloatingBulkPrice::Cadence] The cadence to bill for this price on.
|
122
|
+
#
|
123
|
+
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
124
|
+
#
|
125
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
126
|
+
#
|
127
|
+
# @param model_type [Symbol, Orb::Models::NewFloatingBulkPrice::ModelType]
|
128
|
+
#
|
129
|
+
# @param name [String] The name of the price.
|
130
|
+
#
|
131
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
132
|
+
#
|
133
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
134
|
+
#
|
135
|
+
# @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
136
|
+
#
|
137
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
138
|
+
#
|
139
|
+
# @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
|
140
|
+
#
|
141
|
+
# @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
142
|
+
#
|
143
|
+
# @param external_price_id [String, nil] An alias for the price.
|
144
|
+
#
|
145
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
146
|
+
#
|
147
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
148
|
+
#
|
149
|
+
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
150
|
+
#
|
151
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
152
|
+
|
153
|
+
# The cadence to bill for this price on.
|
154
|
+
#
|
155
|
+
# @see Orb::Models::NewFloatingBulkPrice#cadence
|
156
|
+
module Cadence
|
157
|
+
extend Orb::Internal::Type::Enum
|
158
|
+
|
159
|
+
ANNUAL = :annual
|
160
|
+
SEMI_ANNUAL = :semi_annual
|
161
|
+
MONTHLY = :monthly
|
162
|
+
QUARTERLY = :quarterly
|
163
|
+
ONE_TIME = :one_time
|
164
|
+
CUSTOM = :custom
|
165
|
+
|
166
|
+
# @!method self.values
|
167
|
+
# @return [Array<Symbol>]
|
168
|
+
end
|
169
|
+
|
170
|
+
# @see Orb::Models::NewFloatingBulkPrice#model_type
|
171
|
+
module ModelType
|
172
|
+
extend Orb::Internal::Type::Enum
|
173
|
+
|
174
|
+
BULK = :bulk
|
175
|
+
|
176
|
+
# @!method self.values
|
177
|
+
# @return [Array<Symbol>]
|
178
|
+
end
|
179
|
+
|
180
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
181
|
+
#
|
182
|
+
# @see Orb::Models::NewFloatingBulkPrice#conversion_rate_config
|
183
|
+
module ConversionRateConfig
|
184
|
+
extend Orb::Internal::Type::Union
|
185
|
+
|
186
|
+
discriminator :conversion_rate_type
|
187
|
+
|
188
|
+
variant :unit, -> { Orb::UnitConversionRateConfig }
|
189
|
+
|
190
|
+
variant :tiered, -> { Orb::TieredConversionRateConfig }
|
191
|
+
|
192
|
+
# @!method self.variants
|
193
|
+
# @return [Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig)]
|
194
|
+
end
|
195
|
+
end
|
196
|
+
end
|
197
|
+
end
|
@@ -0,0 +1,197 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
class NewFloatingBulkWithProrationPrice < Orb::Internal::Type::BaseModel
|
6
|
+
# @!attribute bulk_with_proration_config
|
7
|
+
#
|
8
|
+
# @return [Hash{Symbol=>Object}]
|
9
|
+
required :bulk_with_proration_config, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
|
10
|
+
|
11
|
+
# @!attribute cadence
|
12
|
+
# The cadence to bill for this price on.
|
13
|
+
#
|
14
|
+
# @return [Symbol, Orb::Models::NewFloatingBulkWithProrationPrice::Cadence]
|
15
|
+
required :cadence, enum: -> { Orb::NewFloatingBulkWithProrationPrice::Cadence }
|
16
|
+
|
17
|
+
# @!attribute currency
|
18
|
+
# An ISO 4217 currency string for which this price is billed in.
|
19
|
+
#
|
20
|
+
# @return [String]
|
21
|
+
required :currency, String
|
22
|
+
|
23
|
+
# @!attribute item_id
|
24
|
+
# The id of the item the price will be associated with.
|
25
|
+
#
|
26
|
+
# @return [String]
|
27
|
+
required :item_id, String
|
28
|
+
|
29
|
+
# @!attribute model_type
|
30
|
+
#
|
31
|
+
# @return [Symbol, Orb::Models::NewFloatingBulkWithProrationPrice::ModelType]
|
32
|
+
required :model_type, enum: -> { Orb::NewFloatingBulkWithProrationPrice::ModelType }
|
33
|
+
|
34
|
+
# @!attribute name
|
35
|
+
# The name of the price.
|
36
|
+
#
|
37
|
+
# @return [String]
|
38
|
+
required :name, String
|
39
|
+
|
40
|
+
# @!attribute billable_metric_id
|
41
|
+
# The id of the billable metric for the price. Only needed if the price is
|
42
|
+
# usage-based.
|
43
|
+
#
|
44
|
+
# @return [String, nil]
|
45
|
+
optional :billable_metric_id, String, nil?: true
|
46
|
+
|
47
|
+
# @!attribute billed_in_advance
|
48
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
49
|
+
# this is true, and in-arrears if this is false.
|
50
|
+
#
|
51
|
+
# @return [Boolean, nil]
|
52
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
53
|
+
|
54
|
+
# @!attribute billing_cycle_configuration
|
55
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
56
|
+
# months.
|
57
|
+
#
|
58
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
59
|
+
optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
60
|
+
|
61
|
+
# @!attribute conversion_rate
|
62
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
63
|
+
#
|
64
|
+
# @return [Float, nil]
|
65
|
+
optional :conversion_rate, Float, nil?: true
|
66
|
+
|
67
|
+
# @!attribute conversion_rate_config
|
68
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
69
|
+
#
|
70
|
+
# @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
|
71
|
+
optional :conversion_rate_config,
|
72
|
+
union: -> { Orb::NewFloatingBulkWithProrationPrice::ConversionRateConfig },
|
73
|
+
nil?: true
|
74
|
+
|
75
|
+
# @!attribute dimensional_price_configuration
|
76
|
+
# For dimensional price: specifies a price group and dimension values
|
77
|
+
#
|
78
|
+
# @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
|
79
|
+
optional :dimensional_price_configuration, -> { Orb::NewDimensionalPriceConfiguration }, nil?: true
|
80
|
+
|
81
|
+
# @!attribute external_price_id
|
82
|
+
# An alias for the price.
|
83
|
+
#
|
84
|
+
# @return [String, nil]
|
85
|
+
optional :external_price_id, String, nil?: true
|
86
|
+
|
87
|
+
# @!attribute fixed_price_quantity
|
88
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
89
|
+
# applied.
|
90
|
+
#
|
91
|
+
# @return [Float, nil]
|
92
|
+
optional :fixed_price_quantity, Float, nil?: true
|
93
|
+
|
94
|
+
# @!attribute invoice_grouping_key
|
95
|
+
# The property used to group this price on an invoice
|
96
|
+
#
|
97
|
+
# @return [String, nil]
|
98
|
+
optional :invoice_grouping_key, String, nil?: true
|
99
|
+
|
100
|
+
# @!attribute invoicing_cycle_configuration
|
101
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
102
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
103
|
+
#
|
104
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
105
|
+
optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
106
|
+
|
107
|
+
# @!attribute metadata
|
108
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
109
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
110
|
+
# by setting `metadata` to `null`.
|
111
|
+
#
|
112
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
113
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
114
|
+
|
115
|
+
# @!method initialize(bulk_with_proration_config:, cadence:, currency:, item_id:, model_type:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
|
116
|
+
# Some parameter documentations has been truncated, see
|
117
|
+
# {Orb::Models::NewFloatingBulkWithProrationPrice} for more details.
|
118
|
+
#
|
119
|
+
# @param bulk_with_proration_config [Hash{Symbol=>Object}]
|
120
|
+
#
|
121
|
+
# @param cadence [Symbol, Orb::Models::NewFloatingBulkWithProrationPrice::Cadence] The cadence to bill for this price on.
|
122
|
+
#
|
123
|
+
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
124
|
+
#
|
125
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
126
|
+
#
|
127
|
+
# @param model_type [Symbol, Orb::Models::NewFloatingBulkWithProrationPrice::ModelType]
|
128
|
+
#
|
129
|
+
# @param name [String] The name of the price.
|
130
|
+
#
|
131
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
132
|
+
#
|
133
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
134
|
+
#
|
135
|
+
# @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
136
|
+
#
|
137
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
138
|
+
#
|
139
|
+
# @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
|
140
|
+
#
|
141
|
+
# @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
142
|
+
#
|
143
|
+
# @param external_price_id [String, nil] An alias for the price.
|
144
|
+
#
|
145
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
146
|
+
#
|
147
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
148
|
+
#
|
149
|
+
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
150
|
+
#
|
151
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
152
|
+
|
153
|
+
# The cadence to bill for this price on.
|
154
|
+
#
|
155
|
+
# @see Orb::Models::NewFloatingBulkWithProrationPrice#cadence
|
156
|
+
module Cadence
|
157
|
+
extend Orb::Internal::Type::Enum
|
158
|
+
|
159
|
+
ANNUAL = :annual
|
160
|
+
SEMI_ANNUAL = :semi_annual
|
161
|
+
MONTHLY = :monthly
|
162
|
+
QUARTERLY = :quarterly
|
163
|
+
ONE_TIME = :one_time
|
164
|
+
CUSTOM = :custom
|
165
|
+
|
166
|
+
# @!method self.values
|
167
|
+
# @return [Array<Symbol>]
|
168
|
+
end
|
169
|
+
|
170
|
+
# @see Orb::Models::NewFloatingBulkWithProrationPrice#model_type
|
171
|
+
module ModelType
|
172
|
+
extend Orb::Internal::Type::Enum
|
173
|
+
|
174
|
+
BULK_WITH_PRORATION = :bulk_with_proration
|
175
|
+
|
176
|
+
# @!method self.values
|
177
|
+
# @return [Array<Symbol>]
|
178
|
+
end
|
179
|
+
|
180
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
181
|
+
#
|
182
|
+
# @see Orb::Models::NewFloatingBulkWithProrationPrice#conversion_rate_config
|
183
|
+
module ConversionRateConfig
|
184
|
+
extend Orb::Internal::Type::Union
|
185
|
+
|
186
|
+
discriminator :conversion_rate_type
|
187
|
+
|
188
|
+
variant :unit, -> { Orb::UnitConversionRateConfig }
|
189
|
+
|
190
|
+
variant :tiered, -> { Orb::TieredConversionRateConfig }
|
191
|
+
|
192
|
+
# @!method self.variants
|
193
|
+
# @return [Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig)]
|
194
|
+
end
|
195
|
+
end
|
196
|
+
end
|
197
|
+
end
|
@@ -0,0 +1,197 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
class NewFloatingCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel
|
6
|
+
# @!attribute cadence
|
7
|
+
# The cadence to bill for this price on.
|
8
|
+
#
|
9
|
+
# @return [Symbol, Orb::Models::NewFloatingCumulativeGroupedBulkPrice::Cadence]
|
10
|
+
required :cadence, enum: -> { Orb::NewFloatingCumulativeGroupedBulkPrice::Cadence }
|
11
|
+
|
12
|
+
# @!attribute cumulative_grouped_bulk_config
|
13
|
+
#
|
14
|
+
# @return [Hash{Symbol=>Object}]
|
15
|
+
required :cumulative_grouped_bulk_config, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
|
16
|
+
|
17
|
+
# @!attribute currency
|
18
|
+
# An ISO 4217 currency string for which this price is billed in.
|
19
|
+
#
|
20
|
+
# @return [String]
|
21
|
+
required :currency, String
|
22
|
+
|
23
|
+
# @!attribute item_id
|
24
|
+
# The id of the item the price will be associated with.
|
25
|
+
#
|
26
|
+
# @return [String]
|
27
|
+
required :item_id, String
|
28
|
+
|
29
|
+
# @!attribute model_type
|
30
|
+
#
|
31
|
+
# @return [Symbol, Orb::Models::NewFloatingCumulativeGroupedBulkPrice::ModelType]
|
32
|
+
required :model_type, enum: -> { Orb::NewFloatingCumulativeGroupedBulkPrice::ModelType }
|
33
|
+
|
34
|
+
# @!attribute name
|
35
|
+
# The name of the price.
|
36
|
+
#
|
37
|
+
# @return [String]
|
38
|
+
required :name, String
|
39
|
+
|
40
|
+
# @!attribute billable_metric_id
|
41
|
+
# The id of the billable metric for the price. Only needed if the price is
|
42
|
+
# usage-based.
|
43
|
+
#
|
44
|
+
# @return [String, nil]
|
45
|
+
optional :billable_metric_id, String, nil?: true
|
46
|
+
|
47
|
+
# @!attribute billed_in_advance
|
48
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
49
|
+
# this is true, and in-arrears if this is false.
|
50
|
+
#
|
51
|
+
# @return [Boolean, nil]
|
52
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
53
|
+
|
54
|
+
# @!attribute billing_cycle_configuration
|
55
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
56
|
+
# months.
|
57
|
+
#
|
58
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
59
|
+
optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
60
|
+
|
61
|
+
# @!attribute conversion_rate
|
62
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
63
|
+
#
|
64
|
+
# @return [Float, nil]
|
65
|
+
optional :conversion_rate, Float, nil?: true
|
66
|
+
|
67
|
+
# @!attribute conversion_rate_config
|
68
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
69
|
+
#
|
70
|
+
# @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
|
71
|
+
optional :conversion_rate_config,
|
72
|
+
union: -> { Orb::NewFloatingCumulativeGroupedBulkPrice::ConversionRateConfig },
|
73
|
+
nil?: true
|
74
|
+
|
75
|
+
# @!attribute dimensional_price_configuration
|
76
|
+
# For dimensional price: specifies a price group and dimension values
|
77
|
+
#
|
78
|
+
# @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
|
79
|
+
optional :dimensional_price_configuration, -> { Orb::NewDimensionalPriceConfiguration }, nil?: true
|
80
|
+
|
81
|
+
# @!attribute external_price_id
|
82
|
+
# An alias for the price.
|
83
|
+
#
|
84
|
+
# @return [String, nil]
|
85
|
+
optional :external_price_id, String, nil?: true
|
86
|
+
|
87
|
+
# @!attribute fixed_price_quantity
|
88
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
89
|
+
# applied.
|
90
|
+
#
|
91
|
+
# @return [Float, nil]
|
92
|
+
optional :fixed_price_quantity, Float, nil?: true
|
93
|
+
|
94
|
+
# @!attribute invoice_grouping_key
|
95
|
+
# The property used to group this price on an invoice
|
96
|
+
#
|
97
|
+
# @return [String, nil]
|
98
|
+
optional :invoice_grouping_key, String, nil?: true
|
99
|
+
|
100
|
+
# @!attribute invoicing_cycle_configuration
|
101
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
102
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
103
|
+
#
|
104
|
+
# @return [Orb::Models::NewBillingCycleConfiguration, nil]
|
105
|
+
optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
|
106
|
+
|
107
|
+
# @!attribute metadata
|
108
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
109
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
110
|
+
# by setting `metadata` to `null`.
|
111
|
+
#
|
112
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
113
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
114
|
+
|
115
|
+
# @!method initialize(cadence:, cumulative_grouped_bulk_config:, currency:, item_id:, model_type:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil)
|
116
|
+
# Some parameter documentations has been truncated, see
|
117
|
+
# {Orb::Models::NewFloatingCumulativeGroupedBulkPrice} for more details.
|
118
|
+
#
|
119
|
+
# @param cadence [Symbol, Orb::Models::NewFloatingCumulativeGroupedBulkPrice::Cadence] The cadence to bill for this price on.
|
120
|
+
#
|
121
|
+
# @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
|
122
|
+
#
|
123
|
+
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
124
|
+
#
|
125
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
126
|
+
#
|
127
|
+
# @param model_type [Symbol, Orb::Models::NewFloatingCumulativeGroupedBulkPrice::ModelType]
|
128
|
+
#
|
129
|
+
# @param name [String] The name of the price.
|
130
|
+
#
|
131
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
132
|
+
#
|
133
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
134
|
+
#
|
135
|
+
# @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
136
|
+
#
|
137
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
138
|
+
#
|
139
|
+
# @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
|
140
|
+
#
|
141
|
+
# @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
142
|
+
#
|
143
|
+
# @param external_price_id [String, nil] An alias for the price.
|
144
|
+
#
|
145
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
146
|
+
#
|
147
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
148
|
+
#
|
149
|
+
# @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
150
|
+
#
|
151
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
152
|
+
|
153
|
+
# The cadence to bill for this price on.
|
154
|
+
#
|
155
|
+
# @see Orb::Models::NewFloatingCumulativeGroupedBulkPrice#cadence
|
156
|
+
module Cadence
|
157
|
+
extend Orb::Internal::Type::Enum
|
158
|
+
|
159
|
+
ANNUAL = :annual
|
160
|
+
SEMI_ANNUAL = :semi_annual
|
161
|
+
MONTHLY = :monthly
|
162
|
+
QUARTERLY = :quarterly
|
163
|
+
ONE_TIME = :one_time
|
164
|
+
CUSTOM = :custom
|
165
|
+
|
166
|
+
# @!method self.values
|
167
|
+
# @return [Array<Symbol>]
|
168
|
+
end
|
169
|
+
|
170
|
+
# @see Orb::Models::NewFloatingCumulativeGroupedBulkPrice#model_type
|
171
|
+
module ModelType
|
172
|
+
extend Orb::Internal::Type::Enum
|
173
|
+
|
174
|
+
CUMULATIVE_GROUPED_BULK = :cumulative_grouped_bulk
|
175
|
+
|
176
|
+
# @!method self.values
|
177
|
+
# @return [Array<Symbol>]
|
178
|
+
end
|
179
|
+
|
180
|
+
# The configuration for the rate of the price currency to the invoicing currency.
|
181
|
+
#
|
182
|
+
# @see Orb::Models::NewFloatingCumulativeGroupedBulkPrice#conversion_rate_config
|
183
|
+
module ConversionRateConfig
|
184
|
+
extend Orb::Internal::Type::Union
|
185
|
+
|
186
|
+
discriminator :conversion_rate_type
|
187
|
+
|
188
|
+
variant :unit, -> { Orb::UnitConversionRateConfig }
|
189
|
+
|
190
|
+
variant :tiered, -> { Orb::TieredConversionRateConfig }
|
191
|
+
|
192
|
+
# @!method self.variants
|
193
|
+
# @return [Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig)]
|
194
|
+
end
|
195
|
+
end
|
196
|
+
end
|
197
|
+
end
|