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