orb-billing 1.13.0 → 1.14.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 +43 -0
- data/README.md +1 -1
- data/lib/orb/client.rb +7 -0
- data/lib/orb/internal/util.rb +22 -7
- data/lib/orb/models/alert.rb +10 -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 +29 -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 +8 -1
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +17769 -414
- 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 +17633 -406
- 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/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_retrieve_params.rb +7 -1
- data/lib/orb/models/credit_note_fetch_params.rb +7 -1
- data/lib/orb/models/customer.rb +13 -1
- data/lib/orb/models/customer_create_params.rb +12 -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_update_by_external_id_params.rb +25 -5
- data/lib/orb/models/customer_update_params.rb +25 -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_params.rb +8 -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_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/event_deprecate_params.rb +7 -1
- 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_delete_line_item_params.rb +7 -1
- data/lib/orb/models/invoice_fetch_params.rb +7 -1
- 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_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 +8 -1
- data/lib/orb/models/licenses/usage_get_usage_params.rb +8 -1
- data/lib/orb/models/metric_fetch_params.rb +7 -1
- data/lib/orb/models/metric_update_params.rb +8 -1
- data/lib/orb/models/plan_create_params.rb +8502 -1
- data/lib/orb/models/plan_fetch_params.rb +7 -1
- data/lib/orb/models/plan_update_params.rb +8 -1
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +7 -1
- data/lib/orb/models/plans/external_plan_id_update_params.rb +8 -1
- data/lib/orb/models/plans/migration_cancel_params.rb +7 -1
- data/lib/orb/models/plans/migration_list_params.rb +8 -1
- data/lib/orb/models/plans/migration_retrieve_params.rb +7 -1
- data/lib/orb/models/price.rb +248 -31
- data/lib/orb/models/price_create_params.rb +949 -1321
- data/lib/orb/models/price_evaluate_params.rb +8 -1
- data/lib/orb/models/price_fetch_params.rb +7 -1
- 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_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_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 +8 -1
- data/lib/orb/models/subscription_redeem_coupon_params.rb +8 -1
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +8 -1
- 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 +8 -1
- data/lib/orb/models/subscription_update_trial_params.rb +8 -1
- data/lib/orb/resources/alerts.rb +8 -1
- 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 +12 -67
- data/lib/orb/resources/customers.rb +6 -5
- data/lib/orb/resources/events/backfills.rb +3 -4
- data/lib/orb/resources/invoices.rb +12 -5
- data/lib/orb/resources/prices.rb +9 -100
- data/lib/orb/resources/subscriptions.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/client.rbi +6 -0
- data/rbi/orb/internal/util.rbi +8 -0
- data/rbi/orb/models/alert.rbi +10 -0
- 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 +26 -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 +6 -0
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +30163 -889
- 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 +30126 -884
- 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/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_retrieve_params.rbi +13 -5
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -5
- data/rbi/orb/models/customer.rbi +22 -0
- data/rbi/orb/models/customer_create_params.rbi +17 -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_update_by_external_id_params.rbi +31 -4
- data/rbi/orb/models/customer_update_params.rbi +31 -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_params.rbi +6 -0
- 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_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/event_deprecate_params.rbi +13 -5
- 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_delete_line_item_params.rbi +10 -2
- data/rbi/orb/models/invoice_fetch_params.rbi +13 -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_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 +6 -0
- data/rbi/orb/models/licenses/usage_get_usage_params.rbi +6 -0
- data/rbi/orb/models/metric_fetch_params.rbi +13 -5
- data/rbi/orb/models/metric_update_params.rbi +6 -0
- data/rbi/orb/models/plan_create_params.rbi +14618 -0
- data/rbi/orb/models/plan_fetch_params.rbi +13 -5
- data/rbi/orb/models/plan_update_params.rbi +6 -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 +6 -0
- data/rbi/orb/models/plans/migration_cancel_params.rbi +10 -2
- data/rbi/orb/models/plans/migration_list_params.rbi +6 -0
- data/rbi/orb/models/plans/migration_retrieve_params.rbi +10 -2
- data/rbi/orb/models/price.rbi +186 -0
- data/rbi/orb/models/price_create_params.rbi +1778 -2590
- data/rbi/orb/models/price_evaluate_params.rbi +6 -0
- data/rbi/orb/models/price_fetch_params.rbi +13 -5
- 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_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_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 +6 -0
- data/rbi/orb/models/subscription_redeem_coupon_params.rbi +6 -0
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +6 -0
- 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 +6 -0
- data/rbi/orb/models/subscription_update_trial_params.rbi +6 -0
- data/rbi/orb/resources/alerts.rbi +8 -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 +22 -132
- data/rbi/orb/resources/customers.rbi +12 -7
- data/rbi/orb/resources/events/backfills.rbi +3 -4
- data/rbi/orb/resources/invoices.rbi +11 -3
- data/rbi/orb/resources/prices.rbi +35 -184
- data/rbi/orb/resources/subscriptions.rbi +4 -4
- data/sig/orb/client.rbs +3 -0
- data/sig/orb/internal/util.rbs +4 -0
- data/sig/orb/models/alert.rbs +5 -0
- 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 +16 -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 +5 -1
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +12092 -373
- 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 +12075 -370
- 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/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_retrieve_params.rbs +8 -3
- data/sig/orb/models/credit_note_fetch_params.rbs +11 -3
- data/sig/orb/models/customer.rbs +14 -2
- 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_update_by_external_id_params.rbs +17 -1
- data/sig/orb/models/customer_update_params.rbs +17 -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_params.rbs +5 -0
- 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/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_delete_line_item_params.rbs +6 -1
- data/sig/orb/models/invoice_fetch_params.rbs +12 -3
- 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_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 +5 -0
- data/sig/orb/models/licenses/usage_get_usage_params.rbs +5 -0
- data/sig/orb/models/metric_fetch_params.rbs +12 -3
- data/sig/orb/models/metric_update_params.rbs +5 -1
- data/sig/orb/models/plan_create_params.rbs +5850 -0
- data/sig/orb/models/plan_fetch_params.rbs +9 -3
- data/sig/orb/models/plan_update_params.rbs +9 -1
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +11 -3
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +9 -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 +155 -0
- data/sig/orb/models/price_create_params.rbs +616 -1011
- data/sig/orb/models/price_evaluate_params.rbs +5 -0
- 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_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_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 +5 -0
- data/sig/orb/models/subscription_redeem_coupon_params.rbs +5 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +5 -0
- 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 +5 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +5 -0
- data/sig/orb/resources/alerts.rbs +2 -0
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -26
- data/sig/orb/resources/invoices.rbs +1 -0
- data/sig/orb/resources/prices.rbs +1 -48
- metadata +2 -2
|
@@ -12,8 +12,14 @@ module Orb
|
|
|
12
12
|
# @return [String]
|
|
13
13
|
required :plan_id, String
|
|
14
14
|
|
|
15
|
-
# @!
|
|
15
|
+
# @!attribute version
|
|
16
|
+
#
|
|
17
|
+
# @return [String]
|
|
18
|
+
required :version, String
|
|
19
|
+
|
|
20
|
+
# @!method initialize(plan_id:, version:, request_options: {})
|
|
16
21
|
# @param plan_id [String]
|
|
22
|
+
# @param version [String]
|
|
17
23
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
18
24
|
end
|
|
19
25
|
end
|
|
@@ -7,13 +7,20 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute plan_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :plan_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute version
|
|
11
16
|
# Plan version to set as the default.
|
|
12
17
|
#
|
|
13
18
|
# @return [Integer]
|
|
14
19
|
required :version, Integer
|
|
15
20
|
|
|
16
|
-
# @!method initialize(version:, request_options: {})
|
|
21
|
+
# @!method initialize(plan_id:, version:, request_options: {})
|
|
22
|
+
# @param plan_id [String]
|
|
23
|
+
#
|
|
17
24
|
# @param version [Integer] Plan version to set as the default.
|
|
18
25
|
#
|
|
19
26
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute coupon_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :coupon_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(coupon_id:, request_options: {})
|
|
16
|
+
# @param coupon_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute coupon_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :coupon_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(coupon_id:, request_options: {})
|
|
16
|
+
# @param coupon_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
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 coupon_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :coupon_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.
|
|
@@ -21,10 +26,12 @@ module Orb
|
|
|
21
26
|
# @return [Integer, nil]
|
|
22
27
|
optional :limit, Integer
|
|
23
28
|
|
|
24
|
-
# @!method initialize(cursor: nil, limit: nil, request_options: {})
|
|
29
|
+
# @!method initialize(coupon_id:, cursor: nil, limit: nil, request_options: {})
|
|
25
30
|
# Some parameter documentations has been truncated, see
|
|
26
31
|
# {Orb::Models::Coupons::SubscriptionListParams} for more details.
|
|
27
32
|
#
|
|
33
|
+
# @param coupon_id [String]
|
|
34
|
+
#
|
|
28
35
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
|
29
36
|
#
|
|
30
37
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute block_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :block_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(block_id:, request_options: {})
|
|
16
|
+
# @param block_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute block_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :block_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(block_id:, request_options: {})
|
|
16
|
+
# @param block_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute block_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :block_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(block_id:, request_options: {})
|
|
16
|
+
# @param block_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute credit_note_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :credit_note_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(credit_note_id:, request_options: {})
|
|
16
|
+
# @param credit_note_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
data/lib/orb/models/customer.rb
CHANGED
|
@@ -407,6 +407,7 @@ module Orb
|
|
|
407
407
|
STRIPE_CHARGE = :stripe_charge
|
|
408
408
|
STRIPE_INVOICE = :stripe_invoice
|
|
409
409
|
NETSUITE = :netsuite
|
|
410
|
+
NETSUITE_AMPERSAND = :netsuite_ampersand
|
|
410
411
|
|
|
411
412
|
# @!method self.values
|
|
412
413
|
# @return [Array<Symbol>]
|
|
@@ -451,6 +452,7 @@ module Orb
|
|
|
451
452
|
|
|
452
453
|
QUICKBOOKS = :quickbooks
|
|
453
454
|
NETSUITE = :netsuite
|
|
455
|
+
NETSUITE_AMPERSAND = :netsuite_ampersand
|
|
454
456
|
|
|
455
457
|
# @!method self.values
|
|
456
458
|
# @return [Array<Symbol>]
|
|
@@ -480,6 +482,14 @@ module Orb
|
|
|
480
482
|
# @return [Symbol, Orb::Models::Customer::PaymentConfiguration::PaymentProvider::ProviderType]
|
|
481
483
|
required :provider_type, enum: -> { Orb::Customer::PaymentConfiguration::PaymentProvider::ProviderType }
|
|
482
484
|
|
|
485
|
+
# @!attribute default_shared_payment_token
|
|
486
|
+
# The ID of a shared payment token granted by an agent to use as the default
|
|
487
|
+
# payment instrument for this customer. When set, auto-collection will use this
|
|
488
|
+
# token instead of the customer's default payment method.
|
|
489
|
+
#
|
|
490
|
+
# @return [String, nil]
|
|
491
|
+
optional :default_shared_payment_token, String, nil?: true
|
|
492
|
+
|
|
483
493
|
# @!attribute excluded_payment_method_types
|
|
484
494
|
# List of Stripe payment method types to exclude for this customer. Excluded
|
|
485
495
|
# payment methods will not be available for the customer to select during payment,
|
|
@@ -490,12 +500,14 @@ module Orb
|
|
|
490
500
|
# @return [Array<String>, nil]
|
|
491
501
|
optional :excluded_payment_method_types, Orb::Internal::Type::ArrayOf[String]
|
|
492
502
|
|
|
493
|
-
# @!method initialize(provider_type:, excluded_payment_method_types: nil)
|
|
503
|
+
# @!method initialize(provider_type:, default_shared_payment_token: nil, excluded_payment_method_types: nil)
|
|
494
504
|
# Some parameter documentations has been truncated, see
|
|
495
505
|
# {Orb::Models::Customer::PaymentConfiguration::PaymentProvider} for more details.
|
|
496
506
|
#
|
|
497
507
|
# @param provider_type [Symbol, Orb::Models::Customer::PaymentConfiguration::PaymentProvider::ProviderType] The payment provider to configure.
|
|
498
508
|
#
|
|
509
|
+
# @param default_shared_payment_token [String, nil] The ID of a shared payment token granted by an agent to use as the default payme
|
|
510
|
+
#
|
|
499
511
|
# @param excluded_payment_method_types [Array<String>] List of Stripe payment method types to exclude for this customer. Excluded payme
|
|
500
512
|
|
|
501
513
|
# The payment provider to configure.
|
|
@@ -353,6 +353,14 @@ module Orb
|
|
|
353
353
|
required :provider_type,
|
|
354
354
|
enum: -> { Orb::CustomerCreateParams::PaymentConfiguration::PaymentProvider::ProviderType }
|
|
355
355
|
|
|
356
|
+
# @!attribute default_shared_payment_token
|
|
357
|
+
# The ID of a shared payment token granted by an agent to use as the default
|
|
358
|
+
# payment instrument for this customer. When set, auto-collection will use this
|
|
359
|
+
# token instead of the customer's default payment method.
|
|
360
|
+
#
|
|
361
|
+
# @return [String, nil]
|
|
362
|
+
optional :default_shared_payment_token, String, nil?: true
|
|
363
|
+
|
|
356
364
|
# @!attribute excluded_payment_method_types
|
|
357
365
|
# List of Stripe payment method types to exclude for this customer. Excluded
|
|
358
366
|
# payment methods will not be available for the customer to select during payment,
|
|
@@ -363,13 +371,15 @@ module Orb
|
|
|
363
371
|
# @return [Array<String>, nil]
|
|
364
372
|
optional :excluded_payment_method_types, Orb::Internal::Type::ArrayOf[String]
|
|
365
373
|
|
|
366
|
-
# @!method initialize(provider_type:, excluded_payment_method_types: nil)
|
|
374
|
+
# @!method initialize(provider_type:, default_shared_payment_token: nil, excluded_payment_method_types: nil)
|
|
367
375
|
# Some parameter documentations has been truncated, see
|
|
368
376
|
# {Orb::Models::CustomerCreateParams::PaymentConfiguration::PaymentProvider} for
|
|
369
377
|
# more details.
|
|
370
378
|
#
|
|
371
379
|
# @param provider_type [Symbol, Orb::Models::CustomerCreateParams::PaymentConfiguration::PaymentProvider::ProviderType] The payment provider to configure.
|
|
372
380
|
#
|
|
381
|
+
# @param default_shared_payment_token [String, nil] The ID of a shared payment token granted by an agent to use as the default payme
|
|
382
|
+
#
|
|
373
383
|
# @param excluded_payment_method_types [Array<String>] List of Stripe payment method types to exclude for this customer. Excluded payme
|
|
374
384
|
|
|
375
385
|
# The payment provider to configure.
|
|
@@ -397,6 +407,7 @@ module Orb
|
|
|
397
407
|
STRIPE_CHARGE = :stripe_charge
|
|
398
408
|
STRIPE_INVOICE = :stripe_invoice
|
|
399
409
|
NETSUITE = :netsuite
|
|
410
|
+
NETSUITE_AMPERSAND = :netsuite_ampersand
|
|
400
411
|
|
|
401
412
|
# @!method self.values
|
|
402
413
|
# @return [Array<Symbol>]
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute customer_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :customer_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(customer_id:, request_options: {})
|
|
16
|
+
# @param customer_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute external_customer_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :external_customer_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(external_customer_id:, request_options: {})
|
|
16
|
+
# @param external_customer_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute customer_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :customer_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(customer_id:, request_options: {})
|
|
16
|
+
# @param customer_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb
CHANGED
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute external_customer_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :external_customer_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(external_customer_id:, request_options: {})
|
|
16
|
+
# @param external_customer_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,7 +7,13 @@ module Orb
|
|
|
7
7
|
extend Orb::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute customer_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :customer_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(customer_id:, request_options: {})
|
|
16
|
+
# @param customer_id [String]
|
|
11
17
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -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,8 +48,10 @@ 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
|
|
@@ -287,10 +294,12 @@ module Orb
|
|
|
287
294
|
# @return [Orb::Models::CustomerTaxID, nil]
|
|
288
295
|
optional :tax_id, -> { Orb::CustomerTaxID }, nil?: true
|
|
289
296
|
|
|
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: {})
|
|
297
|
+
# @!method initialize(id:, 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: {})
|
|
291
298
|
# Some parameter documentations has been truncated, see
|
|
292
299
|
# {Orb::Models::CustomerUpdateByExternalIDParams} for more details.
|
|
293
300
|
#
|
|
301
|
+
# @param id [String]
|
|
302
|
+
#
|
|
294
303
|
# @param accounting_sync_configuration [Orb::Models::NewAccountingSyncConfiguration, nil]
|
|
295
304
|
#
|
|
296
305
|
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
|
@@ -301,7 +310,7 @@ module Orb
|
|
|
301
310
|
#
|
|
302
311
|
# @param billing_address [Orb::Models::AddressInput, nil]
|
|
303
312
|
#
|
|
304
|
-
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance.
|
|
313
|
+
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. This c
|
|
305
314
|
#
|
|
306
315
|
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
|
307
316
|
#
|
|
@@ -353,6 +362,14 @@ module Orb
|
|
|
353
362
|
required :provider_type,
|
|
354
363
|
enum: -> { Orb::CustomerUpdateByExternalIDParams::PaymentConfiguration::PaymentProvider::ProviderType }
|
|
355
364
|
|
|
365
|
+
# @!attribute default_shared_payment_token
|
|
366
|
+
# The ID of a shared payment token granted by an agent to use as the default
|
|
367
|
+
# payment instrument for this customer. When set, auto-collection will use this
|
|
368
|
+
# token instead of the customer's default payment method.
|
|
369
|
+
#
|
|
370
|
+
# @return [String, nil]
|
|
371
|
+
optional :default_shared_payment_token, String, nil?: true
|
|
372
|
+
|
|
356
373
|
# @!attribute excluded_payment_method_types
|
|
357
374
|
# List of Stripe payment method types to exclude for this customer. Excluded
|
|
358
375
|
# payment methods will not be available for the customer to select during payment,
|
|
@@ -363,13 +380,15 @@ module Orb
|
|
|
363
380
|
# @return [Array<String>, nil]
|
|
364
381
|
optional :excluded_payment_method_types, Orb::Internal::Type::ArrayOf[String]
|
|
365
382
|
|
|
366
|
-
# @!method initialize(provider_type:, excluded_payment_method_types: nil)
|
|
383
|
+
# @!method initialize(provider_type:, default_shared_payment_token: nil, excluded_payment_method_types: nil)
|
|
367
384
|
# Some parameter documentations has been truncated, see
|
|
368
385
|
# {Orb::Models::CustomerUpdateByExternalIDParams::PaymentConfiguration::PaymentProvider}
|
|
369
386
|
# for more details.
|
|
370
387
|
#
|
|
371
388
|
# @param provider_type [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentConfiguration::PaymentProvider::ProviderType] The payment provider to configure.
|
|
372
389
|
#
|
|
390
|
+
# @param default_shared_payment_token [String, nil] The ID of a shared payment token granted by an agent to use as the default payme
|
|
391
|
+
#
|
|
373
392
|
# @param excluded_payment_method_types [Array<String>] List of Stripe payment method types to exclude for this customer. Excluded payme
|
|
374
393
|
|
|
375
394
|
# The payment provider to configure.
|
|
@@ -401,6 +420,7 @@ module Orb
|
|
|
401
420
|
STRIPE_CHARGE = :stripe_charge
|
|
402
421
|
STRIPE_INVOICE = :stripe_invoice
|
|
403
422
|
NETSUITE = :netsuite
|
|
423
|
+
NETSUITE_AMPERSAND = :netsuite_ampersand
|
|
404
424
|
|
|
405
425
|
# @!method self.values
|
|
406
426
|
# @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,8 +48,10 @@ 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
|
|
@@ -281,10 +288,12 @@ module Orb
|
|
|
281
288
|
# @return [Orb::Models::CustomerTaxID, nil]
|
|
282
289
|
optional :tax_id, -> { Orb::CustomerTaxID }, nil?: true
|
|
283
290
|
|
|
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: {})
|
|
291
|
+
# @!method initialize(customer_id:, 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: {})
|
|
285
292
|
# Some parameter documentations has been truncated, see
|
|
286
293
|
# {Orb::Models::CustomerUpdateParams} for more details.
|
|
287
294
|
#
|
|
295
|
+
# @param customer_id [String]
|
|
296
|
+
#
|
|
288
297
|
# @param accounting_sync_configuration [Orb::Models::NewAccountingSyncConfiguration, nil]
|
|
289
298
|
#
|
|
290
299
|
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
|
@@ -295,7 +304,7 @@ module Orb
|
|
|
295
304
|
#
|
|
296
305
|
# @param billing_address [Orb::Models::AddressInput, nil]
|
|
297
306
|
#
|
|
298
|
-
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance.
|
|
307
|
+
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. This c
|
|
299
308
|
#
|
|
300
309
|
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
|
301
310
|
#
|
|
@@ -347,6 +356,14 @@ module Orb
|
|
|
347
356
|
required :provider_type,
|
|
348
357
|
enum: -> { Orb::CustomerUpdateParams::PaymentConfiguration::PaymentProvider::ProviderType }
|
|
349
358
|
|
|
359
|
+
# @!attribute default_shared_payment_token
|
|
360
|
+
# The ID of a shared payment token granted by an agent to use as the default
|
|
361
|
+
# payment instrument for this customer. When set, auto-collection will use this
|
|
362
|
+
# token instead of the customer's default payment method.
|
|
363
|
+
#
|
|
364
|
+
# @return [String, nil]
|
|
365
|
+
optional :default_shared_payment_token, String, nil?: true
|
|
366
|
+
|
|
350
367
|
# @!attribute excluded_payment_method_types
|
|
351
368
|
# List of Stripe payment method types to exclude for this customer. Excluded
|
|
352
369
|
# payment methods will not be available for the customer to select during payment,
|
|
@@ -357,13 +374,15 @@ module Orb
|
|
|
357
374
|
# @return [Array<String>, nil]
|
|
358
375
|
optional :excluded_payment_method_types, Orb::Internal::Type::ArrayOf[String]
|
|
359
376
|
|
|
360
|
-
# @!method initialize(provider_type:, excluded_payment_method_types: nil)
|
|
377
|
+
# @!method initialize(provider_type:, default_shared_payment_token: nil, excluded_payment_method_types: nil)
|
|
361
378
|
# Some parameter documentations has been truncated, see
|
|
362
379
|
# {Orb::Models::CustomerUpdateParams::PaymentConfiguration::PaymentProvider} for
|
|
363
380
|
# more details.
|
|
364
381
|
#
|
|
365
382
|
# @param provider_type [Symbol, Orb::Models::CustomerUpdateParams::PaymentConfiguration::PaymentProvider::ProviderType] The payment provider to configure.
|
|
366
383
|
#
|
|
384
|
+
# @param default_shared_payment_token [String, nil] The ID of a shared payment token granted by an agent to use as the default payme
|
|
385
|
+
#
|
|
367
386
|
# @param excluded_payment_method_types [Array<String>] List of Stripe payment method types to exclude for this customer. Excluded payme
|
|
368
387
|
|
|
369
388
|
# The payment provider to configure.
|
|
@@ -395,6 +414,7 @@ module Orb
|
|
|
395
414
|
STRIPE_CHARGE = :stripe_charge
|
|
396
415
|
STRIPE_INVOICE = :stripe_invoice
|
|
397
416
|
NETSUITE = :netsuite
|
|
417
|
+
NETSUITE_AMPERSAND = :netsuite_ampersand
|
|
398
418
|
|
|
399
419
|
# @!method self.values
|
|
400
420
|
# @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
|