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
@@ -32,8 +32,8 @@ module Orb
|
|
32
32
|
attr_accessor :currency
|
33
33
|
|
34
34
|
# A valid customer email, to be used for notifications. When Orb triggers payment
|
35
|
-
#
|
36
|
-
#
|
35
|
+
# through a payment gateway, this email will be used for any automatically issued
|
36
|
+
# receipts.
|
37
37
|
sig { returns(String) }
|
38
38
|
attr_accessor :email
|
39
39
|
|
@@ -44,8 +44,8 @@ module Orb
|
|
44
44
|
attr_accessor :exempt_from_automated_tax
|
45
45
|
|
46
46
|
# An optional user-defined ID for this customer resource, used throughout the
|
47
|
-
#
|
48
|
-
#
|
47
|
+
# system as an alias for this Customer. Use this field to identify a customer by
|
48
|
+
# an existing identifier in your system.
|
49
49
|
sig { returns(T.nilable(String)) }
|
50
50
|
attr_accessor :external_customer_id
|
51
51
|
|
@@ -57,9 +57,9 @@ module Orb
|
|
57
57
|
attr_writer :hierarchy
|
58
58
|
|
59
59
|
# User specified key-value pairs for the resource. If not present, this defaults
|
60
|
-
#
|
61
|
-
#
|
62
|
-
#
|
60
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
61
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
62
|
+
# `null`.
|
63
63
|
sig { returns(T::Hash[Symbol, String]) }
|
64
64
|
attr_accessor :metadata
|
65
65
|
|
@@ -68,13 +68,13 @@ module Orb
|
|
68
68
|
attr_accessor :name
|
69
69
|
|
70
70
|
# This is used for creating charges or invoices in an external system via Orb.
|
71
|
-
#
|
72
|
-
#
|
71
|
+
# When not in test mode, the connection must first be configured in the Orb
|
72
|
+
# webapp.
|
73
73
|
sig { returns(T.nilable(Orb::Models::Customer::PaymentProvider::TaggedSymbol)) }
|
74
74
|
attr_accessor :payment_provider
|
75
75
|
|
76
76
|
# The ID of this customer in an external payments solution, such as Stripe. This
|
77
|
-
#
|
77
|
+
# is used for creating charges or invoices in the external system via Orb.
|
78
78
|
sig { returns(T.nilable(String)) }
|
79
79
|
attr_accessor :payment_provider_id
|
80
80
|
|
@@ -91,110 +91,110 @@ module Orb
|
|
91
91
|
attr_writer :shipping_address
|
92
92
|
|
93
93
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
94
|
-
#
|
94
|
+
# added to the headers of invoices.
|
95
95
|
#
|
96
|
-
#
|
96
|
+
# ### Supported Tax ID Countries and Types
|
97
97
|
#
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
102
|
-
#
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
#
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
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
|
-
#
|
98
|
+
# | Country | Type | Description |
|
99
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
100
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
101
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
102
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
103
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
104
|
+
# | Austria | `eu_vat` | European VAT Number |
|
105
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
106
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
107
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
108
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
109
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
110
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
111
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
112
|
+
# | Canada | `ca_bn` | Canadian BN |
|
113
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
114
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
115
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
116
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
117
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
118
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
119
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
120
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
121
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
122
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
123
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
124
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
125
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
126
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
127
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
128
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
129
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
130
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
131
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
132
|
+
# | Finland | `eu_vat` | European VAT Number |
|
133
|
+
# | France | `eu_vat` | European VAT Number |
|
134
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
135
|
+
# | Germany | `eu_vat` | European VAT Number |
|
136
|
+
# | Greece | `eu_vat` | European VAT Number |
|
137
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
138
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
139
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
140
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
141
|
+
# | India | `in_gst` | Indian GST Number |
|
142
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
143
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
144
|
+
# | Israel | `il_vat` | Israel VAT |
|
145
|
+
# | Italy | `eu_vat` | European VAT Number |
|
146
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
147
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
148
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
149
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
150
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
151
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
152
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
153
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
154
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
155
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
156
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
157
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
158
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
159
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
160
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
161
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
162
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
163
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
164
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
165
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
166
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
167
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
168
|
+
# | Poland | `eu_vat` | European VAT Number |
|
169
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
170
|
+
# | Romania | `eu_vat` | European VAT Number |
|
171
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
172
|
+
# | Russia | `ru_inn` | Russian INN |
|
173
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
174
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
175
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
176
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
177
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
178
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
179
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
180
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
181
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
182
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
183
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
184
|
+
# | Spain | `eu_vat` | European VAT Number |
|
185
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
186
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
187
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
188
|
+
# | Thailand | `th_vat` | Thai VAT |
|
189
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
190
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
191
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
192
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
193
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
194
|
+
# | United States | `us_ein` | United States EIN |
|
195
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
196
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
197
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
198
198
|
sig { returns(T.nilable(Orb::Models::Customer::TaxID)) }
|
199
199
|
attr_reader :tax_id
|
200
200
|
|
@@ -202,8 +202,8 @@ module Orb
|
|
202
202
|
attr_writer :tax_id
|
203
203
|
|
204
204
|
# A timezone identifier from the IANA timezone database, such as
|
205
|
-
#
|
206
|
-
#
|
205
|
+
# "America/Los_Angeles". This "defaults to your account's timezone if not set.
|
206
|
+
# This cannot be changed after customer creation.
|
207
207
|
sig { returns(String) }
|
208
208
|
attr_accessor :timezone
|
209
209
|
|
@@ -230,23 +230,23 @@ module Orb
|
|
230
230
|
attr_writer :reporting_configuration
|
231
231
|
|
232
232
|
# A customer is a buyer of your products, and the other party to the billing
|
233
|
-
#
|
233
|
+
# relationship.
|
234
234
|
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
235
|
+
# In Orb, customers are assigned system generated identifiers automatically, but
|
236
|
+
# it's often desirable to have these match existing identifiers in your system. To
|
237
|
+
# avoid having to denormalize Orb ID information, you can pass in an
|
238
|
+
# `external_customer_id` with your own identifier. See
|
239
|
+
# [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
|
240
|
+
# information about how these aliases work in Orb.
|
241
241
|
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
242
|
+
# In addition to having an identifier in your system, a customer may exist in a
|
243
|
+
# payment provider solution like Stripe. Use the `payment_provider_id` and the
|
244
|
+
# `payment_provider` enum field to express this mapping.
|
245
245
|
#
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
246
|
+
# A customer also has a timezone (from the standard
|
247
|
+
# [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
248
|
+
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
249
|
+
# information on what this timezone parameter influences within Orb.
|
250
250
|
sig do
|
251
251
|
params(
|
252
252
|
id: String,
|
@@ -297,9 +297,7 @@ module Orb
|
|
297
297
|
timezone:,
|
298
298
|
accounting_sync_configuration: nil,
|
299
299
|
reporting_configuration: nil
|
300
|
-
)
|
301
|
-
end
|
302
|
-
|
300
|
+
); end
|
303
301
|
sig do
|
304
302
|
override
|
305
303
|
.returns(
|
@@ -329,8 +327,7 @@ module Orb
|
|
329
327
|
}
|
330
328
|
)
|
331
329
|
end
|
332
|
-
def to_hash
|
333
|
-
end
|
330
|
+
def to_hash; end
|
334
331
|
|
335
332
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
336
333
|
sig { returns(T.nilable(String)) }
|
@@ -362,8 +359,7 @@ module Orb
|
|
362
359
|
)
|
363
360
|
.returns(T.attached_class)
|
364
361
|
end
|
365
|
-
def self.new(city:, country:, line1:, line2:, postal_code:, state:)
|
366
|
-
end
|
362
|
+
def self.new(city:, country:, line1:, line2:, postal_code:, state:); end
|
367
363
|
|
368
364
|
sig do
|
369
365
|
override
|
@@ -378,8 +374,7 @@ module Orb
|
|
378
374
|
}
|
379
375
|
)
|
380
376
|
end
|
381
|
-
def to_hash
|
382
|
-
end
|
377
|
+
def to_hash; end
|
383
378
|
end
|
384
379
|
|
385
380
|
class Hierarchy < Orb::Internal::Type::BaseModel
|
@@ -400,8 +395,7 @@ module Orb
|
|
400
395
|
)
|
401
396
|
.returns(T.attached_class)
|
402
397
|
end
|
403
|
-
def self.new(children:, parent:)
|
404
|
-
end
|
398
|
+
def self.new(children:, parent:); end
|
405
399
|
|
406
400
|
sig do
|
407
401
|
override
|
@@ -412,8 +406,7 @@ module Orb
|
|
412
406
|
}
|
413
407
|
)
|
414
408
|
end
|
415
|
-
def to_hash
|
416
|
-
end
|
409
|
+
def to_hash; end
|
417
410
|
|
418
411
|
class Child < Orb::Internal::Type::BaseModel
|
419
412
|
sig { returns(String) }
|
@@ -423,12 +416,10 @@ module Orb
|
|
423
416
|
attr_accessor :external_customer_id
|
424
417
|
|
425
418
|
sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
|
426
|
-
def self.new(id:, external_customer_id:)
|
427
|
-
end
|
419
|
+
def self.new(id:, external_customer_id:); end
|
428
420
|
|
429
421
|
sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
|
430
|
-
def to_hash
|
431
|
-
end
|
422
|
+
def to_hash; end
|
432
423
|
end
|
433
424
|
|
434
425
|
class Parent < Orb::Internal::Type::BaseModel
|
@@ -439,18 +430,16 @@ module Orb
|
|
439
430
|
attr_accessor :external_customer_id
|
440
431
|
|
441
432
|
sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
|
442
|
-
def self.new(id:, external_customer_id:)
|
443
|
-
end
|
433
|
+
def self.new(id:, external_customer_id:); end
|
444
434
|
|
445
435
|
sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
|
446
|
-
def to_hash
|
447
|
-
end
|
436
|
+
def to_hash; end
|
448
437
|
end
|
449
438
|
end
|
450
439
|
|
451
440
|
# This is used for creating charges or invoices in an external system via Orb.
|
452
|
-
#
|
453
|
-
#
|
441
|
+
# When not in test mode, the connection must first be configured in the Orb
|
442
|
+
# webapp.
|
454
443
|
module PaymentProvider
|
455
444
|
extend Orb::Internal::Type::Enum
|
456
445
|
|
@@ -464,8 +453,7 @@ module Orb
|
|
464
453
|
NETSUITE = T.let(:netsuite, Orb::Models::Customer::PaymentProvider::TaggedSymbol)
|
465
454
|
|
466
455
|
sig { override.returns(T::Array[Orb::Models::Customer::PaymentProvider::TaggedSymbol]) }
|
467
|
-
def self.values
|
468
|
-
end
|
456
|
+
def self.values; end
|
469
457
|
end
|
470
458
|
|
471
459
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
@@ -498,8 +486,7 @@ module Orb
|
|
498
486
|
)
|
499
487
|
.returns(T.attached_class)
|
500
488
|
end
|
501
|
-
def self.new(city:, country:, line1:, line2:, postal_code:, state:)
|
502
|
-
end
|
489
|
+
def self.new(city:, country:, line1:, line2:, postal_code:, state:); end
|
503
490
|
|
504
491
|
sig do
|
505
492
|
override
|
@@ -514,8 +501,7 @@ module Orb
|
|
514
501
|
}
|
515
502
|
)
|
516
503
|
end
|
517
|
-
def to_hash
|
518
|
-
end
|
504
|
+
def to_hash; end
|
519
505
|
end
|
520
506
|
|
521
507
|
class TaxID < Orb::Internal::Type::BaseModel
|
@@ -529,110 +515,110 @@ module Orb
|
|
529
515
|
attr_accessor :value
|
530
516
|
|
531
517
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
532
|
-
#
|
518
|
+
# added to the headers of invoices.
|
533
519
|
#
|
534
|
-
#
|
520
|
+
# ### Supported Tax ID Countries and Types
|
535
521
|
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
#
|
546
|
-
#
|
547
|
-
#
|
548
|
-
#
|
549
|
-
#
|
550
|
-
#
|
551
|
-
#
|
552
|
-
#
|
553
|
-
#
|
554
|
-
#
|
555
|
-
#
|
556
|
-
#
|
557
|
-
#
|
558
|
-
#
|
559
|
-
#
|
560
|
-
#
|
561
|
-
#
|
562
|
-
#
|
563
|
-
#
|
564
|
-
#
|
565
|
-
#
|
566
|
-
#
|
567
|
-
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
571
|
-
#
|
572
|
-
#
|
573
|
-
#
|
574
|
-
#
|
575
|
-
#
|
576
|
-
#
|
577
|
-
#
|
578
|
-
#
|
579
|
-
#
|
580
|
-
#
|
581
|
-
#
|
582
|
-
#
|
583
|
-
#
|
584
|
-
#
|
585
|
-
#
|
586
|
-
#
|
587
|
-
#
|
588
|
-
#
|
589
|
-
#
|
590
|
-
#
|
591
|
-
#
|
592
|
-
#
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
#
|
617
|
-
#
|
618
|
-
#
|
619
|
-
#
|
620
|
-
#
|
621
|
-
#
|
622
|
-
#
|
623
|
-
#
|
624
|
-
#
|
625
|
-
#
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
635
|
-
#
|
522
|
+
# | Country | Type | Description |
|
523
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
524
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
525
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
526
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
527
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
528
|
+
# | Austria | `eu_vat` | European VAT Number |
|
529
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
530
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
531
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
532
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
533
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
534
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
535
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
536
|
+
# | Canada | `ca_bn` | Canadian BN |
|
537
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
538
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
539
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
540
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
541
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
542
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
543
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
544
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
545
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
546
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
547
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
548
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
549
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
550
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
551
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
552
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
553
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
554
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
555
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
556
|
+
# | Finland | `eu_vat` | European VAT Number |
|
557
|
+
# | France | `eu_vat` | European VAT Number |
|
558
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
559
|
+
# | Germany | `eu_vat` | European VAT Number |
|
560
|
+
# | Greece | `eu_vat` | European VAT Number |
|
561
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
562
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
563
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
564
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
565
|
+
# | India | `in_gst` | Indian GST Number |
|
566
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
567
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
568
|
+
# | Israel | `il_vat` | Israel VAT |
|
569
|
+
# | Italy | `eu_vat` | European VAT Number |
|
570
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
571
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
572
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
573
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
574
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
575
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
576
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
577
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
578
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
579
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
580
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
581
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
582
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
583
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
584
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
585
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
586
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
587
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
588
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
589
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
590
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
591
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
592
|
+
# | Poland | `eu_vat` | European VAT Number |
|
593
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
594
|
+
# | Romania | `eu_vat` | European VAT Number |
|
595
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
596
|
+
# | Russia | `ru_inn` | Russian INN |
|
597
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
598
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
599
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
600
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
601
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
602
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
603
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
604
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
605
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
606
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
607
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
608
|
+
# | Spain | `eu_vat` | European VAT Number |
|
609
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
610
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
611
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
612
|
+
# | Thailand | `th_vat` | Thai VAT |
|
613
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
614
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
615
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
616
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
617
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
618
|
+
# | United States | `us_ein` | United States EIN |
|
619
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
620
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
621
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
636
622
|
sig do
|
637
623
|
params(
|
638
624
|
country: Orb::Models::Customer::TaxID::Country::OrSymbol,
|
@@ -641,8 +627,7 @@ module Orb
|
|
641
627
|
)
|
642
628
|
.returns(T.attached_class)
|
643
629
|
end
|
644
|
-
def self.new(country:, type:, value:)
|
645
|
-
end
|
630
|
+
def self.new(country:, type:, value:); end
|
646
631
|
|
647
632
|
sig do
|
648
633
|
override
|
@@ -654,8 +639,7 @@ module Orb
|
|
654
639
|
}
|
655
640
|
)
|
656
641
|
end
|
657
|
-
def to_hash
|
658
|
-
end
|
642
|
+
def to_hash; end
|
659
643
|
|
660
644
|
module Country
|
661
645
|
extend Orb::Internal::Type::Enum
|
@@ -743,8 +727,7 @@ module Orb
|
|
743
727
|
ZA = T.let(:ZA, Orb::Models::Customer::TaxID::Country::TaggedSymbol)
|
744
728
|
|
745
729
|
sig { override.returns(T::Array[Orb::Models::Customer::TaxID::Country::TaggedSymbol]) }
|
746
|
-
def self.values
|
747
|
-
end
|
730
|
+
def self.values; end
|
748
731
|
end
|
749
732
|
|
750
733
|
module Type
|
@@ -826,8 +809,7 @@ module Orb
|
|
826
809
|
ZA_VAT = T.let(:za_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol)
|
827
810
|
|
828
811
|
sig { override.returns(T::Array[Orb::Models::Customer::TaxID::Type::TaggedSymbol]) }
|
829
|
-
def self.values
|
830
|
-
end
|
812
|
+
def self.values; end
|
831
813
|
end
|
832
814
|
end
|
833
815
|
|
@@ -845,8 +827,7 @@ module Orb
|
|
845
827
|
)
|
846
828
|
.returns(T.attached_class)
|
847
829
|
end
|
848
|
-
def self.new(accounting_providers:, excluded:)
|
849
|
-
end
|
830
|
+
def self.new(accounting_providers:, excluded:); end
|
850
831
|
|
851
832
|
sig do
|
852
833
|
override
|
@@ -857,8 +838,7 @@ module Orb
|
|
857
838
|
}
|
858
839
|
)
|
859
840
|
end
|
860
|
-
def to_hash
|
861
|
-
end
|
841
|
+
def to_hash; end
|
862
842
|
|
863
843
|
class AccountingProvider < Orb::Internal::Type::BaseModel
|
864
844
|
sig { returns(T.nilable(String)) }
|
@@ -878,8 +858,7 @@ module Orb
|
|
878
858
|
)
|
879
859
|
.returns(T.attached_class)
|
880
860
|
end
|
881
|
-
def self.new(external_provider_id:, provider_type:)
|
882
|
-
end
|
861
|
+
def self.new(external_provider_id:, provider_type:); end
|
883
862
|
|
884
863
|
sig do
|
885
864
|
override
|
@@ -890,8 +869,7 @@ module Orb
|
|
890
869
|
}
|
891
870
|
)
|
892
871
|
end
|
893
|
-
def to_hash
|
894
|
-
end
|
872
|
+
def to_hash; end
|
895
873
|
|
896
874
|
module ProviderType
|
897
875
|
extend Orb::Internal::Type::Enum
|
@@ -924,8 +902,7 @@ module Orb
|
|
924
902
|
T::Array[Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol]
|
925
903
|
)
|
926
904
|
end
|
927
|
-
def self.values
|
928
|
-
end
|
905
|
+
def self.values; end
|
929
906
|
end
|
930
907
|
end
|
931
908
|
end
|
@@ -935,12 +912,10 @@ module Orb
|
|
935
912
|
attr_accessor :exempt
|
936
913
|
|
937
914
|
sig { params(exempt: T::Boolean).returns(T.attached_class) }
|
938
|
-
def self.new(exempt:)
|
939
|
-
end
|
915
|
+
def self.new(exempt:); end
|
940
916
|
|
941
917
|
sig { override.returns({exempt: T::Boolean}) }
|
942
|
-
def to_hash
|
943
|
-
end
|
918
|
+
def to_hash; end
|
944
919
|
end
|
945
920
|
end
|
946
921
|
end
|