orb-billing 0.2.0 → 0.3.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 +34 -0
- data/README.md +59 -49
- data/lib/orb/client.rb +4 -4
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +4 -8
- data/lib/orb/internal/transport/base_client.rb +7 -7
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +32 -14
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +4 -0
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +9 -5
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +4 -0
- data/lib/orb/internal/util.rb +69 -61
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +24 -29
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +211 -252
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +589 -637
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +2709 -3820
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +341 -377
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +108 -28
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +135 -36
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/lib/orb/client.rbi +4 -4
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +17 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/base_model.rbi +7 -1
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/enum.rbi +3 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +5 -2
- data/rbi/lib/orb/internal/type/hash_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/union.rbi +3 -0
- data/rbi/lib/orb/internal/util.rbi +24 -19
- data/rbi/lib/orb/internal.rbi +0 -1
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +14 -12
- metadata +8 -5
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Customers#update
|
6
6
|
class CustomerUpdateParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute accounting_sync_configuration
|
@@ -226,51 +225,53 @@ module Orb
|
|
226
225
|
# @return [Orb::Models::CustomerUpdateParams::TaxID, nil]
|
227
226
|
optional :tax_id, -> { Orb::Models::CustomerUpdateParams::TaxID }, nil?: true
|
228
227
|
|
229
|
-
# @!
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
255
|
-
#
|
256
|
-
#
|
257
|
-
#
|
258
|
-
#
|
259
|
-
#
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
266
|
-
#
|
267
|
-
#
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
|
273
|
-
#
|
228
|
+
# @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
|
229
|
+
# Some parameter documentations has been truncated, see
|
230
|
+
# {Orb::Models::CustomerUpdateParams} for more details.
|
231
|
+
#
|
232
|
+
# @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
|
233
|
+
#
|
234
|
+
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
235
|
+
# ...
|
236
|
+
#
|
237
|
+
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
238
|
+
# ...
|
239
|
+
#
|
240
|
+
# @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
|
241
|
+
#
|
242
|
+
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
243
|
+
# ...
|
244
|
+
#
|
245
|
+
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
246
|
+
#
|
247
|
+
# @param email_delivery [Boolean, nil]
|
248
|
+
#
|
249
|
+
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
|
250
|
+
# ...
|
251
|
+
#
|
252
|
+
# @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
253
|
+
#
|
254
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
255
|
+
# ...
|
256
|
+
#
|
257
|
+
# @param name [String, nil] The full name of the customer
|
258
|
+
#
|
259
|
+
# @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
260
|
+
# ...
|
261
|
+
#
|
262
|
+
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
263
|
+
# ...
|
264
|
+
#
|
265
|
+
# @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
|
266
|
+
#
|
267
|
+
# @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
|
268
|
+
#
|
269
|
+
# @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
|
270
|
+
#
|
271
|
+
# @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
272
|
+
# ...
|
273
|
+
#
|
274
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
274
275
|
|
275
276
|
class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
|
276
277
|
# @!attribute accounting_providers
|
@@ -285,13 +286,9 @@ module Orb
|
|
285
286
|
# @return [Boolean, nil]
|
286
287
|
optional :excluded, Orb::Internal::Type::Boolean, nil?: true
|
287
288
|
|
288
|
-
# @!
|
289
|
-
#
|
290
|
-
#
|
291
|
-
# #
|
292
|
-
# def initialize(accounting_providers: nil, excluded: nil, **) = super
|
293
|
-
|
294
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
289
|
+
# @!method initialize(accounting_providers: nil, excluded: nil)
|
290
|
+
# @param accounting_providers [Array<Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
|
291
|
+
# @param excluded [Boolean, nil]
|
295
292
|
|
296
293
|
class AccountingProvider < Orb::Internal::Type::BaseModel
|
297
294
|
# @!attribute external_provider_id
|
@@ -304,13 +301,9 @@ module Orb
|
|
304
301
|
# @return [String]
|
305
302
|
required :provider_type, String
|
306
303
|
|
307
|
-
# @!
|
308
|
-
#
|
309
|
-
#
|
310
|
-
# #
|
311
|
-
# def initialize(external_provider_id:, provider_type:, **) = super
|
312
|
-
|
313
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
304
|
+
# @!method initialize(external_provider_id:, provider_type:)
|
305
|
+
# @param external_provider_id [String]
|
306
|
+
# @param provider_type [String]
|
314
307
|
end
|
315
308
|
end
|
316
309
|
|
@@ -345,31 +338,23 @@ module Orb
|
|
345
338
|
# @return [String, nil]
|
346
339
|
optional :state, String, nil?: true
|
347
340
|
|
348
|
-
# @!
|
349
|
-
#
|
350
|
-
#
|
351
|
-
#
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
355
|
-
# #
|
356
|
-
# def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super
|
357
|
-
|
358
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
341
|
+
# @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
342
|
+
# @param city [String, nil]
|
343
|
+
# @param country [String, nil]
|
344
|
+
# @param line1 [String, nil]
|
345
|
+
# @param line2 [String, nil]
|
346
|
+
# @param postal_code [String, nil]
|
347
|
+
# @param state [String, nil]
|
359
348
|
end
|
360
349
|
|
361
350
|
class Hierarchy < Orb::Internal::Type::BaseModel
|
362
|
-
# @!attribute
|
351
|
+
# @!attribute child_customer_ids
|
363
352
|
# A list of child customer IDs to add to the hierarchy. The desired child
|
364
353
|
# customers must not already be part of another hierarchy.
|
365
354
|
#
|
366
355
|
# @return [Array<String>, nil]
|
367
356
|
optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String]
|
368
357
|
|
369
|
-
# @!parse
|
370
|
-
# # @return [Array<String>]
|
371
|
-
# attr_writer :child_customer_ids
|
372
|
-
|
373
358
|
# @!attribute parent_customer_id
|
374
359
|
# The ID of the parent customer in the hierarchy. The desired parent customer must
|
375
360
|
# not be a child of another customer.
|
@@ -377,15 +362,17 @@ module Orb
|
|
377
362
|
# @return [String, nil]
|
378
363
|
optional :parent_customer_id, String, nil?: true
|
379
364
|
|
380
|
-
# @!
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
|
388
|
-
#
|
365
|
+
# @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
|
366
|
+
# Some parameter documentations has been truncated, see
|
367
|
+
# {Orb::Models::CustomerUpdateParams::Hierarchy} for more details.
|
368
|
+
#
|
369
|
+
# The hierarchical relationships for this customer.
|
370
|
+
#
|
371
|
+
# @param child_customer_ids [Array<String>] A list of child customer IDs to add to the hierarchy. The desired child customer
|
372
|
+
# ...
|
373
|
+
#
|
374
|
+
# @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must
|
375
|
+
# ...
|
389
376
|
end
|
390
377
|
|
391
378
|
# This is used for creating charges or invoices in an external system via Orb.
|
@@ -404,11 +391,8 @@ module Orb
|
|
404
391
|
STRIPE_INVOICE = :stripe_invoice
|
405
392
|
NETSUITE = :netsuite
|
406
393
|
|
407
|
-
|
408
|
-
|
409
|
-
# @!parse
|
410
|
-
# # @return [Array<Symbol>]
|
411
|
-
# def self.values; end
|
394
|
+
# @!method self.values
|
395
|
+
# @return [Array<Symbol>]
|
412
396
|
end
|
413
397
|
|
414
398
|
class ReportingConfiguration < Orb::Internal::Type::BaseModel
|
@@ -417,12 +401,8 @@ module Orb
|
|
417
401
|
# @return [Boolean]
|
418
402
|
required :exempt, Orb::Internal::Type::Boolean
|
419
403
|
|
420
|
-
# @!
|
421
|
-
#
|
422
|
-
# #
|
423
|
-
# def initialize(exempt:, **) = super
|
424
|
-
|
425
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
404
|
+
# @!method initialize(exempt:)
|
405
|
+
# @param exempt [Boolean]
|
426
406
|
end
|
427
407
|
|
428
408
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
@@ -456,17 +436,13 @@ module Orb
|
|
456
436
|
# @return [String, nil]
|
457
437
|
optional :state, String, nil?: true
|
458
438
|
|
459
|
-
# @!
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
# #
|
467
|
-
# def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super
|
468
|
-
|
469
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
439
|
+
# @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
440
|
+
# @param city [String, nil]
|
441
|
+
# @param country [String, nil]
|
442
|
+
# @param line1 [String, nil]
|
443
|
+
# @param line2 [String, nil]
|
444
|
+
# @param postal_code [String, nil]
|
445
|
+
# @param state [String, nil]
|
470
446
|
end
|
471
447
|
|
472
448
|
module TaxConfiguration
|
@@ -494,14 +470,10 @@ module Orb
|
|
494
470
|
# @return [String, nil]
|
495
471
|
optional :tax_exemption_code, String, nil?: true
|
496
472
|
|
497
|
-
# @!
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
501
|
-
# #
|
502
|
-
# def initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara, **) = super
|
503
|
-
|
504
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
473
|
+
# @!method initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara)
|
474
|
+
# @param tax_exempt [Boolean]
|
475
|
+
# @param tax_exemption_code [String, nil]
|
476
|
+
# @param tax_provider [Symbol, :avalara]
|
505
477
|
end
|
506
478
|
|
507
479
|
class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel
|
@@ -515,18 +487,13 @@ module Orb
|
|
515
487
|
# @return [Symbol, :taxjar]
|
516
488
|
required :tax_provider, const: :taxjar
|
517
489
|
|
518
|
-
# @!
|
519
|
-
#
|
520
|
-
#
|
521
|
-
# #
|
522
|
-
# def initialize(tax_exempt:, tax_provider: :taxjar, **) = super
|
523
|
-
|
524
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
490
|
+
# @!method initialize(tax_exempt:, tax_provider: :taxjar)
|
491
|
+
# @param tax_exempt [Boolean]
|
492
|
+
# @param tax_provider [Symbol, :taxjar]
|
525
493
|
end
|
526
494
|
|
527
|
-
# @!
|
528
|
-
#
|
529
|
-
# def self.variants; end
|
495
|
+
# @!method self.variants
|
496
|
+
# @return [Array(Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration)]
|
530
497
|
end
|
531
498
|
|
532
499
|
class TaxID < Orb::Internal::Type::BaseModel
|
@@ -545,120 +512,116 @@ module Orb
|
|
545
512
|
# @return [String]
|
546
513
|
required :value, String
|
547
514
|
|
548
|
-
# @!
|
549
|
-
#
|
550
|
-
#
|
551
|
-
#
|
552
|
-
#
|
553
|
-
#
|
554
|
-
#
|
555
|
-
#
|
556
|
-
#
|
557
|
-
#
|
558
|
-
#
|
559
|
-
#
|
560
|
-
#
|
561
|
-
#
|
562
|
-
#
|
563
|
-
#
|
564
|
-
#
|
565
|
-
#
|
566
|
-
#
|
567
|
-
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
571
|
-
#
|
572
|
-
#
|
573
|
-
#
|
574
|
-
#
|
575
|
-
#
|
576
|
-
#
|
577
|
-
#
|
578
|
-
#
|
579
|
-
#
|
580
|
-
#
|
581
|
-
#
|
582
|
-
#
|
583
|
-
#
|
584
|
-
#
|
585
|
-
#
|
586
|
-
#
|
587
|
-
#
|
588
|
-
#
|
589
|
-
#
|
590
|
-
#
|
591
|
-
#
|
592
|
-
#
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
#
|
617
|
-
#
|
618
|
-
#
|
619
|
-
#
|
620
|
-
#
|
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
|
-
# def initialize(country:, type:, value:, **) = super
|
660
|
-
|
661
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
515
|
+
# @!method initialize(country:, type:, value:)
|
516
|
+
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
517
|
+
# added to the headers of invoices.
|
518
|
+
#
|
519
|
+
# ### Supported Tax ID Countries and Types
|
520
|
+
#
|
521
|
+
# | Country | Type | Description |
|
522
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
523
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
524
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
525
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
526
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
527
|
+
# | Austria | `eu_vat` | European VAT Number |
|
528
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
529
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
530
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
531
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
532
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
533
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
534
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
535
|
+
# | Canada | `ca_bn` | Canadian BN |
|
536
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
537
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
538
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
539
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
540
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
541
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
542
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
543
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
544
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
545
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
546
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
547
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
548
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
549
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
550
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
551
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
552
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
553
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
554
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
555
|
+
# | Finland | `eu_vat` | European VAT Number |
|
556
|
+
# | France | `eu_vat` | European VAT Number |
|
557
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
558
|
+
# | Germany | `eu_vat` | European VAT Number |
|
559
|
+
# | Greece | `eu_vat` | European VAT Number |
|
560
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
561
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
562
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
563
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
564
|
+
# | India | `in_gst` | Indian GST Number |
|
565
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
566
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
567
|
+
# | Israel | `il_vat` | Israel VAT |
|
568
|
+
# | Italy | `eu_vat` | European VAT Number |
|
569
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
570
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
571
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
572
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
573
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
574
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
575
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
576
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
577
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
578
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
579
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
580
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
581
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
582
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
583
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
584
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
585
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
586
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
587
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
588
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
589
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
590
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
591
|
+
# | Poland | `eu_vat` | European VAT Number |
|
592
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
593
|
+
# | Romania | `eu_vat` | European VAT Number |
|
594
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
595
|
+
# | Russia | `ru_inn` | Russian INN |
|
596
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
597
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
598
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
599
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
600
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
601
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
602
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
603
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
604
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
605
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
606
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
607
|
+
# | Spain | `eu_vat` | European VAT Number |
|
608
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
609
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
610
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
611
|
+
# | Thailand | `th_vat` | Thai VAT |
|
612
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
613
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
614
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
615
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
616
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
617
|
+
# | United States | `us_ein` | United States EIN |
|
618
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
619
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
620
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
621
|
+
#
|
622
|
+
# @param country [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country]
|
623
|
+
# @param type [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type]
|
624
|
+
# @param value [String]
|
662
625
|
|
663
626
|
# @see Orb::Models::CustomerUpdateParams::TaxID#country
|
664
627
|
module Country
|
@@ -743,11 +706,8 @@ module Orb
|
|
743
706
|
VN = :VN
|
744
707
|
ZA = :ZA
|
745
708
|
|
746
|
-
|
747
|
-
|
748
|
-
# @!parse
|
749
|
-
# # @return [Array<Symbol>]
|
750
|
-
# def self.values; end
|
709
|
+
# @!method self.values
|
710
|
+
# @return [Array<Symbol>]
|
751
711
|
end
|
752
712
|
|
753
713
|
# @see Orb::Models::CustomerUpdateParams::TaxID#type
|
@@ -826,11 +786,8 @@ module Orb
|
|
826
786
|
VN_TIN = :vn_tin
|
827
787
|
ZA_VAT = :za_vat
|
828
788
|
|
829
|
-
|
830
|
-
|
831
|
-
# @!parse
|
832
|
-
# # @return [Array<Symbol>]
|
833
|
-
# def self.values; end
|
789
|
+
# @!method self.values
|
790
|
+
# @return [Array<Symbol>]
|
834
791
|
end
|
835
792
|
end
|
836
793
|
end
|