orb-billing 1.13.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 +55 -0
- data/README.md +1 -1
- data/lib/orb/client.rb +21 -0
- data/lib/orb/internal/transport/base_client.rb +5 -0
- data/lib/orb/internal/type/union.rb +13 -27
- data/lib/orb/internal/util.rb +22 -7
- 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 +114 -1
- data/lib/orb/models/alert_create_for_customer_params.rb +8 -1
- data/lib/orb/models/alert_create_for_external_customer_params.rb +8 -1
- data/lib/orb/models/alert_create_for_subscription_params.rb +142 -1
- data/lib/orb/models/alert_disable_params.rb +8 -1
- data/lib/orb/models/alert_enable_params.rb +8 -1
- data/lib/orb/models/alert_retrieve_params.rb +7 -1
- data/lib/orb/models/alert_update_params.rb +120 -1
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +3296 -631
- data/lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb +7 -1
- data/lib/orb/models/beta/external_plan_id_set_default_plan_version_params.rb +8 -1
- data/lib/orb/models/beta_create_plan_version_params.rb +3263 -622
- data/lib/orb/models/beta_fetch_plan_version_params.rb +7 -1
- data/lib/orb/models/beta_set_default_plan_version_params.rb +8 -1
- data/lib/orb/models/changed_subscription_resources.rb +200 -10
- data/lib/orb/models/conversion_rate_config.rb +18 -0
- data/lib/orb/models/coupon_archive_params.rb +7 -1
- data/lib/orb/models/coupon_fetch_params.rb +7 -1
- data/lib/orb/models/coupons/subscription_list_params.rb +8 -1
- data/lib/orb/models/credit_block_delete_params.rb +7 -1
- data/lib/orb/models/credit_block_list_invoices_params.rb +7 -1
- data/lib/orb/models/credit_block_list_invoices_response.rb +155 -1
- data/lib/orb/models/credit_block_retrieve_params.rb +7 -1
- data/lib/orb/models/credit_block_retrieve_response.rb +150 -1
- data/lib/orb/models/credit_note_fetch_params.rb +7 -1
- data/lib/orb/models/customer.rb +122 -3
- data/lib/orb/models/customer_create_params.rb +17 -1
- data/lib/orb/models/customer_delete_params.rb +7 -1
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +7 -1
- data/lib/orb/models/customer_fetch_params.rb +7 -1
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +7 -1
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +7 -1
- data/lib/orb/models/customer_tax_id.rb +15 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +39 -5
- data/lib/orb/models/customer_update_params.rb +39 -5
- data/lib/orb/models/customers/balance_transaction_create_params.rb +8 -1
- data/lib/orb/models/customers/balance_transaction_list_params.rb +8 -1
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/cost_list_params.rb +8 -1
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +155 -1
- data/lib/orb/models/customers/credit_list_params.rb +8 -1
- data/lib/orb/models/customers/credit_list_response.rb +152 -1
- data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +5 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +582 -315
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +580 -313
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +7 -1
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +7 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +8 -1
- data/lib/orb/models/customers/credits/top_up_list_params.rb +8 -1
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +7 -1
- data/lib/orb/models/dimensional_price_group_update_params.rb +8 -1
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +7 -1
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb +8 -1
- data/lib/orb/models/discount.rb +145 -1
- data/lib/orb/models/event_deprecate_params.rb +7 -1
- data/lib/orb/models/event_ingest_params.rb +5 -2
- data/lib/orb/models/event_update_params.rb +8 -1
- data/lib/orb/models/events/backfill_close_params.rb +7 -1
- data/lib/orb/models/events/backfill_fetch_params.rb +7 -1
- data/lib/orb/models/events/backfill_revert_params.rb +7 -1
- data/lib/orb/models/invoice.rb +198 -10
- data/lib/orb/models/invoice_create_params.rb +6 -5
- data/lib/orb/models/invoice_delete_line_item_params.rb +7 -1
- data/lib/orb/models/invoice_fetch_params.rb +7 -1
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +200 -10
- data/lib/orb/models/invoice_issue_params.rb +8 -1
- data/lib/orb/models/invoice_issue_summary_params.rb +8 -1
- 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/invoice_mark_paid_params.rb +8 -1
- data/lib/orb/models/invoice_pay_params.rb +16 -1
- data/lib/orb/models/invoice_update_params.rb +8 -1
- data/lib/orb/models/invoice_void_params.rb +7 -1
- data/lib/orb/models/item_archive_params.rb +7 -1
- data/lib/orb/models/item_fetch_params.rb +7 -1
- data/lib/orb/models/item_update_params.rb +8 -1
- data/lib/orb/models/license_deactivate_params.rb +8 -1
- data/lib/orb/models/license_retrieve_by_external_id_params.rb +8 -1
- data/lib/orb/models/license_retrieve_params.rb +7 -1
- data/lib/orb/models/license_type_retrieve_params.rb +7 -1
- data/lib/orb/models/licenses/external_license_get_usage_params.rb +11 -4
- data/lib/orb/models/licenses/usage_get_all_usage_params.rb +3 -3
- data/lib/orb/models/licenses/usage_get_usage_params.rb +11 -4
- data/lib/orb/models/metric_fetch_params.rb +7 -1
- data/lib/orb/models/metric_update_params.rb +8 -1
- 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 +1478 -158
- data/lib/orb/models/plan_fetch_params.rb +7 -1
- data/lib/orb/models/plan_update_params.rb +16 -1
- data/lib/orb/models/plan_version.rb +186 -5
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +7 -1
- data/lib/orb/models/plans/external_plan_id_update_params.rb +16 -1
- data/lib/orb/models/plans/migration_cancel_params.rb +7 -1
- data/lib/orb/models/plans/migration_cancel_response.rb +22 -4
- data/lib/orb/models/plans/migration_list_params.rb +8 -1
- data/lib/orb/models/plans/migration_list_response.rb +22 -4
- data/lib/orb/models/plans/migration_retrieve_params.rb +7 -1
- data/lib/orb/models/plans/migration_retrieve_response.rb +22 -4
- data/lib/orb/models/price.rb +2807 -1244
- data/lib/orb/models/price_create_params.rb +1800 -1355
- data/lib/orb/models/price_evaluate_multiple_params.rb +889 -54
- data/lib/orb/models/price_evaluate_params.rb +8 -1
- data/lib/orb/models/price_evaluate_preview_events_params.rb +881 -46
- data/lib/orb/models/price_fetch_params.rb +7 -1
- data/lib/orb/models/price_interval.rb +2 -2
- data/lib/orb/models/price_update_params.rb +8 -1
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +7 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +8 -1
- data/lib/orb/models/subscription.rb +168 -4
- data/lib/orb/models/subscription_cancel_params.rb +8 -1
- data/lib/orb/models/subscription_change_apply_params.rb +8 -1
- data/lib/orb/models/subscription_change_cancel_params.rb +7 -1
- data/lib/orb/models/subscription_change_retrieve_params.rb +7 -1
- data/lib/orb/models/subscription_create_params.rb +2818 -674
- data/lib/orb/models/subscription_fetch_costs_params.rb +8 -1
- data/lib/orb/models/subscription_fetch_params.rb +7 -1
- data/lib/orb/models/subscription_fetch_schedule_params.rb +8 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -1
- data/lib/orb/models/subscription_price_intervals_params.rb +1103 -55
- data/lib/orb/models/subscription_redeem_coupon_params.rb +8 -1
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +2839 -685
- data/lib/orb/models/subscription_trigger_phase_params.rb +8 -1
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +7 -1
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +8 -1
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +7 -1
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -1
- data/lib/orb/models/subscription_update_params.rb +19 -1
- data/lib/orb/models/subscription_update_trial_params.rb +8 -1
- data/lib/orb/models.rb +2 -0
- data/lib/orb/resources/alerts.rb +20 -2
- data/lib/orb/resources/coupons.rb +1 -2
- data/lib/orb/resources/credit_blocks.rb +11 -8
- data/lib/orb/resources/customers/credits/ledger.rb +40 -81
- data/lib/orb/resources/customers.rb +12 -7
- data/lib/orb/resources/events/backfills.rb +3 -4
- data/lib/orb/resources/events.rb +7 -34
- data/lib/orb/resources/invoices.rb +18 -7
- 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 +13 -104
- data/lib/orb/resources/subscriptions.rb +24 -7
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/client.rbi +6 -0
- data/rbi/orb/internal/util.rbi +8 -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 +182 -3
- data/rbi/orb/models/alert_create_for_customer_params.rbi +6 -0
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +6 -0
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +285 -0
- data/rbi/orb/models/alert_disable_params.rbi +6 -0
- data/rbi/orb/models/alert_enable_params.rbi +6 -0
- data/rbi/orb/models/alert_retrieve_params.rbi +13 -5
- data/rbi/orb/models/alert_update_params.rbi +214 -0
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +5873 -1161
- data/rbi/orb/models/beta/external_plan_id_fetch_plan_version_params.rbi +10 -2
- data/rbi/orb/models/beta/external_plan_id_set_default_plan_version_params.rbi +10 -1
- data/rbi/orb/models/beta_create_plan_version_params.rbi +5877 -1165
- data/rbi/orb/models/beta_fetch_plan_version_params.rbi +10 -2
- data/rbi/orb/models/beta_set_default_plan_version_params.rbi +10 -1
- data/rbi/orb/models/changed_subscription_resources.rbi +360 -5
- data/rbi/orb/models/conversion_rate_config.rbi +18 -0
- data/rbi/orb/models/coupon_archive_params.rbi +13 -5
- data/rbi/orb/models/coupon_fetch_params.rbi +13 -5
- data/rbi/orb/models/coupons/subscription_list_params.rbi +6 -0
- data/rbi/orb/models/credit_block_delete_params.rbi +13 -5
- data/rbi/orb/models/credit_block_list_invoices_params.rbi +13 -5
- data/rbi/orb/models/credit_block_list_invoices_response.rbi +346 -3
- data/rbi/orb/models/credit_block_retrieve_params.rbi +13 -5
- data/rbi/orb/models/credit_block_retrieve_response.rbi +344 -3
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -5
- data/rbi/orb/models/customer.rbi +202 -0
- data/rbi/orb/models/customer_create_params.rbi +27 -0
- data/rbi/orb/models/customer_delete_params.rbi +13 -5
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -5
- data/rbi/orb/models/customer_fetch_params.rbi +13 -5
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +13 -5
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +13 -5
- data/rbi/orb/models/customer_tax_id.rbi +15 -1
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +51 -4
- data/rbi/orb/models/customer_update_params.rbi +51 -4
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +6 -0
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +6 -0
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/cost_list_params.rbi +6 -0
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +346 -3
- data/rbi/orb/models/customers/credit_list_params.rbi +6 -0
- data/rbi/orb/models/customers/credit_list_response.rbi +347 -3
- data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +4 -0
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +861 -478
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +861 -478
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +6 -1
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +10 -2
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +6 -0
- data/rbi/orb/models/dimensional_price_group.rbi +1 -1
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -5
- data/rbi/orb/models/dimensional_price_group_update_params.rbi +6 -0
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +16 -5
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi +6 -0
- data/rbi/orb/models/discount.rbi +269 -1
- data/rbi/orb/models/event_deprecate_params.rbi +13 -5
- data/rbi/orb/models/event_ingest_params.rbi +4 -2
- data/rbi/orb/models/event_update_params.rbi +6 -0
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -5
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -5
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -5
- data/rbi/orb/models/invoice.rbi +360 -5
- data/rbi/orb/models/invoice_create_params.rbi +12 -7
- data/rbi/orb/models/invoice_delete_line_item_params.rbi +10 -2
- data/rbi/orb/models/invoice_fetch_params.rbi +13 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +360 -5
- data/rbi/orb/models/invoice_issue_params.rbi +10 -1
- data/rbi/orb/models/invoice_issue_summary_params.rbi +10 -1
- 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/invoice_mark_paid_params.rbi +6 -0
- data/rbi/orb/models/invoice_pay_params.rbi +27 -5
- data/rbi/orb/models/invoice_update_params.rbi +6 -0
- data/rbi/orb/models/invoice_void_params.rbi +13 -5
- data/rbi/orb/models/item_archive_params.rbi +13 -5
- data/rbi/orb/models/item_fetch_params.rbi +13 -5
- data/rbi/orb/models/item_update_params.rbi +6 -0
- data/rbi/orb/models/license_deactivate_params.rbi +10 -1
- data/rbi/orb/models/license_retrieve_by_external_id_params.rbi +6 -0
- data/rbi/orb/models/license_retrieve_params.rbi +13 -5
- data/rbi/orb/models/license_type_retrieve_params.rbi +13 -5
- data/rbi/orb/models/licenses/external_license_get_usage_params.rbi +9 -3
- data/rbi/orb/models/licenses/usage_get_all_usage_params.rbi +3 -3
- data/rbi/orb/models/licenses/usage_get_usage_params.rbi +9 -3
- data/rbi/orb/models/metric_fetch_params.rbi +13 -5
- data/rbi/orb/models/metric_update_params.rbi +6 -0
- 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 +2566 -209
- data/rbi/orb/models/plan_fetch_params.rbi +13 -5
- data/rbi/orb/models/plan_update_params.rbi +14 -0
- data/rbi/orb/models/plan_version.rbi +339 -0
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -5
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +14 -0
- data/rbi/orb/models/plans/migration_cancel_params.rbi +10 -2
- data/rbi/orb/models/plans/migration_cancel_response.rbi +22 -1
- data/rbi/orb/models/plans/migration_list_params.rbi +6 -0
- data/rbi/orb/models/plans/migration_list_response.rbi +22 -1
- data/rbi/orb/models/plans/migration_retrieve_params.rbi +10 -2
- data/rbi/orb/models/plans/migration_retrieve_response.rbi +22 -1
- data/rbi/orb/models/price.rbi +4733 -2280
- data/rbi/orb/models/price_create_params.rbi +3022 -2408
- data/rbi/orb/models/price_evaluate_multiple_params.rbi +1540 -114
- data/rbi/orb/models/price_evaluate_params.rbi +6 -0
- data/rbi/orb/models/price_evaluate_preview_events_params.rbi +1540 -114
- data/rbi/orb/models/price_fetch_params.rbi +13 -5
- data/rbi/orb/models/price_interval.rbi +3 -0
- data/rbi/orb/models/price_update_params.rbi +6 -0
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +13 -5
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +6 -0
- data/rbi/orb/models/subscription.rbi +324 -2
- data/rbi/orb/models/subscription_cancel_params.rbi +6 -0
- data/rbi/orb/models/subscription_change_apply_params.rbi +6 -0
- data/rbi/orb/models/subscription_change_cancel_params.rbi +16 -5
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +16 -5
- data/rbi/orb/models/subscription_create_params.rbi +4998 -1186
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +6 -0
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -5
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +6 -0
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +6 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +2133 -264
- data/rbi/orb/models/subscription_redeem_coupon_params.rbi +6 -0
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +5001 -1183
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +6 -0
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +13 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +10 -1
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +13 -5
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +6 -0
- data/rbi/orb/models/subscription_update_params.rbi +20 -0
- data/rbi/orb/models/subscription_update_trial_params.rbi +6 -0
- data/rbi/orb/models.rbi +2 -0
- data/rbi/orb/resources/alerts.rbi +43 -0
- data/rbi/orb/resources/coupons.rbi +1 -2
- data/rbi/orb/resources/credit_blocks.rbi +10 -7
- data/rbi/orb/resources/customers/credits/ledger.rbi +50 -146
- data/rbi/orb/resources/customers.rbi +35 -7
- data/rbi/orb/resources/events/backfills.rbi +3 -4
- data/rbi/orb/resources/events.rbi +8 -35
- data/rbi/orb/resources/invoices.rbi +20 -6
- 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 +38 -184
- data/rbi/orb/resources/subscriptions.rbi +33 -4
- data/sig/orb/client.rbs +3 -0
- data/sig/orb/internal/util.rbs +4 -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 +90 -3
- data/sig/orb/models/alert_create_for_customer_params.rbs +5 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +5 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +98 -1
- data/sig/orb/models/alert_disable_params.rbs +6 -1
- data/sig/orb/models/alert_enable_params.rbs +6 -1
- data/sig/orb/models/alert_retrieve_params.rbs +9 -3
- data/sig/orb/models/alert_update_params.rbs +90 -1
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +2318 -397
- data/sig/orb/models/beta/external_plan_id_fetch_plan_version_params.rbs +6 -1
- data/sig/orb/models/beta/external_plan_id_set_default_plan_version_params.rbs +6 -1
- data/sig/orb/models/beta_create_plan_version_params.rbs +2300 -389
- data/sig/orb/models/beta_fetch_plan_version_params.rbs +10 -2
- data/sig/orb/models/beta_set_default_plan_version_params.rbs +10 -2
- data/sig/orb/models/changed_subscription_resources.rbs +140 -1
- data/sig/orb/models/conversion_rate_config.rbs +12 -0
- data/sig/orb/models/coupon_archive_params.rbs +12 -3
- data/sig/orb/models/coupon_fetch_params.rbs +12 -3
- data/sig/orb/models/coupons/subscription_list_params.rbs +5 -1
- data/sig/orb/models/credit_block_delete_params.rbs +8 -3
- data/sig/orb/models/credit_block_list_invoices_params.rbs +8 -3
- data/sig/orb/models/credit_block_list_invoices_response.rbs +124 -3
- data/sig/orb/models/credit_block_retrieve_params.rbs +8 -3
- data/sig/orb/models/credit_block_retrieve_response.rbs +124 -3
- data/sig/orb/models/credit_note_fetch_params.rbs +11 -3
- data/sig/orb/models/customer.rbs +79 -1
- data/sig/orb/models/customer_create_params.rbs +12 -1
- data/sig/orb/models/customer_delete_params.rbs +12 -3
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +11 -3
- data/sig/orb/models/customer_fetch_params.rbs +12 -3
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +11 -3
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +11 -3
- data/sig/orb/models/customer_tax_id.rbs +20 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +22 -1
- data/sig/orb/models/customer_update_params.rbs +22 -1
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +5 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +5 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/cost_list_params.rbs +5 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +124 -3
- data/sig/orb/models/customers/credit_list_params.rbs +5 -0
- data/sig/orb/models/customers/credit_list_response.rbs +124 -3
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +345 -157
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +345 -157
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -1
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +6 -1
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +5 -1
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +5 -1
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +12 -3
- data/sig/orb/models/dimensional_price_group_update_params.rbs +5 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +12 -3
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbs +5 -0
- data/sig/orb/models/discount.rbs +114 -0
- data/sig/orb/models/event_deprecate_params.rbs +9 -3
- data/sig/orb/models/event_update_params.rbs +5 -0
- data/sig/orb/models/events/backfill_close_params.rbs +11 -3
- data/sig/orb/models/events/backfill_fetch_params.rbs +11 -3
- data/sig/orb/models/events/backfill_revert_params.rbs +11 -3
- data/sig/orb/models/invoice.rbs +140 -1
- data/sig/orb/models/invoice_delete_line_item_params.rbs +6 -1
- data/sig/orb/models/invoice_fetch_params.rbs +12 -3
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +140 -1
- data/sig/orb/models/invoice_issue_params.rbs +6 -1
- data/sig/orb/models/invoice_issue_summary_params.rbs +6 -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/invoice_mark_paid_params.rbs +10 -1
- data/sig/orb/models/invoice_pay_params.rbs +17 -3
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +12 -3
- data/sig/orb/models/item_archive_params.rbs +9 -3
- data/sig/orb/models/item_fetch_params.rbs +9 -3
- data/sig/orb/models/item_update_params.rbs +5 -0
- data/sig/orb/models/license_deactivate_params.rbs +10 -2
- data/sig/orb/models/license_retrieve_by_external_id_params.rbs +9 -1
- data/sig/orb/models/license_retrieve_params.rbs +11 -3
- data/sig/orb/models/license_type_retrieve_params.rbs +11 -3
- data/sig/orb/models/licenses/external_license_get_usage_params.rbs +9 -4
- data/sig/orb/models/licenses/usage_get_all_usage_params.rbs +4 -4
- data/sig/orb/models/licenses/usage_get_usage_params.rbs +9 -4
- data/sig/orb/models/metric_fetch_params.rbs +12 -3
- data/sig/orb/models/metric_update_params.rbs +5 -1
- 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 +1030 -72
- data/sig/orb/models/plan_fetch_params.rbs +9 -3
- data/sig/orb/models/plan_update_params.rbs +14 -1
- data/sig/orb/models/plan_version.rbs +134 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +11 -3
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +14 -1
- data/sig/orb/models/plans/migration_cancel_params.rbs +6 -1
- data/sig/orb/models/plans/migration_list_params.rbs +5 -1
- data/sig/orb/models/plans/migration_retrieve_params.rbs +6 -1
- data/sig/orb/models/price.rbs +2361 -1156
- data/sig/orb/models/price_create_params.rbs +1124 -931
- data/sig/orb/models/price_evaluate_multiple_params.rbs +626 -23
- data/sig/orb/models/price_evaluate_params.rbs +5 -0
- data/sig/orb/models/price_evaluate_preview_events_params.rbs +626 -23
- data/sig/orb/models/price_fetch_params.rbs +9 -3
- data/sig/orb/models/price_update_params.rbs +5 -1
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +11 -3
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -1
- data/sig/orb/models/subscription.rbs +124 -0
- data/sig/orb/models/subscription_cancel_params.rbs +5 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +5 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +12 -3
- data/sig/orb/models/subscription_change_retrieve_params.rbs +12 -3
- data/sig/orb/models/subscription_create_params.rbs +2009 -430
- data/sig/orb/models/subscription_fetch_costs_params.rbs +5 -0
- data/sig/orb/models/subscription_fetch_params.rbs +11 -3
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +5 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +5 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +800 -23
- data/sig/orb/models/subscription_redeem_coupon_params.rbs +5 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2014 -430
- data/sig/orb/models/subscription_trigger_phase_params.rbs +9 -1
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +11 -3
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +10 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +11 -3
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +5 -0
- data/sig/orb/models/subscription_update_params.rbs +10 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +5 -0
- data/sig/orb/models.rbs +2 -0
- data/sig/orb/resources/alerts.rbs +6 -0
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -26
- data/sig/orb/resources/customers.rbs +2 -0
- data/sig/orb/resources/invoices.rbs +1 -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/prices.rbs +1 -48
- data/sig/orb/resources/subscriptions.rbs +3 -0
- metadata +6 -7
data/rbi/orb/models/customer.rbi
CHANGED
|
@@ -83,6 +83,10 @@ module Orb
|
|
|
83
83
|
sig { returns(T.nilable(String)) }
|
|
84
84
|
attr_accessor :payment_provider_id
|
|
85
85
|
|
|
86
|
+
# Deprecated. Returns the URL of the most recent non-expired portal link, or null.
|
|
87
|
+
# When the account has opted into customer portal sessions, this field always
|
|
88
|
+
# returns null. Use POST /v1/customers/{id}/portal_sessions to mint short-lived
|
|
89
|
+
# portal session URLs.
|
|
86
90
|
sig { returns(T.nilable(String)) }
|
|
87
91
|
attr_accessor :portal_url
|
|
88
92
|
|
|
@@ -149,11 +153,13 @@ module Orb
|
|
|
149
153
|
# | Estonia | `eu_vat` | European VAT Number |
|
|
150
154
|
# | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
|
|
151
155
|
# | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
156
|
+
# | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
|
|
152
157
|
# | Finland | `eu_vat` | European VAT Number |
|
|
153
158
|
# | France | `eu_vat` | European VAT Number |
|
|
154
159
|
# | Georgia | `ge_vat` | Georgian VAT |
|
|
155
160
|
# | Germany | `de_stn` | German Tax Number (Steuernummer) |
|
|
156
161
|
# | Germany | `eu_vat` | European VAT Number |
|
|
162
|
+
# | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
|
|
157
163
|
# | Greece | `eu_vat` | European VAT Number |
|
|
158
164
|
# | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
|
|
159
165
|
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
@@ -165,6 +171,7 @@ module Orb
|
|
|
165
171
|
# | Ireland | `eu_vat` | European VAT Number |
|
|
166
172
|
# | Israel | `il_vat` | Israel VAT |
|
|
167
173
|
# | Italy | `eu_vat` | European VAT Number |
|
|
174
|
+
# | Italy | `it_cf` | Italian Codice Fiscale Number |
|
|
168
175
|
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
169
176
|
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
170
177
|
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
@@ -195,6 +202,7 @@ module Orb
|
|
|
195
202
|
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
196
203
|
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
197
204
|
# | Oman | `om_vat` | Omani VAT Number |
|
|
205
|
+
# | Paraguay | `py_ruc` | Paraguayan RUC Number |
|
|
198
206
|
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
199
207
|
# | Philippines | `ph_tin` | Philippines Tax Identification Number |
|
|
200
208
|
# | Poland | `eu_vat` | European VAT Number |
|
|
@@ -216,6 +224,7 @@ module Orb
|
|
|
216
224
|
# | South Korea | `kr_brn` | Korean BRN |
|
|
217
225
|
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
218
226
|
# | Spain | `eu_vat` | European VAT Number |
|
|
227
|
+
# | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
|
|
219
228
|
# | Suriname | `sr_fin` | Suriname FIN Number |
|
|
220
229
|
# | Sweden | `eu_vat` | European VAT Number |
|
|
221
230
|
# | Switzerland | `ch_uid` | Switzerland UID Number |
|
|
@@ -265,6 +274,22 @@ module Orb
|
|
|
265
274
|
sig { returns(T.nilable(T::Boolean)) }
|
|
266
275
|
attr_accessor :automatic_tax_enabled
|
|
267
276
|
|
|
277
|
+
# A payment method represents a customer's stored payment instrument held with an
|
|
278
|
+
# external payment provider (such as Adyen or Stripe).
|
|
279
|
+
#
|
|
280
|
+
# The serialization is intentionally minimal for now; provider-pulled details
|
|
281
|
+
# (e.g. card display metadata) will be added over time.
|
|
282
|
+
sig { returns(T.nilable(Orb::Customer::DefaultPaymentMethod)) }
|
|
283
|
+
attr_reader :default_payment_method
|
|
284
|
+
|
|
285
|
+
sig do
|
|
286
|
+
params(
|
|
287
|
+
default_payment_method:
|
|
288
|
+
T.nilable(Orb::Customer::DefaultPaymentMethod::OrHash)
|
|
289
|
+
).void
|
|
290
|
+
end
|
|
291
|
+
attr_writer :default_payment_method
|
|
292
|
+
|
|
268
293
|
# Payment configuration for the customer, applicable when using Orb Invoicing with
|
|
269
294
|
# a supported payment provider such as Stripe.
|
|
270
295
|
sig { returns(T.nilable(Orb::Customer::PaymentConfiguration)) }
|
|
@@ -333,6 +358,8 @@ module Orb
|
|
|
333
358
|
accounting_sync_configuration:
|
|
334
359
|
T.nilable(Orb::Customer::AccountingSyncConfiguration::OrHash),
|
|
335
360
|
automatic_tax_enabled: T.nilable(T::Boolean),
|
|
361
|
+
default_payment_method:
|
|
362
|
+
T.nilable(Orb::Customer::DefaultPaymentMethod::OrHash),
|
|
336
363
|
payment_configuration:
|
|
337
364
|
T.nilable(Orb::Customer::PaymentConfiguration::OrHash),
|
|
338
365
|
reporting_configuration:
|
|
@@ -378,6 +405,10 @@ module Orb
|
|
|
378
405
|
# The ID of this customer in an external payments solution, such as Stripe. This
|
|
379
406
|
# is used for creating charges or invoices in the external system via Orb.
|
|
380
407
|
payment_provider_id:,
|
|
408
|
+
# Deprecated. Returns the URL of the most recent non-expired portal link, or null.
|
|
409
|
+
# When the account has opted into customer portal sessions, this field always
|
|
410
|
+
# returns null. Use POST /v1/customers/{id}/portal_sessions to mint short-lived
|
|
411
|
+
# portal session URLs.
|
|
381
412
|
portal_url:,
|
|
382
413
|
shipping_address:,
|
|
383
414
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
@@ -437,11 +468,13 @@ module Orb
|
|
|
437
468
|
# | Estonia | `eu_vat` | European VAT Number |
|
|
438
469
|
# | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
|
|
439
470
|
# | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
471
|
+
# | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
|
|
440
472
|
# | Finland | `eu_vat` | European VAT Number |
|
|
441
473
|
# | France | `eu_vat` | European VAT Number |
|
|
442
474
|
# | Georgia | `ge_vat` | Georgian VAT |
|
|
443
475
|
# | Germany | `de_stn` | German Tax Number (Steuernummer) |
|
|
444
476
|
# | Germany | `eu_vat` | European VAT Number |
|
|
477
|
+
# | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
|
|
445
478
|
# | Greece | `eu_vat` | European VAT Number |
|
|
446
479
|
# | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
|
|
447
480
|
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
@@ -453,6 +486,7 @@ module Orb
|
|
|
453
486
|
# | Ireland | `eu_vat` | European VAT Number |
|
|
454
487
|
# | Israel | `il_vat` | Israel VAT |
|
|
455
488
|
# | Italy | `eu_vat` | European VAT Number |
|
|
489
|
+
# | Italy | `it_cf` | Italian Codice Fiscale Number |
|
|
456
490
|
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
457
491
|
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
458
492
|
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
@@ -483,6 +517,7 @@ module Orb
|
|
|
483
517
|
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
484
518
|
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
485
519
|
# | Oman | `om_vat` | Omani VAT Number |
|
|
520
|
+
# | Paraguay | `py_ruc` | Paraguayan RUC Number |
|
|
486
521
|
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
487
522
|
# | Philippines | `ph_tin` | Philippines Tax Identification Number |
|
|
488
523
|
# | Poland | `eu_vat` | European VAT Number |
|
|
@@ -504,6 +539,7 @@ module Orb
|
|
|
504
539
|
# | South Korea | `kr_brn` | Korean BRN |
|
|
505
540
|
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
506
541
|
# | Spain | `eu_vat` | European VAT Number |
|
|
542
|
+
# | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
|
|
507
543
|
# | Suriname | `sr_fin` | Suriname FIN Number |
|
|
508
544
|
# | Sweden | `eu_vat` | European VAT Number |
|
|
509
545
|
# | Switzerland | `ch_uid` | Switzerland UID Number |
|
|
@@ -534,6 +570,12 @@ module Orb
|
|
|
534
570
|
# Whether automatic tax calculation is enabled for this customer. This field is
|
|
535
571
|
# nullable for backwards compatibility but will always return a boolean value.
|
|
536
572
|
automatic_tax_enabled: nil,
|
|
573
|
+
# A payment method represents a customer's stored payment instrument held with an
|
|
574
|
+
# external payment provider (such as Adyen or Stripe).
|
|
575
|
+
#
|
|
576
|
+
# The serialization is intentionally minimal for now; provider-pulled details
|
|
577
|
+
# (e.g. card display metadata) will be added over time.
|
|
578
|
+
default_payment_method: nil,
|
|
537
579
|
# Payment configuration for the customer, applicable when using Orb Invoicing with
|
|
538
580
|
# a supported payment provider such as Stripe.
|
|
539
581
|
payment_configuration: nil,
|
|
@@ -569,6 +611,8 @@ module Orb
|
|
|
569
611
|
accounting_sync_configuration:
|
|
570
612
|
T.nilable(Orb::Customer::AccountingSyncConfiguration),
|
|
571
613
|
automatic_tax_enabled: T.nilable(T::Boolean),
|
|
614
|
+
default_payment_method:
|
|
615
|
+
T.nilable(Orb::Customer::DefaultPaymentMethod),
|
|
572
616
|
payment_configuration:
|
|
573
617
|
T.nilable(Orb::Customer::PaymentConfiguration),
|
|
574
618
|
reporting_configuration:
|
|
@@ -636,6 +680,7 @@ module Orb
|
|
|
636
680
|
T.let(:stripe_invoice, Orb::Customer::PaymentProvider::TaggedSymbol)
|
|
637
681
|
NETSUITE =
|
|
638
682
|
T.let(:netsuite, Orb::Customer::PaymentProvider::TaggedSymbol)
|
|
683
|
+
ADYEN = T.let(:adyen, Orb::Customer::PaymentProvider::TaggedSymbol)
|
|
639
684
|
|
|
640
685
|
sig do
|
|
641
686
|
override.returns(
|
|
@@ -770,6 +815,151 @@ module Orb
|
|
|
770
815
|
end
|
|
771
816
|
end
|
|
772
817
|
|
|
818
|
+
class DefaultPaymentMethod < Orb::Internal::Type::BaseModel
|
|
819
|
+
OrHash =
|
|
820
|
+
T.type_alias do
|
|
821
|
+
T.any(Orb::Customer::DefaultPaymentMethod, Orb::Internal::AnyHash)
|
|
822
|
+
end
|
|
823
|
+
|
|
824
|
+
# The Orb-assigned unique identifier for the payment method.
|
|
825
|
+
sig { returns(String) }
|
|
826
|
+
attr_accessor :id
|
|
827
|
+
|
|
828
|
+
# The time at which the payment method was created.
|
|
829
|
+
sig { returns(Time) }
|
|
830
|
+
attr_accessor :created_at
|
|
831
|
+
|
|
832
|
+
# The ID of the Orb customer this payment method is attached to.
|
|
833
|
+
sig { returns(String) }
|
|
834
|
+
attr_accessor :customer_id
|
|
835
|
+
|
|
836
|
+
# Whether this is the customer's default payment method.
|
|
837
|
+
sig { returns(T::Boolean) }
|
|
838
|
+
attr_accessor :default
|
|
839
|
+
|
|
840
|
+
# The identifier of this payment method in the external payment provider.
|
|
841
|
+
sig { returns(String) }
|
|
842
|
+
attr_accessor :external_payment_method_id
|
|
843
|
+
|
|
844
|
+
# The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
|
|
845
|
+
sig do
|
|
846
|
+
returns(
|
|
847
|
+
Orb::Customer::DefaultPaymentMethod::PaymentMethodType::TaggedSymbol
|
|
848
|
+
)
|
|
849
|
+
end
|
|
850
|
+
attr_accessor :payment_method_type
|
|
851
|
+
|
|
852
|
+
# The external payment provider this method belongs to, derived from the linked
|
|
853
|
+
# payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection
|
|
854
|
+
# has been removed.
|
|
855
|
+
sig { returns(T.nilable(String)) }
|
|
856
|
+
attr_accessor :provider_type
|
|
857
|
+
|
|
858
|
+
# A payment method represents a customer's stored payment instrument held with an
|
|
859
|
+
# external payment provider (such as Adyen or Stripe).
|
|
860
|
+
#
|
|
861
|
+
# The serialization is intentionally minimal for now; provider-pulled details
|
|
862
|
+
# (e.g. card display metadata) will be added over time.
|
|
863
|
+
sig do
|
|
864
|
+
params(
|
|
865
|
+
id: String,
|
|
866
|
+
created_at: Time,
|
|
867
|
+
customer_id: String,
|
|
868
|
+
default: T::Boolean,
|
|
869
|
+
external_payment_method_id: String,
|
|
870
|
+
payment_method_type:
|
|
871
|
+
Orb::Customer::DefaultPaymentMethod::PaymentMethodType::OrSymbol,
|
|
872
|
+
provider_type: T.nilable(String)
|
|
873
|
+
).returns(T.attached_class)
|
|
874
|
+
end
|
|
875
|
+
def self.new(
|
|
876
|
+
# The Orb-assigned unique identifier for the payment method.
|
|
877
|
+
id:,
|
|
878
|
+
# The time at which the payment method was created.
|
|
879
|
+
created_at:,
|
|
880
|
+
# The ID of the Orb customer this payment method is attached to.
|
|
881
|
+
customer_id:,
|
|
882
|
+
# Whether this is the customer's default payment method.
|
|
883
|
+
default:,
|
|
884
|
+
# The identifier of this payment method in the external payment provider.
|
|
885
|
+
external_payment_method_id:,
|
|
886
|
+
# The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
|
|
887
|
+
payment_method_type:,
|
|
888
|
+
# The external payment provider this method belongs to, derived from the linked
|
|
889
|
+
# payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection
|
|
890
|
+
# has been removed.
|
|
891
|
+
provider_type:
|
|
892
|
+
)
|
|
893
|
+
end
|
|
894
|
+
|
|
895
|
+
sig do
|
|
896
|
+
override.returns(
|
|
897
|
+
{
|
|
898
|
+
id: String,
|
|
899
|
+
created_at: Time,
|
|
900
|
+
customer_id: String,
|
|
901
|
+
default: T::Boolean,
|
|
902
|
+
external_payment_method_id: String,
|
|
903
|
+
payment_method_type:
|
|
904
|
+
Orb::Customer::DefaultPaymentMethod::PaymentMethodType::TaggedSymbol,
|
|
905
|
+
provider_type: T.nilable(String)
|
|
906
|
+
}
|
|
907
|
+
)
|
|
908
|
+
end
|
|
909
|
+
def to_hash
|
|
910
|
+
end
|
|
911
|
+
|
|
912
|
+
# The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
|
|
913
|
+
module PaymentMethodType
|
|
914
|
+
extend Orb::Internal::Type::Enum
|
|
915
|
+
|
|
916
|
+
TaggedSymbol =
|
|
917
|
+
T.type_alias do
|
|
918
|
+
T.all(
|
|
919
|
+
Symbol,
|
|
920
|
+
Orb::Customer::DefaultPaymentMethod::PaymentMethodType
|
|
921
|
+
)
|
|
922
|
+
end
|
|
923
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
924
|
+
|
|
925
|
+
CARD =
|
|
926
|
+
T.let(
|
|
927
|
+
:card,
|
|
928
|
+
Orb::Customer::DefaultPaymentMethod::PaymentMethodType::TaggedSymbol
|
|
929
|
+
)
|
|
930
|
+
US_BANK_ACCOUNT =
|
|
931
|
+
T.let(
|
|
932
|
+
:us_bank_account,
|
|
933
|
+
Orb::Customer::DefaultPaymentMethod::PaymentMethodType::TaggedSymbol
|
|
934
|
+
)
|
|
935
|
+
LINK =
|
|
936
|
+
T.let(
|
|
937
|
+
:link,
|
|
938
|
+
Orb::Customer::DefaultPaymentMethod::PaymentMethodType::TaggedSymbol
|
|
939
|
+
)
|
|
940
|
+
AMAZON_PAY =
|
|
941
|
+
T.let(
|
|
942
|
+
:amazon_pay,
|
|
943
|
+
Orb::Customer::DefaultPaymentMethod::PaymentMethodType::TaggedSymbol
|
|
944
|
+
)
|
|
945
|
+
CRYPTO =
|
|
946
|
+
T.let(
|
|
947
|
+
:crypto,
|
|
948
|
+
Orb::Customer::DefaultPaymentMethod::PaymentMethodType::TaggedSymbol
|
|
949
|
+
)
|
|
950
|
+
|
|
951
|
+
sig do
|
|
952
|
+
override.returns(
|
|
953
|
+
T::Array[
|
|
954
|
+
Orb::Customer::DefaultPaymentMethod::PaymentMethodType::TaggedSymbol
|
|
955
|
+
]
|
|
956
|
+
)
|
|
957
|
+
end
|
|
958
|
+
def self.values
|
|
959
|
+
end
|
|
960
|
+
end
|
|
961
|
+
end
|
|
962
|
+
|
|
773
963
|
class PaymentConfiguration < Orb::Internal::Type::BaseModel
|
|
774
964
|
OrHash =
|
|
775
965
|
T.type_alias do
|
|
@@ -840,6 +1030,12 @@ module Orb
|
|
|
840
1030
|
end
|
|
841
1031
|
attr_accessor :provider_type
|
|
842
1032
|
|
|
1033
|
+
# The ID of a shared payment token granted by an agent to use as the default
|
|
1034
|
+
# payment instrument for this customer. When set, auto-collection will use this
|
|
1035
|
+
# token instead of the customer's default payment method.
|
|
1036
|
+
sig { returns(T.nilable(String)) }
|
|
1037
|
+
attr_accessor :default_shared_payment_token
|
|
1038
|
+
|
|
843
1039
|
# List of Stripe payment method types to exclude for this customer. Excluded
|
|
844
1040
|
# payment methods will not be available for the customer to select during payment,
|
|
845
1041
|
# and will not be used for auto-collection. If a customer's default payment method
|
|
@@ -855,12 +1051,17 @@ module Orb
|
|
|
855
1051
|
params(
|
|
856
1052
|
provider_type:
|
|
857
1053
|
Orb::Customer::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
|
|
1054
|
+
default_shared_payment_token: T.nilable(String),
|
|
858
1055
|
excluded_payment_method_types: T::Array[String]
|
|
859
1056
|
).returns(T.attached_class)
|
|
860
1057
|
end
|
|
861
1058
|
def self.new(
|
|
862
1059
|
# The payment provider to configure.
|
|
863
1060
|
provider_type:,
|
|
1061
|
+
# The ID of a shared payment token granted by an agent to use as the default
|
|
1062
|
+
# payment instrument for this customer. When set, auto-collection will use this
|
|
1063
|
+
# token instead of the customer's default payment method.
|
|
1064
|
+
default_shared_payment_token: nil,
|
|
864
1065
|
# List of Stripe payment method types to exclude for this customer. Excluded
|
|
865
1066
|
# payment methods will not be available for the customer to select during payment,
|
|
866
1067
|
# and will not be used for auto-collection. If a customer's default payment method
|
|
@@ -875,6 +1076,7 @@ module Orb
|
|
|
875
1076
|
{
|
|
876
1077
|
provider_type:
|
|
877
1078
|
Orb::Customer::PaymentConfiguration::PaymentProvider::ProviderType::TaggedSymbol,
|
|
1079
|
+
default_shared_payment_token: T.nilable(String),
|
|
878
1080
|
excluded_payment_method_types: T::Array[String]
|
|
879
1081
|
}
|
|
880
1082
|
)
|
|
@@ -206,11 +206,13 @@ module Orb
|
|
|
206
206
|
# | Estonia | `eu_vat` | European VAT Number |
|
|
207
207
|
# | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
|
|
208
208
|
# | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
209
|
+
# | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
|
|
209
210
|
# | Finland | `eu_vat` | European VAT Number |
|
|
210
211
|
# | France | `eu_vat` | European VAT Number |
|
|
211
212
|
# | Georgia | `ge_vat` | Georgian VAT |
|
|
212
213
|
# | Germany | `de_stn` | German Tax Number (Steuernummer) |
|
|
213
214
|
# | Germany | `eu_vat` | European VAT Number |
|
|
215
|
+
# | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
|
|
214
216
|
# | Greece | `eu_vat` | European VAT Number |
|
|
215
217
|
# | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
|
|
216
218
|
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
@@ -222,6 +224,7 @@ module Orb
|
|
|
222
224
|
# | Ireland | `eu_vat` | European VAT Number |
|
|
223
225
|
# | Israel | `il_vat` | Israel VAT |
|
|
224
226
|
# | Italy | `eu_vat` | European VAT Number |
|
|
227
|
+
# | Italy | `it_cf` | Italian Codice Fiscale Number |
|
|
225
228
|
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
226
229
|
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
227
230
|
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
@@ -252,6 +255,7 @@ module Orb
|
|
|
252
255
|
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
253
256
|
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
254
257
|
# | Oman | `om_vat` | Omani VAT Number |
|
|
258
|
+
# | Paraguay | `py_ruc` | Paraguayan RUC Number |
|
|
255
259
|
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
256
260
|
# | Philippines | `ph_tin` | Philippines Tax Identification Number |
|
|
257
261
|
# | Poland | `eu_vat` | European VAT Number |
|
|
@@ -273,6 +277,7 @@ module Orb
|
|
|
273
277
|
# | South Korea | `kr_brn` | Korean BRN |
|
|
274
278
|
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
275
279
|
# | Spain | `eu_vat` | European VAT Number |
|
|
280
|
+
# | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
|
|
276
281
|
# | Suriname | `sr_fin` | Suriname FIN Number |
|
|
277
282
|
# | Sweden | `eu_vat` | European VAT Number |
|
|
278
283
|
# | Switzerland | `ch_uid` | Switzerland UID Number |
|
|
@@ -451,11 +456,13 @@ module Orb
|
|
|
451
456
|
# | Estonia | `eu_vat` | European VAT Number |
|
|
452
457
|
# | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
|
|
453
458
|
# | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
459
|
+
# | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
|
|
454
460
|
# | Finland | `eu_vat` | European VAT Number |
|
|
455
461
|
# | France | `eu_vat` | European VAT Number |
|
|
456
462
|
# | Georgia | `ge_vat` | Georgian VAT |
|
|
457
463
|
# | Germany | `de_stn` | German Tax Number (Steuernummer) |
|
|
458
464
|
# | Germany | `eu_vat` | European VAT Number |
|
|
465
|
+
# | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
|
|
459
466
|
# | Greece | `eu_vat` | European VAT Number |
|
|
460
467
|
# | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
|
|
461
468
|
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
@@ -467,6 +474,7 @@ module Orb
|
|
|
467
474
|
# | Ireland | `eu_vat` | European VAT Number |
|
|
468
475
|
# | Israel | `il_vat` | Israel VAT |
|
|
469
476
|
# | Italy | `eu_vat` | European VAT Number |
|
|
477
|
+
# | Italy | `it_cf` | Italian Codice Fiscale Number |
|
|
470
478
|
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
471
479
|
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
472
480
|
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
@@ -497,6 +505,7 @@ module Orb
|
|
|
497
505
|
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
498
506
|
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
499
507
|
# | Oman | `om_vat` | Omani VAT Number |
|
|
508
|
+
# | Paraguay | `py_ruc` | Paraguayan RUC Number |
|
|
500
509
|
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
501
510
|
# | Philippines | `ph_tin` | Philippines Tax Identification Number |
|
|
502
511
|
# | Poland | `eu_vat` | European VAT Number |
|
|
@@ -518,6 +527,7 @@ module Orb
|
|
|
518
527
|
# | South Korea | `kr_brn` | Korean BRN |
|
|
519
528
|
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
520
529
|
# | Spain | `eu_vat` | European VAT Number |
|
|
530
|
+
# | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
|
|
521
531
|
# | Suriname | `sr_fin` | Suriname FIN Number |
|
|
522
532
|
# | Sweden | `eu_vat` | European VAT Number |
|
|
523
533
|
# | Switzerland | `ch_uid` | Switzerland UID Number |
|
|
@@ -668,6 +678,12 @@ module Orb
|
|
|
668
678
|
end
|
|
669
679
|
attr_accessor :provider_type
|
|
670
680
|
|
|
681
|
+
# The ID of a shared payment token granted by an agent to use as the default
|
|
682
|
+
# payment instrument for this customer. When set, auto-collection will use this
|
|
683
|
+
# token instead of the customer's default payment method.
|
|
684
|
+
sig { returns(T.nilable(String)) }
|
|
685
|
+
attr_accessor :default_shared_payment_token
|
|
686
|
+
|
|
671
687
|
# List of Stripe payment method types to exclude for this customer. Excluded
|
|
672
688
|
# payment methods will not be available for the customer to select during payment,
|
|
673
689
|
# and will not be used for auto-collection. If a customer's default payment method
|
|
@@ -683,12 +699,17 @@ module Orb
|
|
|
683
699
|
params(
|
|
684
700
|
provider_type:
|
|
685
701
|
Orb::CustomerCreateParams::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
|
|
702
|
+
default_shared_payment_token: T.nilable(String),
|
|
686
703
|
excluded_payment_method_types: T::Array[String]
|
|
687
704
|
).returns(T.attached_class)
|
|
688
705
|
end
|
|
689
706
|
def self.new(
|
|
690
707
|
# The payment provider to configure.
|
|
691
708
|
provider_type:,
|
|
709
|
+
# The ID of a shared payment token granted by an agent to use as the default
|
|
710
|
+
# payment instrument for this customer. When set, auto-collection will use this
|
|
711
|
+
# token instead of the customer's default payment method.
|
|
712
|
+
default_shared_payment_token: nil,
|
|
692
713
|
# List of Stripe payment method types to exclude for this customer. Excluded
|
|
693
714
|
# payment methods will not be available for the customer to select during payment,
|
|
694
715
|
# and will not be used for auto-collection. If a customer's default payment method
|
|
@@ -703,6 +724,7 @@ module Orb
|
|
|
703
724
|
{
|
|
704
725
|
provider_type:
|
|
705
726
|
Orb::CustomerCreateParams::PaymentConfiguration::PaymentProvider::ProviderType::OrSymbol,
|
|
727
|
+
default_shared_payment_token: T.nilable(String),
|
|
706
728
|
excluded_payment_method_types: T::Array[String]
|
|
707
729
|
}
|
|
708
730
|
)
|
|
@@ -779,6 +801,11 @@ module Orb
|
|
|
779
801
|
:netsuite,
|
|
780
802
|
Orb::CustomerCreateParams::PaymentProvider::TaggedSymbol
|
|
781
803
|
)
|
|
804
|
+
ADYEN =
|
|
805
|
+
T.let(
|
|
806
|
+
:adyen,
|
|
807
|
+
Orb::CustomerCreateParams::PaymentProvider::TaggedSymbol
|
|
808
|
+
)
|
|
782
809
|
|
|
783
810
|
sig do
|
|
784
811
|
override.returns(
|
|
@@ -11,15 +11,23 @@ module Orb
|
|
|
11
11
|
T.any(Orb::CustomerDeleteParams, Orb::Internal::AnyHash)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
+
sig { returns(String) }
|
|
15
|
+
attr_accessor :customer_id
|
|
16
|
+
|
|
14
17
|
sig do
|
|
15
|
-
params(
|
|
16
|
-
|
|
17
|
-
|
|
18
|
+
params(
|
|
19
|
+
customer_id: String,
|
|
20
|
+
request_options: Orb::RequestOptions::OrHash
|
|
21
|
+
).returns(T.attached_class)
|
|
18
22
|
end
|
|
19
|
-
def self.new(request_options: {})
|
|
23
|
+
def self.new(customer_id:, request_options: {})
|
|
20
24
|
end
|
|
21
25
|
|
|
22
|
-
sig
|
|
26
|
+
sig do
|
|
27
|
+
override.returns(
|
|
28
|
+
{ customer_id: String, request_options: Orb::RequestOptions }
|
|
29
|
+
)
|
|
30
|
+
end
|
|
23
31
|
def to_hash
|
|
24
32
|
end
|
|
25
33
|
end
|
|
@@ -11,15 +11,23 @@ module Orb
|
|
|
11
11
|
T.any(Orb::CustomerFetchByExternalIDParams, Orb::Internal::AnyHash)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
+
sig { returns(String) }
|
|
15
|
+
attr_accessor :external_customer_id
|
|
16
|
+
|
|
14
17
|
sig do
|
|
15
|
-
params(
|
|
16
|
-
|
|
17
|
-
|
|
18
|
+
params(
|
|
19
|
+
external_customer_id: String,
|
|
20
|
+
request_options: Orb::RequestOptions::OrHash
|
|
21
|
+
).returns(T.attached_class)
|
|
18
22
|
end
|
|
19
|
-
def self.new(request_options: {})
|
|
23
|
+
def self.new(external_customer_id:, request_options: {})
|
|
20
24
|
end
|
|
21
25
|
|
|
22
|
-
sig
|
|
26
|
+
sig do
|
|
27
|
+
override.returns(
|
|
28
|
+
{ external_customer_id: String, request_options: Orb::RequestOptions }
|
|
29
|
+
)
|
|
30
|
+
end
|
|
23
31
|
def to_hash
|
|
24
32
|
end
|
|
25
33
|
end
|
|
@@ -9,15 +9,23 @@ module Orb
|
|
|
9
9
|
OrHash =
|
|
10
10
|
T.type_alias { T.any(Orb::CustomerFetchParams, Orb::Internal::AnyHash) }
|
|
11
11
|
|
|
12
|
+
sig { returns(String) }
|
|
13
|
+
attr_accessor :customer_id
|
|
14
|
+
|
|
12
15
|
sig do
|
|
13
|
-
params(
|
|
14
|
-
|
|
15
|
-
|
|
16
|
+
params(
|
|
17
|
+
customer_id: String,
|
|
18
|
+
request_options: Orb::RequestOptions::OrHash
|
|
19
|
+
).returns(T.attached_class)
|
|
16
20
|
end
|
|
17
|
-
def self.new(request_options: {})
|
|
21
|
+
def self.new(customer_id:, request_options: {})
|
|
18
22
|
end
|
|
19
23
|
|
|
20
|
-
sig
|
|
24
|
+
sig do
|
|
25
|
+
override.returns(
|
|
26
|
+
{ customer_id: String, request_options: Orb::RequestOptions }
|
|
27
|
+
)
|
|
28
|
+
end
|
|
21
29
|
def to_hash
|
|
22
30
|
end
|
|
23
31
|
end
|
data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi
CHANGED
|
@@ -14,15 +14,23 @@ module Orb
|
|
|
14
14
|
)
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
+
sig { returns(String) }
|
|
18
|
+
attr_accessor :external_customer_id
|
|
19
|
+
|
|
17
20
|
sig do
|
|
18
|
-
params(
|
|
19
|
-
|
|
20
|
-
|
|
21
|
+
params(
|
|
22
|
+
external_customer_id: String,
|
|
23
|
+
request_options: Orb::RequestOptions::OrHash
|
|
24
|
+
).returns(T.attached_class)
|
|
21
25
|
end
|
|
22
|
-
def self.new(request_options: {})
|
|
26
|
+
def self.new(external_customer_id:, request_options: {})
|
|
23
27
|
end
|
|
24
28
|
|
|
25
|
-
sig
|
|
29
|
+
sig do
|
|
30
|
+
override.returns(
|
|
31
|
+
{ external_customer_id: String, request_options: Orb::RequestOptions }
|
|
32
|
+
)
|
|
33
|
+
end
|
|
26
34
|
def to_hash
|
|
27
35
|
end
|
|
28
36
|
end
|
|
@@ -14,15 +14,23 @@ module Orb
|
|
|
14
14
|
)
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
+
sig { returns(String) }
|
|
18
|
+
attr_accessor :customer_id
|
|
19
|
+
|
|
17
20
|
sig do
|
|
18
|
-
params(
|
|
19
|
-
|
|
20
|
-
|
|
21
|
+
params(
|
|
22
|
+
customer_id: String,
|
|
23
|
+
request_options: Orb::RequestOptions::OrHash
|
|
24
|
+
).returns(T.attached_class)
|
|
21
25
|
end
|
|
22
|
-
def self.new(request_options: {})
|
|
26
|
+
def self.new(customer_id:, request_options: {})
|
|
23
27
|
end
|
|
24
28
|
|
|
25
|
-
sig
|
|
29
|
+
sig do
|
|
30
|
+
override.returns(
|
|
31
|
+
{ customer_id: String, request_options: Orb::RequestOptions }
|
|
32
|
+
)
|
|
33
|
+
end
|
|
26
34
|
def to_hash
|
|
27
35
|
end
|
|
28
36
|
end
|