orb-billing 0.2.0 → 0.3.1
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 +67 -0
- data/README.md +63 -53
- data/lib/orb/client.rb +4 -4
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +7 -11
- data/lib/orb/internal/transport/base_client.rb +10 -10
- 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 +33 -23
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +14 -11
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +19 -16
- 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 +3 -10
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +14 -11
- data/lib/orb/internal/util.rb +88 -64
- 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 +29 -34
- 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 +216 -257
- 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 +212 -257
- data/lib/orb/models/customer_update_params.rb +212 -255
- 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 +23 -27
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +23 -27
- 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 +384 -491
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
- 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 +384 -494
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
- 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 +619 -681
- 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 +618 -669
- 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 +281 -306
- 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 +259 -291
- data/lib/orb/models/plan_create_params.rb +2070 -2466
- 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 +3842 -5005
- 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 +360 -405
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +358 -399
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +384 -418
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
- data/lib/orb/models/subscription_create_params.rb +4735 -5417
- data/lib/orb/models/subscription_create_response.rb +358 -399
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
- 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 +2560 -3040
- data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
- 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 +362 -396
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
- 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 +360 -399
- 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/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -6
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +26 -8
- 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 +112 -32
- 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 +138 -39
- 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 +9 -3
- data/lib/orb/resources/prices.rb +101 -26
- 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 → orb}/client.rbi +4 -4
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/orb/file_part.rbi +34 -0
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
- data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
- data/rbi/{lib/orb → orb}/internal.rbi +0 -1
- data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
- data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- 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 +16 -12
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +230 -224
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Customers#update_by_external_id
|
6
6
|
class CustomerUpdateByExternalIDParams < 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
|
@@ -119,7 +118,7 @@ module Orb
|
|
119
118
|
|
120
119
|
# @!attribute tax_configuration
|
121
120
|
#
|
122
|
-
# @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::
|
121
|
+
# @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
|
123
122
|
optional :tax_configuration,
|
124
123
|
union: -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration },
|
125
124
|
nil?: true
|
@@ -234,51 +233,53 @@ module Orb
|
|
234
233
|
# @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil]
|
235
234
|
optional :tax_id, -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxID }, nil?: true
|
236
235
|
|
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
|
-
#
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
|
281
|
-
#
|
236
|
+
# @!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: {})
|
237
|
+
# Some parameter documentations has been truncated, see
|
238
|
+
# {Orb::Models::CustomerUpdateByExternalIDParams} for more details.
|
239
|
+
#
|
240
|
+
# @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
|
241
|
+
#
|
242
|
+
# @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
|
243
|
+
# ...
|
244
|
+
#
|
245
|
+
# @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
|
246
|
+
# ...
|
247
|
+
#
|
248
|
+
# @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
|
249
|
+
#
|
250
|
+
# @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
|
251
|
+
# ...
|
252
|
+
#
|
253
|
+
# @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
|
254
|
+
#
|
255
|
+
# @param email_delivery [Boolean, nil]
|
256
|
+
#
|
257
|
+
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
|
258
|
+
# ...
|
259
|
+
#
|
260
|
+
# @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
|
261
|
+
#
|
262
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
263
|
+
# ...
|
264
|
+
#
|
265
|
+
# @param name [String, nil] The full name of the customer
|
266
|
+
#
|
267
|
+
# @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
|
268
|
+
# ...
|
269
|
+
#
|
270
|
+
# @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
|
271
|
+
# ...
|
272
|
+
#
|
273
|
+
# @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
|
274
|
+
#
|
275
|
+
# @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
|
276
|
+
#
|
277
|
+
# @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
|
278
|
+
#
|
279
|
+
# @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
280
|
+
# ...
|
281
|
+
#
|
282
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
282
283
|
|
283
284
|
class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
|
284
285
|
# @!attribute accounting_providers
|
@@ -293,13 +294,9 @@ module Orb
|
|
293
294
|
# @return [Boolean, nil]
|
294
295
|
optional :excluded, Orb::Internal::Type::Boolean, nil?: true
|
295
296
|
|
296
|
-
# @!
|
297
|
-
#
|
298
|
-
#
|
299
|
-
# #
|
300
|
-
# def initialize(accounting_providers: nil, excluded: nil, **) = super
|
301
|
-
|
302
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
297
|
+
# @!method initialize(accounting_providers: nil, excluded: nil)
|
298
|
+
# @param accounting_providers [Array<Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
|
299
|
+
# @param excluded [Boolean, nil]
|
303
300
|
|
304
301
|
class AccountingProvider < Orb::Internal::Type::BaseModel
|
305
302
|
# @!attribute external_provider_id
|
@@ -312,13 +309,9 @@ module Orb
|
|
312
309
|
# @return [String]
|
313
310
|
required :provider_type, String
|
314
311
|
|
315
|
-
# @!
|
316
|
-
#
|
317
|
-
#
|
318
|
-
# #
|
319
|
-
# def initialize(external_provider_id:, provider_type:, **) = super
|
320
|
-
|
321
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
312
|
+
# @!method initialize(external_provider_id:, provider_type:)
|
313
|
+
# @param external_provider_id [String]
|
314
|
+
# @param provider_type [String]
|
322
315
|
end
|
323
316
|
end
|
324
317
|
|
@@ -353,31 +346,23 @@ module Orb
|
|
353
346
|
# @return [String, nil]
|
354
347
|
optional :state, String, nil?: true
|
355
348
|
|
356
|
-
# @!
|
357
|
-
#
|
358
|
-
#
|
359
|
-
#
|
360
|
-
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
# #
|
364
|
-
# def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super
|
365
|
-
|
366
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
349
|
+
# @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
350
|
+
# @param city [String, nil]
|
351
|
+
# @param country [String, nil]
|
352
|
+
# @param line1 [String, nil]
|
353
|
+
# @param line2 [String, nil]
|
354
|
+
# @param postal_code [String, nil]
|
355
|
+
# @param state [String, nil]
|
367
356
|
end
|
368
357
|
|
369
358
|
class Hierarchy < Orb::Internal::Type::BaseModel
|
370
|
-
# @!attribute
|
359
|
+
# @!attribute child_customer_ids
|
371
360
|
# A list of child customer IDs to add to the hierarchy. The desired child
|
372
361
|
# customers must not already be part of another hierarchy.
|
373
362
|
#
|
374
363
|
# @return [Array<String>, nil]
|
375
364
|
optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String]
|
376
365
|
|
377
|
-
# @!parse
|
378
|
-
# # @return [Array<String>]
|
379
|
-
# attr_writer :child_customer_ids
|
380
|
-
|
381
366
|
# @!attribute parent_customer_id
|
382
367
|
# The ID of the parent customer in the hierarchy. The desired parent customer must
|
383
368
|
# not be a child of another customer.
|
@@ -385,15 +370,17 @@ module Orb
|
|
385
370
|
# @return [String, nil]
|
386
371
|
optional :parent_customer_id, String, nil?: true
|
387
372
|
|
388
|
-
# @!
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
|
396
|
-
#
|
373
|
+
# @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
|
374
|
+
# Some parameter documentations has been truncated, see
|
375
|
+
# {Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy} for more details.
|
376
|
+
#
|
377
|
+
# The hierarchical relationships for this customer.
|
378
|
+
#
|
379
|
+
# @param child_customer_ids [Array<String>] A list of child customer IDs to add to the hierarchy. The desired child customer
|
380
|
+
# ...
|
381
|
+
#
|
382
|
+
# @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must
|
383
|
+
# ...
|
397
384
|
end
|
398
385
|
|
399
386
|
# This is used for creating charges or invoices in an external system via Orb.
|
@@ -412,11 +399,8 @@ module Orb
|
|
412
399
|
STRIPE_INVOICE = :stripe_invoice
|
413
400
|
NETSUITE = :netsuite
|
414
401
|
|
415
|
-
|
416
|
-
|
417
|
-
# @!parse
|
418
|
-
# # @return [Array<Symbol>]
|
419
|
-
# def self.values; end
|
402
|
+
# @!method self.values
|
403
|
+
# @return [Array<Symbol>]
|
420
404
|
end
|
421
405
|
|
422
406
|
class ReportingConfiguration < Orb::Internal::Type::BaseModel
|
@@ -425,12 +409,8 @@ module Orb
|
|
425
409
|
# @return [Boolean]
|
426
410
|
required :exempt, Orb::Internal::Type::Boolean
|
427
411
|
|
428
|
-
# @!
|
429
|
-
#
|
430
|
-
# #
|
431
|
-
# def initialize(exempt:, **) = super
|
432
|
-
|
433
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
412
|
+
# @!method initialize(exempt:)
|
413
|
+
# @param exempt [Boolean]
|
434
414
|
end
|
435
415
|
|
436
416
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
@@ -464,17 +444,13 @@ module Orb
|
|
464
444
|
# @return [String, nil]
|
465
445
|
optional :state, String, nil?: true
|
466
446
|
|
467
|
-
# @!
|
468
|
-
#
|
469
|
-
#
|
470
|
-
#
|
471
|
-
#
|
472
|
-
#
|
473
|
-
#
|
474
|
-
# #
|
475
|
-
# def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super
|
476
|
-
|
477
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
447
|
+
# @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
|
448
|
+
# @param city [String, nil]
|
449
|
+
# @param country [String, nil]
|
450
|
+
# @param line1 [String, nil]
|
451
|
+
# @param line2 [String, nil]
|
452
|
+
# @param postal_code [String, nil]
|
453
|
+
# @param state [String, nil]
|
478
454
|
end
|
479
455
|
|
480
456
|
module TaxConfiguration
|
@@ -482,13 +458,11 @@ module Orb
|
|
482
458
|
|
483
459
|
discriminator :tax_provider
|
484
460
|
|
485
|
-
variant :avalara,
|
486
|
-
-> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration }
|
461
|
+
variant :avalara, -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara }
|
487
462
|
|
488
|
-
variant :taxjar,
|
489
|
-
-> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration }
|
463
|
+
variant :taxjar, -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar }
|
490
464
|
|
491
|
-
class
|
465
|
+
class Avalara < Orb::Internal::Type::BaseModel
|
492
466
|
# @!attribute tax_exempt
|
493
467
|
#
|
494
468
|
# @return [Boolean]
|
@@ -504,17 +478,13 @@ module Orb
|
|
504
478
|
# @return [String, nil]
|
505
479
|
optional :tax_exemption_code, String, nil?: true
|
506
480
|
|
507
|
-
# @!
|
508
|
-
#
|
509
|
-
#
|
510
|
-
#
|
511
|
-
# #
|
512
|
-
# def initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara, **) = super
|
513
|
-
|
514
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
481
|
+
# @!method initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara)
|
482
|
+
# @param tax_exempt [Boolean]
|
483
|
+
# @param tax_exemption_code [String, nil]
|
484
|
+
# @param tax_provider [Symbol, :avalara]
|
515
485
|
end
|
516
486
|
|
517
|
-
class
|
487
|
+
class Taxjar < Orb::Internal::Type::BaseModel
|
518
488
|
# @!attribute tax_exempt
|
519
489
|
#
|
520
490
|
# @return [Boolean]
|
@@ -525,18 +495,13 @@ module Orb
|
|
525
495
|
# @return [Symbol, :taxjar]
|
526
496
|
required :tax_provider, const: :taxjar
|
527
497
|
|
528
|
-
# @!
|
529
|
-
#
|
530
|
-
#
|
531
|
-
# #
|
532
|
-
# def initialize(tax_exempt:, tax_provider: :taxjar, **) = super
|
533
|
-
|
534
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
498
|
+
# @!method initialize(tax_exempt:, tax_provider: :taxjar)
|
499
|
+
# @param tax_exempt [Boolean]
|
500
|
+
# @param tax_provider [Symbol, :taxjar]
|
535
501
|
end
|
536
502
|
|
537
|
-
# @!
|
538
|
-
#
|
539
|
-
# def self.variants; end
|
503
|
+
# @!method self.variants
|
504
|
+
# @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar)]
|
540
505
|
end
|
541
506
|
|
542
507
|
class TaxID < Orb::Internal::Type::BaseModel
|
@@ -555,120 +520,116 @@ module Orb
|
|
555
520
|
# @return [String]
|
556
521
|
required :value, String
|
557
522
|
|
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
|
-
#
|
660
|
-
#
|
661
|
-
#
|
662
|
-
#
|
663
|
-
#
|
664
|
-
#
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
# #
|
669
|
-
# def initialize(country:, type:, value:, **) = super
|
670
|
-
|
671
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
523
|
+
# @!method initialize(country:, type:, value:)
|
524
|
+
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
525
|
+
# added to the headers of invoices.
|
526
|
+
#
|
527
|
+
# ### Supported Tax ID Countries and Types
|
528
|
+
#
|
529
|
+
# | Country | Type | Description |
|
530
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
531
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
532
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
533
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
534
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
535
|
+
# | Austria | `eu_vat` | European VAT Number |
|
536
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
537
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
538
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
539
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
540
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
541
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
542
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
543
|
+
# | Canada | `ca_bn` | Canadian BN |
|
544
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
545
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
546
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
547
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
548
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
549
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
550
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
551
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
552
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
553
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
554
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
555
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
556
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
557
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
558
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
559
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
560
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
561
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
562
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
563
|
+
# | Finland | `eu_vat` | European VAT Number |
|
564
|
+
# | France | `eu_vat` | European VAT Number |
|
565
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
566
|
+
# | Germany | `eu_vat` | European VAT Number |
|
567
|
+
# | Greece | `eu_vat` | European VAT Number |
|
568
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
569
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
570
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
571
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
572
|
+
# | India | `in_gst` | Indian GST Number |
|
573
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
574
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
575
|
+
# | Israel | `il_vat` | Israel VAT |
|
576
|
+
# | Italy | `eu_vat` | European VAT Number |
|
577
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
578
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
579
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
580
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
581
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
582
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
583
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
584
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
585
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
586
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
587
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
588
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
589
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
590
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
591
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
592
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
593
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
594
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
595
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
596
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
597
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
598
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
599
|
+
# | Poland | `eu_vat` | European VAT Number |
|
600
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
601
|
+
# | Romania | `eu_vat` | European VAT Number |
|
602
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
603
|
+
# | Russia | `ru_inn` | Russian INN |
|
604
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
605
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
606
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
607
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
608
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
609
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
610
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
611
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
612
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
613
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
614
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
615
|
+
# | Spain | `eu_vat` | European VAT Number |
|
616
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
617
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
618
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
619
|
+
# | Thailand | `th_vat` | Thai VAT |
|
620
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
621
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
622
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
623
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
624
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
625
|
+
# | United States | `us_ein` | United States EIN |
|
626
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
627
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
628
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
629
|
+
#
|
630
|
+
# @param country [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country]
|
631
|
+
# @param type [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type]
|
632
|
+
# @param value [String]
|
672
633
|
|
673
634
|
# @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#country
|
674
635
|
module Country
|
@@ -753,11 +714,8 @@ module Orb
|
|
753
714
|
VN = :VN
|
754
715
|
ZA = :ZA
|
755
716
|
|
756
|
-
|
757
|
-
|
758
|
-
# @!parse
|
759
|
-
# # @return [Array<Symbol>]
|
760
|
-
# def self.values; end
|
717
|
+
# @!method self.values
|
718
|
+
# @return [Array<Symbol>]
|
761
719
|
end
|
762
720
|
|
763
721
|
# @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#type
|
@@ -836,11 +794,8 @@ module Orb
|
|
836
794
|
VN_TIN = :vn_tin
|
837
795
|
ZA_VAT = :za_vat
|
838
796
|
|
839
|
-
|
840
|
-
|
841
|
-
# @!parse
|
842
|
-
# # @return [Array<Symbol>]
|
843
|
-
# def self.values; end
|
797
|
+
# @!method self.values
|
798
|
+
# @return [Array<Symbol>]
|
844
799
|
end
|
845
800
|
end
|
846
801
|
end
|