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