orb-billing 1.14.0 → 1.15.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 +12 -0
- data/lib/orb/client.rb +14 -0
- data/lib/orb/internal/transport/base_client.rb +5 -0
- data/lib/orb/internal/type/union.rb +13 -27
- data/lib/orb/models/accounting_provider_config.rb +14 -3
- data/lib/orb/models/adjustment_interval.rb +185 -3
- data/lib/orb/models/alert.rb +105 -1
- data/lib/orb/models/alert_create_for_subscription_params.rb +120 -7
- data/lib/orb/models/alert_update_params.rb +113 -1
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +2419 -17109
- data/lib/orb/models/beta_create_plan_version_params.rb +2361 -16947
- data/lib/orb/models/changed_subscription_resources.rb +200 -10
- data/lib/orb/models/conversion_rate_config.rb +18 -0
- data/lib/orb/models/credit_block_list_invoices_response.rb +155 -1
- data/lib/orb/models/credit_block_retrieve_response.rb +150 -1
- data/lib/orb/models/customer.rb +111 -4
- data/lib/orb/models/customer_create_params.rb +6 -1
- data/lib/orb/models/customer_tax_id.rb +15 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +16 -2
- data/lib/orb/models/customer_update_params.rb +16 -2
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +155 -1
- data/lib/orb/models/customers/credit_list_response.rb +152 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +4 -4
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/discount.rb +145 -1
- data/lib/orb/models/event_ingest_params.rb +5 -2
- data/lib/orb/models/invoice.rb +198 -10
- data/lib/orb/models/invoice_create_params.rb +6 -5
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +200 -10
- data/lib/orb/models/invoice_issue_summary_response.rb +9 -3
- data/lib/orb/models/invoice_level_discount.rb +145 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +189 -5
- data/lib/orb/models/invoice_list_summary_response.rb +9 -3
- data/lib/orb/models/licenses/external_license_get_usage_params.rb +3 -3
- data/lib/orb/models/licenses/usage_get_all_usage_params.rb +3 -3
- data/lib/orb/models/licenses/usage_get_usage_params.rb +3 -3
- data/lib/orb/models/mutated_subscription.rb +169 -4
- data/lib/orb/models/new_allocation_price.rb +11 -1
- data/lib/orb/models/new_floating_bulk_price.rb +1 -3
- data/lib/orb/models/new_floating_bulk_with_proration_price.rb +1 -3
- data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +1 -3
- data/lib/orb/models/new_floating_grouped_allocation_price.rb +1 -3
- data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_floating_grouped_tiered_price.rb +1 -3
- data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +1 -3
- data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +1 -3
- data/lib/orb/models/new_floating_matrix_price.rb +1 -3
- data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +1 -3
- data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_floating_minimum_composite_price.rb +1 -3
- data/lib/orb/models/new_floating_package_price.rb +1 -3
- data/lib/orb/models/new_floating_package_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +1 -3
- data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +1 -3
- data/lib/orb/models/new_floating_threshold_total_amount_price.rb +1 -3
- data/lib/orb/models/new_floating_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_floating_tiered_price.rb +1 -3
- data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_floating_tiered_with_proration_price.rb +1 -3
- data/lib/orb/models/new_floating_unit_price.rb +1 -3
- data/lib/orb/models/new_floating_unit_with_percent_price.rb +1 -3
- data/lib/orb/models/new_floating_unit_with_proration_price.rb +1 -3
- data/lib/orb/models/new_plan_bulk_price.rb +1 -1
- data/lib/orb/models/new_plan_bulk_with_proration_price.rb +1 -3
- data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +1 -3
- data/lib/orb/models/new_plan_grouped_allocation_price.rb +1 -3
- data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_plan_grouped_tiered_price.rb +1 -3
- data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +1 -3
- data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +1 -3
- data/lib/orb/models/new_plan_matrix_price.rb +1 -5
- data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +1 -3
- data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_plan_minimum_composite_price.rb +1 -3
- data/lib/orb/models/new_plan_package_price.rb +1 -5
- data/lib/orb/models/new_plan_package_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +1 -3
- data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +1 -3
- data/lib/orb/models/new_plan_threshold_total_amount_price.rb +1 -3
- data/lib/orb/models/new_plan_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_plan_tiered_price.rb +1 -5
- data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_plan_unit_price.rb +1 -1
- data/lib/orb/models/new_plan_unit_with_percent_price.rb +1 -3
- data/lib/orb/models/new_plan_unit_with_proration_price.rb +1 -3
- data/lib/orb/models/new_subscription_bulk_price.rb +1 -3
- data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +1 -3
- data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +1 -3
- data/lib/orb/models/new_subscription_grouped_allocation_price.rb +1 -3
- data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_subscription_grouped_tiered_price.rb +1 -3
- data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +1 -3
- data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +1 -3
- data/lib/orb/models/new_subscription_matrix_price.rb +1 -3
- data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +1 -3
- data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_subscription_minimum_composite_price.rb +1 -3
- data/lib/orb/models/new_subscription_package_price.rb +1 -3
- data/lib/orb/models/new_subscription_package_with_allocation_price.rb +1 -3
- data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +1 -3
- data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +1 -3
- data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +1 -3
- data/lib/orb/models/new_subscription_tiered_package_price.rb +1 -3
- data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_subscription_tiered_price.rb +1 -3
- data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +1 -3
- data/lib/orb/models/new_subscription_unit_price.rb +1 -3
- data/lib/orb/models/new_subscription_unit_with_percent_price.rb +1 -3
- data/lib/orb/models/new_subscription_unit_with_proration_price.rb +1 -3
- data/lib/orb/models/per_price_cost.rb +2 -2
- data/lib/orb/models/plan.rb +189 -9
- data/lib/orb/models/plan_create_params.rb +1047 -8228
- data/lib/orb/models/plan_update_params.rb +9 -1
- data/lib/orb/models/plan_version.rb +186 -5
- data/lib/orb/models/plans/external_plan_id_update_params.rb +9 -1
- data/lib/orb/models/plans/migration_cancel_response.rb +22 -4
- data/lib/orb/models/plans/migration_list_response.rb +22 -4
- data/lib/orb/models/plans/migration_retrieve_response.rb +22 -4
- data/lib/orb/models/price.rb +2614 -1268
- data/lib/orb/models/price_create_params.rb +866 -49
- data/lib/orb/models/price_evaluate_multiple_params.rb +889 -54
- data/lib/orb/models/price_evaluate_preview_events_params.rb +881 -46
- data/lib/orb/models/price_interval.rb +2 -2
- data/lib/orb/models/subscription.rb +168 -4
- data/lib/orb/models/subscription_create_params.rb +2818 -674
- data/lib/orb/models/subscription_price_intervals_params.rb +1098 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +2834 -687
- data/lib/orb/models/subscription_update_params.rb +12 -1
- data/lib/orb/models.rb +2 -0
- data/lib/orb/resources/alerts.rb +14 -3
- data/lib/orb/resources/customers/credits/ledger.rb +28 -14
- data/lib/orb/resources/customers.rb +6 -2
- data/lib/orb/resources/events.rb +7 -34
- data/lib/orb/resources/invoices.rb +6 -2
- data/lib/orb/resources/licenses/external_licenses.rb +1 -1
- data/lib/orb/resources/licenses/usage.rb +2 -2
- data/lib/orb/resources/metrics.rb +5 -5
- data/lib/orb/resources/plans/external_plan_id.rb +5 -3
- data/lib/orb/resources/plans.rb +9 -5
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +5 -5
- data/lib/orb/resources/subscriptions.rb +20 -3
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/models/accounting_provider_config.rbi +38 -5
- data/rbi/orb/models/adjustment_interval.rbi +336 -0
- data/rbi/orb/models/alert.rbi +172 -3
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +268 -9
- data/rbi/orb/models/alert_update_params.rbi +208 -0
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +3833 -28395
- data/rbi/orb/models/beta_create_plan_version_params.rbi +3833 -28363
- data/rbi/orb/models/changed_subscription_resources.rbi +360 -5
- data/rbi/orb/models/conversion_rate_config.rbi +18 -0
- data/rbi/orb/models/credit_block_list_invoices_response.rbi +346 -3
- data/rbi/orb/models/credit_block_retrieve_response.rbi +344 -3
- data/rbi/orb/models/customer.rbi +190 -10
- data/rbi/orb/models/customer_create_params.rbi +12 -2
- data/rbi/orb/models/customer_tax_id.rbi +15 -1
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +22 -2
- data/rbi/orb/models/customer_update_params.rbi +22 -2
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +346 -3
- data/rbi/orb/models/customers/credit_list_response.rbi +347 -3
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +6 -6
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +6 -6
- data/rbi/orb/models/dimensional_price_group.rbi +1 -1
- data/rbi/orb/models/discount.rbi +269 -1
- data/rbi/orb/models/event_ingest_params.rbi +4 -2
- data/rbi/orb/models/invoice.rbi +360 -5
- data/rbi/orb/models/invoice_create_params.rbi +12 -7
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +360 -5
- data/rbi/orb/models/invoice_issue_summary_response.rbi +19 -4
- data/rbi/orb/models/invoice_level_discount.rbi +298 -1
- data/rbi/orb/models/invoice_line_item_create_response.rbi +339 -0
- data/rbi/orb/models/invoice_list_summary_response.rbi +19 -4
- data/rbi/orb/models/licenses/external_license_get_usage_params.rbi +3 -3
- data/rbi/orb/models/licenses/usage_get_all_usage_params.rbi +3 -3
- data/rbi/orb/models/licenses/usage_get_usage_params.rbi +3 -3
- data/rbi/orb/models/mutated_subscription.rbi +324 -2
- data/rbi/orb/models/new_allocation_price.rbi +12 -0
- data/rbi/orb/models/per_price_cost.rbi +3 -0
- data/rbi/orb/models/plan.rbi +339 -2
- data/rbi/orb/models/plan_create_params.rbi +1877 -14138
- data/rbi/orb/models/plan_update_params.rbi +8 -0
- data/rbi/orb/models/plan_version.rbi +339 -0
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +8 -0
- data/rbi/orb/models/plans/migration_cancel_response.rbi +22 -1
- data/rbi/orb/models/plans/migration_list_response.rbi +22 -1
- data/rbi/orb/models/plans/migration_retrieve_response.rbi +22 -1
- data/rbi/orb/models/price.rbi +4552 -2285
- data/rbi/orb/models/price_create_params.rbi +1540 -114
- data/rbi/orb/models/price_evaluate_multiple_params.rbi +1540 -114
- data/rbi/orb/models/price_evaluate_preview_events_params.rbi +1540 -114
- data/rbi/orb/models/price_interval.rbi +3 -0
- data/rbi/orb/models/subscription.rbi +324 -2
- data/rbi/orb/models/subscription_create_params.rbi +4998 -1186
- data/rbi/orb/models/subscription_price_intervals_params.rbi +2127 -264
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +4997 -1185
- data/rbi/orb/models/subscription_update_params.rbi +14 -0
- data/rbi/orb/models.rbi +2 -0
- data/rbi/orb/resources/alerts.rbi +39 -4
- data/rbi/orb/resources/customers/credits/ledger.rbi +28 -14
- data/rbi/orb/resources/customers.rbi +23 -0
- data/rbi/orb/resources/events.rbi +8 -35
- data/rbi/orb/resources/invoices.rbi +9 -3
- data/rbi/orb/resources/licenses/external_licenses.rbi +1 -1
- data/rbi/orb/resources/licenses/usage.rbi +2 -2
- data/rbi/orb/resources/metrics.rbi +5 -5
- data/rbi/orb/resources/plans/external_plan_id.rbi +5 -2
- data/rbi/orb/resources/plans.rbi +9 -3
- data/rbi/orb/resources/prices.rbi +3 -0
- data/rbi/orb/resources/subscriptions.rbi +29 -0
- data/sig/orb/models/accounting_provider_config.rbs +21 -4
- data/sig/orb/models/adjustment_interval.rbs +134 -0
- data/sig/orb/models/alert.rbs +85 -3
- data/sig/orb/models/alert_create_for_subscription_params.rbs +86 -4
- data/sig/orb/models/alert_update_params.rbs +86 -1
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +1803 -11601
- data/sig/orb/models/beta_create_plan_version_params.rbs +1747 -11541
- data/sig/orb/models/changed_subscription_resources.rbs +140 -1
- data/sig/orb/models/conversion_rate_config.rbs +12 -0
- data/sig/orb/models/credit_block_list_invoices_response.rbs +124 -3
- data/sig/orb/models/credit_block_retrieve_response.rbs +124 -3
- data/sig/orb/models/customer.rbs +70 -4
- data/sig/orb/models/customer_create_params.rbs +2 -2
- data/sig/orb/models/customer_tax_id.rbs +20 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +7 -2
- data/sig/orb/models/customer_update_params.rbs +7 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +124 -3
- data/sig/orb/models/customers/credit_list_response.rbs +124 -3
- data/sig/orb/models/discount.rbs +114 -0
- data/sig/orb/models/invoice.rbs +140 -1
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +140 -1
- data/sig/orb/models/invoice_issue_summary_response.rbs +2 -1
- data/sig/orb/models/invoice_level_discount.rbs +117 -1
- data/sig/orb/models/invoice_line_item_create_response.rbs +134 -0
- data/sig/orb/models/invoice_list_summary_response.rbs +2 -1
- data/sig/orb/models/licenses/external_license_get_usage_params.rbs +4 -4
- data/sig/orb/models/licenses/usage_get_all_usage_params.rbs +4 -4
- data/sig/orb/models/licenses/usage_get_usage_params.rbs +4 -4
- data/sig/orb/models/mutated_subscription.rbs +124 -0
- data/sig/orb/models/new_allocation_price.rbs +5 -0
- data/sig/orb/models/new_floating_bulk_price.rbs +4 -4
- data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +4 -4
- data/sig/orb/models/new_floating_grouped_allocation_price.rbs +4 -4
- data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_floating_grouped_tiered_price.rbs +4 -4
- data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +4 -4
- data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +4 -4
- data/sig/orb/models/new_floating_matrix_price.rbs +4 -4
- data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +4 -4
- data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_floating_minimum_composite_price.rbs +4 -4
- data/sig/orb/models/new_floating_package_price.rbs +4 -4
- data/sig/orb/models/new_floating_package_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
- data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +4 -4
- data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +4 -4
- data/sig/orb/models/new_floating_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_floating_tiered_price.rbs +4 -4
- data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_floating_unit_price.rbs +4 -4
- data/sig/orb/models/new_floating_unit_with_percent_price.rbs +4 -4
- data/sig/orb/models/new_floating_unit_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_plan_bulk_price.rbs +4 -4
- data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +4 -4
- data/sig/orb/models/new_plan_grouped_allocation_price.rbs +4 -4
- data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_plan_grouped_tiered_price.rbs +4 -4
- data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +4 -4
- data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +4 -4
- data/sig/orb/models/new_plan_matrix_price.rbs +4 -4
- data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +4 -4
- data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_plan_minimum_composite_price.rbs +4 -4
- data/sig/orb/models/new_plan_package_price.rbs +4 -4
- data/sig/orb/models/new_plan_package_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
- data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +4 -4
- data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +4 -4
- data/sig/orb/models/new_plan_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_plan_tiered_price.rbs +4 -4
- data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_plan_unit_price.rbs +4 -4
- data/sig/orb/models/new_plan_unit_with_percent_price.rbs +4 -4
- data/sig/orb/models/new_plan_unit_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_subscription_bulk_price.rbs +4 -4
- data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +4 -4
- data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +4 -4
- data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +4 -4
- data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +4 -4
- data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +4 -4
- data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +4 -4
- data/sig/orb/models/new_subscription_matrix_price.rbs +4 -4
- data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +4 -4
- data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_subscription_minimum_composite_price.rbs +4 -4
- data/sig/orb/models/new_subscription_package_price.rbs +4 -4
- data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +4 -4
- data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
- data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +4 -4
- data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +4 -4
- data/sig/orb/models/new_subscription_tiered_package_price.rbs +4 -4
- data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_subscription_tiered_price.rbs +4 -4
- data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +4 -4
- data/sig/orb/models/new_subscription_unit_price.rbs +4 -4
- data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +4 -4
- data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +4 -4
- data/sig/orb/models/plan.rbs +134 -0
- data/sig/orb/models/plan_create_params.rbs +836 -5728
- data/sig/orb/models/plan_update_params.rbs +5 -0
- data/sig/orb/models/plan_version.rbs +134 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +5 -0
- data/sig/orb/models/price.rbs +2200 -1150
- data/sig/orb/models/price_create_params.rbs +611 -23
- data/sig/orb/models/price_evaluate_multiple_params.rbs +626 -23
- data/sig/orb/models/price_evaluate_preview_events_params.rbs +626 -23
- data/sig/orb/models/subscription.rbs +124 -0
- data/sig/orb/models/subscription_create_params.rbs +2009 -430
- data/sig/orb/models/subscription_price_intervals_params.rbs +795 -23
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2009 -430
- data/sig/orb/models/subscription_update_params.rbs +5 -0
- data/sig/orb/models.rbs +2 -0
- data/sig/orb/resources/alerts.rbs +5 -1
- data/sig/orb/resources/customers.rbs +2 -0
- data/sig/orb/resources/licenses/external_licenses.rbs +1 -1
- data/sig/orb/resources/licenses/usage.rbs +2 -2
- data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
- data/sig/orb/resources/plans.rbs +2 -0
- data/sig/orb/resources/subscriptions.rbs +3 -0
- metadata +6 -7
|
@@ -148,11 +148,13 @@ module Orb
|
|
|
148
148
|
# | Estonia | `eu_vat` | European VAT Number |
|
|
149
149
|
# | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
|
|
150
150
|
# | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
151
|
+
# | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
|
|
151
152
|
# | Finland | `eu_vat` | European VAT Number |
|
|
152
153
|
# | France | `eu_vat` | European VAT Number |
|
|
153
154
|
# | Georgia | `ge_vat` | Georgian VAT |
|
|
154
155
|
# | Germany | `de_stn` | German Tax Number (Steuernummer) |
|
|
155
156
|
# | Germany | `eu_vat` | European VAT Number |
|
|
157
|
+
# | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
|
|
156
158
|
# | Greece | `eu_vat` | European VAT Number |
|
|
157
159
|
# | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
|
|
158
160
|
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
@@ -164,6 +166,7 @@ module Orb
|
|
|
164
166
|
# | Ireland | `eu_vat` | European VAT Number |
|
|
165
167
|
# | Israel | `il_vat` | Israel VAT |
|
|
166
168
|
# | Italy | `eu_vat` | European VAT Number |
|
|
169
|
+
# | Italy | `it_cf` | Italian Codice Fiscale Number |
|
|
167
170
|
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
168
171
|
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
169
172
|
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
@@ -194,6 +197,7 @@ module Orb
|
|
|
194
197
|
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
195
198
|
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
196
199
|
# | Oman | `om_vat` | Omani VAT Number |
|
|
200
|
+
# | Paraguay | `py_ruc` | Paraguayan RUC Number |
|
|
197
201
|
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
198
202
|
# | Philippines | `ph_tin` | Philippines Tax Identification Number |
|
|
199
203
|
# | Poland | `eu_vat` | European VAT Number |
|
|
@@ -215,6 +219,7 @@ module Orb
|
|
|
215
219
|
# | South Korea | `kr_brn` | Korean BRN |
|
|
216
220
|
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
217
221
|
# | Spain | `eu_vat` | European VAT Number |
|
|
222
|
+
# | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
|
|
218
223
|
# | Suriname | `sr_fin` | Suriname FIN Number |
|
|
219
224
|
# | Sweden | `eu_vat` | European VAT Number |
|
|
220
225
|
# | Switzerland | `ch_uid` | Switzerland UID Number |
|
|
@@ -252,7 +257,7 @@ module Orb
|
|
|
252
257
|
|
|
253
258
|
# @!attribute discounts
|
|
254
259
|
#
|
|
255
|
-
# @return [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
|
|
260
|
+
# @return [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount, Orb::Models::InvoiceLevelDiscount::TieredPercentage>]
|
|
256
261
|
required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::InvoiceLevelDiscount] }
|
|
257
262
|
|
|
258
263
|
# @!attribute due_date
|
|
@@ -271,8 +276,8 @@ module Orb
|
|
|
271
276
|
required :eligible_to_issue_at, Time, nil?: true
|
|
272
277
|
|
|
273
278
|
# @!attribute hosted_invoice_url
|
|
274
|
-
# A URL for the customer-facing invoice portal. This URL expires
|
|
275
|
-
#
|
|
279
|
+
# A URL for the customer-facing invoice portal. This URL expires 60 days after the
|
|
280
|
+
# link is generated, or 30 days after the invoice's due date — whichever is later.
|
|
276
281
|
#
|
|
277
282
|
# @return [String, nil]
|
|
278
283
|
required :hosted_invoice_url, String, nil?: true
|
|
@@ -475,13 +480,13 @@ module Orb
|
|
|
475
480
|
#
|
|
476
481
|
# @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
|
|
477
482
|
#
|
|
478
|
-
# @param discounts [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
|
|
483
|
+
# @param discounts [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount, Orb::Models::InvoiceLevelDiscount::TieredPercentage>]
|
|
479
484
|
#
|
|
480
485
|
# @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
|
|
481
486
|
#
|
|
482
487
|
# @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
|
|
483
488
|
#
|
|
484
|
-
# @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires
|
|
489
|
+
# @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 60 days after the
|
|
485
490
|
#
|
|
486
491
|
# @param invoice_date [Time] The scheduled date of the invoice
|
|
487
492
|
#
|
|
@@ -791,7 +796,7 @@ module Orb
|
|
|
791
796
|
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
|
792
797
|
# discounts -> minimums -> maximums).
|
|
793
798
|
#
|
|
794
|
-
# @return [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>]
|
|
799
|
+
# @return [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>]
|
|
795
800
|
required :adjustments,
|
|
796
801
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment] }
|
|
797
802
|
|
|
@@ -852,7 +857,7 @@ module Orb
|
|
|
852
857
|
# For more on the types of prices, see
|
|
853
858
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
854
859
|
#
|
|
855
|
-
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, 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::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
860
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
856
861
|
required :price, union: -> { Orb::Price }
|
|
857
862
|
|
|
858
863
|
# @!attribute quantity
|
|
@@ -903,7 +908,7 @@ module Orb
|
|
|
903
908
|
#
|
|
904
909
|
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
|
905
910
|
#
|
|
906
|
-
# @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
|
|
911
|
+
# @param adjustments [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>] All adjustments applied to the line item in the order they were applied based on
|
|
907
912
|
#
|
|
908
913
|
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
|
909
914
|
#
|
|
@@ -919,7 +924,7 @@ module Orb
|
|
|
919
924
|
#
|
|
920
925
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
|
921
926
|
#
|
|
922
|
-
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, 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::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
|
|
927
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
|
|
923
928
|
#
|
|
924
929
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
|
925
930
|
#
|
|
@@ -944,12 +949,196 @@ module Orb
|
|
|
944
949
|
|
|
945
950
|
variant :percentage_discount, -> { Orb::MonetaryPercentageDiscountAdjustment }
|
|
946
951
|
|
|
952
|
+
variant :tiered_percentage_discount,
|
|
953
|
+
-> { Orb::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount }
|
|
954
|
+
|
|
947
955
|
variant :minimum, -> { Orb::MonetaryMinimumAdjustment }
|
|
948
956
|
|
|
949
957
|
variant :maximum, -> { Orb::MonetaryMaximumAdjustment }
|
|
950
958
|
|
|
959
|
+
class TieredPercentageDiscount < Orb::Internal::Type::BaseModel
|
|
960
|
+
# @!attribute id
|
|
961
|
+
#
|
|
962
|
+
# @return [String]
|
|
963
|
+
required :id, String
|
|
964
|
+
|
|
965
|
+
# @!attribute adjustment_type
|
|
966
|
+
#
|
|
967
|
+
# @return [Symbol, :tiered_percentage_discount]
|
|
968
|
+
required :adjustment_type, const: :tiered_percentage_discount
|
|
969
|
+
|
|
970
|
+
# @!attribute amount
|
|
971
|
+
# The value applied by an adjustment.
|
|
972
|
+
#
|
|
973
|
+
# @return [String]
|
|
974
|
+
required :amount, String
|
|
975
|
+
|
|
976
|
+
# @!attribute applies_to_price_ids
|
|
977
|
+
# @deprecated
|
|
978
|
+
#
|
|
979
|
+
# The price IDs that this adjustment applies to.
|
|
980
|
+
#
|
|
981
|
+
# @return [Array<String>]
|
|
982
|
+
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
|
983
|
+
|
|
984
|
+
# @!attribute filters
|
|
985
|
+
# The filters that determine which prices to apply this adjustment to.
|
|
986
|
+
#
|
|
987
|
+
# @return [Array<Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter>]
|
|
988
|
+
required :filters,
|
|
989
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter] }
|
|
990
|
+
|
|
991
|
+
# @!attribute is_invoice_level
|
|
992
|
+
# True for adjustments that apply to an entire invoice, false for adjustments that
|
|
993
|
+
# apply to only one price.
|
|
994
|
+
#
|
|
995
|
+
# @return [Boolean]
|
|
996
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
|
997
|
+
|
|
998
|
+
# @!attribute reason
|
|
999
|
+
# The reason for the adjustment.
|
|
1000
|
+
#
|
|
1001
|
+
# @return [String, nil]
|
|
1002
|
+
required :reason, String, nil?: true
|
|
1003
|
+
|
|
1004
|
+
# @!attribute replaces_adjustment_id
|
|
1005
|
+
# The adjustment id this adjustment replaces. This adjustment will take the place
|
|
1006
|
+
# of the replaced adjustment in plan version migrations.
|
|
1007
|
+
#
|
|
1008
|
+
# @return [String, nil]
|
|
1009
|
+
required :replaces_adjustment_id, String, nil?: true
|
|
1010
|
+
|
|
1011
|
+
# @!attribute tiers
|
|
1012
|
+
# The ordered, contiguous bands of cumulative eligible spend, each discounted at
|
|
1013
|
+
# its own percentage (progressive fill-a-tier), applied to the prices this
|
|
1014
|
+
# adjustment covers in a given billing period.
|
|
1015
|
+
#
|
|
1016
|
+
# @return [Array<Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Tier>]
|
|
1017
|
+
required :tiers,
|
|
1018
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Tier] }
|
|
1019
|
+
|
|
1020
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, replaces_adjustment_id:, tiers:, adjustment_type: :tiered_percentage_discount)
|
|
1021
|
+
# Some parameter documentations has been truncated, see
|
|
1022
|
+
# {Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount}
|
|
1023
|
+
# for more details.
|
|
1024
|
+
#
|
|
1025
|
+
# @param id [String]
|
|
1026
|
+
#
|
|
1027
|
+
# @param amount [String] The value applied by an adjustment.
|
|
1028
|
+
#
|
|
1029
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
|
1030
|
+
#
|
|
1031
|
+
# @param filters [Array<Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
|
1032
|
+
#
|
|
1033
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invoice, false for adjustments that
|
|
1034
|
+
#
|
|
1035
|
+
# @param reason [String, nil] The reason for the adjustment.
|
|
1036
|
+
#
|
|
1037
|
+
# @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
|
|
1038
|
+
#
|
|
1039
|
+
# @param tiers [Array<Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Tier>] The ordered, contiguous bands of cumulative eligible spend, each discounted at i
|
|
1040
|
+
#
|
|
1041
|
+
# @param adjustment_type [Symbol, :tiered_percentage_discount]
|
|
1042
|
+
|
|
1043
|
+
class Filter < Orb::Internal::Type::BaseModel
|
|
1044
|
+
# @!attribute field
|
|
1045
|
+
# The property of the price to filter on.
|
|
1046
|
+
#
|
|
1047
|
+
# @return [Symbol, Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter::Field]
|
|
1048
|
+
required :field,
|
|
1049
|
+
enum: -> { Orb::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter::Field }
|
|
1050
|
+
|
|
1051
|
+
# @!attribute operator
|
|
1052
|
+
# Should prices that match the filter be included or excluded.
|
|
1053
|
+
#
|
|
1054
|
+
# @return [Symbol, Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter::Operator]
|
|
1055
|
+
required :operator,
|
|
1056
|
+
enum: -> { Orb::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter::Operator }
|
|
1057
|
+
|
|
1058
|
+
# @!attribute values
|
|
1059
|
+
# The IDs or values that match this filter.
|
|
1060
|
+
#
|
|
1061
|
+
# @return [Array<String>]
|
|
1062
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
|
1063
|
+
|
|
1064
|
+
# @!method initialize(field:, operator:, values:)
|
|
1065
|
+
# @param field [Symbol, Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter::Field] The property of the price to filter on.
|
|
1066
|
+
#
|
|
1067
|
+
# @param operator [Symbol, Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
|
1068
|
+
#
|
|
1069
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
|
1070
|
+
|
|
1071
|
+
# The property of the price to filter on.
|
|
1072
|
+
#
|
|
1073
|
+
# @see Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter#field
|
|
1074
|
+
module Field
|
|
1075
|
+
extend Orb::Internal::Type::Enum
|
|
1076
|
+
|
|
1077
|
+
PRICE_ID = :price_id
|
|
1078
|
+
ITEM_ID = :item_id
|
|
1079
|
+
PRICE_TYPE = :price_type
|
|
1080
|
+
CURRENCY = :currency
|
|
1081
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
|
1082
|
+
|
|
1083
|
+
# @!method self.values
|
|
1084
|
+
# @return [Array<Symbol>]
|
|
1085
|
+
end
|
|
1086
|
+
|
|
1087
|
+
# Should prices that match the filter be included or excluded.
|
|
1088
|
+
#
|
|
1089
|
+
# @see Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Filter#operator
|
|
1090
|
+
module Operator
|
|
1091
|
+
extend Orb::Internal::Type::Enum
|
|
1092
|
+
|
|
1093
|
+
INCLUDES = :includes
|
|
1094
|
+
EXCLUDES = :excludes
|
|
1095
|
+
|
|
1096
|
+
# @!method self.values
|
|
1097
|
+
# @return [Array<Symbol>]
|
|
1098
|
+
end
|
|
1099
|
+
end
|
|
1100
|
+
|
|
1101
|
+
class Tier < Orb::Internal::Type::BaseModel
|
|
1102
|
+
# @!attribute lower_bound
|
|
1103
|
+
# Exclusive lower bound of cumulative spend for this tier.
|
|
1104
|
+
#
|
|
1105
|
+
# @return [Float]
|
|
1106
|
+
required :lower_bound, Float
|
|
1107
|
+
|
|
1108
|
+
# @!attribute percentage
|
|
1109
|
+
# The percentage (between 0 and 1) discounted from spend that falls within this
|
|
1110
|
+
# tier.
|
|
1111
|
+
#
|
|
1112
|
+
# @return [Float]
|
|
1113
|
+
required :percentage, Float
|
|
1114
|
+
|
|
1115
|
+
# @!attribute upper_bound
|
|
1116
|
+
# Inclusive upper bound of cumulative spend for this tier; null for the final
|
|
1117
|
+
# open-ended tier.
|
|
1118
|
+
#
|
|
1119
|
+
# @return [Float, nil]
|
|
1120
|
+
optional :upper_bound, Float, nil?: true
|
|
1121
|
+
|
|
1122
|
+
# @!method initialize(lower_bound:, percentage:, upper_bound: nil)
|
|
1123
|
+
# Some parameter documentations has been truncated, see
|
|
1124
|
+
# {Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount::Tier}
|
|
1125
|
+
# for more details.
|
|
1126
|
+
#
|
|
1127
|
+
# One band of a tiered percentage discount. Bounds are denominated in the
|
|
1128
|
+
# discount's currency. `lower_bound` is the exclusive start of the band and
|
|
1129
|
+
# `upper_bound` is the inclusive end; `upper_bound` is null only for the
|
|
1130
|
+
# open-ended final tier.
|
|
1131
|
+
#
|
|
1132
|
+
# @param lower_bound [Float] Exclusive lower bound of cumulative spend for this tier.
|
|
1133
|
+
#
|
|
1134
|
+
# @param percentage [Float] The percentage (between 0 and 1) discounted from spend that falls within this ti
|
|
1135
|
+
#
|
|
1136
|
+
# @param upper_bound [Float, nil] Inclusive upper bound of cumulative spend for this tier; null for the final open
|
|
1137
|
+
end
|
|
1138
|
+
end
|
|
1139
|
+
|
|
951
1140
|
# @!method self.variants
|
|
952
|
-
# @return [Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment)]
|
|
1141
|
+
# @return [Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::ChangedSubscriptionResources::CreatedInvoice::LineItem::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment)]
|
|
953
1142
|
end
|
|
954
1143
|
|
|
955
1144
|
module SubLineItem
|
|
@@ -1042,6 +1231,7 @@ module Orb
|
|
|
1042
1231
|
extend Orb::Internal::Type::Enum
|
|
1043
1232
|
|
|
1044
1233
|
STRIPE = :stripe
|
|
1234
|
+
ADYEN = :adyen
|
|
1045
1235
|
|
|
1046
1236
|
# @!method self.values
|
|
1047
1237
|
# @return [Array<Symbol>]
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
module ConversionRateConfig
|
|
6
|
+
extend Orb::Internal::Type::Union
|
|
7
|
+
|
|
8
|
+
discriminator :conversion_rate_type
|
|
9
|
+
|
|
10
|
+
variant :unit, -> { Orb::UnitConversionRateConfig }
|
|
11
|
+
|
|
12
|
+
variant :tiered, -> { Orb::TieredConversionRateConfig }
|
|
13
|
+
|
|
14
|
+
# @!method self.variants
|
|
15
|
+
# @return [Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig)]
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -33,6 +33,16 @@ module Orb
|
|
|
33
33
|
# @return [Float]
|
|
34
34
|
required :balance, Float
|
|
35
35
|
|
|
36
|
+
# @!attribute credit_block_source
|
|
37
|
+
# How this credit block was created: `allocation` (a subscription's recurring
|
|
38
|
+
# credit allocation), `top_up` (an automatic balance-threshold top-up), or
|
|
39
|
+
# `manual` (a manual credit ledger increment, including credits voided or expired
|
|
40
|
+
# off another block).
|
|
41
|
+
#
|
|
42
|
+
# @return [Symbol, Orb::Models::CreditBlockListInvoicesResponse::Block::CreditBlockSource]
|
|
43
|
+
required :credit_block_source,
|
|
44
|
+
enum: -> { Orb::Models::CreditBlockListInvoicesResponse::Block::CreditBlockSource }
|
|
45
|
+
|
|
36
46
|
# @!attribute effective_date
|
|
37
47
|
#
|
|
38
48
|
# @return [Time, nil]
|
|
@@ -73,7 +83,16 @@ module Orb
|
|
|
73
83
|
# @return [Symbol, Orb::Models::CreditBlockListInvoicesResponse::Block::Status]
|
|
74
84
|
required :status, enum: -> { Orb::Models::CreditBlockListInvoicesResponse::Block::Status }
|
|
75
85
|
|
|
76
|
-
# @!
|
|
86
|
+
# @!attribute credit_allocation
|
|
87
|
+
# The credit allocation that funded a block. Extends the allocation resource
|
|
88
|
+
# serialized on prices with the catalog-item attribution of the funding price.
|
|
89
|
+
#
|
|
90
|
+
# @return [Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation, nil]
|
|
91
|
+
optional :credit_allocation,
|
|
92
|
+
-> { Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation },
|
|
93
|
+
nil?: true
|
|
94
|
+
|
|
95
|
+
# @!method initialize(id:, balance:, credit_block_source:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:, credit_allocation: nil)
|
|
77
96
|
# Some parameter documentations has been truncated, see
|
|
78
97
|
# {Orb::Models::CreditBlockListInvoicesResponse::Block} for more details.
|
|
79
98
|
#
|
|
@@ -83,6 +102,8 @@ module Orb
|
|
|
83
102
|
#
|
|
84
103
|
# @param balance [Float]
|
|
85
104
|
#
|
|
105
|
+
# @param credit_block_source [Symbol, Orb::Models::CreditBlockListInvoicesResponse::Block::CreditBlockSource] How this credit block was created: `allocation` (a subscription's recurring cred
|
|
106
|
+
#
|
|
86
107
|
# @param effective_date [Time, nil]
|
|
87
108
|
#
|
|
88
109
|
# @param expiry_date [Time, nil]
|
|
@@ -96,6 +117,25 @@ module Orb
|
|
|
96
117
|
# @param per_unit_cost_basis [String, nil]
|
|
97
118
|
#
|
|
98
119
|
# @param status [Symbol, Orb::Models::CreditBlockListInvoicesResponse::Block::Status]
|
|
120
|
+
#
|
|
121
|
+
# @param credit_allocation [Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation, nil] The credit allocation that funded a block. Extends the allocation resource
|
|
122
|
+
|
|
123
|
+
# How this credit block was created: `allocation` (a subscription's recurring
|
|
124
|
+
# credit allocation), `top_up` (an automatic balance-threshold top-up), or
|
|
125
|
+
# `manual` (a manual credit ledger increment, including credits voided or expired
|
|
126
|
+
# off another block).
|
|
127
|
+
#
|
|
128
|
+
# @see Orb::Models::CreditBlockListInvoicesResponse::Block#credit_block_source
|
|
129
|
+
module CreditBlockSource
|
|
130
|
+
extend Orb::Internal::Type::Enum
|
|
131
|
+
|
|
132
|
+
ALLOCATION = :allocation
|
|
133
|
+
TOP_UP = :top_up
|
|
134
|
+
MANUAL = :manual
|
|
135
|
+
|
|
136
|
+
# @!method self.values
|
|
137
|
+
# @return [Array<Symbol>]
|
|
138
|
+
end
|
|
99
139
|
|
|
100
140
|
class Filter < Orb::Internal::Type::BaseModel
|
|
101
141
|
# @!attribute field
|
|
@@ -163,6 +203,120 @@ module Orb
|
|
|
163
203
|
# @!method self.values
|
|
164
204
|
# @return [Array<Symbol>]
|
|
165
205
|
end
|
|
206
|
+
|
|
207
|
+
# @see Orb::Models::CreditBlockListInvoicesResponse::Block#credit_allocation
|
|
208
|
+
class CreditAllocation < Orb::Internal::Type::BaseModel
|
|
209
|
+
# @!attribute allows_rollover
|
|
210
|
+
#
|
|
211
|
+
# @return [Boolean]
|
|
212
|
+
required :allows_rollover, Orb::Internal::Type::Boolean
|
|
213
|
+
|
|
214
|
+
# @!attribute currency
|
|
215
|
+
#
|
|
216
|
+
# @return [String]
|
|
217
|
+
required :currency, String
|
|
218
|
+
|
|
219
|
+
# @!attribute custom_expiration
|
|
220
|
+
#
|
|
221
|
+
# @return [Orb::Models::CustomExpiration, nil]
|
|
222
|
+
required :custom_expiration, -> { Orb::CustomExpiration }, nil?: true
|
|
223
|
+
|
|
224
|
+
# @!attribute item_id
|
|
225
|
+
# The ID of the catalog item this block was allocated from, derived from the
|
|
226
|
+
# allocation's price.
|
|
227
|
+
#
|
|
228
|
+
# @return [String]
|
|
229
|
+
required :item_id, String
|
|
230
|
+
|
|
231
|
+
# @!attribute filters
|
|
232
|
+
#
|
|
233
|
+
# @return [Array<Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter>, nil]
|
|
234
|
+
optional :filters,
|
|
235
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter] }
|
|
236
|
+
|
|
237
|
+
# @!attribute license_type_id
|
|
238
|
+
#
|
|
239
|
+
# @return [String, nil]
|
|
240
|
+
optional :license_type_id, String, nil?: true
|
|
241
|
+
|
|
242
|
+
# @!method initialize(allows_rollover:, currency:, custom_expiration:, item_id:, filters: nil, license_type_id: nil)
|
|
243
|
+
# Some parameter documentations has been truncated, see
|
|
244
|
+
# {Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation} for more
|
|
245
|
+
# details.
|
|
246
|
+
#
|
|
247
|
+
# The credit allocation that funded a block. Extends the allocation resource
|
|
248
|
+
# serialized on prices with the catalog-item attribution of the funding price.
|
|
249
|
+
#
|
|
250
|
+
# @param allows_rollover [Boolean]
|
|
251
|
+
#
|
|
252
|
+
# @param currency [String]
|
|
253
|
+
#
|
|
254
|
+
# @param custom_expiration [Orb::Models::CustomExpiration, nil]
|
|
255
|
+
#
|
|
256
|
+
# @param item_id [String] The ID of the catalog item this block was allocated from, derived from the alloc
|
|
257
|
+
#
|
|
258
|
+
# @param filters [Array<Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter>]
|
|
259
|
+
#
|
|
260
|
+
# @param license_type_id [String, nil]
|
|
261
|
+
|
|
262
|
+
class Filter < Orb::Internal::Type::BaseModel
|
|
263
|
+
# @!attribute field
|
|
264
|
+
# The property of the price to filter on.
|
|
265
|
+
#
|
|
266
|
+
# @return [Symbol, Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter::Field]
|
|
267
|
+
required :field,
|
|
268
|
+
enum: -> { Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter::Field }
|
|
269
|
+
|
|
270
|
+
# @!attribute operator
|
|
271
|
+
# Should prices that match the filter be included or excluded.
|
|
272
|
+
#
|
|
273
|
+
# @return [Symbol, Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter::Operator]
|
|
274
|
+
required :operator,
|
|
275
|
+
enum: -> { Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter::Operator }
|
|
276
|
+
|
|
277
|
+
# @!attribute values
|
|
278
|
+
# The IDs or values that match this filter.
|
|
279
|
+
#
|
|
280
|
+
# @return [Array<String>]
|
|
281
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
|
282
|
+
|
|
283
|
+
# @!method initialize(field:, operator:, values:)
|
|
284
|
+
# @param field [Symbol, Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter::Field] The property of the price to filter on.
|
|
285
|
+
#
|
|
286
|
+
# @param operator [Symbol, Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter::Operator] Should prices that match the filter be included or excluded.
|
|
287
|
+
#
|
|
288
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
|
289
|
+
|
|
290
|
+
# The property of the price to filter on.
|
|
291
|
+
#
|
|
292
|
+
# @see Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter#field
|
|
293
|
+
module Field
|
|
294
|
+
extend Orb::Internal::Type::Enum
|
|
295
|
+
|
|
296
|
+
PRICE_ID = :price_id
|
|
297
|
+
ITEM_ID = :item_id
|
|
298
|
+
PRICE_TYPE = :price_type
|
|
299
|
+
CURRENCY = :currency
|
|
300
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
|
301
|
+
|
|
302
|
+
# @!method self.values
|
|
303
|
+
# @return [Array<Symbol>]
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
# Should prices that match the filter be included or excluded.
|
|
307
|
+
#
|
|
308
|
+
# @see Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation::Filter#operator
|
|
309
|
+
module Operator
|
|
310
|
+
extend Orb::Internal::Type::Enum
|
|
311
|
+
|
|
312
|
+
INCLUDES = :includes
|
|
313
|
+
EXCLUDES = :excludes
|
|
314
|
+
|
|
315
|
+
# @!method self.values
|
|
316
|
+
# @return [Array<Symbol>]
|
|
317
|
+
end
|
|
318
|
+
end
|
|
319
|
+
end
|
|
166
320
|
end
|
|
167
321
|
|
|
168
322
|
class Invoice < Orb::Internal::Type::BaseModel
|