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
|
@@ -76,11 +76,13 @@ module Orb
|
|
|
76
76
|
# | Estonia | `eu_vat` | European VAT Number |
|
|
77
77
|
# | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
|
|
78
78
|
# | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
79
|
+
# | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
|
|
79
80
|
# | Finland | `eu_vat` | European VAT Number |
|
|
80
81
|
# | France | `eu_vat` | European VAT Number |
|
|
81
82
|
# | Georgia | `ge_vat` | Georgian VAT |
|
|
82
83
|
# | Germany | `de_stn` | German Tax Number (Steuernummer) |
|
|
83
84
|
# | Germany | `eu_vat` | European VAT Number |
|
|
85
|
+
# | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
|
|
84
86
|
# | Greece | `eu_vat` | European VAT Number |
|
|
85
87
|
# | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
|
|
86
88
|
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
@@ -92,6 +94,7 @@ module Orb
|
|
|
92
94
|
# | Ireland | `eu_vat` | European VAT Number |
|
|
93
95
|
# | Israel | `il_vat` | Israel VAT |
|
|
94
96
|
# | Italy | `eu_vat` | European VAT Number |
|
|
97
|
+
# | Italy | `it_cf` | Italian Codice Fiscale Number |
|
|
95
98
|
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
96
99
|
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
97
100
|
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
@@ -122,6 +125,7 @@ module Orb
|
|
|
122
125
|
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
123
126
|
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
124
127
|
# | Oman | `om_vat` | Omani VAT Number |
|
|
128
|
+
# | Paraguay | `py_ruc` | Paraguayan RUC Number |
|
|
125
129
|
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
126
130
|
# | Philippines | `ph_tin` | Philippines Tax Identification Number |
|
|
127
131
|
# | Poland | `eu_vat` | European VAT Number |
|
|
@@ -143,6 +147,7 @@ module Orb
|
|
|
143
147
|
# | South Korea | `kr_brn` | Korean BRN |
|
|
144
148
|
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
145
149
|
# | Spain | `eu_vat` | European VAT Number |
|
|
150
|
+
# | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
|
|
146
151
|
# | Suriname | `sr_fin` | Suriname FIN Number |
|
|
147
152
|
# | Sweden | `eu_vat` | European VAT Number |
|
|
148
153
|
# | Switzerland | `ch_uid` | Switzerland UID Number |
|
|
@@ -204,9 +209,9 @@ module Orb
|
|
|
204
209
|
CO = :CO
|
|
205
210
|
CR = :CR
|
|
206
211
|
CV = :CV
|
|
207
|
-
DE = :DE
|
|
208
212
|
CY = :CY
|
|
209
213
|
CZ = :CZ
|
|
214
|
+
DE = :DE
|
|
210
215
|
DK = :DK
|
|
211
216
|
DO = :DO
|
|
212
217
|
EC = :EC
|
|
@@ -216,9 +221,11 @@ module Orb
|
|
|
216
221
|
ET = :ET
|
|
217
222
|
EU = :EU
|
|
218
223
|
FI = :FI
|
|
224
|
+
FO = :FO
|
|
219
225
|
FR = :FR
|
|
220
226
|
GB = :GB
|
|
221
227
|
GE = :GE
|
|
228
|
+
GI = :GI
|
|
222
229
|
GN = :GN
|
|
223
230
|
GR = :GR
|
|
224
231
|
HK = :HK
|
|
@@ -238,6 +245,7 @@ module Orb
|
|
|
238
245
|
KZ = :KZ
|
|
239
246
|
LA = :LA
|
|
240
247
|
LI = :LI
|
|
248
|
+
LK = :LK
|
|
241
249
|
LT = :LT
|
|
242
250
|
LU = :LU
|
|
243
251
|
LV = :LV
|
|
@@ -259,6 +267,7 @@ module Orb
|
|
|
259
267
|
PH = :PH
|
|
260
268
|
PL = :PL
|
|
261
269
|
PT = :PT
|
|
270
|
+
PY = :PY
|
|
262
271
|
RO = :RO
|
|
263
272
|
RS = :RS
|
|
264
273
|
RU = :RU
|
|
@@ -339,8 +348,10 @@ module Orb
|
|
|
339
348
|
ES_CIF = :es_cif
|
|
340
349
|
ET_TIN = :et_tin
|
|
341
350
|
EU_OSS_VAT = :eu_oss_vat
|
|
351
|
+
FO_VAT = :fo_vat
|
|
342
352
|
GB_VAT = :gb_vat
|
|
343
353
|
GE_VAT = :ge_vat
|
|
354
|
+
GI_TIN = :gi_tin
|
|
344
355
|
GN_NIF = :gn_nif
|
|
345
356
|
HK_BR = :hk_br
|
|
346
357
|
HR_OIB = :hr_oib
|
|
@@ -349,6 +360,7 @@ module Orb
|
|
|
349
360
|
IL_VAT = :il_vat
|
|
350
361
|
IN_GST = :in_gst
|
|
351
362
|
IS_VAT = :is_vat
|
|
363
|
+
IT_CF = :it_cf
|
|
352
364
|
JP_CN = :jp_cn
|
|
353
365
|
JP_RN = :jp_rn
|
|
354
366
|
JP_TRN = :jp_trn
|
|
@@ -360,6 +372,7 @@ module Orb
|
|
|
360
372
|
LA_TIN = :la_tin
|
|
361
373
|
LI_UID = :li_uid
|
|
362
374
|
LI_VAT = :li_vat
|
|
375
|
+
LK_VAT = :lk_vat
|
|
363
376
|
MA_VAT = :ma_vat
|
|
364
377
|
MD_VAT = :md_vat
|
|
365
378
|
ME_PIB = :me_pib
|
|
@@ -378,6 +391,7 @@ module Orb
|
|
|
378
391
|
PE_RUC = :pe_ruc
|
|
379
392
|
PH_TIN = :ph_tin
|
|
380
393
|
PL_NIP = :pl_nip
|
|
394
|
+
PY_RUC = :py_ruc
|
|
381
395
|
RO_TIN = :ro_tin
|
|
382
396
|
RS_PIB = :rs_pib
|
|
383
397
|
RU_INN = :ru_inn
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute accounting_sync_configuration
|
|
11
16
|
#
|
|
12
17
|
# @return [Orb::Models::NewAccountingSyncConfiguration, nil]
|
|
@@ -43,12 +48,21 @@ module Orb
|
|
|
43
48
|
optional :billing_address, -> { Orb::AddressInput }, nil?: true
|
|
44
49
|
|
|
45
50
|
# @!attribute currency
|
|
46
|
-
# An ISO 4217 currency string used for the customer's invoices and balance.
|
|
47
|
-
# set
|
|
51
|
+
# An ISO 4217 currency string used for the customer's invoices and balance. This
|
|
52
|
+
# can only be set if the customer does not already have a currency configured. If
|
|
53
|
+
# not set at creation or update time, it will be set at subscription creation
|
|
54
|
+
# time.
|
|
48
55
|
#
|
|
49
56
|
# @return [String, nil]
|
|
50
57
|
optional :currency, String, nil?: true
|
|
51
58
|
|
|
59
|
+
# @!attribute default_payment_method_id
|
|
60
|
+
# The Orb ID of the payment method to set as this customer's default. Pass `null`
|
|
61
|
+
# to clear the customer's default payment method.
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :default_payment_method_id, String, nil?: true
|
|
65
|
+
|
|
52
66
|
# @!attribute email
|
|
53
67
|
# A valid customer email, to be used for invoicing and notifications.
|
|
54
68
|
#
|
|
@@ -195,11 +209,13 @@ module Orb
|
|
|
195
209
|
# | Estonia | `eu_vat` | European VAT Number |
|
|
196
210
|
# | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
|
|
197
211
|
# | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
212
|
+
# | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
|
|
198
213
|
# | Finland | `eu_vat` | European VAT Number |
|
|
199
214
|
# | France | `eu_vat` | European VAT Number |
|
|
200
215
|
# | Georgia | `ge_vat` | Georgian VAT |
|
|
201
216
|
# | Germany | `de_stn` | German Tax Number (Steuernummer) |
|
|
202
217
|
# | Germany | `eu_vat` | European VAT Number |
|
|
218
|
+
# | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
|
|
203
219
|
# | Greece | `eu_vat` | European VAT Number |
|
|
204
220
|
# | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
|
|
205
221
|
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
@@ -211,6 +227,7 @@ module Orb
|
|
|
211
227
|
# | Ireland | `eu_vat` | European VAT Number |
|
|
212
228
|
# | Israel | `il_vat` | Israel VAT |
|
|
213
229
|
# | Italy | `eu_vat` | European VAT Number |
|
|
230
|
+
# | Italy | `it_cf` | Italian Codice Fiscale Number |
|
|
214
231
|
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
215
232
|
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
216
233
|
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
@@ -241,6 +258,7 @@ module Orb
|
|
|
241
258
|
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
242
259
|
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
243
260
|
# | Oman | `om_vat` | Omani VAT Number |
|
|
261
|
+
# | Paraguay | `py_ruc` | Paraguayan RUC Number |
|
|
244
262
|
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
245
263
|
# | Philippines | `ph_tin` | Philippines Tax Identification Number |
|
|
246
264
|
# | Poland | `eu_vat` | European VAT Number |
|
|
@@ -262,6 +280,7 @@ module Orb
|
|
|
262
280
|
# | South Korea | `kr_brn` | Korean BRN |
|
|
263
281
|
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
264
282
|
# | Spain | `eu_vat` | European VAT Number |
|
|
283
|
+
# | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
|
|
265
284
|
# | Suriname | `sr_fin` | Suriname FIN Number |
|
|
266
285
|
# | Sweden | `eu_vat` | European VAT Number |
|
|
267
286
|
# | Switzerland | `ch_uid` | Switzerland UID Number |
|
|
@@ -287,10 +306,12 @@ module Orb
|
|
|
287
306
|
# @return [Orb::Models::CustomerTaxID, nil]
|
|
288
307
|
optional :tax_id, -> { Orb::CustomerTaxID }, nil?: true
|
|
289
308
|
|
|
290
|
-
# @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
|
309
|
+
# @!method initialize(id:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, default_payment_method_id: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
|
291
310
|
# Some parameter documentations has been truncated, see
|
|
292
311
|
# {Orb::Models::CustomerUpdateByExternalIDParams} for more details.
|
|
293
312
|
#
|
|
313
|
+
# @param id [String]
|
|
314
|
+
#
|
|
294
315
|
# @param accounting_sync_configuration [Orb::Models::NewAccountingSyncConfiguration, nil]
|
|
295
316
|
#
|
|
296
317
|
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
|
@@ -301,7 +322,9 @@ module Orb
|
|
|
301
322
|
#
|
|
302
323
|
# @param billing_address [Orb::Models::AddressInput, nil]
|
|
303
324
|
#
|
|
304
|
-
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance.
|
|
325
|
+
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. This c
|
|
326
|
+
#
|
|
327
|
+
# @param default_payment_method_id [String, nil] The Orb ID of the payment method to set as this customer's default. Pass `null`
|
|
305
328
|
#
|
|
306
329
|
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
|
307
330
|
#
|
|
@@ -353,6 +376,14 @@ module Orb
|
|
|
353
376
|
required :provider_type,
|
|
354
377
|
enum: -> { Orb::CustomerUpdateByExternalIDParams::PaymentConfiguration::PaymentProvider::ProviderType }
|
|
355
378
|
|
|
379
|
+
# @!attribute default_shared_payment_token
|
|
380
|
+
# The ID of a shared payment token granted by an agent to use as the default
|
|
381
|
+
# payment instrument for this customer. When set, auto-collection will use this
|
|
382
|
+
# token instead of the customer's default payment method.
|
|
383
|
+
#
|
|
384
|
+
# @return [String, nil]
|
|
385
|
+
optional :default_shared_payment_token, String, nil?: true
|
|
386
|
+
|
|
356
387
|
# @!attribute excluded_payment_method_types
|
|
357
388
|
# List of Stripe payment method types to exclude for this customer. Excluded
|
|
358
389
|
# payment methods will not be available for the customer to select during payment,
|
|
@@ -363,13 +394,15 @@ module Orb
|
|
|
363
394
|
# @return [Array<String>, nil]
|
|
364
395
|
optional :excluded_payment_method_types, Orb::Internal::Type::ArrayOf[String]
|
|
365
396
|
|
|
366
|
-
# @!method initialize(provider_type:, excluded_payment_method_types: nil)
|
|
397
|
+
# @!method initialize(provider_type:, default_shared_payment_token: nil, excluded_payment_method_types: nil)
|
|
367
398
|
# Some parameter documentations has been truncated, see
|
|
368
399
|
# {Orb::Models::CustomerUpdateByExternalIDParams::PaymentConfiguration::PaymentProvider}
|
|
369
400
|
# for more details.
|
|
370
401
|
#
|
|
371
402
|
# @param provider_type [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentConfiguration::PaymentProvider::ProviderType] The payment provider to configure.
|
|
372
403
|
#
|
|
404
|
+
# @param default_shared_payment_token [String, nil] The ID of a shared payment token granted by an agent to use as the default payme
|
|
405
|
+
#
|
|
373
406
|
# @param excluded_payment_method_types [Array<String>] List of Stripe payment method types to exclude for this customer. Excluded payme
|
|
374
407
|
|
|
375
408
|
# The payment provider to configure.
|
|
@@ -401,6 +434,7 @@ module Orb
|
|
|
401
434
|
STRIPE_CHARGE = :stripe_charge
|
|
402
435
|
STRIPE_INVOICE = :stripe_invoice
|
|
403
436
|
NETSUITE = :netsuite
|
|
437
|
+
ADYEN = :adyen
|
|
404
438
|
|
|
405
439
|
# @!method self.values
|
|
406
440
|
# @return [Array<Symbol>]
|
|
@@ -7,6 +7,11 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute customer_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :customer_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute accounting_sync_configuration
|
|
11
16
|
#
|
|
12
17
|
# @return [Orb::Models::NewAccountingSyncConfiguration, nil]
|
|
@@ -43,12 +48,21 @@ module Orb
|
|
|
43
48
|
optional :billing_address, -> { Orb::AddressInput }, nil?: true
|
|
44
49
|
|
|
45
50
|
# @!attribute currency
|
|
46
|
-
# An ISO 4217 currency string used for the customer's invoices and balance.
|
|
47
|
-
# set
|
|
51
|
+
# An ISO 4217 currency string used for the customer's invoices and balance. This
|
|
52
|
+
# can only be set if the customer does not already have a currency configured. If
|
|
53
|
+
# not set at creation or update time, it will be set at subscription creation
|
|
54
|
+
# time.
|
|
48
55
|
#
|
|
49
56
|
# @return [String, nil]
|
|
50
57
|
optional :currency, String, nil?: true
|
|
51
58
|
|
|
59
|
+
# @!attribute default_payment_method_id
|
|
60
|
+
# The Orb ID of the payment method to set as this customer's default. Pass `null`
|
|
61
|
+
# to clear the customer's default payment method.
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :default_payment_method_id, String, nil?: true
|
|
65
|
+
|
|
52
66
|
# @!attribute email
|
|
53
67
|
# A valid customer email, to be used for invoicing and notifications.
|
|
54
68
|
#
|
|
@@ -189,11 +203,13 @@ module Orb
|
|
|
189
203
|
# | Estonia | `eu_vat` | European VAT Number |
|
|
190
204
|
# | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
|
|
191
205
|
# | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
206
|
+
# | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
|
|
192
207
|
# | Finland | `eu_vat` | European VAT Number |
|
|
193
208
|
# | France | `eu_vat` | European VAT Number |
|
|
194
209
|
# | Georgia | `ge_vat` | Georgian VAT |
|
|
195
210
|
# | Germany | `de_stn` | German Tax Number (Steuernummer) |
|
|
196
211
|
# | Germany | `eu_vat` | European VAT Number |
|
|
212
|
+
# | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
|
|
197
213
|
# | Greece | `eu_vat` | European VAT Number |
|
|
198
214
|
# | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
|
|
199
215
|
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
@@ -205,6 +221,7 @@ module Orb
|
|
|
205
221
|
# | Ireland | `eu_vat` | European VAT Number |
|
|
206
222
|
# | Israel | `il_vat` | Israel VAT |
|
|
207
223
|
# | Italy | `eu_vat` | European VAT Number |
|
|
224
|
+
# | Italy | `it_cf` | Italian Codice Fiscale Number |
|
|
208
225
|
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
209
226
|
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
210
227
|
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
@@ -235,6 +252,7 @@ module Orb
|
|
|
235
252
|
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
236
253
|
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
237
254
|
# | Oman | `om_vat` | Omani VAT Number |
|
|
255
|
+
# | Paraguay | `py_ruc` | Paraguayan RUC Number |
|
|
238
256
|
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
239
257
|
# | Philippines | `ph_tin` | Philippines Tax Identification Number |
|
|
240
258
|
# | Poland | `eu_vat` | European VAT Number |
|
|
@@ -256,6 +274,7 @@ module Orb
|
|
|
256
274
|
# | South Korea | `kr_brn` | Korean BRN |
|
|
257
275
|
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
258
276
|
# | Spain | `eu_vat` | European VAT Number |
|
|
277
|
+
# | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
|
|
259
278
|
# | Suriname | `sr_fin` | Suriname FIN Number |
|
|
260
279
|
# | Sweden | `eu_vat` | European VAT Number |
|
|
261
280
|
# | Switzerland | `ch_uid` | Switzerland UID Number |
|
|
@@ -281,10 +300,12 @@ module Orb
|
|
|
281
300
|
# @return [Orb::Models::CustomerTaxID, nil]
|
|
282
301
|
optional :tax_id, -> { Orb::CustomerTaxID }, nil?: true
|
|
283
302
|
|
|
284
|
-
# @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
|
303
|
+
# @!method initialize(customer_id:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, default_payment_method_id: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
|
285
304
|
# Some parameter documentations has been truncated, see
|
|
286
305
|
# {Orb::Models::CustomerUpdateParams} for more details.
|
|
287
306
|
#
|
|
307
|
+
# @param customer_id [String]
|
|
308
|
+
#
|
|
288
309
|
# @param accounting_sync_configuration [Orb::Models::NewAccountingSyncConfiguration, nil]
|
|
289
310
|
#
|
|
290
311
|
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
|
@@ -295,7 +316,9 @@ module Orb
|
|
|
295
316
|
#
|
|
296
317
|
# @param billing_address [Orb::Models::AddressInput, nil]
|
|
297
318
|
#
|
|
298
|
-
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance.
|
|
319
|
+
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. This c
|
|
320
|
+
#
|
|
321
|
+
# @param default_payment_method_id [String, nil] The Orb ID of the payment method to set as this customer's default. Pass `null`
|
|
299
322
|
#
|
|
300
323
|
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
|
301
324
|
#
|
|
@@ -347,6 +370,14 @@ module Orb
|
|
|
347
370
|
required :provider_type,
|
|
348
371
|
enum: -> { Orb::CustomerUpdateParams::PaymentConfiguration::PaymentProvider::ProviderType }
|
|
349
372
|
|
|
373
|
+
# @!attribute default_shared_payment_token
|
|
374
|
+
# The ID of a shared payment token granted by an agent to use as the default
|
|
375
|
+
# payment instrument for this customer. When set, auto-collection will use this
|
|
376
|
+
# token instead of the customer's default payment method.
|
|
377
|
+
#
|
|
378
|
+
# @return [String, nil]
|
|
379
|
+
optional :default_shared_payment_token, String, nil?: true
|
|
380
|
+
|
|
350
381
|
# @!attribute excluded_payment_method_types
|
|
351
382
|
# List of Stripe payment method types to exclude for this customer. Excluded
|
|
352
383
|
# payment methods will not be available for the customer to select during payment,
|
|
@@ -357,13 +388,15 @@ module Orb
|
|
|
357
388
|
# @return [Array<String>, nil]
|
|
358
389
|
optional :excluded_payment_method_types, Orb::Internal::Type::ArrayOf[String]
|
|
359
390
|
|
|
360
|
-
# @!method initialize(provider_type:, excluded_payment_method_types: nil)
|
|
391
|
+
# @!method initialize(provider_type:, default_shared_payment_token: nil, excluded_payment_method_types: nil)
|
|
361
392
|
# Some parameter documentations has been truncated, see
|
|
362
393
|
# {Orb::Models::CustomerUpdateParams::PaymentConfiguration::PaymentProvider} for
|
|
363
394
|
# more details.
|
|
364
395
|
#
|
|
365
396
|
# @param provider_type [Symbol, Orb::Models::CustomerUpdateParams::PaymentConfiguration::PaymentProvider::ProviderType] The payment provider to configure.
|
|
366
397
|
#
|
|
398
|
+
# @param default_shared_payment_token [String, nil] The ID of a shared payment token granted by an agent to use as the default payme
|
|
399
|
+
#
|
|
367
400
|
# @param excluded_payment_method_types [Array<String>] List of Stripe payment method types to exclude for this customer. Excluded payme
|
|
368
401
|
|
|
369
402
|
# The payment provider to configure.
|
|
@@ -395,6 +428,7 @@ module Orb
|
|
|
395
428
|
STRIPE_CHARGE = :stripe_charge
|
|
396
429
|
STRIPE_INVOICE = :stripe_invoice
|
|
397
430
|
NETSUITE = :netsuite
|
|
431
|
+
ADYEN = :adyen
|
|
398
432
|
|
|
399
433
|
# @!method self.values
|
|
400
434
|
# @return [Array<Symbol>]
|
|
@@ -8,6 +8,11 @@ module Orb
|
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute customer_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :customer_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute amount
|
|
12
17
|
#
|
|
13
18
|
# @return [String]
|
|
@@ -24,7 +29,9 @@ module Orb
|
|
|
24
29
|
# @return [String, nil]
|
|
25
30
|
optional :description, String, nil?: true
|
|
26
31
|
|
|
27
|
-
# @!method initialize(amount:, type:, description: nil, request_options: {})
|
|
32
|
+
# @!method initialize(customer_id:, amount:, type:, description: nil, request_options: {})
|
|
33
|
+
# @param customer_id [String]
|
|
34
|
+
#
|
|
28
35
|
# @param amount [String]
|
|
29
36
|
#
|
|
30
37
|
# @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
|
|
@@ -8,6 +8,11 @@ module Orb
|
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute customer_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :customer_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute cursor
|
|
12
17
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
13
18
|
# from the initial request.
|
|
@@ -41,10 +46,12 @@ module Orb
|
|
|
41
46
|
# @return [Time, nil]
|
|
42
47
|
optional :operation_time_lte, Time, nil?: true
|
|
43
48
|
|
|
44
|
-
# @!method initialize(cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {})
|
|
49
|
+
# @!method initialize(customer_id:, cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {})
|
|
45
50
|
# Some parameter documentations has been truncated, see
|
|
46
51
|
# {Orb::Models::Customers::BalanceTransactionListParams} for more details.
|
|
47
52
|
#
|
|
53
|
+
# @param customer_id [String]
|
|
54
|
+
#
|
|
48
55
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
49
56
|
#
|
|
50
57
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
|
@@ -8,6 +8,11 @@ module Orb
|
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute external_customer_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :external_customer_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute currency
|
|
12
17
|
# The currency or custom pricing unit to use.
|
|
13
18
|
#
|
|
@@ -35,10 +40,12 @@ module Orb
|
|
|
35
40
|
# @return [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
|
|
36
41
|
optional :view_mode, enum: -> { Orb::Customers::CostListByExternalIDParams::ViewMode }, nil?: true
|
|
37
42
|
|
|
38
|
-
# @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
|
|
43
|
+
# @!method initialize(external_customer_id:, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
|
|
39
44
|
# Some parameter documentations has been truncated, see
|
|
40
45
|
# {Orb::Models::Customers::CostListByExternalIDParams} for more details.
|
|
41
46
|
#
|
|
47
|
+
# @param external_customer_id [String]
|
|
48
|
+
#
|
|
42
49
|
# @param currency [String, nil] The currency or custom pricing unit to use.
|
|
43
50
|
#
|
|
44
51
|
# @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
|
|
@@ -8,6 +8,11 @@ module Orb
|
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute customer_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :customer_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute currency
|
|
12
17
|
# The currency or custom pricing unit to use.
|
|
13
18
|
#
|
|
@@ -35,10 +40,12 @@ module Orb
|
|
|
35
40
|
# @return [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
|
|
36
41
|
optional :view_mode, enum: -> { Orb::Customers::CostListParams::ViewMode }, nil?: true
|
|
37
42
|
|
|
38
|
-
# @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
|
|
43
|
+
# @!method initialize(customer_id:, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
|
|
39
44
|
# Some parameter documentations has been truncated, see
|
|
40
45
|
# {Orb::Models::Customers::CostListParams} for more details.
|
|
41
46
|
#
|
|
47
|
+
# @param customer_id [String]
|
|
48
|
+
#
|
|
42
49
|
# @param currency [String, nil] The currency or custom pricing unit to use.
|
|
43
50
|
#
|
|
44
51
|
# @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
|
|
@@ -8,6 +8,11 @@ module Orb
|
|
|
8
8
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute external_customer_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :external_customer_id, String
|
|
15
|
+
|
|
11
16
|
# @!attribute currency
|
|
12
17
|
# The ledger currency or custom pricing unit to use.
|
|
13
18
|
#
|
|
@@ -54,10 +59,12 @@ module Orb
|
|
|
54
59
|
# @return [Integer, nil]
|
|
55
60
|
optional :limit, Integer
|
|
56
61
|
|
|
57
|
-
# @!method initialize(currency: nil, cursor: nil, effective_date_gt: nil, effective_date_gte: nil, effective_date_lt: nil, effective_date_lte: nil, include_all_blocks: nil, limit: nil, request_options: {})
|
|
62
|
+
# @!method initialize(external_customer_id:, currency: nil, cursor: nil, effective_date_gt: nil, effective_date_gte: nil, effective_date_lt: nil, effective_date_lte: nil, include_all_blocks: nil, limit: nil, request_options: {})
|
|
58
63
|
# Some parameter documentations has been truncated, see
|
|
59
64
|
# {Orb::Models::Customers::CreditListByExternalIDParams} for more details.
|
|
60
65
|
#
|
|
66
|
+
# @param external_customer_id [String]
|
|
67
|
+
#
|
|
61
68
|
# @param currency [String, nil] The ledger currency or custom pricing unit to use.
|
|
62
69
|
#
|
|
63
70
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|