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
data/lib/orb/models/customer.rb
CHANGED
@@ -242,78 +242,79 @@ module Orb
|
|
242
242
|
# @return [Orb::Models::Customer::ReportingConfiguration, nil]
|
243
243
|
optional :reporting_configuration, -> { Orb::Models::Customer::ReportingConfiguration }, nil?: true
|
244
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
|
-
#
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
#
|
287
|
-
#
|
288
|
-
#
|
289
|
-
#
|
290
|
-
#
|
291
|
-
#
|
292
|
-
#
|
293
|
-
#
|
294
|
-
#
|
295
|
-
#
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
300
|
-
#
|
301
|
-
#
|
302
|
-
#
|
303
|
-
#
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
|
316
|
-
#
|
245
|
+
# @!method initialize(id:, additional_emails:, auto_collection:, balance:, billing_address:, created_at:, currency:, email:, email_delivery:, exempt_from_automated_tax:, external_customer_id:, hierarchy:, metadata:, name:, payment_provider:, payment_provider_id:, portal_url:, shipping_address:, tax_id:, timezone:, accounting_sync_configuration: nil, reporting_configuration: nil)
|
246
|
+
# Some parameter documentations has been truncated, see {Orb::Models::Customer}
|
247
|
+
# for more details.
|
248
|
+
#
|
249
|
+
# A customer is a buyer of your products, and the other party to the billing
|
250
|
+
# relationship.
|
251
|
+
#
|
252
|
+
# In Orb, customers are assigned system generated identifiers automatically, but
|
253
|
+
# it's often desirable to have these match existing identifiers in your system. To
|
254
|
+
# avoid having to denormalize Orb ID information, you can pass in an
|
255
|
+
# `external_customer_id` with your own identifier. See
|
256
|
+
# [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
257
|
+
# information about how these aliases work in Orb.
|
258
|
+
#
|
259
|
+
# In addition to having an identifier in your system, a customer may exist in a
|
260
|
+
# payment provider solution like Stripe. Use the `payment_provider_id` and the
|
261
|
+
# `payment_provider` enum field to express this mapping.
|
262
|
+
#
|
263
|
+
# A customer also has a timezone (from the standard
|
264
|
+
# [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
265
|
+
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
266
|
+
# information on what this timezone parameter influences within Orb.
|
267
|
+
#
|
268
|
+
# @param id [String]
|
269
|
+
#
|
270
|
+
# @param additional_emails [Array<String>]
|
271
|
+
#
|
272
|
+
# @param auto_collection [Boolean]
|
273
|
+
#
|
274
|
+
# @param balance [String] The customer's current balance in their currency.
|
275
|
+
#
|
276
|
+
# @param billing_address [Orb::Models::Customer::BillingAddress, nil]
|
277
|
+
#
|
278
|
+
# @param created_at [Time]
|
279
|
+
#
|
280
|
+
# @param currency [String, nil]
|
281
|
+
#
|
282
|
+
# @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment
|
283
|
+
# ...
|
284
|
+
#
|
285
|
+
# @param email_delivery [Boolean]
|
286
|
+
#
|
287
|
+
# @param exempt_from_automated_tax [Boolean, nil]
|
288
|
+
#
|
289
|
+
# @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
|
290
|
+
# ...
|
291
|
+
#
|
292
|
+
# @param hierarchy [Orb::Models::Customer::Hierarchy] The hierarchical relationships for this customer.
|
293
|
+
#
|
294
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
295
|
+
# ...
|
296
|
+
#
|
297
|
+
# @param name [String] The full name of the customer
|
298
|
+
#
|
299
|
+
# @param payment_provider [Symbol, Orb::Models::Customer::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
300
|
+
# ...
|
301
|
+
#
|
302
|
+
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
303
|
+
# ...
|
304
|
+
#
|
305
|
+
# @param portal_url [String, nil]
|
306
|
+
#
|
307
|
+
# @param shipping_address [Orb::Models::Customer::ShippingAddress, nil]
|
308
|
+
#
|
309
|
+
# @param tax_id [Orb::Models::Customer::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
310
|
+
# ...
|
311
|
+
#
|
312
|
+
# @param timezone [String] A timezone identifier from the IANA timezone database, such as "America/Los_Ange
|
313
|
+
# ...
|
314
|
+
#
|
315
|
+
# @param accounting_sync_configuration [Orb::Models::Customer::AccountingSyncConfiguration, nil]
|
316
|
+
#
|
317
|
+
# @param reporting_configuration [Orb::Models::Customer::ReportingConfiguration, nil]
|
317
318
|
|
318
319
|
# @see Orb::Models::Customer#billing_address
|
319
320
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
@@ -347,17 +348,13 @@ module Orb
|
|
347
348
|
# @return [String, nil]
|
348
349
|
required :state, String, nil?: true
|
349
350
|
|
350
|
-
# @!
|
351
|
-
#
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
# #
|
358
|
-
# def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super
|
359
|
-
|
360
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
351
|
+
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
352
|
+
# @param city [String, nil]
|
353
|
+
# @param country [String, nil]
|
354
|
+
# @param line1 [String, nil]
|
355
|
+
# @param line2 [String, nil]
|
356
|
+
# @param postal_code [String, nil]
|
357
|
+
# @param state [String, nil]
|
361
358
|
end
|
362
359
|
|
363
360
|
# @see Orb::Models::Customer#hierarchy
|
@@ -372,15 +369,11 @@ module Orb
|
|
372
369
|
# @return [Orb::Models::Customer::Hierarchy::Parent, nil]
|
373
370
|
required :parent, -> { Orb::Models::Customer::Hierarchy::Parent }, nil?: true
|
374
371
|
|
375
|
-
# @!
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
# #
|
381
|
-
# def initialize(children:, parent:, **) = super
|
382
|
-
|
383
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
372
|
+
# @!method initialize(children:, parent:)
|
373
|
+
# The hierarchical relationships for this customer.
|
374
|
+
#
|
375
|
+
# @param children [Array<Orb::Models::Customer::Hierarchy::Child>]
|
376
|
+
# @param parent [Orb::Models::Customer::Hierarchy::Parent, nil]
|
384
377
|
|
385
378
|
class Child < Orb::Internal::Type::BaseModel
|
386
379
|
# @!attribute id
|
@@ -393,13 +386,9 @@ module Orb
|
|
393
386
|
# @return [String, nil]
|
394
387
|
required :external_customer_id, String, nil?: true
|
395
388
|
|
396
|
-
# @!
|
397
|
-
#
|
398
|
-
#
|
399
|
-
# #
|
400
|
-
# def initialize(id:, external_customer_id:, **) = super
|
401
|
-
|
402
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
389
|
+
# @!method initialize(id:, external_customer_id:)
|
390
|
+
# @param id [String]
|
391
|
+
# @param external_customer_id [String, nil]
|
403
392
|
end
|
404
393
|
|
405
394
|
# @see Orb::Models::Customer::Hierarchy#parent
|
@@ -414,13 +403,9 @@ module Orb
|
|
414
403
|
# @return [String, nil]
|
415
404
|
required :external_customer_id, String, nil?: true
|
416
405
|
|
417
|
-
# @!
|
418
|
-
#
|
419
|
-
#
|
420
|
-
# #
|
421
|
-
# def initialize(id:, external_customer_id:, **) = super
|
422
|
-
|
423
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
406
|
+
# @!method initialize(id:, external_customer_id:)
|
407
|
+
# @param id [String]
|
408
|
+
# @param external_customer_id [String, nil]
|
424
409
|
end
|
425
410
|
end
|
426
411
|
|
@@ -438,11 +423,8 @@ module Orb
|
|
438
423
|
STRIPE_INVOICE = :stripe_invoice
|
439
424
|
NETSUITE = :netsuite
|
440
425
|
|
441
|
-
|
442
|
-
|
443
|
-
# @!parse
|
444
|
-
# # @return [Array<Symbol>]
|
445
|
-
# def self.values; end
|
426
|
+
# @!method self.values
|
427
|
+
# @return [Array<Symbol>]
|
446
428
|
end
|
447
429
|
|
448
430
|
# @see Orb::Models::Customer#shipping_address
|
@@ -477,17 +459,13 @@ module Orb
|
|
477
459
|
# @return [String, nil]
|
478
460
|
required :state, String, nil?: true
|
479
461
|
|
480
|
-
# @!
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
# #
|
488
|
-
# def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super
|
489
|
-
|
490
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
462
|
+
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
463
|
+
# @param city [String, nil]
|
464
|
+
# @param country [String, nil]
|
465
|
+
# @param line1 [String, nil]
|
466
|
+
# @param line2 [String, nil]
|
467
|
+
# @param postal_code [String, nil]
|
468
|
+
# @param state [String, nil]
|
491
469
|
end
|
492
470
|
|
493
471
|
# @see Orb::Models::Customer#tax_id
|
@@ -507,120 +485,116 @@ module Orb
|
|
507
485
|
# @return [String]
|
508
486
|
required :value, String
|
509
487
|
|
510
|
-
# @!
|
511
|
-
#
|
512
|
-
#
|
513
|
-
#
|
514
|
-
#
|
515
|
-
#
|
516
|
-
#
|
517
|
-
#
|
518
|
-
#
|
519
|
-
#
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
535
|
-
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
#
|
546
|
-
#
|
547
|
-
#
|
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
|
-
# def initialize(country:, type:, value:, **) = super
|
622
|
-
|
623
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
488
|
+
# @!method initialize(country:, type:, value:)
|
489
|
+
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
490
|
+
# added to the headers of invoices.
|
491
|
+
#
|
492
|
+
# ### Supported Tax ID Countries and Types
|
493
|
+
#
|
494
|
+
# | Country | Type | Description |
|
495
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
496
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
497
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
498
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
499
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
500
|
+
# | Austria | `eu_vat` | European VAT Number |
|
501
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
502
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
503
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
504
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
505
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
506
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
507
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
508
|
+
# | Canada | `ca_bn` | Canadian BN |
|
509
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
510
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
511
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
512
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
513
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
514
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
515
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
516
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
517
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
518
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
519
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
520
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
521
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
522
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
523
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
524
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
525
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
526
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
527
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
528
|
+
# | Finland | `eu_vat` | European VAT Number |
|
529
|
+
# | France | `eu_vat` | European VAT Number |
|
530
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
531
|
+
# | Germany | `eu_vat` | European VAT Number |
|
532
|
+
# | Greece | `eu_vat` | European VAT Number |
|
533
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
534
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
535
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
536
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
537
|
+
# | India | `in_gst` | Indian GST Number |
|
538
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
539
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
540
|
+
# | Israel | `il_vat` | Israel VAT |
|
541
|
+
# | Italy | `eu_vat` | European VAT Number |
|
542
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
543
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
544
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
545
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
546
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
547
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
548
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
549
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
550
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
551
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
552
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
553
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
554
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
555
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
556
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
557
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
558
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
559
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
560
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
561
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
562
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
563
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
564
|
+
# | Poland | `eu_vat` | European VAT Number |
|
565
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
566
|
+
# | Romania | `eu_vat` | European VAT Number |
|
567
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
568
|
+
# | Russia | `ru_inn` | Russian INN |
|
569
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
570
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
571
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
572
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
573
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
574
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
575
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
576
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
577
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
578
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
579
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
580
|
+
# | Spain | `eu_vat` | European VAT Number |
|
581
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
582
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
583
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
584
|
+
# | Thailand | `th_vat` | Thai VAT |
|
585
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
586
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
587
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
588
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
589
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
590
|
+
# | United States | `us_ein` | United States EIN |
|
591
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
592
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
593
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
594
|
+
#
|
595
|
+
# @param country [Symbol, Orb::Models::Customer::TaxID::Country]
|
596
|
+
# @param type [Symbol, Orb::Models::Customer::TaxID::Type]
|
597
|
+
# @param value [String]
|
624
598
|
|
625
599
|
# @see Orb::Models::Customer::TaxID#country
|
626
600
|
module Country
|
@@ -705,11 +679,8 @@ module Orb
|
|
705
679
|
VN = :VN
|
706
680
|
ZA = :ZA
|
707
681
|
|
708
|
-
|
709
|
-
|
710
|
-
# @!parse
|
711
|
-
# # @return [Array<Symbol>]
|
712
|
-
# def self.values; end
|
682
|
+
# @!method self.values
|
683
|
+
# @return [Array<Symbol>]
|
713
684
|
end
|
714
685
|
|
715
686
|
# @see Orb::Models::Customer::TaxID#type
|
@@ -788,11 +759,8 @@ module Orb
|
|
788
759
|
VN_TIN = :vn_tin
|
789
760
|
ZA_VAT = :za_vat
|
790
761
|
|
791
|
-
|
792
|
-
|
793
|
-
# @!parse
|
794
|
-
# # @return [Array<Symbol>]
|
795
|
-
# def self.values; end
|
762
|
+
# @!method self.values
|
763
|
+
# @return [Array<Symbol>]
|
796
764
|
end
|
797
765
|
end
|
798
766
|
|
@@ -809,13 +777,9 @@ module Orb
|
|
809
777
|
# @return [Boolean]
|
810
778
|
required :excluded, Orb::Internal::Type::Boolean
|
811
779
|
|
812
|
-
# @!
|
813
|
-
#
|
814
|
-
#
|
815
|
-
# #
|
816
|
-
# def initialize(accounting_providers:, excluded:, **) = super
|
817
|
-
|
818
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
780
|
+
# @!method initialize(accounting_providers:, excluded:)
|
781
|
+
# @param accounting_providers [Array<Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider>]
|
782
|
+
# @param excluded [Boolean]
|
819
783
|
|
820
784
|
class AccountingProvider < Orb::Internal::Type::BaseModel
|
821
785
|
# @!attribute external_provider_id
|
@@ -829,13 +793,9 @@ module Orb
|
|
829
793
|
required :provider_type,
|
830
794
|
enum: -> { Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType }
|
831
795
|
|
832
|
-
# @!
|
833
|
-
#
|
834
|
-
#
|
835
|
-
# #
|
836
|
-
# def initialize(external_provider_id:, provider_type:, **) = super
|
837
|
-
|
838
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
796
|
+
# @!method initialize(external_provider_id:, provider_type:)
|
797
|
+
# @param external_provider_id [String, nil]
|
798
|
+
# @param provider_type [Symbol, Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
|
839
799
|
|
840
800
|
# @see Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider#provider_type
|
841
801
|
module ProviderType
|
@@ -844,11 +804,8 @@ module Orb
|
|
844
804
|
QUICKBOOKS = :quickbooks
|
845
805
|
NETSUITE = :netsuite
|
846
806
|
|
847
|
-
|
848
|
-
|
849
|
-
# @!parse
|
850
|
-
# # @return [Array<Symbol>]
|
851
|
-
# def self.values; end
|
807
|
+
# @!method self.values
|
808
|
+
# @return [Array<Symbol>]
|
852
809
|
end
|
853
810
|
end
|
854
811
|
end
|
@@ -860,12 +817,8 @@ module Orb
|
|
860
817
|
# @return [Boolean]
|
861
818
|
required :exempt, Orb::Internal::Type::Boolean
|
862
819
|
|
863
|
-
# @!
|
864
|
-
#
|
865
|
-
# #
|
866
|
-
# def initialize(exempt:, **) = super
|
867
|
-
|
868
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
820
|
+
# @!method initialize(exempt:)
|
821
|
+
# @param exempt [Boolean]
|
869
822
|
end
|
870
823
|
end
|
871
824
|
end
|