orb-billing 0.12.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -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
@@ -22,7 +22,7 @@ module Orb
|
|
22
22
|
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
23
23
|
# discounts -> minimums -> maximums).
|
24
24
|
#
|
25
|
-
# @return [Array<Orb::Models::
|
25
|
+
# @return [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>]
|
26
26
|
required :adjustments,
|
27
27
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::Adjustment] }
|
28
28
|
|
@@ -69,8 +69,8 @@ module Orb
|
|
69
69
|
#
|
70
70
|
# This field is deprecated in favor of `adjustments`.
|
71
71
|
#
|
72
|
-
# @return [Orb::Models::
|
73
|
-
required :maximum, -> { Orb::
|
72
|
+
# @return [Orb::Models::Maximum, nil]
|
73
|
+
required :maximum, -> { Orb::Maximum }, nil?: true
|
74
74
|
|
75
75
|
# @!attribute maximum_amount
|
76
76
|
# @deprecated
|
@@ -85,8 +85,8 @@ module Orb
|
|
85
85
|
#
|
86
86
|
# This field is deprecated in favor of `adjustments`.
|
87
87
|
#
|
88
|
-
# @return [Orb::Models::
|
89
|
-
required :minimum, -> { Orb::
|
88
|
+
# @return [Orb::Models::Minimum, nil]
|
89
|
+
required :minimum, -> { Orb::Minimum }, nil?: true
|
90
90
|
|
91
91
|
# @!attribute minimum_amount
|
92
92
|
# @deprecated
|
@@ -120,7 +120,7 @@ module Orb
|
|
120
120
|
# For more on the types of prices, see
|
121
121
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
122
122
|
#
|
123
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::
|
123
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
124
124
|
required :price, union: -> { Orb::Price }
|
125
125
|
|
126
126
|
# @!attribute quantity
|
@@ -139,7 +139,7 @@ module Orb
|
|
139
139
|
# For complex pricing structures, the line item can be broken down further in
|
140
140
|
# `sub_line_items`.
|
141
141
|
#
|
142
|
-
# @return [Array<Orb::Models::
|
142
|
+
# @return [Array<Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem>]
|
143
143
|
required :sub_line_items,
|
144
144
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem] }
|
145
145
|
|
@@ -153,9 +153,8 @@ module Orb
|
|
153
153
|
# An array of tax rates and their incurred tax amounts. Empty if no tax
|
154
154
|
# integration is configured.
|
155
155
|
#
|
156
|
-
# @return [Array<Orb::Models::
|
157
|
-
required :tax_amounts,
|
158
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::TaxAmount] }
|
156
|
+
# @return [Array<Orb::Models::TaxAmount>]
|
157
|
+
required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::TaxAmount] }
|
159
158
|
|
160
159
|
# @!attribute usage_customer_ids
|
161
160
|
# A list of customer ids that were used to calculate the usage for this line item.
|
@@ -171,7 +170,7 @@ module Orb
|
|
171
170
|
#
|
172
171
|
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
173
172
|
#
|
174
|
-
# @param adjustments [Array<Orb::Models::
|
173
|
+
# @param adjustments [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>] All adjustments applied to the line item in the order they were applied based on
|
175
174
|
#
|
176
175
|
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
177
176
|
#
|
@@ -185,11 +184,11 @@ module Orb
|
|
185
184
|
#
|
186
185
|
# @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
|
187
186
|
#
|
188
|
-
# @param maximum [Orb::Models::
|
187
|
+
# @param maximum [Orb::Models::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
189
188
|
#
|
190
189
|
# @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
191
190
|
#
|
192
|
-
# @param minimum [Orb::Models::
|
191
|
+
# @param minimum [Orb::Models::Minimum, nil] This field is deprecated in favor of `adjustments`.
|
193
192
|
#
|
194
193
|
# @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
195
194
|
#
|
@@ -197,17 +196,17 @@ module Orb
|
|
197
196
|
#
|
198
197
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
199
198
|
#
|
200
|
-
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::
|
199
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
201
200
|
#
|
202
201
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
203
202
|
#
|
204
203
|
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
205
204
|
#
|
206
|
-
# @param sub_line_items [Array<Orb::Models::
|
205
|
+
# @param sub_line_items [Array<Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem>] For complex pricing structures, the line item can be broken down further in `sub
|
207
206
|
#
|
208
207
|
# @param subtotal [String] The line amount before before any adjustments.
|
209
208
|
#
|
210
|
-
# @param tax_amounts [Array<Orb::Models::
|
209
|
+
# @param tax_amounts [Array<Orb::Models::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
211
210
|
#
|
212
211
|
# @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
|
213
212
|
|
@@ -216,877 +215,18 @@ module Orb
|
|
216
215
|
|
217
216
|
discriminator :adjustment_type
|
218
217
|
|
219
|
-
variant :usage_discount, -> { Orb::
|
218
|
+
variant :usage_discount, -> { Orb::MonetaryUsageDiscountAdjustment }
|
220
219
|
|
221
|
-
variant :amount_discount, -> { Orb::
|
220
|
+
variant :amount_discount, -> { Orb::MonetaryAmountDiscountAdjustment }
|
222
221
|
|
223
|
-
variant :percentage_discount,
|
224
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount }
|
222
|
+
variant :percentage_discount, -> { Orb::MonetaryPercentageDiscountAdjustment }
|
225
223
|
|
226
|
-
variant :minimum, -> { Orb::
|
224
|
+
variant :minimum, -> { Orb::MonetaryMinimumAdjustment }
|
227
225
|
|
228
|
-
variant :maximum, -> { Orb::
|
229
|
-
|
230
|
-
class UsageDiscount < Orb::Internal::Type::BaseModel
|
231
|
-
# @!attribute id
|
232
|
-
#
|
233
|
-
# @return [String]
|
234
|
-
required :id, String
|
235
|
-
|
236
|
-
# @!attribute adjustment_type
|
237
|
-
#
|
238
|
-
# @return [Symbol, :usage_discount]
|
239
|
-
required :adjustment_type, const: :usage_discount
|
240
|
-
|
241
|
-
# @!attribute amount
|
242
|
-
# The value applied by an adjustment.
|
243
|
-
#
|
244
|
-
# @return [String]
|
245
|
-
required :amount, String
|
246
|
-
|
247
|
-
# @!attribute applies_to_price_ids
|
248
|
-
# @deprecated
|
249
|
-
#
|
250
|
-
# The price IDs that this adjustment applies to.
|
251
|
-
#
|
252
|
-
# @return [Array<String>]
|
253
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
254
|
-
|
255
|
-
# @!attribute filters
|
256
|
-
# The filters that determine which prices to apply this adjustment to.
|
257
|
-
#
|
258
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter>]
|
259
|
-
required :filters,
|
260
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter] }
|
261
|
-
|
262
|
-
# @!attribute is_invoice_level
|
263
|
-
# True for adjustments that apply to an entire invocice, false for adjustments
|
264
|
-
# that apply to only one price.
|
265
|
-
#
|
266
|
-
# @return [Boolean]
|
267
|
-
required :is_invoice_level, Orb::Internal::Type::Boolean
|
268
|
-
|
269
|
-
# @!attribute reason
|
270
|
-
# The reason for the adjustment.
|
271
|
-
#
|
272
|
-
# @return [String, nil]
|
273
|
-
required :reason, String, nil?: true
|
274
|
-
|
275
|
-
# @!attribute usage_discount
|
276
|
-
# The number of usage units by which to discount the price this adjustment applies
|
277
|
-
# to in a given billing period.
|
278
|
-
#
|
279
|
-
# @return [Float]
|
280
|
-
required :usage_discount, Float
|
281
|
-
|
282
|
-
# @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
283
|
-
# Some parameter documentations has been truncated, see
|
284
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount} for more
|
285
|
-
# details.
|
286
|
-
#
|
287
|
-
# @param id [String]
|
288
|
-
#
|
289
|
-
# @param amount [String] The value applied by an adjustment.
|
290
|
-
#
|
291
|
-
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
292
|
-
#
|
293
|
-
# @param filters [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
294
|
-
#
|
295
|
-
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
296
|
-
#
|
297
|
-
# @param reason [String, nil] The reason for the adjustment.
|
298
|
-
#
|
299
|
-
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
300
|
-
#
|
301
|
-
# @param adjustment_type [Symbol, :usage_discount]
|
302
|
-
|
303
|
-
class Filter < Orb::Internal::Type::BaseModel
|
304
|
-
# @!attribute field
|
305
|
-
# The property of the price to filter on.
|
306
|
-
#
|
307
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter::Field]
|
308
|
-
required :field,
|
309
|
-
enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter::Field }
|
310
|
-
|
311
|
-
# @!attribute operator
|
312
|
-
# Should prices that match the filter be included or excluded.
|
313
|
-
#
|
314
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter::Operator]
|
315
|
-
required :operator,
|
316
|
-
enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter::Operator }
|
317
|
-
|
318
|
-
# @!attribute values
|
319
|
-
# The IDs or values that match this filter.
|
320
|
-
#
|
321
|
-
# @return [Array<String>]
|
322
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
323
|
-
|
324
|
-
# @!method initialize(field:, operator:, values:)
|
325
|
-
# @param field [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter::Field] The property of the price to filter on.
|
326
|
-
#
|
327
|
-
# @param operator [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
328
|
-
#
|
329
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
330
|
-
|
331
|
-
# The property of the price to filter on.
|
332
|
-
#
|
333
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter#field
|
334
|
-
module Field
|
335
|
-
extend Orb::Internal::Type::Enum
|
336
|
-
|
337
|
-
PRICE_ID = :price_id
|
338
|
-
ITEM_ID = :item_id
|
339
|
-
PRICE_TYPE = :price_type
|
340
|
-
CURRENCY = :currency
|
341
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
342
|
-
|
343
|
-
# @!method self.values
|
344
|
-
# @return [Array<Symbol>]
|
345
|
-
end
|
346
|
-
|
347
|
-
# Should prices that match the filter be included or excluded.
|
348
|
-
#
|
349
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount::Filter#operator
|
350
|
-
module Operator
|
351
|
-
extend Orb::Internal::Type::Enum
|
352
|
-
|
353
|
-
INCLUDES = :includes
|
354
|
-
EXCLUDES = :excludes
|
355
|
-
|
356
|
-
# @!method self.values
|
357
|
-
# @return [Array<Symbol>]
|
358
|
-
end
|
359
|
-
end
|
360
|
-
end
|
361
|
-
|
362
|
-
class AmountDiscount < Orb::Internal::Type::BaseModel
|
363
|
-
# @!attribute id
|
364
|
-
#
|
365
|
-
# @return [String]
|
366
|
-
required :id, String
|
367
|
-
|
368
|
-
# @!attribute adjustment_type
|
369
|
-
#
|
370
|
-
# @return [Symbol, :amount_discount]
|
371
|
-
required :adjustment_type, const: :amount_discount
|
372
|
-
|
373
|
-
# @!attribute amount
|
374
|
-
# The value applied by an adjustment.
|
375
|
-
#
|
376
|
-
# @return [String]
|
377
|
-
required :amount, String
|
378
|
-
|
379
|
-
# @!attribute amount_discount
|
380
|
-
# The amount by which to discount the prices this adjustment applies to in a given
|
381
|
-
# billing period.
|
382
|
-
#
|
383
|
-
# @return [String]
|
384
|
-
required :amount_discount, String
|
385
|
-
|
386
|
-
# @!attribute applies_to_price_ids
|
387
|
-
# @deprecated
|
388
|
-
#
|
389
|
-
# The price IDs that this adjustment applies to.
|
390
|
-
#
|
391
|
-
# @return [Array<String>]
|
392
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
393
|
-
|
394
|
-
# @!attribute filters
|
395
|
-
# The filters that determine which prices to apply this adjustment to.
|
396
|
-
#
|
397
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter>]
|
398
|
-
required :filters,
|
399
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter] }
|
400
|
-
|
401
|
-
# @!attribute is_invoice_level
|
402
|
-
# True for adjustments that apply to an entire invocice, false for adjustments
|
403
|
-
# that apply to only one price.
|
404
|
-
#
|
405
|
-
# @return [Boolean]
|
406
|
-
required :is_invoice_level, Orb::Internal::Type::Boolean
|
407
|
-
|
408
|
-
# @!attribute reason
|
409
|
-
# The reason for the adjustment.
|
410
|
-
#
|
411
|
-
# @return [String, nil]
|
412
|
-
required :reason, String, nil?: true
|
413
|
-
|
414
|
-
# @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
|
415
|
-
# Some parameter documentations has been truncated, see
|
416
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount} for
|
417
|
-
# more details.
|
418
|
-
#
|
419
|
-
# @param id [String]
|
420
|
-
#
|
421
|
-
# @param amount [String] The value applied by an adjustment.
|
422
|
-
#
|
423
|
-
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
424
|
-
#
|
425
|
-
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
426
|
-
#
|
427
|
-
# @param filters [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
428
|
-
#
|
429
|
-
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
430
|
-
#
|
431
|
-
# @param reason [String, nil] The reason for the adjustment.
|
432
|
-
#
|
433
|
-
# @param adjustment_type [Symbol, :amount_discount]
|
434
|
-
|
435
|
-
class Filter < Orb::Internal::Type::BaseModel
|
436
|
-
# @!attribute field
|
437
|
-
# The property of the price to filter on.
|
438
|
-
#
|
439
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter::Field]
|
440
|
-
required :field,
|
441
|
-
enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter::Field }
|
442
|
-
|
443
|
-
# @!attribute operator
|
444
|
-
# Should prices that match the filter be included or excluded.
|
445
|
-
#
|
446
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter::Operator]
|
447
|
-
required :operator,
|
448
|
-
enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter::Operator }
|
449
|
-
|
450
|
-
# @!attribute values
|
451
|
-
# The IDs or values that match this filter.
|
452
|
-
#
|
453
|
-
# @return [Array<String>]
|
454
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
455
|
-
|
456
|
-
# @!method initialize(field:, operator:, values:)
|
457
|
-
# @param field [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter::Field] The property of the price to filter on.
|
458
|
-
#
|
459
|
-
# @param operator [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
460
|
-
#
|
461
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
462
|
-
|
463
|
-
# The property of the price to filter on.
|
464
|
-
#
|
465
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter#field
|
466
|
-
module Field
|
467
|
-
extend Orb::Internal::Type::Enum
|
468
|
-
|
469
|
-
PRICE_ID = :price_id
|
470
|
-
ITEM_ID = :item_id
|
471
|
-
PRICE_TYPE = :price_type
|
472
|
-
CURRENCY = :currency
|
473
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
474
|
-
|
475
|
-
# @!method self.values
|
476
|
-
# @return [Array<Symbol>]
|
477
|
-
end
|
478
|
-
|
479
|
-
# Should prices that match the filter be included or excluded.
|
480
|
-
#
|
481
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount::Filter#operator
|
482
|
-
module Operator
|
483
|
-
extend Orb::Internal::Type::Enum
|
484
|
-
|
485
|
-
INCLUDES = :includes
|
486
|
-
EXCLUDES = :excludes
|
487
|
-
|
488
|
-
# @!method self.values
|
489
|
-
# @return [Array<Symbol>]
|
490
|
-
end
|
491
|
-
end
|
492
|
-
end
|
493
|
-
|
494
|
-
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
495
|
-
# @!attribute id
|
496
|
-
#
|
497
|
-
# @return [String]
|
498
|
-
required :id, String
|
499
|
-
|
500
|
-
# @!attribute adjustment_type
|
501
|
-
#
|
502
|
-
# @return [Symbol, :percentage_discount]
|
503
|
-
required :adjustment_type, const: :percentage_discount
|
504
|
-
|
505
|
-
# @!attribute amount
|
506
|
-
# The value applied by an adjustment.
|
507
|
-
#
|
508
|
-
# @return [String]
|
509
|
-
required :amount, String
|
510
|
-
|
511
|
-
# @!attribute applies_to_price_ids
|
512
|
-
# @deprecated
|
513
|
-
#
|
514
|
-
# The price IDs that this adjustment applies to.
|
515
|
-
#
|
516
|
-
# @return [Array<String>]
|
517
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
518
|
-
|
519
|
-
# @!attribute filters
|
520
|
-
# The filters that determine which prices to apply this adjustment to.
|
521
|
-
#
|
522
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter>]
|
523
|
-
required :filters,
|
524
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter] }
|
525
|
-
|
526
|
-
# @!attribute is_invoice_level
|
527
|
-
# True for adjustments that apply to an entire invocice, false for adjustments
|
528
|
-
# that apply to only one price.
|
529
|
-
#
|
530
|
-
# @return [Boolean]
|
531
|
-
required :is_invoice_level, Orb::Internal::Type::Boolean
|
532
|
-
|
533
|
-
# @!attribute percentage_discount
|
534
|
-
# The percentage (as a value between 0 and 1) by which to discount the price
|
535
|
-
# intervals this adjustment applies to in a given billing period.
|
536
|
-
#
|
537
|
-
# @return [Float]
|
538
|
-
required :percentage_discount, Float
|
539
|
-
|
540
|
-
# @!attribute reason
|
541
|
-
# The reason for the adjustment.
|
542
|
-
#
|
543
|
-
# @return [String, nil]
|
544
|
-
required :reason, String, nil?: true
|
545
|
-
|
546
|
-
# @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
|
547
|
-
# Some parameter documentations has been truncated, see
|
548
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount} for
|
549
|
-
# more details.
|
550
|
-
#
|
551
|
-
# @param id [String]
|
552
|
-
#
|
553
|
-
# @param amount [String] The value applied by an adjustment.
|
554
|
-
#
|
555
|
-
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
556
|
-
#
|
557
|
-
# @param filters [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
558
|
-
#
|
559
|
-
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
560
|
-
#
|
561
|
-
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
562
|
-
#
|
563
|
-
# @param reason [String, nil] The reason for the adjustment.
|
564
|
-
#
|
565
|
-
# @param adjustment_type [Symbol, :percentage_discount]
|
566
|
-
|
567
|
-
class Filter < Orb::Internal::Type::BaseModel
|
568
|
-
# @!attribute field
|
569
|
-
# The property of the price to filter on.
|
570
|
-
#
|
571
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter::Field]
|
572
|
-
required :field,
|
573
|
-
enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter::Field }
|
574
|
-
|
575
|
-
# @!attribute operator
|
576
|
-
# Should prices that match the filter be included or excluded.
|
577
|
-
#
|
578
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter::Operator]
|
579
|
-
required :operator,
|
580
|
-
enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter::Operator }
|
581
|
-
|
582
|
-
# @!attribute values
|
583
|
-
# The IDs or values that match this filter.
|
584
|
-
#
|
585
|
-
# @return [Array<String>]
|
586
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
587
|
-
|
588
|
-
# @!method initialize(field:, operator:, values:)
|
589
|
-
# @param field [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter::Field] The property of the price to filter on.
|
590
|
-
#
|
591
|
-
# @param operator [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
592
|
-
#
|
593
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
594
|
-
|
595
|
-
# The property of the price to filter on.
|
596
|
-
#
|
597
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter#field
|
598
|
-
module Field
|
599
|
-
extend Orb::Internal::Type::Enum
|
600
|
-
|
601
|
-
PRICE_ID = :price_id
|
602
|
-
ITEM_ID = :item_id
|
603
|
-
PRICE_TYPE = :price_type
|
604
|
-
CURRENCY = :currency
|
605
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
606
|
-
|
607
|
-
# @!method self.values
|
608
|
-
# @return [Array<Symbol>]
|
609
|
-
end
|
610
|
-
|
611
|
-
# Should prices that match the filter be included or excluded.
|
612
|
-
#
|
613
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount::Filter#operator
|
614
|
-
module Operator
|
615
|
-
extend Orb::Internal::Type::Enum
|
616
|
-
|
617
|
-
INCLUDES = :includes
|
618
|
-
EXCLUDES = :excludes
|
619
|
-
|
620
|
-
# @!method self.values
|
621
|
-
# @return [Array<Symbol>]
|
622
|
-
end
|
623
|
-
end
|
624
|
-
end
|
625
|
-
|
626
|
-
class Minimum < Orb::Internal::Type::BaseModel
|
627
|
-
# @!attribute id
|
628
|
-
#
|
629
|
-
# @return [String]
|
630
|
-
required :id, String
|
631
|
-
|
632
|
-
# @!attribute adjustment_type
|
633
|
-
#
|
634
|
-
# @return [Symbol, :minimum]
|
635
|
-
required :adjustment_type, const: :minimum
|
636
|
-
|
637
|
-
# @!attribute amount
|
638
|
-
# The value applied by an adjustment.
|
639
|
-
#
|
640
|
-
# @return [String]
|
641
|
-
required :amount, String
|
642
|
-
|
643
|
-
# @!attribute applies_to_price_ids
|
644
|
-
# @deprecated
|
645
|
-
#
|
646
|
-
# The price IDs that this adjustment applies to.
|
647
|
-
#
|
648
|
-
# @return [Array<String>]
|
649
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
650
|
-
|
651
|
-
# @!attribute filters
|
652
|
-
# The filters that determine which prices to apply this adjustment to.
|
653
|
-
#
|
654
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter>]
|
655
|
-
required :filters,
|
656
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter] }
|
657
|
-
|
658
|
-
# @!attribute is_invoice_level
|
659
|
-
# True for adjustments that apply to an entire invocice, false for adjustments
|
660
|
-
# that apply to only one price.
|
661
|
-
#
|
662
|
-
# @return [Boolean]
|
663
|
-
required :is_invoice_level, Orb::Internal::Type::Boolean
|
664
|
-
|
665
|
-
# @!attribute item_id
|
666
|
-
# The item ID that revenue from this minimum will be attributed to.
|
667
|
-
#
|
668
|
-
# @return [String]
|
669
|
-
required :item_id, String
|
670
|
-
|
671
|
-
# @!attribute minimum_amount
|
672
|
-
# The minimum amount to charge in a given billing period for the prices this
|
673
|
-
# adjustment applies to.
|
674
|
-
#
|
675
|
-
# @return [String]
|
676
|
-
required :minimum_amount, String
|
677
|
-
|
678
|
-
# @!attribute reason
|
679
|
-
# The reason for the adjustment.
|
680
|
-
#
|
681
|
-
# @return [String, nil]
|
682
|
-
required :reason, String, nil?: true
|
683
|
-
|
684
|
-
# @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
|
685
|
-
# Some parameter documentations has been truncated, see
|
686
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum} for more
|
687
|
-
# details.
|
688
|
-
#
|
689
|
-
# @param id [String]
|
690
|
-
#
|
691
|
-
# @param amount [String] The value applied by an adjustment.
|
692
|
-
#
|
693
|
-
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
694
|
-
#
|
695
|
-
# @param filters [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter>] The filters that determine which prices to apply this adjustment to.
|
696
|
-
#
|
697
|
-
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
698
|
-
#
|
699
|
-
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
700
|
-
#
|
701
|
-
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
702
|
-
#
|
703
|
-
# @param reason [String, nil] The reason for the adjustment.
|
704
|
-
#
|
705
|
-
# @param adjustment_type [Symbol, :minimum]
|
706
|
-
|
707
|
-
class Filter < Orb::Internal::Type::BaseModel
|
708
|
-
# @!attribute field
|
709
|
-
# The property of the price to filter on.
|
710
|
-
#
|
711
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter::Field]
|
712
|
-
required :field,
|
713
|
-
enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter::Field }
|
714
|
-
|
715
|
-
# @!attribute operator
|
716
|
-
# Should prices that match the filter be included or excluded.
|
717
|
-
#
|
718
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter::Operator]
|
719
|
-
required :operator,
|
720
|
-
enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter::Operator }
|
721
|
-
|
722
|
-
# @!attribute values
|
723
|
-
# The IDs or values that match this filter.
|
724
|
-
#
|
725
|
-
# @return [Array<String>]
|
726
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
727
|
-
|
728
|
-
# @!method initialize(field:, operator:, values:)
|
729
|
-
# @param field [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter::Field] The property of the price to filter on.
|
730
|
-
#
|
731
|
-
# @param operator [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
|
732
|
-
#
|
733
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
734
|
-
|
735
|
-
# The property of the price to filter on.
|
736
|
-
#
|
737
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter#field
|
738
|
-
module Field
|
739
|
-
extend Orb::Internal::Type::Enum
|
740
|
-
|
741
|
-
PRICE_ID = :price_id
|
742
|
-
ITEM_ID = :item_id
|
743
|
-
PRICE_TYPE = :price_type
|
744
|
-
CURRENCY = :currency
|
745
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
746
|
-
|
747
|
-
# @!method self.values
|
748
|
-
# @return [Array<Symbol>]
|
749
|
-
end
|
750
|
-
|
751
|
-
# Should prices that match the filter be included or excluded.
|
752
|
-
#
|
753
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum::Filter#operator
|
754
|
-
module Operator
|
755
|
-
extend Orb::Internal::Type::Enum
|
756
|
-
|
757
|
-
INCLUDES = :includes
|
758
|
-
EXCLUDES = :excludes
|
759
|
-
|
760
|
-
# @!method self.values
|
761
|
-
# @return [Array<Symbol>]
|
762
|
-
end
|
763
|
-
end
|
764
|
-
end
|
765
|
-
|
766
|
-
class Maximum < Orb::Internal::Type::BaseModel
|
767
|
-
# @!attribute id
|
768
|
-
#
|
769
|
-
# @return [String]
|
770
|
-
required :id, String
|
771
|
-
|
772
|
-
# @!attribute adjustment_type
|
773
|
-
#
|
774
|
-
# @return [Symbol, :maximum]
|
775
|
-
required :adjustment_type, const: :maximum
|
776
|
-
|
777
|
-
# @!attribute amount
|
778
|
-
# The value applied by an adjustment.
|
779
|
-
#
|
780
|
-
# @return [String]
|
781
|
-
required :amount, String
|
782
|
-
|
783
|
-
# @!attribute applies_to_price_ids
|
784
|
-
# @deprecated
|
785
|
-
#
|
786
|
-
# The price IDs that this adjustment applies to.
|
787
|
-
#
|
788
|
-
# @return [Array<String>]
|
789
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
790
|
-
|
791
|
-
# @!attribute filters
|
792
|
-
# The filters that determine which prices to apply this adjustment to.
|
793
|
-
#
|
794
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter>]
|
795
|
-
required :filters,
|
796
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter] }
|
797
|
-
|
798
|
-
# @!attribute is_invoice_level
|
799
|
-
# True for adjustments that apply to an entire invocice, false for adjustments
|
800
|
-
# that apply to only one price.
|
801
|
-
#
|
802
|
-
# @return [Boolean]
|
803
|
-
required :is_invoice_level, Orb::Internal::Type::Boolean
|
804
|
-
|
805
|
-
# @!attribute maximum_amount
|
806
|
-
# The maximum amount to charge in a given billing period for the prices this
|
807
|
-
# adjustment applies to.
|
808
|
-
#
|
809
|
-
# @return [String]
|
810
|
-
required :maximum_amount, String
|
811
|
-
|
812
|
-
# @!attribute reason
|
813
|
-
# The reason for the adjustment.
|
814
|
-
#
|
815
|
-
# @return [String, nil]
|
816
|
-
required :reason, String, nil?: true
|
817
|
-
|
818
|
-
# @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
|
819
|
-
# Some parameter documentations has been truncated, see
|
820
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum} for more
|
821
|
-
# details.
|
822
|
-
#
|
823
|
-
# @param id [String]
|
824
|
-
#
|
825
|
-
# @param amount [String] The value applied by an adjustment.
|
826
|
-
#
|
827
|
-
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
828
|
-
#
|
829
|
-
# @param filters [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter>] The filters that determine which prices to apply this adjustment to.
|
830
|
-
#
|
831
|
-
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
832
|
-
#
|
833
|
-
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
834
|
-
#
|
835
|
-
# @param reason [String, nil] The reason for the adjustment.
|
836
|
-
#
|
837
|
-
# @param adjustment_type [Symbol, :maximum]
|
838
|
-
|
839
|
-
class Filter < Orb::Internal::Type::BaseModel
|
840
|
-
# @!attribute field
|
841
|
-
# The property of the price to filter on.
|
842
|
-
#
|
843
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter::Field]
|
844
|
-
required :field,
|
845
|
-
enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter::Field }
|
846
|
-
|
847
|
-
# @!attribute operator
|
848
|
-
# Should prices that match the filter be included or excluded.
|
849
|
-
#
|
850
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter::Operator]
|
851
|
-
required :operator,
|
852
|
-
enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter::Operator }
|
853
|
-
|
854
|
-
# @!attribute values
|
855
|
-
# The IDs or values that match this filter.
|
856
|
-
#
|
857
|
-
# @return [Array<String>]
|
858
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
859
|
-
|
860
|
-
# @!method initialize(field:, operator:, values:)
|
861
|
-
# @param field [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter::Field] The property of the price to filter on.
|
862
|
-
#
|
863
|
-
# @param operator [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
|
864
|
-
#
|
865
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
866
|
-
|
867
|
-
# The property of the price to filter on.
|
868
|
-
#
|
869
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter#field
|
870
|
-
module Field
|
871
|
-
extend Orb::Internal::Type::Enum
|
872
|
-
|
873
|
-
PRICE_ID = :price_id
|
874
|
-
ITEM_ID = :item_id
|
875
|
-
PRICE_TYPE = :price_type
|
876
|
-
CURRENCY = :currency
|
877
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
878
|
-
|
879
|
-
# @!method self.values
|
880
|
-
# @return [Array<Symbol>]
|
881
|
-
end
|
882
|
-
|
883
|
-
# Should prices that match the filter be included or excluded.
|
884
|
-
#
|
885
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum::Filter#operator
|
886
|
-
module Operator
|
887
|
-
extend Orb::Internal::Type::Enum
|
888
|
-
|
889
|
-
INCLUDES = :includes
|
890
|
-
EXCLUDES = :excludes
|
891
|
-
|
892
|
-
# @!method self.values
|
893
|
-
# @return [Array<Symbol>]
|
894
|
-
end
|
895
|
-
end
|
896
|
-
end
|
226
|
+
variant :maximum, -> { Orb::MonetaryMaximumAdjustment }
|
897
227
|
|
898
228
|
# @!method self.variants
|
899
|
-
# @return [Array(Orb::Models::
|
900
|
-
end
|
901
|
-
|
902
|
-
# @deprecated
|
903
|
-
#
|
904
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse#maximum
|
905
|
-
class Maximum < Orb::Internal::Type::BaseModel
|
906
|
-
# @!attribute applies_to_price_ids
|
907
|
-
# @deprecated
|
908
|
-
#
|
909
|
-
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
910
|
-
# maximums, this can be a subset of prices.
|
911
|
-
#
|
912
|
-
# @return [Array<String>]
|
913
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
914
|
-
|
915
|
-
# @!attribute filters
|
916
|
-
# The filters that determine which prices to apply this maximum to.
|
917
|
-
#
|
918
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter>]
|
919
|
-
required :filters,
|
920
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter] }
|
921
|
-
|
922
|
-
# @!attribute maximum_amount
|
923
|
-
# Maximum amount applied
|
924
|
-
#
|
925
|
-
# @return [String]
|
926
|
-
required :maximum_amount, String
|
927
|
-
|
928
|
-
# @!method initialize(applies_to_price_ids:, filters:, maximum_amount:)
|
929
|
-
# Some parameter documentations has been truncated, see
|
930
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Maximum} for more details.
|
931
|
-
#
|
932
|
-
# This field is deprecated in favor of `adjustments`.
|
933
|
-
#
|
934
|
-
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
935
|
-
#
|
936
|
-
# @param filters [Array<Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter>] The filters that determine which prices to apply this maximum to.
|
937
|
-
#
|
938
|
-
# @param maximum_amount [String] Maximum amount applied
|
939
|
-
|
940
|
-
class Filter < Orb::Internal::Type::BaseModel
|
941
|
-
# @!attribute field
|
942
|
-
# The property of the price to filter on.
|
943
|
-
#
|
944
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter::Field]
|
945
|
-
required :field, enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter::Field }
|
946
|
-
|
947
|
-
# @!attribute operator
|
948
|
-
# Should prices that match the filter be included or excluded.
|
949
|
-
#
|
950
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter::Operator]
|
951
|
-
required :operator, enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter::Operator }
|
952
|
-
|
953
|
-
# @!attribute values
|
954
|
-
# The IDs or values that match this filter.
|
955
|
-
#
|
956
|
-
# @return [Array<String>]
|
957
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
958
|
-
|
959
|
-
# @!method initialize(field:, operator:, values:)
|
960
|
-
# @param field [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter::Field] The property of the price to filter on.
|
961
|
-
#
|
962
|
-
# @param operator [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
|
963
|
-
#
|
964
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
965
|
-
|
966
|
-
# The property of the price to filter on.
|
967
|
-
#
|
968
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter#field
|
969
|
-
module Field
|
970
|
-
extend Orb::Internal::Type::Enum
|
971
|
-
|
972
|
-
PRICE_ID = :price_id
|
973
|
-
ITEM_ID = :item_id
|
974
|
-
PRICE_TYPE = :price_type
|
975
|
-
CURRENCY = :currency
|
976
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
977
|
-
|
978
|
-
# @!method self.values
|
979
|
-
# @return [Array<Symbol>]
|
980
|
-
end
|
981
|
-
|
982
|
-
# Should prices that match the filter be included or excluded.
|
983
|
-
#
|
984
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Maximum::Filter#operator
|
985
|
-
module Operator
|
986
|
-
extend Orb::Internal::Type::Enum
|
987
|
-
|
988
|
-
INCLUDES = :includes
|
989
|
-
EXCLUDES = :excludes
|
990
|
-
|
991
|
-
# @!method self.values
|
992
|
-
# @return [Array<Symbol>]
|
993
|
-
end
|
994
|
-
end
|
995
|
-
end
|
996
|
-
|
997
|
-
# @deprecated
|
998
|
-
#
|
999
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse#minimum
|
1000
|
-
class Minimum < Orb::Internal::Type::BaseModel
|
1001
|
-
# @!attribute applies_to_price_ids
|
1002
|
-
# @deprecated
|
1003
|
-
#
|
1004
|
-
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
1005
|
-
# minimums, this can be a subset of prices.
|
1006
|
-
#
|
1007
|
-
# @return [Array<String>]
|
1008
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
1009
|
-
|
1010
|
-
# @!attribute filters
|
1011
|
-
# The filters that determine which prices to apply this minimum to.
|
1012
|
-
#
|
1013
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter>]
|
1014
|
-
required :filters,
|
1015
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter] }
|
1016
|
-
|
1017
|
-
# @!attribute minimum_amount
|
1018
|
-
# Minimum amount applied
|
1019
|
-
#
|
1020
|
-
# @return [String]
|
1021
|
-
required :minimum_amount, String
|
1022
|
-
|
1023
|
-
# @!method initialize(applies_to_price_ids:, filters:, minimum_amount:)
|
1024
|
-
# Some parameter documentations has been truncated, see
|
1025
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Minimum} for more details.
|
1026
|
-
#
|
1027
|
-
# This field is deprecated in favor of `adjustments`.
|
1028
|
-
#
|
1029
|
-
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
1030
|
-
#
|
1031
|
-
# @param filters [Array<Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter>] The filters that determine which prices to apply this minimum to.
|
1032
|
-
#
|
1033
|
-
# @param minimum_amount [String] Minimum amount applied
|
1034
|
-
|
1035
|
-
class Filter < Orb::Internal::Type::BaseModel
|
1036
|
-
# @!attribute field
|
1037
|
-
# The property of the price to filter on.
|
1038
|
-
#
|
1039
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter::Field]
|
1040
|
-
required :field, enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter::Field }
|
1041
|
-
|
1042
|
-
# @!attribute operator
|
1043
|
-
# Should prices that match the filter be included or excluded.
|
1044
|
-
#
|
1045
|
-
# @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter::Operator]
|
1046
|
-
required :operator, enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter::Operator }
|
1047
|
-
|
1048
|
-
# @!attribute values
|
1049
|
-
# The IDs or values that match this filter.
|
1050
|
-
#
|
1051
|
-
# @return [Array<String>]
|
1052
|
-
required :values, Orb::Internal::Type::ArrayOf[String]
|
1053
|
-
|
1054
|
-
# @!method initialize(field:, operator:, values:)
|
1055
|
-
# @param field [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter::Field] The property of the price to filter on.
|
1056
|
-
#
|
1057
|
-
# @param operator [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
|
1058
|
-
#
|
1059
|
-
# @param values [Array<String>] The IDs or values that match this filter.
|
1060
|
-
|
1061
|
-
# The property of the price to filter on.
|
1062
|
-
#
|
1063
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter#field
|
1064
|
-
module Field
|
1065
|
-
extend Orb::Internal::Type::Enum
|
1066
|
-
|
1067
|
-
PRICE_ID = :price_id
|
1068
|
-
ITEM_ID = :item_id
|
1069
|
-
PRICE_TYPE = :price_type
|
1070
|
-
CURRENCY = :currency
|
1071
|
-
PRICING_UNIT_ID = :pricing_unit_id
|
1072
|
-
|
1073
|
-
# @!method self.values
|
1074
|
-
# @return [Array<Symbol>]
|
1075
|
-
end
|
1076
|
-
|
1077
|
-
# Should prices that match the filter be included or excluded.
|
1078
|
-
#
|
1079
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::Minimum::Filter#operator
|
1080
|
-
module Operator
|
1081
|
-
extend Orb::Internal::Type::Enum
|
1082
|
-
|
1083
|
-
INCLUDES = :includes
|
1084
|
-
EXCLUDES = :excludes
|
1085
|
-
|
1086
|
-
# @!method self.values
|
1087
|
-
# @return [Array<Symbol>]
|
1088
|
-
end
|
1089
|
-
end
|
229
|
+
# @return [Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment)]
|
1090
230
|
end
|
1091
231
|
|
1092
232
|
module SubLineItem
|
@@ -1094,271 +234,14 @@ module Orb
|
|
1094
234
|
|
1095
235
|
discriminator :type
|
1096
236
|
|
1097
|
-
variant :matrix, -> { Orb::
|
1098
|
-
|
1099
|
-
variant :tier, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier }
|
1100
|
-
|
1101
|
-
variant :"'null'", -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null }
|
1102
|
-
|
1103
|
-
class Matrix < Orb::Internal::Type::BaseModel
|
1104
|
-
# @!attribute amount
|
1105
|
-
# The total amount for this sub line item.
|
1106
|
-
#
|
1107
|
-
# @return [String]
|
1108
|
-
required :amount, String
|
1109
|
-
|
1110
|
-
# @!attribute grouping
|
1111
|
-
#
|
1112
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping, nil]
|
1113
|
-
required :grouping,
|
1114
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping },
|
1115
|
-
nil?: true
|
1116
|
-
|
1117
|
-
# @!attribute matrix_config
|
1118
|
-
#
|
1119
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig]
|
1120
|
-
required :matrix_config,
|
1121
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig }
|
1122
|
-
|
1123
|
-
# @!attribute name
|
1124
|
-
#
|
1125
|
-
# @return [String]
|
1126
|
-
required :name, String
|
1127
|
-
|
1128
|
-
# @!attribute quantity
|
1129
|
-
#
|
1130
|
-
# @return [Float]
|
1131
|
-
required :quantity, Float
|
1132
|
-
|
1133
|
-
# @!attribute type
|
1134
|
-
#
|
1135
|
-
# @return [Symbol, :matrix]
|
1136
|
-
required :type, const: :matrix
|
1137
|
-
|
1138
|
-
# @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
1139
|
-
# @param amount [String] The total amount for this sub line item.
|
1140
|
-
#
|
1141
|
-
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping, nil]
|
1142
|
-
#
|
1143
|
-
# @param matrix_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig]
|
1144
|
-
#
|
1145
|
-
# @param name [String]
|
1146
|
-
#
|
1147
|
-
# @param quantity [Float]
|
1148
|
-
#
|
1149
|
-
# @param type [Symbol, :matrix]
|
1150
|
-
|
1151
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix#grouping
|
1152
|
-
class Grouping < Orb::Internal::Type::BaseModel
|
1153
|
-
# @!attribute key
|
1154
|
-
#
|
1155
|
-
# @return [String]
|
1156
|
-
required :key, String
|
1157
|
-
|
1158
|
-
# @!attribute value
|
1159
|
-
# No value indicates the default group
|
1160
|
-
#
|
1161
|
-
# @return [String, nil]
|
1162
|
-
required :value, String, nil?: true
|
1163
|
-
|
1164
|
-
# @!method initialize(key:, value:)
|
1165
|
-
# @param key [String]
|
1166
|
-
#
|
1167
|
-
# @param value [String, nil] No value indicates the default group
|
1168
|
-
end
|
1169
|
-
|
1170
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix#matrix_config
|
1171
|
-
class MatrixConfig < Orb::Internal::Type::BaseModel
|
1172
|
-
# @!attribute dimension_values
|
1173
|
-
# The ordered dimension values for this line item.
|
1174
|
-
#
|
1175
|
-
# @return [Array<String, nil>]
|
1176
|
-
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
1177
|
-
|
1178
|
-
# @!method initialize(dimension_values:)
|
1179
|
-
# @param dimension_values [Array<String, nil>] The ordered dimension values for this line item.
|
1180
|
-
end
|
1181
|
-
end
|
1182
|
-
|
1183
|
-
class Tier < Orb::Internal::Type::BaseModel
|
1184
|
-
# @!attribute amount
|
1185
|
-
# The total amount for this sub line item.
|
1186
|
-
#
|
1187
|
-
# @return [String]
|
1188
|
-
required :amount, String
|
1189
|
-
|
1190
|
-
# @!attribute grouping
|
1191
|
-
#
|
1192
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping, nil]
|
1193
|
-
required :grouping,
|
1194
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping },
|
1195
|
-
nil?: true
|
1196
|
-
|
1197
|
-
# @!attribute name
|
1198
|
-
#
|
1199
|
-
# @return [String]
|
1200
|
-
required :name, String
|
1201
|
-
|
1202
|
-
# @!attribute quantity
|
1203
|
-
#
|
1204
|
-
# @return [Float]
|
1205
|
-
required :quantity, Float
|
1206
|
-
|
1207
|
-
# @!attribute tier_config
|
1208
|
-
#
|
1209
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig]
|
1210
|
-
required :tier_config, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig }
|
237
|
+
variant :matrix, -> { Orb::MatrixSubLineItem }
|
1211
238
|
|
1212
|
-
|
1213
|
-
#
|
1214
|
-
# @return [Symbol, :tier]
|
1215
|
-
required :type, const: :tier
|
239
|
+
variant :tier, -> { Orb::TierSubLineItem }
|
1216
240
|
|
1217
|
-
|
1218
|
-
# @param amount [String] The total amount for this sub line item.
|
1219
|
-
#
|
1220
|
-
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping, nil]
|
1221
|
-
#
|
1222
|
-
# @param name [String]
|
1223
|
-
#
|
1224
|
-
# @param quantity [Float]
|
1225
|
-
#
|
1226
|
-
# @param tier_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig]
|
1227
|
-
#
|
1228
|
-
# @param type [Symbol, :tier]
|
1229
|
-
|
1230
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier#grouping
|
1231
|
-
class Grouping < Orb::Internal::Type::BaseModel
|
1232
|
-
# @!attribute key
|
1233
|
-
#
|
1234
|
-
# @return [String]
|
1235
|
-
required :key, String
|
1236
|
-
|
1237
|
-
# @!attribute value
|
1238
|
-
# No value indicates the default group
|
1239
|
-
#
|
1240
|
-
# @return [String, nil]
|
1241
|
-
required :value, String, nil?: true
|
1242
|
-
|
1243
|
-
# @!method initialize(key:, value:)
|
1244
|
-
# @param key [String]
|
1245
|
-
#
|
1246
|
-
# @param value [String, nil] No value indicates the default group
|
1247
|
-
end
|
1248
|
-
|
1249
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier#tier_config
|
1250
|
-
class TierConfig < Orb::Internal::Type::BaseModel
|
1251
|
-
# @!attribute first_unit
|
1252
|
-
#
|
1253
|
-
# @return [Float]
|
1254
|
-
required :first_unit, Float
|
1255
|
-
|
1256
|
-
# @!attribute last_unit
|
1257
|
-
#
|
1258
|
-
# @return [Float, nil]
|
1259
|
-
required :last_unit, Float, nil?: true
|
1260
|
-
|
1261
|
-
# @!attribute unit_amount
|
1262
|
-
#
|
1263
|
-
# @return [String]
|
1264
|
-
required :unit_amount, String
|
1265
|
-
|
1266
|
-
# @!method initialize(first_unit:, last_unit:, unit_amount:)
|
1267
|
-
# @param first_unit [Float]
|
1268
|
-
# @param last_unit [Float, nil]
|
1269
|
-
# @param unit_amount [String]
|
1270
|
-
end
|
1271
|
-
end
|
1272
|
-
|
1273
|
-
class Null < Orb::Internal::Type::BaseModel
|
1274
|
-
# @!attribute amount
|
1275
|
-
# The total amount for this sub line item.
|
1276
|
-
#
|
1277
|
-
# @return [String]
|
1278
|
-
required :amount, String
|
1279
|
-
|
1280
|
-
# @!attribute grouping
|
1281
|
-
#
|
1282
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping, nil]
|
1283
|
-
required :grouping,
|
1284
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping },
|
1285
|
-
nil?: true
|
1286
|
-
|
1287
|
-
# @!attribute name
|
1288
|
-
#
|
1289
|
-
# @return [String]
|
1290
|
-
required :name, String
|
1291
|
-
|
1292
|
-
# @!attribute quantity
|
1293
|
-
#
|
1294
|
-
# @return [Float]
|
1295
|
-
required :quantity, Float
|
1296
|
-
|
1297
|
-
# @!attribute type
|
1298
|
-
#
|
1299
|
-
# @return [Symbol, :"'null'"]
|
1300
|
-
required :type, const: :"'null'"
|
1301
|
-
|
1302
|
-
# @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
|
1303
|
-
# @param amount [String] The total amount for this sub line item.
|
1304
|
-
#
|
1305
|
-
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping, nil]
|
1306
|
-
#
|
1307
|
-
# @param name [String]
|
1308
|
-
#
|
1309
|
-
# @param quantity [Float]
|
1310
|
-
#
|
1311
|
-
# @param type [Symbol, :"'null'"]
|
1312
|
-
|
1313
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null#grouping
|
1314
|
-
class Grouping < Orb::Internal::Type::BaseModel
|
1315
|
-
# @!attribute key
|
1316
|
-
#
|
1317
|
-
# @return [String]
|
1318
|
-
required :key, String
|
1319
|
-
|
1320
|
-
# @!attribute value
|
1321
|
-
# No value indicates the default group
|
1322
|
-
#
|
1323
|
-
# @return [String, nil]
|
1324
|
-
required :value, String, nil?: true
|
1325
|
-
|
1326
|
-
# @!method initialize(key:, value:)
|
1327
|
-
# @param key [String]
|
1328
|
-
#
|
1329
|
-
# @param value [String, nil] No value indicates the default group
|
1330
|
-
end
|
1331
|
-
end
|
241
|
+
variant :"'null'", -> { Orb::OtherSubLineItem }
|
1332
242
|
|
1333
243
|
# @!method self.variants
|
1334
|
-
# @return [Array(Orb::Models::
|
1335
|
-
end
|
1336
|
-
|
1337
|
-
class TaxAmount < Orb::Internal::Type::BaseModel
|
1338
|
-
# @!attribute amount
|
1339
|
-
# The amount of additional tax incurred by this tax rate.
|
1340
|
-
#
|
1341
|
-
# @return [String]
|
1342
|
-
required :amount, String
|
1343
|
-
|
1344
|
-
# @!attribute tax_rate_description
|
1345
|
-
# The human-readable description of the applied tax rate.
|
1346
|
-
#
|
1347
|
-
# @return [String]
|
1348
|
-
required :tax_rate_description, String
|
1349
|
-
|
1350
|
-
# @!attribute tax_rate_percentage
|
1351
|
-
# The tax rate percentage, out of 100.
|
1352
|
-
#
|
1353
|
-
# @return [String, nil]
|
1354
|
-
required :tax_rate_percentage, String, nil?: true
|
1355
|
-
|
1356
|
-
# @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
|
1357
|
-
# @param amount [String] The amount of additional tax incurred by this tax rate.
|
1358
|
-
#
|
1359
|
-
# @param tax_rate_description [String] The human-readable description of the applied tax rate.
|
1360
|
-
#
|
1361
|
-
# @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
|
244
|
+
# @return [Array(Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem)]
|
1362
245
|
end
|
1363
246
|
end
|
1364
247
|
end
|