orb-billing 0.1.0.pre.alpha.38 → 0.1.0.pre.alpha.39
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/README.md +1 -1
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/transport/base_client.rb +1 -1
- data/lib/orb/internal/transport/pooled_net_requester.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +14 -17
- data/lib/orb/internal/type/converter.rb +20 -22
- data/lib/orb/internal/type/enum.rb +8 -8
- data/lib/orb/internal/util.rb +1 -5
- data/lib/orb/models/alert.rb +9 -9
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
- data/lib/orb/models/alert_list_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +1 -1
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +7 -7
- data/lib/orb/models/coupon_create_params.rb +2 -2
- data/lib/orb/models/coupon_list_params.rb +2 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
- data/lib/orb/models/credit_note.rb +1 -1
- data/lib/orb/models/credit_note_list_params.rb +5 -5
- data/lib/orb/models/customer.rb +232 -232
- data/lib/orb/models/customer_create_params.rb +223 -223
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
- data/lib/orb/models/customer_update_params.rb +224 -224
- data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
- data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/cost_list_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credit_list_params.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
- data/lib/orb/models/dimensional_price_group.rb +7 -7
- data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
- data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +7 -7
- data/lib/orb/models/event_ingest_response.rb +4 -4
- data/lib/orb/models/event_search_params.rb +5 -5
- data/lib/orb/models/event_search_response.rb +8 -8
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +7 -7
- data/lib/orb/models/events/backfill_create_params.rb +11 -11
- data/lib/orb/models/events/backfill_create_response.rb +7 -7
- data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +7 -7
- data/lib/orb/models/events/backfill_revert_response.rb +7 -7
- data/lib/orb/models/events/event_volumes.rb +1 -1
- data/lib/orb/models/events/volume_list_params.rb +7 -7
- data/lib/orb/models/invoice.rb +270 -270
- data/lib/orb/models/invoice_create_params.rb +12 -11
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
- data/lib/orb/models/invoice_issue_params.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
- data/lib/orb/models/invoice_list_params.rb +12 -12
- data/lib/orb/models/invoice_update_params.rb +2 -2
- data/lib/orb/models/item.rb +2 -2
- data/lib/orb/models/item_list_params.rb +1 -1
- data/lib/orb/models/metric_create_params.rb +2 -2
- data/lib/orb/models/metric_list_params.rb +5 -5
- data/lib/orb/models/metric_update_params.rb +2 -2
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +35 -35
- data/lib/orb/models/plan_create_params.rb +267 -267
- data/lib/orb/models/plan_list_params.rb +5 -5
- data/lib/orb/models/plan_update_params.rb +4 -4
- data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
- data/lib/orb/models/price.rb +158 -158
- data/lib/orb/models/price_create_params.rb +20 -20
- data/lib/orb/models/price_evaluate_params.rb +4 -4
- data/lib/orb/models/price_list_params.rb +1 -1
- data/lib/orb/models/price_update_params.rb +2 -2
- data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
- data/lib/orb/models/subscription.rb +114 -87
- data/lib/orb/models/subscription_cancel_params.rb +3 -3
- data/lib/orb/models/subscription_cancel_response.rb +150 -72
- data/lib/orb/models/subscription_change_apply_params.rb +33 -0
- data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
- data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
- data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
- data/lib/orb/models/subscription_create_params.rb +641 -641
- data/lib/orb/models/subscription_create_response.rb +150 -72
- data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
- data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
- data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
- data/lib/orb/models/subscription_list_params.rb +5 -5
- data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
- data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
- data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
- data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
- data/lib/orb/models/subscription_update_params.rb +10 -10
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +152 -72
- data/lib/orb/models/trial_discount.rb +1 -1
- data/lib/orb/models/usage_discount.rb +2 -2
- data/lib/orb/request_options.rb +7 -7
- data/lib/orb/resources/alerts.rb +38 -38
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +8 -8
- data/lib/orb/resources/customers/balance_transactions.rb +26 -26
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +344 -344
- data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
- data/lib/orb/resources/customers/credits.rb +8 -8
- data/lib/orb/resources/customers.rb +59 -59
- data/lib/orb/resources/dimensional_price_groups.rb +6 -6
- data/lib/orb/resources/events/backfills.rb +49 -49
- data/lib/orb/resources/events/volume.rb +10 -10
- data/lib/orb/resources/events.rb +295 -295
- data/lib/orb/resources/invoice_line_items.rb +1 -1
- data/lib/orb/resources/invoices.rb +38 -38
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +11 -11
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +22 -22
- data/lib/orb/resources/prices/external_price_id.rb +4 -4
- data/lib/orb/resources/prices.rb +30 -30
- data/lib/orb/resources/subscription_changes.rb +87 -0
- data/lib/orb/resources/subscriptions.rb +813 -813
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +7 -0
- data/rbi/lib/orb/client.rbi +5 -4
- data/rbi/lib/orb/errors.rbi +3 -6
- data/rbi/lib/orb/internal/page.rbi +3 -6
- data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +7 -13
- data/rbi/lib/orb/internal/type/array_of.rbi +8 -16
- data/rbi/lib/orb/internal/type/base_model.rbi +45 -64
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/boolean.rbi +4 -8
- data/rbi/lib/orb/internal/type/converter.rbi +25 -31
- data/rbi/lib/orb/internal/type/enum.rbi +14 -20
- data/rbi/lib/orb/internal/type/hash_of.rbi +8 -16
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +10 -20
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -8
- data/rbi/lib/orb/internal/util.rbi +34 -68
- data/rbi/lib/orb/internal.rbi +1 -1
- data/rbi/lib/orb/models/alert.rbi +21 -33
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
- data/rbi/lib/orb/models/amount_discount.rbi +4 -7
- data/rbi/lib/orb/models/billable_metric.rbi +10 -13
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
- data/rbi/lib/orb/models/coupon.rbi +9 -11
- data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
- data/rbi/lib/orb/models/credit_note.rbi +22 -45
- data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer.rbi +256 -281
- data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
- data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
- data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
- data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
- data/rbi/lib/orb/models/discount.rbi +1 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
- data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
- data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
- data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
- data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
- data/rbi/lib/orb/models/event_search_params.rbi +7 -9
- data/rbi/lib/orb/models/event_search_response.rbi +11 -14
- data/rbi/lib/orb/models/event_update_params.rbi +5 -6
- data/rbi/lib/orb/models/event_update_response.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
- data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
- data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
- data/rbi/lib/orb/models/invoice.rbi +388 -465
- data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
- data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
- data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
- data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
- data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
- data/rbi/lib/orb/models/item.rbi +7 -12
- data/rbi/lib/orb/models/item_create_params.rbi +2 -4
- data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/item_list_params.rbi +3 -5
- data/rbi/lib/orb/models/item_update_params.rbi +5 -10
- data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
- data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
- data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
- data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
- data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
- data/rbi/lib/orb/models/plan.rbi +180 -219
- data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
- data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
- data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
- data/rbi/lib/orb/models/price.rbi +827 -1494
- data/rbi/lib/orb/models/price_create_params.rbi +60 -101
- data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
- data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
- data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/price_list_params.rbi +3 -5
- data/rbi/lib/orb/models/price_update_params.rbi +4 -6
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
- data/rbi/lib/orb/models/subscription.rbi +167 -187
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
- data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
- data/rbi/lib/orb/models/subscriptions.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
- data/rbi/lib/orb/models/trial_discount.rbi +4 -8
- data/rbi/lib/orb/models/usage_discount.rbi +5 -8
- data/rbi/lib/orb/request_options.rbi +9 -11
- data/rbi/lib/orb/resources/alerts.rbi +44 -60
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
- data/rbi/lib/orb/resources/coupons.rbi +18 -25
- data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
- data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
- data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
- data/rbi/lib/orb/resources/customers.rbi +407 -417
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
- data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
- data/rbi/lib/orb/resources/events/volume.rbi +19 -22
- data/rbi/lib/orb/resources/events.rbi +311 -319
- data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
- data/rbi/lib/orb/resources/invoices.rbi +62 -76
- data/rbi/lib/orb/resources/items.rbi +7 -14
- data/rbi/lib/orb/resources/metrics.rbi +17 -25
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
- data/rbi/lib/orb/resources/plans.rbi +63 -71
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
- data/rbi/lib/orb/resources/prices.rbi +77 -87
- data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
- data/rbi/lib/orb/resources/top_level.rbi +6 -8
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/models/subscription.rbs +14 -0
- data/sig/orb/models/subscription_cancel_response.rbs +47 -2
- data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
- data/sig/orb/models/subscription_create_response.rbs +47 -2
- data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
- data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
- data/sig/orb/resources/customers.rbs +2 -2
- data/sig/orb/resources/subscription_changes.rbs +24 -0
- metadata +23 -2
@@ -18,13 +18,13 @@ module Orb
|
|
18
18
|
attr_writer :accounting_sync_configuration
|
19
19
|
|
20
20
|
# Additional email addresses for this customer. If populated, these email
|
21
|
-
#
|
21
|
+
# addresses will be CC'd for customer communications.
|
22
22
|
sig { returns(T.nilable(T::Array[String])) }
|
23
23
|
attr_accessor :additional_emails
|
24
24
|
|
25
25
|
# Used to determine if invoices for this customer will automatically attempt to
|
26
|
-
#
|
27
|
-
#
|
26
|
+
# charge a saved payment method, if available. This parameter defaults to `True`
|
27
|
+
# when a payment provider is provided on customer creation.
|
28
28
|
sig { returns(T.nilable(T::Boolean)) }
|
29
29
|
attr_accessor :auto_collection
|
30
30
|
|
@@ -40,7 +40,7 @@ module Orb
|
|
40
40
|
attr_writer :billing_address
|
41
41
|
|
42
42
|
# An ISO 4217 currency string used for the customer's invoices and balance. If not
|
43
|
-
#
|
43
|
+
# set at creation time, will be set at subscription creation time.
|
44
44
|
sig { returns(T.nilable(String)) }
|
45
45
|
attr_accessor :currency
|
46
46
|
|
@@ -52,7 +52,7 @@ module Orb
|
|
52
52
|
attr_accessor :email_delivery
|
53
53
|
|
54
54
|
# The external customer ID. This can only be set if empty and the customer has no
|
55
|
-
#
|
55
|
+
# past or current subscriptions.
|
56
56
|
sig { returns(T.nilable(String)) }
|
57
57
|
attr_accessor :external_customer_id
|
58
58
|
|
@@ -67,8 +67,8 @@ module Orb
|
|
67
67
|
attr_writer :hierarchy
|
68
68
|
|
69
69
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
70
|
-
#
|
71
|
-
#
|
70
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
71
|
+
# by setting `metadata` to `null`.
|
72
72
|
sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
|
73
73
|
attr_accessor :metadata
|
74
74
|
|
@@ -77,17 +77,17 @@ module Orb
|
|
77
77
|
attr_accessor :name
|
78
78
|
|
79
79
|
# This is used for creating charges or invoices in an external system via Orb.
|
80
|
-
#
|
80
|
+
# When not in test mode:
|
81
81
|
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
82
|
+
# - the connection must first be configured in the Orb webapp.
|
83
|
+
# - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
|
84
|
+
# `bill.com`, `netsuite`), any product mappings must first be configured with
|
85
|
+
# the Orb team.
|
86
86
|
sig { returns(T.nilable(Orb::Models::CustomerUpdateParams::PaymentProvider::OrSymbol)) }
|
87
87
|
attr_accessor :payment_provider
|
88
88
|
|
89
89
|
# The ID of this customer in an external payments solution, such as Stripe. This
|
90
|
-
#
|
90
|
+
# is used for creating charges or invoices in the external system via Orb.
|
91
91
|
sig { returns(T.nilable(String)) }
|
92
92
|
attr_accessor :payment_provider_id
|
93
93
|
|
@@ -126,110 +126,110 @@ module Orb
|
|
126
126
|
attr_accessor :tax_configuration
|
127
127
|
|
128
128
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
129
|
-
#
|
129
|
+
# added to the headers of invoices.
|
130
130
|
#
|
131
|
-
#
|
131
|
+
# ### Supported Tax ID Countries and Types
|
132
132
|
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
#
|
139
|
-
#
|
140
|
-
#
|
141
|
-
#
|
142
|
-
#
|
143
|
-
#
|
144
|
-
#
|
145
|
-
#
|
146
|
-
#
|
147
|
-
#
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
#
|
154
|
-
#
|
155
|
-
#
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
#
|
167
|
-
#
|
168
|
-
#
|
169
|
-
#
|
170
|
-
#
|
171
|
-
#
|
172
|
-
#
|
173
|
-
#
|
174
|
-
#
|
175
|
-
#
|
176
|
-
#
|
177
|
-
#
|
178
|
-
#
|
179
|
-
#
|
180
|
-
#
|
181
|
-
#
|
182
|
-
#
|
183
|
-
#
|
184
|
-
#
|
185
|
-
#
|
186
|
-
#
|
187
|
-
#
|
188
|
-
#
|
189
|
-
#
|
190
|
-
#
|
191
|
-
#
|
192
|
-
#
|
193
|
-
#
|
194
|
-
#
|
195
|
-
#
|
196
|
-
#
|
197
|
-
#
|
198
|
-
#
|
199
|
-
#
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
203
|
-
#
|
204
|
-
#
|
205
|
-
#
|
206
|
-
#
|
207
|
-
#
|
208
|
-
#
|
209
|
-
#
|
210
|
-
#
|
211
|
-
#
|
212
|
-
#
|
213
|
-
#
|
214
|
-
#
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
218
|
-
#
|
219
|
-
#
|
220
|
-
#
|
221
|
-
#
|
222
|
-
#
|
223
|
-
#
|
224
|
-
#
|
225
|
-
#
|
226
|
-
#
|
227
|
-
#
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
133
|
+
# | Country | Type | Description |
|
134
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
135
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
136
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
137
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
138
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
139
|
+
# | Austria | `eu_vat` | European VAT Number |
|
140
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
141
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
142
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
143
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
144
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
145
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
146
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
147
|
+
# | Canada | `ca_bn` | Canadian BN |
|
148
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
149
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
150
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
151
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
152
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
153
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
154
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
155
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
156
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
157
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
158
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
159
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
160
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
161
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
162
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
163
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
164
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
165
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
166
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
167
|
+
# | Finland | `eu_vat` | European VAT Number |
|
168
|
+
# | France | `eu_vat` | European VAT Number |
|
169
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
170
|
+
# | Germany | `eu_vat` | European VAT Number |
|
171
|
+
# | Greece | `eu_vat` | European VAT Number |
|
172
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
173
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
174
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
175
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
176
|
+
# | India | `in_gst` | Indian GST Number |
|
177
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
178
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
179
|
+
# | Israel | `il_vat` | Israel VAT |
|
180
|
+
# | Italy | `eu_vat` | European VAT Number |
|
181
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
182
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
183
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
184
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
185
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
186
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
187
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
188
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
189
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
190
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
191
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
192
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
193
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
194
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
195
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
196
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
197
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
198
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
199
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
200
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
201
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
202
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
203
|
+
# | Poland | `eu_vat` | European VAT Number |
|
204
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
205
|
+
# | Romania | `eu_vat` | European VAT Number |
|
206
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
207
|
+
# | Russia | `ru_inn` | Russian INN |
|
208
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
209
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
210
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
211
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
212
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
213
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
214
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
215
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
216
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
217
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
218
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
219
|
+
# | Spain | `eu_vat` | European VAT Number |
|
220
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
221
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
222
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
223
|
+
# | Thailand | `th_vat` | Thai VAT |
|
224
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
225
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
226
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
227
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
228
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
229
|
+
# | United States | `us_ein` | United States EIN |
|
230
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
231
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
232
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
233
233
|
sig { returns(T.nilable(Orb::Models::CustomerUpdateParams::TaxID)) }
|
234
234
|
attr_reader :tax_id
|
235
235
|
|
@@ -284,9 +284,7 @@ module Orb
|
|
284
284
|
tax_configuration: nil,
|
285
285
|
tax_id: nil,
|
286
286
|
request_options: {}
|
287
|
-
)
|
288
|
-
end
|
289
|
-
|
287
|
+
); end
|
290
288
|
sig do
|
291
289
|
override
|
292
290
|
.returns(
|
@@ -317,8 +315,7 @@ module Orb
|
|
317
315
|
}
|
318
316
|
)
|
319
317
|
end
|
320
|
-
def to_hash
|
321
|
-
end
|
318
|
+
def to_hash; end
|
322
319
|
|
323
320
|
class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
|
324
321
|
sig do
|
@@ -335,18 +332,17 @@ module Orb
|
|
335
332
|
params(
|
336
333
|
accounting_providers: T.nilable(
|
337
334
|
T::Array[
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
335
|
+
T.any(
|
336
|
+
Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider,
|
337
|
+
Orb::Internal::AnyHash
|
338
|
+
)
|
342
339
|
]
|
343
340
|
),
|
344
341
|
excluded: T.nilable(T::Boolean)
|
345
342
|
)
|
346
343
|
.returns(T.attached_class)
|
347
344
|
end
|
348
|
-
def self.new(accounting_providers: nil, excluded: nil)
|
349
|
-
end
|
345
|
+
def self.new(accounting_providers: nil, excluded: nil); end
|
350
346
|
|
351
347
|
sig do
|
352
348
|
override
|
@@ -357,8 +353,7 @@ module Orb
|
|
357
353
|
}
|
358
354
|
)
|
359
355
|
end
|
360
|
-
def to_hash
|
361
|
-
end
|
356
|
+
def to_hash; end
|
362
357
|
|
363
358
|
class AccountingProvider < Orb::Internal::Type::BaseModel
|
364
359
|
sig { returns(String) }
|
@@ -368,12 +363,10 @@ module Orb
|
|
368
363
|
attr_accessor :provider_type
|
369
364
|
|
370
365
|
sig { params(external_provider_id: String, provider_type: String).returns(T.attached_class) }
|
371
|
-
def self.new(external_provider_id:, provider_type:)
|
372
|
-
end
|
366
|
+
def self.new(external_provider_id:, provider_type:); end
|
373
367
|
|
374
368
|
sig { override.returns({external_provider_id: String, provider_type: String}) }
|
375
|
-
def to_hash
|
376
|
-
end
|
369
|
+
def to_hash; end
|
377
370
|
end
|
378
371
|
end
|
379
372
|
|
@@ -407,8 +400,7 @@ module Orb
|
|
407
400
|
)
|
408
401
|
.returns(T.attached_class)
|
409
402
|
end
|
410
|
-
def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
411
|
-
end
|
403
|
+
def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end
|
412
404
|
|
413
405
|
sig do
|
414
406
|
override
|
@@ -423,13 +415,12 @@ module Orb
|
|
423
415
|
}
|
424
416
|
)
|
425
417
|
end
|
426
|
-
def to_hash
|
427
|
-
end
|
418
|
+
def to_hash; end
|
428
419
|
end
|
429
420
|
|
430
421
|
class Hierarchy < Orb::Internal::Type::BaseModel
|
431
422
|
# A list of child customer IDs to add to the hierarchy. The desired child
|
432
|
-
#
|
423
|
+
# customers must not already be part of another hierarchy.
|
433
424
|
sig { returns(T.nilable(T::Array[String])) }
|
434
425
|
attr_reader :child_customer_ids
|
435
426
|
|
@@ -437,7 +428,7 @@ module Orb
|
|
437
428
|
attr_writer :child_customer_ids
|
438
429
|
|
439
430
|
# The ID of the parent customer in the hierarchy. The desired parent customer must
|
440
|
-
#
|
431
|
+
# not be a child of another customer.
|
441
432
|
sig { returns(T.nilable(String)) }
|
442
433
|
attr_accessor :parent_customer_id
|
443
434
|
|
@@ -446,23 +437,21 @@ module Orb
|
|
446
437
|
params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String))
|
447
438
|
.returns(T.attached_class)
|
448
439
|
end
|
449
|
-
def self.new(child_customer_ids: nil, parent_customer_id: nil)
|
450
|
-
end
|
440
|
+
def self.new(child_customer_ids: nil, parent_customer_id: nil); end
|
451
441
|
|
452
442
|
sig do
|
453
443
|
override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)})
|
454
444
|
end
|
455
|
-
def to_hash
|
456
|
-
end
|
445
|
+
def to_hash; end
|
457
446
|
end
|
458
447
|
|
459
448
|
# This is used for creating charges or invoices in an external system via Orb.
|
460
|
-
#
|
449
|
+
# When not in test mode:
|
461
450
|
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
451
|
+
# - the connection must first be configured in the Orb webapp.
|
452
|
+
# - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
|
453
|
+
# `bill.com`, `netsuite`), any product mappings must first be configured with
|
454
|
+
# the Orb team.
|
466
455
|
module PaymentProvider
|
467
456
|
extend Orb::Internal::Type::Enum
|
468
457
|
|
@@ -477,8 +466,7 @@ module Orb
|
|
477
466
|
NETSUITE = T.let(:netsuite, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol)
|
478
467
|
|
479
468
|
sig { override.returns(T::Array[Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol]) }
|
480
|
-
def self.values
|
481
|
-
end
|
469
|
+
def self.values; end
|
482
470
|
end
|
483
471
|
|
484
472
|
class ReportingConfiguration < Orb::Internal::Type::BaseModel
|
@@ -486,12 +474,10 @@ module Orb
|
|
486
474
|
attr_accessor :exempt
|
487
475
|
|
488
476
|
sig { params(exempt: T::Boolean).returns(T.attached_class) }
|
489
|
-
def self.new(exempt:)
|
490
|
-
end
|
477
|
+
def self.new(exempt:); end
|
491
478
|
|
492
479
|
sig { override.returns({exempt: T::Boolean}) }
|
493
|
-
def to_hash
|
494
|
-
end
|
480
|
+
def to_hash; end
|
495
481
|
end
|
496
482
|
|
497
483
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
@@ -524,8 +510,7 @@ module Orb
|
|
524
510
|
)
|
525
511
|
.returns(T.attached_class)
|
526
512
|
end
|
527
|
-
def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
528
|
-
end
|
513
|
+
def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end
|
529
514
|
|
530
515
|
sig do
|
531
516
|
override
|
@@ -540,8 +525,7 @@ module Orb
|
|
540
525
|
}
|
541
526
|
)
|
542
527
|
end
|
543
|
-
def to_hash
|
544
|
-
end
|
528
|
+
def to_hash; end
|
545
529
|
end
|
546
530
|
|
547
531
|
module TaxConfiguration
|
@@ -561,8 +545,7 @@ module Orb
|
|
561
545
|
params(tax_exempt: T::Boolean, tax_exemption_code: T.nilable(String), tax_provider: Symbol)
|
562
546
|
.returns(T.attached_class)
|
563
547
|
end
|
564
|
-
def self.new(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara)
|
565
|
-
end
|
548
|
+
def self.new(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara); end
|
566
549
|
|
567
550
|
sig do
|
568
551
|
override.returns(
|
@@ -573,8 +556,7 @@ module Orb
|
|
573
556
|
}
|
574
557
|
)
|
575
558
|
end
|
576
|
-
def to_hash
|
577
|
-
end
|
559
|
+
def to_hash; end
|
578
560
|
end
|
579
561
|
|
580
562
|
class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel
|
@@ -585,12 +567,10 @@ module Orb
|
|
585
567
|
attr_accessor :tax_provider
|
586
568
|
|
587
569
|
sig { params(tax_exempt: T::Boolean, tax_provider: Symbol).returns(T.attached_class) }
|
588
|
-
def self.new(tax_exempt:, tax_provider: :taxjar)
|
589
|
-
end
|
570
|
+
def self.new(tax_exempt:, tax_provider: :taxjar); end
|
590
571
|
|
591
572
|
sig { override.returns({tax_exempt: T::Boolean, tax_provider: Symbol}) }
|
592
|
-
def to_hash
|
593
|
-
end
|
573
|
+
def to_hash; end
|
594
574
|
end
|
595
575
|
|
596
576
|
sig do
|
@@ -599,8 +579,7 @@ module Orb
|
|
599
579
|
[Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration]
|
600
580
|
)
|
601
581
|
end
|
602
|
-
def self.variants
|
603
|
-
end
|
582
|
+
def self.variants; end
|
604
583
|
end
|
605
584
|
|
606
585
|
class TaxID < Orb::Internal::Type::BaseModel
|
@@ -614,110 +593,110 @@ module Orb
|
|
614
593
|
attr_accessor :value
|
615
594
|
|
616
595
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
617
|
-
#
|
596
|
+
# added to the headers of invoices.
|
618
597
|
#
|
619
|
-
#
|
598
|
+
# ### Supported Tax ID Countries and Types
|
620
599
|
#
|
621
|
-
#
|
622
|
-
#
|
623
|
-
#
|
624
|
-
#
|
625
|
-
#
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
635
|
-
#
|
636
|
-
#
|
637
|
-
#
|
638
|
-
#
|
639
|
-
#
|
640
|
-
#
|
641
|
-
#
|
642
|
-
#
|
643
|
-
#
|
644
|
-
#
|
645
|
-
#
|
646
|
-
#
|
647
|
-
#
|
648
|
-
#
|
649
|
-
#
|
650
|
-
#
|
651
|
-
#
|
652
|
-
#
|
653
|
-
#
|
654
|
-
#
|
655
|
-
#
|
656
|
-
#
|
657
|
-
#
|
658
|
-
#
|
659
|
-
#
|
660
|
-
#
|
661
|
-
#
|
662
|
-
#
|
663
|
-
#
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
#
|
669
|
-
#
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
#
|
683
|
-
#
|
684
|
-
#
|
685
|
-
#
|
686
|
-
#
|
687
|
-
#
|
688
|
-
#
|
689
|
-
#
|
690
|
-
#
|
691
|
-
#
|
692
|
-
#
|
693
|
-
#
|
694
|
-
#
|
695
|
-
#
|
696
|
-
#
|
697
|
-
#
|
698
|
-
#
|
699
|
-
#
|
700
|
-
#
|
701
|
-
#
|
702
|
-
#
|
703
|
-
#
|
704
|
-
#
|
705
|
-
#
|
706
|
-
#
|
707
|
-
#
|
708
|
-
#
|
709
|
-
#
|
710
|
-
#
|
711
|
-
#
|
712
|
-
#
|
713
|
-
#
|
714
|
-
#
|
715
|
-
#
|
716
|
-
#
|
717
|
-
#
|
718
|
-
#
|
719
|
-
#
|
720
|
-
#
|
600
|
+
# | Country | Type | Description |
|
601
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
602
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
603
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
604
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
605
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
606
|
+
# | Austria | `eu_vat` | European VAT Number |
|
607
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
608
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
609
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
610
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
611
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
612
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
613
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
614
|
+
# | Canada | `ca_bn` | Canadian BN |
|
615
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
616
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
617
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
618
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
619
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
620
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
621
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
622
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
623
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
624
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
625
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
626
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
627
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
628
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
629
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
630
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
631
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
632
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
633
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
634
|
+
# | Finland | `eu_vat` | European VAT Number |
|
635
|
+
# | France | `eu_vat` | European VAT Number |
|
636
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
637
|
+
# | Germany | `eu_vat` | European VAT Number |
|
638
|
+
# | Greece | `eu_vat` | European VAT Number |
|
639
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
640
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
641
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
642
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
643
|
+
# | India | `in_gst` | Indian GST Number |
|
644
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
645
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
646
|
+
# | Israel | `il_vat` | Israel VAT |
|
647
|
+
# | Italy | `eu_vat` | European VAT Number |
|
648
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
649
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
650
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
651
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
652
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
653
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
654
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
655
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
656
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
657
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
658
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
659
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
660
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
661
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
662
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
663
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
664
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
665
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
666
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
667
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
668
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
669
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
670
|
+
# | Poland | `eu_vat` | European VAT Number |
|
671
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
672
|
+
# | Romania | `eu_vat` | European VAT Number |
|
673
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
674
|
+
# | Russia | `ru_inn` | Russian INN |
|
675
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
676
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
677
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
678
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
679
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
680
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
681
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
682
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
683
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
684
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
685
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
686
|
+
# | Spain | `eu_vat` | European VAT Number |
|
687
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
688
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
689
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
690
|
+
# | Thailand | `th_vat` | Thai VAT |
|
691
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
692
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
693
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
694
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
695
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
696
|
+
# | United States | `us_ein` | United States EIN |
|
697
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
698
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
699
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
721
700
|
sig do
|
722
701
|
params(
|
723
702
|
country: Orb::Models::CustomerUpdateParams::TaxID::Country::OrSymbol,
|
@@ -726,8 +705,7 @@ module Orb
|
|
726
705
|
)
|
727
706
|
.returns(T.attached_class)
|
728
707
|
end
|
729
|
-
def self.new(country:, type:, value:)
|
730
|
-
end
|
708
|
+
def self.new(country:, type:, value:); end
|
731
709
|
|
732
710
|
sig do
|
733
711
|
override
|
@@ -739,8 +717,7 @@ module Orb
|
|
739
717
|
}
|
740
718
|
)
|
741
719
|
end
|
742
|
-
def to_hash
|
743
|
-
end
|
720
|
+
def to_hash; end
|
744
721
|
|
745
722
|
module Country
|
746
723
|
extend Orb::Internal::Type::Enum
|
@@ -829,8 +806,7 @@ module Orb
|
|
829
806
|
ZA = T.let(:ZA, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol)
|
830
807
|
|
831
808
|
sig { override.returns(T::Array[Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol]) }
|
832
|
-
def self.values
|
833
|
-
end
|
809
|
+
def self.values; end
|
834
810
|
end
|
835
811
|
|
836
812
|
module Type
|
@@ -913,8 +889,7 @@ module Orb
|
|
913
889
|
ZA_VAT = T.let(:za_vat, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol)
|
914
890
|
|
915
891
|
sig { override.returns(T::Array[Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol]) }
|
916
|
-
def self.values
|
917
|
-
end
|
892
|
+
def self.values; end
|
918
893
|
end
|
919
894
|
end
|
920
895
|
end
|