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,7 +7,7 @@ module Orb
|
|
|
7
7
|
attr_accessor :id
|
|
8
8
|
|
|
9
9
|
# This is the final amount required to be charged to the customer and reflects the
|
|
10
|
-
#
|
|
10
|
+
# application of the customer balance to the `total` of the invoice.
|
|
11
11
|
sig { returns(String) }
|
|
12
12
|
attr_accessor :amount_due
|
|
13
13
|
|
|
@@ -55,110 +55,110 @@ module Orb
|
|
|
55
55
|
attr_accessor :customer_balance_transactions
|
|
56
56
|
|
|
57
57
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
58
|
-
#
|
|
58
|
+
# added to the headers of invoices.
|
|
59
59
|
#
|
|
60
|
-
#
|
|
60
|
+
# ### Supported Tax ID Countries and Types
|
|
61
61
|
#
|
|
62
|
-
#
|
|
63
|
-
#
|
|
64
|
-
#
|
|
65
|
-
#
|
|
66
|
-
#
|
|
67
|
-
#
|
|
68
|
-
#
|
|
69
|
-
#
|
|
70
|
-
#
|
|
71
|
-
#
|
|
72
|
-
#
|
|
73
|
-
#
|
|
74
|
-
#
|
|
75
|
-
#
|
|
76
|
-
#
|
|
77
|
-
#
|
|
78
|
-
#
|
|
79
|
-
#
|
|
80
|
-
#
|
|
81
|
-
#
|
|
82
|
-
#
|
|
83
|
-
#
|
|
84
|
-
#
|
|
85
|
-
#
|
|
86
|
-
#
|
|
87
|
-
#
|
|
88
|
-
#
|
|
89
|
-
#
|
|
90
|
-
#
|
|
91
|
-
#
|
|
92
|
-
#
|
|
93
|
-
#
|
|
94
|
-
#
|
|
95
|
-
#
|
|
96
|
-
#
|
|
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
|
-
#
|
|
62
|
+
# | Country | Type | Description |
|
|
63
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
64
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
65
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
66
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
67
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
68
|
+
# | Austria | `eu_vat` | European VAT Number |
|
|
69
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
70
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
|
71
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
72
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
73
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
74
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
75
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
|
76
|
+
# | Canada | `ca_bn` | Canadian BN |
|
|
77
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
78
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
79
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
80
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
81
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
82
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
|
83
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
|
84
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
|
85
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
86
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
|
87
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
|
88
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
|
89
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
|
90
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
91
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
92
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
93
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
94
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
|
95
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
96
|
+
# | Finland | `eu_vat` | European VAT Number |
|
|
97
|
+
# | France | `eu_vat` | European VAT Number |
|
|
98
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
|
99
|
+
# | Germany | `eu_vat` | European VAT Number |
|
|
100
|
+
# | Greece | `eu_vat` | European VAT Number |
|
|
101
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
102
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
|
103
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
104
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
|
105
|
+
# | India | `in_gst` | Indian GST Number |
|
|
106
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
107
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
|
108
|
+
# | Israel | `il_vat` | Israel VAT |
|
|
109
|
+
# | Italy | `eu_vat` | European VAT Number |
|
|
110
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
111
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
112
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
113
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
114
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
115
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
|
116
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
117
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
|
118
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
|
119
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
120
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
|
121
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
|
122
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
|
123
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
124
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
|
125
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
126
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
127
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
128
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
129
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
|
130
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
131
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
132
|
+
# | Poland | `eu_vat` | European VAT Number |
|
|
133
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
|
134
|
+
# | Romania | `eu_vat` | European VAT Number |
|
|
135
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
136
|
+
# | Russia | `ru_inn` | Russian INN |
|
|
137
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
|
138
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
139
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
|
140
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
|
141
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
|
142
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
|
143
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
|
144
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
145
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
|
146
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
|
147
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
148
|
+
# | Spain | `eu_vat` | European VAT Number |
|
|
149
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
|
150
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
151
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
152
|
+
# | Thailand | `th_vat` | Thai VAT |
|
|
153
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
154
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
155
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
156
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
157
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
158
|
+
# | United States | `us_ein` | United States EIN |
|
|
159
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
160
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
161
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
162
162
|
sig { returns(T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID)) }
|
|
163
163
|
attr_reader :customer_tax_id
|
|
164
164
|
|
|
@@ -171,8 +171,8 @@ module Orb
|
|
|
171
171
|
attr_writer :customer_tax_id
|
|
172
172
|
|
|
173
173
|
# This field is deprecated in favor of `discounts`. If a `discounts` list is
|
|
174
|
-
#
|
|
175
|
-
#
|
|
174
|
+
# provided, the first discount in the list will be returned. If the list is empty,
|
|
175
|
+
# `None` will be returned.
|
|
176
176
|
sig { returns(T.anything) }
|
|
177
177
|
attr_accessor :discount
|
|
178
178
|
|
|
@@ -184,24 +184,24 @@ module Orb
|
|
|
184
184
|
attr_accessor :discounts
|
|
185
185
|
|
|
186
186
|
# When the invoice payment is due. The due date is null if the invoice is not yet
|
|
187
|
-
#
|
|
187
|
+
# finalized.
|
|
188
188
|
sig { returns(T.nilable(Time)) }
|
|
189
189
|
attr_accessor :due_date
|
|
190
190
|
|
|
191
191
|
# If the invoice has a status of `draft`, this will be the time that the invoice
|
|
192
|
-
#
|
|
193
|
-
#
|
|
192
|
+
# will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
|
|
193
|
+
# true, the invoice will automatically begin issuing at this time.
|
|
194
194
|
sig { returns(T.nilable(Time)) }
|
|
195
195
|
attr_accessor :eligible_to_issue_at
|
|
196
196
|
|
|
197
197
|
# A URL for the customer-facing invoice portal. This URL expires 30 days after the
|
|
198
|
-
#
|
|
198
|
+
# invoice's due date, or 60 days after being re-generated through the UI.
|
|
199
199
|
sig { returns(T.nilable(String)) }
|
|
200
200
|
attr_accessor :hosted_invoice_url
|
|
201
201
|
|
|
202
202
|
# Automatically generated invoice number to help track and reconcile invoices.
|
|
203
|
-
#
|
|
204
|
-
#
|
|
203
|
+
# Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per
|
|
204
|
+
# account or customer.
|
|
205
205
|
sig { returns(String) }
|
|
206
206
|
attr_accessor :invoice_number
|
|
207
207
|
|
|
@@ -213,12 +213,12 @@ module Orb
|
|
|
213
213
|
attr_accessor :invoice_source
|
|
214
214
|
|
|
215
215
|
# If the invoice failed to issue, this will be the last time it failed to issue
|
|
216
|
-
#
|
|
216
|
+
# (even if it is now in a different state.)
|
|
217
217
|
sig { returns(T.nilable(Time)) }
|
|
218
218
|
attr_accessor :issue_failed_at
|
|
219
219
|
|
|
220
220
|
# If the invoice has been issued, this will be the time it transitioned to
|
|
221
|
-
#
|
|
221
|
+
# `issued` (even if it is now in a different state.)
|
|
222
222
|
sig { returns(T.nilable(Time)) }
|
|
223
223
|
attr_accessor :issued_at
|
|
224
224
|
|
|
@@ -245,9 +245,9 @@ module Orb
|
|
|
245
245
|
attr_accessor :memo
|
|
246
246
|
|
|
247
247
|
# User specified key-value pairs for the resource. If not present, this defaults
|
|
248
|
-
#
|
|
249
|
-
#
|
|
250
|
-
#
|
|
248
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
|
249
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
|
250
|
+
# `null`.
|
|
251
251
|
sig { returns(T::Hash[Symbol, String]) }
|
|
252
252
|
attr_accessor :metadata
|
|
253
253
|
|
|
@@ -266,7 +266,7 @@ module Orb
|
|
|
266
266
|
attr_accessor :minimum_amount
|
|
267
267
|
|
|
268
268
|
# If the invoice has a status of `paid`, this gives a timestamp when the invoice
|
|
269
|
-
#
|
|
269
|
+
# was paid.
|
|
270
270
|
sig { returns(T.nilable(Time)) }
|
|
271
271
|
attr_accessor :paid_at
|
|
272
272
|
|
|
@@ -275,18 +275,18 @@ module Orb
|
|
|
275
275
|
attr_accessor :payment_attempts
|
|
276
276
|
|
|
277
277
|
# If payment was attempted on this invoice but failed, this will be the time of
|
|
278
|
-
#
|
|
278
|
+
# the most recent attempt.
|
|
279
279
|
sig { returns(T.nilable(Time)) }
|
|
280
280
|
attr_accessor :payment_failed_at
|
|
281
281
|
|
|
282
282
|
# If payment was attempted on this invoice, this will be the start time of the
|
|
283
|
-
#
|
|
284
|
-
#
|
|
283
|
+
# most recent attempt. This field is especially useful for delayed-notification
|
|
284
|
+
# payment mechanisms (like bank transfers), where payment can take 3 days or more.
|
|
285
285
|
sig { returns(T.nilable(Time)) }
|
|
286
286
|
attr_accessor :payment_started_at
|
|
287
287
|
|
|
288
288
|
# If the invoice is in draft, this timestamp will reflect when the invoice is
|
|
289
|
-
#
|
|
289
|
+
# scheduled to be issued.
|
|
290
290
|
sig { returns(T.nilable(Time)) }
|
|
291
291
|
attr_accessor :scheduled_issue_at
|
|
292
292
|
|
|
@@ -320,8 +320,8 @@ module Orb
|
|
|
320
320
|
attr_accessor :subtotal
|
|
321
321
|
|
|
322
322
|
# If the invoice failed to sync, this will be the last time an external invoicing
|
|
323
|
-
#
|
|
324
|
-
#
|
|
323
|
+
# provider sync was attempted. This field will always be `null` for invoices using
|
|
324
|
+
# Orb Invoicing.
|
|
325
325
|
sig { returns(T.nilable(Time)) }
|
|
326
326
|
attr_accessor :sync_failed_at
|
|
327
327
|
|
|
@@ -334,12 +334,12 @@ module Orb
|
|
|
334
334
|
attr_accessor :total
|
|
335
335
|
|
|
336
336
|
# If the invoice has a status of `void`, this gives a timestamp when the invoice
|
|
337
|
-
#
|
|
337
|
+
# was voided.
|
|
338
338
|
sig { returns(T.nilable(Time)) }
|
|
339
339
|
attr_accessor :voided_at
|
|
340
340
|
|
|
341
341
|
# This is true if the invoice will be automatically issued in the future, and
|
|
342
|
-
#
|
|
342
|
+
# false otherwise.
|
|
343
343
|
sig { returns(T::Boolean) }
|
|
344
344
|
attr_accessor :will_auto_issue
|
|
345
345
|
|
|
@@ -357,12 +357,12 @@ module Orb
|
|
|
357
357
|
customer_tax_id: T.nilable(T.any(Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, Orb::Internal::AnyHash)),
|
|
358
358
|
discount: T.anything,
|
|
359
359
|
discounts: T::Array[
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
360
|
+
T.any(
|
|
361
|
+
Orb::Models::PercentageDiscount,
|
|
362
|
+
Orb::Internal::AnyHash,
|
|
363
|
+
Orb::Models::AmountDiscount,
|
|
364
|
+
Orb::Models::TrialDiscount
|
|
365
|
+
)
|
|
366
366
|
],
|
|
367
367
|
due_date: T.nilable(Time),
|
|
368
368
|
eligible_to_issue_at: T.nilable(Time),
|
|
@@ -438,9 +438,7 @@ module Orb
|
|
|
438
438
|
total:,
|
|
439
439
|
voided_at:,
|
|
440
440
|
will_auto_issue:
|
|
441
|
-
)
|
|
442
|
-
end
|
|
443
|
-
|
|
441
|
+
); end
|
|
444
442
|
sig do
|
|
445
443
|
override
|
|
446
444
|
.returns(
|
|
@@ -489,8 +487,7 @@ module Orb
|
|
|
489
487
|
}
|
|
490
488
|
)
|
|
491
489
|
end
|
|
492
|
-
def to_hash
|
|
493
|
-
end
|
|
490
|
+
def to_hash; end
|
|
494
491
|
|
|
495
492
|
class AutoCollection < Orb::Internal::Type::BaseModel
|
|
496
493
|
# True only if auto-collection is enabled for this invoice.
|
|
@@ -498,8 +495,8 @@ module Orb
|
|
|
498
495
|
attr_accessor :enabled
|
|
499
496
|
|
|
500
497
|
# If the invoice is scheduled for auto-collection, this field will reflect when
|
|
501
|
-
#
|
|
502
|
-
#
|
|
498
|
+
# the next attempt will occur. If dunning has been exhausted, or auto-collection
|
|
499
|
+
# is not enabled for this invoice, this field will be `null`.
|
|
503
500
|
sig { returns(T.nilable(Time)) }
|
|
504
501
|
attr_accessor :next_attempt_at
|
|
505
502
|
|
|
@@ -508,11 +505,11 @@ module Orb
|
|
|
508
505
|
attr_accessor :num_attempts
|
|
509
506
|
|
|
510
507
|
# If Orb has ever attempted payment auto-collection for this invoice, this field
|
|
511
|
-
#
|
|
512
|
-
#
|
|
513
|
-
#
|
|
514
|
-
#
|
|
515
|
-
#
|
|
508
|
+
# will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
|
|
509
|
+
# this can be used to tell whether the invoice is currently in dunning (that is,
|
|
510
|
+
# `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or
|
|
511
|
+
# if dunning has been exhausted (`previously_attempted_at` is non-null, but
|
|
512
|
+
# `next_attempt_time` is null).
|
|
516
513
|
sig { returns(T.nilable(Time)) }
|
|
517
514
|
attr_accessor :previously_attempted_at
|
|
518
515
|
|
|
@@ -525,8 +522,7 @@ module Orb
|
|
|
525
522
|
)
|
|
526
523
|
.returns(T.attached_class)
|
|
527
524
|
end
|
|
528
|
-
def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:)
|
|
529
|
-
end
|
|
525
|
+
def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:); end
|
|
530
526
|
|
|
531
527
|
sig do
|
|
532
528
|
override
|
|
@@ -539,8 +535,7 @@ module Orb
|
|
|
539
535
|
}
|
|
540
536
|
)
|
|
541
537
|
end
|
|
542
|
-
def to_hash
|
|
543
|
-
end
|
|
538
|
+
def to_hash; end
|
|
544
539
|
end
|
|
545
540
|
|
|
546
541
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
|
@@ -573,8 +568,7 @@ module Orb
|
|
|
573
568
|
)
|
|
574
569
|
.returns(T.attached_class)
|
|
575
570
|
end
|
|
576
|
-
def self.new(city:, country:, line1:, line2:, postal_code:, state:)
|
|
577
|
-
end
|
|
571
|
+
def self.new(city:, country:, line1:, line2:, postal_code:, state:); end
|
|
578
572
|
|
|
579
573
|
sig do
|
|
580
574
|
override
|
|
@@ -589,8 +583,7 @@ module Orb
|
|
|
589
583
|
}
|
|
590
584
|
)
|
|
591
585
|
end
|
|
592
|
-
def to_hash
|
|
593
|
-
end
|
|
586
|
+
def to_hash; end
|
|
594
587
|
end
|
|
595
588
|
|
|
596
589
|
class CreditNote < Orb::Internal::Type::BaseModel
|
|
@@ -614,7 +607,7 @@ module Orb
|
|
|
614
607
|
attr_accessor :type
|
|
615
608
|
|
|
616
609
|
# If the credit note has a status of `void`, this gives a timestamp when the
|
|
617
|
-
#
|
|
610
|
+
# credit note was voided.
|
|
618
611
|
sig { returns(T.nilable(Time)) }
|
|
619
612
|
attr_accessor :voided_at
|
|
620
613
|
|
|
@@ -630,8 +623,7 @@ module Orb
|
|
|
630
623
|
)
|
|
631
624
|
.returns(T.attached_class)
|
|
632
625
|
end
|
|
633
|
-
def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:)
|
|
634
|
-
end
|
|
626
|
+
def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:); end
|
|
635
627
|
|
|
636
628
|
sig do
|
|
637
629
|
override
|
|
@@ -647,8 +639,7 @@ module Orb
|
|
|
647
639
|
}
|
|
648
640
|
)
|
|
649
641
|
end
|
|
650
|
-
def to_hash
|
|
651
|
-
end
|
|
642
|
+
def to_hash; end
|
|
652
643
|
end
|
|
653
644
|
|
|
654
645
|
class Customer < Orb::Internal::Type::BaseModel
|
|
@@ -659,12 +650,10 @@ module Orb
|
|
|
659
650
|
attr_accessor :external_customer_id
|
|
660
651
|
|
|
661
652
|
sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
|
|
662
|
-
def self.new(id:, external_customer_id:)
|
|
663
|
-
end
|
|
653
|
+
def self.new(id:, external_customer_id:); end
|
|
664
654
|
|
|
665
655
|
sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
|
|
666
|
-
def to_hash
|
|
667
|
-
end
|
|
656
|
+
def to_hash; end
|
|
668
657
|
end
|
|
669
658
|
|
|
670
659
|
class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
|
|
@@ -704,7 +693,7 @@ module Orb
|
|
|
704
693
|
attr_accessor :description
|
|
705
694
|
|
|
706
695
|
# The new value of the customer's balance prior to the transaction, in the
|
|
707
|
-
#
|
|
696
|
+
# customer's currency.
|
|
708
697
|
sig { returns(String) }
|
|
709
698
|
attr_accessor :ending_balance
|
|
710
699
|
|
|
@@ -725,7 +714,7 @@ module Orb
|
|
|
725
714
|
attr_writer :invoice
|
|
726
715
|
|
|
727
716
|
# The original value of the customer's balance prior to the transaction, in the
|
|
728
|
-
#
|
|
717
|
+
# customer's currency.
|
|
729
718
|
sig { returns(String) }
|
|
730
719
|
attr_accessor :starting_balance
|
|
731
720
|
|
|
@@ -768,9 +757,7 @@ module Orb
|
|
|
768
757
|
invoice:,
|
|
769
758
|
starting_balance:,
|
|
770
759
|
type:
|
|
771
|
-
)
|
|
772
|
-
end
|
|
773
|
-
|
|
760
|
+
); end
|
|
774
761
|
sig do
|
|
775
762
|
override
|
|
776
763
|
.returns(
|
|
@@ -788,8 +775,7 @@ module Orb
|
|
|
788
775
|
}
|
|
789
776
|
)
|
|
790
777
|
end
|
|
791
|
-
def to_hash
|
|
792
|
-
end
|
|
778
|
+
def to_hash; end
|
|
793
779
|
|
|
794
780
|
module Action
|
|
795
781
|
extend Orb::Internal::Type::Enum
|
|
@@ -857,8 +843,7 @@ module Orb
|
|
|
857
843
|
T::Array[Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action::TaggedSymbol]
|
|
858
844
|
)
|
|
859
845
|
end
|
|
860
|
-
def self.values
|
|
861
|
-
end
|
|
846
|
+
def self.values; end
|
|
862
847
|
end
|
|
863
848
|
|
|
864
849
|
class CreditNote < Orb::Internal::Type::BaseModel
|
|
@@ -867,12 +852,10 @@ module Orb
|
|
|
867
852
|
attr_accessor :id
|
|
868
853
|
|
|
869
854
|
sig { params(id: String).returns(T.attached_class) }
|
|
870
|
-
def self.new(id:)
|
|
871
|
-
end
|
|
855
|
+
def self.new(id:); end
|
|
872
856
|
|
|
873
857
|
sig { override.returns({id: String}) }
|
|
874
|
-
def to_hash
|
|
875
|
-
end
|
|
858
|
+
def to_hash; end
|
|
876
859
|
end
|
|
877
860
|
|
|
878
861
|
class Invoice < Orb::Internal::Type::BaseModel
|
|
@@ -881,12 +864,10 @@ module Orb
|
|
|
881
864
|
attr_accessor :id
|
|
882
865
|
|
|
883
866
|
sig { params(id: String).returns(T.attached_class) }
|
|
884
|
-
def self.new(id:)
|
|
885
|
-
end
|
|
867
|
+
def self.new(id:); end
|
|
886
868
|
|
|
887
869
|
sig { override.returns({id: String}) }
|
|
888
|
-
def to_hash
|
|
889
|
-
end
|
|
870
|
+
def to_hash; end
|
|
890
871
|
end
|
|
891
872
|
|
|
892
873
|
module Type
|
|
@@ -920,8 +901,7 @@ module Orb
|
|
|
920
901
|
T::Array[Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type::TaggedSymbol]
|
|
921
902
|
)
|
|
922
903
|
end
|
|
923
|
-
def self.values
|
|
924
|
-
end
|
|
904
|
+
def self.values; end
|
|
925
905
|
end
|
|
926
906
|
end
|
|
927
907
|
|
|
@@ -936,110 +916,110 @@ module Orb
|
|
|
936
916
|
attr_accessor :value
|
|
937
917
|
|
|
938
918
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
|
939
|
-
#
|
|
919
|
+
# added to the headers of invoices.
|
|
940
920
|
#
|
|
941
|
-
#
|
|
921
|
+
# ### Supported Tax ID Countries and Types
|
|
942
922
|
#
|
|
943
|
-
#
|
|
944
|
-
#
|
|
945
|
-
#
|
|
946
|
-
#
|
|
947
|
-
#
|
|
948
|
-
#
|
|
949
|
-
#
|
|
950
|
-
#
|
|
951
|
-
#
|
|
952
|
-
#
|
|
953
|
-
#
|
|
954
|
-
#
|
|
955
|
-
#
|
|
956
|
-
#
|
|
957
|
-
#
|
|
958
|
-
#
|
|
959
|
-
#
|
|
960
|
-
#
|
|
961
|
-
#
|
|
962
|
-
#
|
|
963
|
-
#
|
|
964
|
-
#
|
|
965
|
-
#
|
|
966
|
-
#
|
|
967
|
-
#
|
|
968
|
-
#
|
|
969
|
-
#
|
|
970
|
-
#
|
|
971
|
-
#
|
|
972
|
-
#
|
|
973
|
-
#
|
|
974
|
-
#
|
|
975
|
-
#
|
|
976
|
-
#
|
|
977
|
-
#
|
|
978
|
-
#
|
|
979
|
-
#
|
|
980
|
-
#
|
|
981
|
-
#
|
|
982
|
-
#
|
|
983
|
-
#
|
|
984
|
-
#
|
|
985
|
-
#
|
|
986
|
-
#
|
|
987
|
-
#
|
|
988
|
-
#
|
|
989
|
-
#
|
|
990
|
-
#
|
|
991
|
-
#
|
|
992
|
-
#
|
|
993
|
-
#
|
|
994
|
-
#
|
|
995
|
-
#
|
|
996
|
-
#
|
|
997
|
-
#
|
|
998
|
-
#
|
|
999
|
-
#
|
|
1000
|
-
#
|
|
1001
|
-
#
|
|
1002
|
-
#
|
|
1003
|
-
#
|
|
1004
|
-
#
|
|
1005
|
-
#
|
|
1006
|
-
#
|
|
1007
|
-
#
|
|
1008
|
-
#
|
|
1009
|
-
#
|
|
1010
|
-
#
|
|
1011
|
-
#
|
|
1012
|
-
#
|
|
1013
|
-
#
|
|
1014
|
-
#
|
|
1015
|
-
#
|
|
1016
|
-
#
|
|
1017
|
-
#
|
|
1018
|
-
#
|
|
1019
|
-
#
|
|
1020
|
-
#
|
|
1021
|
-
#
|
|
1022
|
-
#
|
|
1023
|
-
#
|
|
1024
|
-
#
|
|
1025
|
-
#
|
|
1026
|
-
#
|
|
1027
|
-
#
|
|
1028
|
-
#
|
|
1029
|
-
#
|
|
1030
|
-
#
|
|
1031
|
-
#
|
|
1032
|
-
#
|
|
1033
|
-
#
|
|
1034
|
-
#
|
|
1035
|
-
#
|
|
1036
|
-
#
|
|
1037
|
-
#
|
|
1038
|
-
#
|
|
1039
|
-
#
|
|
1040
|
-
#
|
|
1041
|
-
#
|
|
1042
|
-
#
|
|
923
|
+
# | Country | Type | Description |
|
|
924
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
|
925
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
|
926
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
|
927
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
|
928
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
|
929
|
+
# | Austria | `eu_vat` | European VAT Number |
|
|
930
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
|
931
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
|
932
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
|
933
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
|
934
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
|
935
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
|
936
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
|
937
|
+
# | Canada | `ca_bn` | Canadian BN |
|
|
938
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
|
939
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
|
940
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
|
941
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
|
942
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
|
943
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
|
944
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
|
945
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
|
946
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
|
947
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
|
948
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
|
949
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
|
950
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
|
951
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
|
952
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
|
953
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
|
954
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
|
955
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
|
956
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
|
957
|
+
# | Finland | `eu_vat` | European VAT Number |
|
|
958
|
+
# | France | `eu_vat` | European VAT Number |
|
|
959
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
|
960
|
+
# | Germany | `eu_vat` | European VAT Number |
|
|
961
|
+
# | Greece | `eu_vat` | European VAT Number |
|
|
962
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
|
963
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
|
964
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
|
965
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
|
966
|
+
# | India | `in_gst` | Indian GST Number |
|
|
967
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
|
968
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
|
969
|
+
# | Israel | `il_vat` | Israel VAT |
|
|
970
|
+
# | Italy | `eu_vat` | European VAT Number |
|
|
971
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
|
972
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
|
973
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
|
974
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
|
975
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
|
976
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
|
977
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
|
978
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
|
979
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
|
980
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
|
981
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
|
982
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
|
983
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
|
984
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
|
985
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
|
986
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
|
987
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
|
988
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
|
989
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
|
990
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
|
991
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
|
992
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
|
993
|
+
# | Poland | `eu_vat` | European VAT Number |
|
|
994
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
|
995
|
+
# | Romania | `eu_vat` | European VAT Number |
|
|
996
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
|
997
|
+
# | Russia | `ru_inn` | Russian INN |
|
|
998
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
|
999
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
|
1000
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
|
1001
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
|
1002
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
|
1003
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
|
1004
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
|
1005
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
|
1006
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
|
1007
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
|
1008
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
|
1009
|
+
# | Spain | `eu_vat` | European VAT Number |
|
|
1010
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
|
1011
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
|
1012
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
|
1013
|
+
# | Thailand | `th_vat` | Thai VAT |
|
|
1014
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
|
1015
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
|
1016
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
|
1017
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
|
1018
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
|
1019
|
+
# | United States | `us_ein` | United States EIN |
|
|
1020
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
|
1021
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
|
1022
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
|
1043
1023
|
sig do
|
|
1044
1024
|
params(
|
|
1045
1025
|
country: Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::OrSymbol,
|
|
@@ -1048,8 +1028,7 @@ module Orb
|
|
|
1048
1028
|
)
|
|
1049
1029
|
.returns(T.attached_class)
|
|
1050
1030
|
end
|
|
1051
|
-
def self.new(country:, type:, value:)
|
|
1052
|
-
end
|
|
1031
|
+
def self.new(country:, type:, value:); end
|
|
1053
1032
|
|
|
1054
1033
|
sig do
|
|
1055
1034
|
override
|
|
@@ -1061,8 +1040,7 @@ module Orb
|
|
|
1061
1040
|
}
|
|
1062
1041
|
)
|
|
1063
1042
|
end
|
|
1064
|
-
def to_hash
|
|
1065
|
-
end
|
|
1043
|
+
def to_hash; end
|
|
1066
1044
|
|
|
1067
1045
|
module Country
|
|
1068
1046
|
extend Orb::Internal::Type::Enum
|
|
@@ -1154,8 +1132,7 @@ module Orb
|
|
|
1154
1132
|
sig do
|
|
1155
1133
|
override.returns(T::Array[Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol])
|
|
1156
1134
|
end
|
|
1157
|
-
def self.values
|
|
1158
|
-
end
|
|
1135
|
+
def self.values; end
|
|
1159
1136
|
end
|
|
1160
1137
|
|
|
1161
1138
|
module Type
|
|
@@ -1244,8 +1221,7 @@ module Orb
|
|
|
1244
1221
|
ZA_VAT = T.let(:za_vat, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol)
|
|
1245
1222
|
|
|
1246
1223
|
sig { override.returns(T::Array[Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol]) }
|
|
1247
|
-
def self.values
|
|
1248
|
-
end
|
|
1224
|
+
def self.values; end
|
|
1249
1225
|
end
|
|
1250
1226
|
end
|
|
1251
1227
|
|
|
@@ -1262,8 +1238,7 @@ module Orb
|
|
|
1262
1238
|
ONE_OFF = T.let(:one_off, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol)
|
|
1263
1239
|
|
|
1264
1240
|
sig { override.returns(T::Array[Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol]) }
|
|
1265
|
-
def self.values
|
|
1266
|
-
end
|
|
1241
|
+
def self.values; end
|
|
1267
1242
|
end
|
|
1268
1243
|
|
|
1269
1244
|
class LineItem < Orb::Internal::Type::BaseModel
|
|
@@ -1272,30 +1247,30 @@ module Orb
|
|
|
1272
1247
|
attr_accessor :id
|
|
1273
1248
|
|
|
1274
1249
|
# The line amount after any adjustments and before overage conversion, credits and
|
|
1275
|
-
#
|
|
1250
|
+
# partial invoicing.
|
|
1276
1251
|
sig { returns(String) }
|
|
1277
1252
|
attr_accessor :adjusted_subtotal
|
|
1278
1253
|
|
|
1279
1254
|
# All adjustments applied to the line item in the order they were applied based on
|
|
1280
|
-
#
|
|
1281
|
-
#
|
|
1255
|
+
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
|
1256
|
+
# discounts -> minimums -> maximums).
|
|
1282
1257
|
sig do
|
|
1283
1258
|
returns(
|
|
1284
1259
|
T::Array[
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1260
|
+
T.any(
|
|
1261
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment,
|
|
1262
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment,
|
|
1263
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment,
|
|
1264
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment,
|
|
1265
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment
|
|
1266
|
+
)
|
|
1292
1267
|
]
|
|
1293
1268
|
)
|
|
1294
1269
|
end
|
|
1295
1270
|
attr_accessor :adjustments
|
|
1296
1271
|
|
|
1297
1272
|
# The final amount for a line item after all adjustments and pre paid credits have
|
|
1298
|
-
#
|
|
1273
|
+
# been applied.
|
|
1299
1274
|
sig { returns(String) }
|
|
1300
1275
|
attr_accessor :amount
|
|
1301
1276
|
|
|
@@ -1326,8 +1301,8 @@ module Orb
|
|
|
1326
1301
|
attr_accessor :filter
|
|
1327
1302
|
|
|
1328
1303
|
# [DEPRECATED] For configured prices that are split by a grouping key, this will
|
|
1329
|
-
#
|
|
1330
|
-
#
|
|
1304
|
+
# be populated with the key and a value. The `amount` and `subtotal` will be the
|
|
1305
|
+
# values for this particular grouping.
|
|
1331
1306
|
sig { returns(T.nilable(String)) }
|
|
1332
1307
|
attr_accessor :grouping
|
|
1333
1308
|
|
|
@@ -1372,15 +1347,15 @@ module Orb
|
|
|
1372
1347
|
attr_accessor :partially_invoiced_amount
|
|
1373
1348
|
|
|
1374
1349
|
# The Price resource represents a price that can be billed on a subscription,
|
|
1375
|
-
#
|
|
1376
|
-
#
|
|
1350
|
+
# resulting in a charge on an invoice in the form of an invoice line item. Prices
|
|
1351
|
+
# take a quantity and determine an amount to bill.
|
|
1377
1352
|
#
|
|
1378
|
-
#
|
|
1379
|
-
#
|
|
1380
|
-
#
|
|
1353
|
+
# Orb supports a few different pricing models out of the box. Each of these models
|
|
1354
|
+
# is serialized differently in a given Price object. The model_type field
|
|
1355
|
+
# determines the key for the configuration object that is present.
|
|
1381
1356
|
#
|
|
1382
|
-
#
|
|
1383
|
-
#
|
|
1357
|
+
# For more on the types of prices, see
|
|
1358
|
+
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
1384
1359
|
sig do
|
|
1385
1360
|
returns(
|
|
1386
1361
|
T.nilable(
|
|
@@ -1428,15 +1403,15 @@ module Orb
|
|
|
1428
1403
|
attr_accessor :start_date
|
|
1429
1404
|
|
|
1430
1405
|
# For complex pricing structures, the line item can be broken down further in
|
|
1431
|
-
#
|
|
1406
|
+
# `sub_line_items`.
|
|
1432
1407
|
sig do
|
|
1433
1408
|
returns(
|
|
1434
1409
|
T::Array[
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1410
|
+
T.any(
|
|
1411
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem,
|
|
1412
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem,
|
|
1413
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem
|
|
1414
|
+
)
|
|
1440
1415
|
]
|
|
1441
1416
|
)
|
|
1442
1417
|
end
|
|
@@ -1447,7 +1422,7 @@ module Orb
|
|
|
1447
1422
|
attr_accessor :subtotal
|
|
1448
1423
|
|
|
1449
1424
|
# An array of tax rates and their incurred tax amounts. Empty if no tax
|
|
1450
|
-
#
|
|
1425
|
+
# integration is configured.
|
|
1451
1426
|
sig { returns(T::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount]) }
|
|
1452
1427
|
attr_accessor :tax_amounts
|
|
1453
1428
|
|
|
@@ -1460,14 +1435,14 @@ module Orb
|
|
|
1460
1435
|
id: String,
|
|
1461
1436
|
adjusted_subtotal: String,
|
|
1462
1437
|
adjustments: T::Array[
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1438
|
+
T.any(
|
|
1439
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment,
|
|
1440
|
+
Orb::Internal::AnyHash,
|
|
1441
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment,
|
|
1442
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment,
|
|
1443
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment,
|
|
1444
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment
|
|
1445
|
+
)
|
|
1471
1446
|
],
|
|
1472
1447
|
amount: String,
|
|
1473
1448
|
credits_applied: String,
|
|
@@ -1525,12 +1500,12 @@ module Orb
|
|
|
1525
1500
|
quantity: Float,
|
|
1526
1501
|
start_date: Time,
|
|
1527
1502
|
sub_line_items: T::Array[
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
|
|
1533
|
-
|
|
1503
|
+
T.any(
|
|
1504
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem,
|
|
1505
|
+
Orb::Internal::AnyHash,
|
|
1506
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem,
|
|
1507
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem
|
|
1508
|
+
)
|
|
1534
1509
|
],
|
|
1535
1510
|
subtotal: String,
|
|
1536
1511
|
tax_amounts: T::Array[T.any(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount, Orb::Internal::AnyHash)],
|
|
@@ -1561,9 +1536,7 @@ module Orb
|
|
|
1561
1536
|
subtotal:,
|
|
1562
1537
|
tax_amounts:,
|
|
1563
1538
|
usage_customer_ids:
|
|
1564
|
-
)
|
|
1565
|
-
end
|
|
1566
|
-
|
|
1539
|
+
); end
|
|
1567
1540
|
sig do
|
|
1568
1541
|
override
|
|
1569
1542
|
.returns(
|
|
@@ -1571,13 +1544,13 @@ module Orb
|
|
|
1571
1544
|
id: String,
|
|
1572
1545
|
adjusted_subtotal: String,
|
|
1573
1546
|
adjustments: T::Array[
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
|
|
1547
|
+
T.any(
|
|
1548
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment,
|
|
1549
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment,
|
|
1550
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment,
|
|
1551
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment,
|
|
1552
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment
|
|
1553
|
+
)
|
|
1581
1554
|
],
|
|
1582
1555
|
amount: String,
|
|
1583
1556
|
credits_applied: String,
|
|
@@ -1633,11 +1606,11 @@ module Orb
|
|
|
1633
1606
|
quantity: Float,
|
|
1634
1607
|
start_date: Time,
|
|
1635
1608
|
sub_line_items: T::Array[
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
|
|
1640
|
-
|
|
1609
|
+
T.any(
|
|
1610
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem,
|
|
1611
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem,
|
|
1612
|
+
Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem
|
|
1613
|
+
)
|
|
1641
1614
|
],
|
|
1642
1615
|
subtotal: String,
|
|
1643
1616
|
tax_amounts: T::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount],
|
|
@@ -1645,8 +1618,7 @@ module Orb
|
|
|
1645
1618
|
}
|
|
1646
1619
|
)
|
|
1647
1620
|
end
|
|
1648
|
-
def to_hash
|
|
1649
|
-
end
|
|
1621
|
+
def to_hash; end
|
|
1650
1622
|
|
|
1651
1623
|
module Adjustment
|
|
1652
1624
|
extend Orb::Internal::Type::Union
|
|
@@ -1667,7 +1639,7 @@ module Orb
|
|
|
1667
1639
|
attr_accessor :applies_to_price_ids
|
|
1668
1640
|
|
|
1669
1641
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
|
1670
|
-
#
|
|
1642
|
+
# that apply to only one price.
|
|
1671
1643
|
sig { returns(T::Boolean) }
|
|
1672
1644
|
attr_accessor :is_invoice_level
|
|
1673
1645
|
|
|
@@ -1676,7 +1648,7 @@ module Orb
|
|
|
1676
1648
|
attr_accessor :reason
|
|
1677
1649
|
|
|
1678
1650
|
# The number of usage units by which to discount the price this adjustment applies
|
|
1679
|
-
#
|
|
1651
|
+
# to in a given billing period.
|
|
1680
1652
|
sig { returns(Float) }
|
|
1681
1653
|
attr_accessor :usage_discount
|
|
1682
1654
|
|
|
@@ -1700,9 +1672,7 @@ module Orb
|
|
|
1700
1672
|
reason:,
|
|
1701
1673
|
usage_discount:,
|
|
1702
1674
|
adjustment_type: :usage_discount
|
|
1703
|
-
)
|
|
1704
|
-
end
|
|
1705
|
-
|
|
1675
|
+
); end
|
|
1706
1676
|
sig do
|
|
1707
1677
|
override
|
|
1708
1678
|
.returns(
|
|
@@ -1717,8 +1687,7 @@ module Orb
|
|
|
1717
1687
|
}
|
|
1718
1688
|
)
|
|
1719
1689
|
end
|
|
1720
|
-
def to_hash
|
|
1721
|
-
end
|
|
1690
|
+
def to_hash; end
|
|
1722
1691
|
end
|
|
1723
1692
|
|
|
1724
1693
|
class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
|
@@ -1733,7 +1702,7 @@ module Orb
|
|
|
1733
1702
|
attr_accessor :amount
|
|
1734
1703
|
|
|
1735
1704
|
# The amount by which to discount the prices this adjustment applies to in a given
|
|
1736
|
-
#
|
|
1705
|
+
# billing period.
|
|
1737
1706
|
sig { returns(String) }
|
|
1738
1707
|
attr_accessor :amount_discount
|
|
1739
1708
|
|
|
@@ -1742,7 +1711,7 @@ module Orb
|
|
|
1742
1711
|
attr_accessor :applies_to_price_ids
|
|
1743
1712
|
|
|
1744
1713
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
|
1745
|
-
#
|
|
1714
|
+
# that apply to only one price.
|
|
1746
1715
|
sig { returns(T::Boolean) }
|
|
1747
1716
|
attr_accessor :is_invoice_level
|
|
1748
1717
|
|
|
@@ -1770,9 +1739,7 @@ module Orb
|
|
|
1770
1739
|
is_invoice_level:,
|
|
1771
1740
|
reason:,
|
|
1772
1741
|
adjustment_type: :amount_discount
|
|
1773
|
-
)
|
|
1774
|
-
end
|
|
1775
|
-
|
|
1742
|
+
); end
|
|
1776
1743
|
sig do
|
|
1777
1744
|
override
|
|
1778
1745
|
.returns(
|
|
@@ -1787,8 +1754,7 @@ module Orb
|
|
|
1787
1754
|
}
|
|
1788
1755
|
)
|
|
1789
1756
|
end
|
|
1790
|
-
def to_hash
|
|
1791
|
-
end
|
|
1757
|
+
def to_hash; end
|
|
1792
1758
|
end
|
|
1793
1759
|
|
|
1794
1760
|
class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
|
@@ -1807,12 +1773,12 @@ module Orb
|
|
|
1807
1773
|
attr_accessor :applies_to_price_ids
|
|
1808
1774
|
|
|
1809
1775
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
|
1810
|
-
#
|
|
1776
|
+
# that apply to only one price.
|
|
1811
1777
|
sig { returns(T::Boolean) }
|
|
1812
1778
|
attr_accessor :is_invoice_level
|
|
1813
1779
|
|
|
1814
1780
|
# The percentage (as a value between 0 and 1) by which to discount the price
|
|
1815
|
-
#
|
|
1781
|
+
# intervals this adjustment applies to in a given billing period.
|
|
1816
1782
|
sig { returns(Float) }
|
|
1817
1783
|
attr_accessor :percentage_discount
|
|
1818
1784
|
|
|
@@ -1840,9 +1806,7 @@ module Orb
|
|
|
1840
1806
|
percentage_discount:,
|
|
1841
1807
|
reason:,
|
|
1842
1808
|
adjustment_type: :percentage_discount
|
|
1843
|
-
)
|
|
1844
|
-
end
|
|
1845
|
-
|
|
1809
|
+
); end
|
|
1846
1810
|
sig do
|
|
1847
1811
|
override
|
|
1848
1812
|
.returns(
|
|
@@ -1857,8 +1821,7 @@ module Orb
|
|
|
1857
1821
|
}
|
|
1858
1822
|
)
|
|
1859
1823
|
end
|
|
1860
|
-
def to_hash
|
|
1861
|
-
end
|
|
1824
|
+
def to_hash; end
|
|
1862
1825
|
end
|
|
1863
1826
|
|
|
1864
1827
|
class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel
|
|
@@ -1877,7 +1840,7 @@ module Orb
|
|
|
1877
1840
|
attr_accessor :applies_to_price_ids
|
|
1878
1841
|
|
|
1879
1842
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
|
1880
|
-
#
|
|
1843
|
+
# that apply to only one price.
|
|
1881
1844
|
sig { returns(T::Boolean) }
|
|
1882
1845
|
attr_accessor :is_invoice_level
|
|
1883
1846
|
|
|
@@ -1886,7 +1849,7 @@ module Orb
|
|
|
1886
1849
|
attr_accessor :item_id
|
|
1887
1850
|
|
|
1888
1851
|
# The minimum amount to charge in a given billing period for the prices this
|
|
1889
|
-
#
|
|
1852
|
+
# adjustment applies to.
|
|
1890
1853
|
sig { returns(String) }
|
|
1891
1854
|
attr_accessor :minimum_amount
|
|
1892
1855
|
|
|
@@ -1916,9 +1879,7 @@ module Orb
|
|
|
1916
1879
|
minimum_amount:,
|
|
1917
1880
|
reason:,
|
|
1918
1881
|
adjustment_type: :minimum
|
|
1919
|
-
)
|
|
1920
|
-
end
|
|
1921
|
-
|
|
1882
|
+
); end
|
|
1922
1883
|
sig do
|
|
1923
1884
|
override
|
|
1924
1885
|
.returns(
|
|
@@ -1934,8 +1895,7 @@ module Orb
|
|
|
1934
1895
|
}
|
|
1935
1896
|
)
|
|
1936
1897
|
end
|
|
1937
|
-
def to_hash
|
|
1938
|
-
end
|
|
1898
|
+
def to_hash; end
|
|
1939
1899
|
end
|
|
1940
1900
|
|
|
1941
1901
|
class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel
|
|
@@ -1954,12 +1914,12 @@ module Orb
|
|
|
1954
1914
|
attr_accessor :applies_to_price_ids
|
|
1955
1915
|
|
|
1956
1916
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
|
1957
|
-
#
|
|
1917
|
+
# that apply to only one price.
|
|
1958
1918
|
sig { returns(T::Boolean) }
|
|
1959
1919
|
attr_accessor :is_invoice_level
|
|
1960
1920
|
|
|
1961
1921
|
# The maximum amount to charge in a given billing period for the prices this
|
|
1962
|
-
#
|
|
1922
|
+
# adjustment applies to.
|
|
1963
1923
|
sig { returns(String) }
|
|
1964
1924
|
attr_accessor :maximum_amount
|
|
1965
1925
|
|
|
@@ -1987,9 +1947,7 @@ module Orb
|
|
|
1987
1947
|
maximum_amount:,
|
|
1988
1948
|
reason:,
|
|
1989
1949
|
adjustment_type: :maximum
|
|
1990
|
-
)
|
|
1991
|
-
end
|
|
1992
|
-
|
|
1950
|
+
); end
|
|
1993
1951
|
sig do
|
|
1994
1952
|
override
|
|
1995
1953
|
.returns(
|
|
@@ -2004,8 +1962,7 @@ module Orb
|
|
|
2004
1962
|
}
|
|
2005
1963
|
)
|
|
2006
1964
|
end
|
|
2007
|
-
def to_hash
|
|
2008
|
-
end
|
|
1965
|
+
def to_hash; end
|
|
2009
1966
|
end
|
|
2010
1967
|
|
|
2011
1968
|
sig do
|
|
@@ -2014,13 +1971,12 @@ module Orb
|
|
|
2014
1971
|
[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment]
|
|
2015
1972
|
)
|
|
2016
1973
|
end
|
|
2017
|
-
def self.variants
|
|
2018
|
-
end
|
|
1974
|
+
def self.variants; end
|
|
2019
1975
|
end
|
|
2020
1976
|
|
|
2021
1977
|
class Maximum < Orb::Internal::Type::BaseModel
|
|
2022
1978
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
|
2023
|
-
#
|
|
1979
|
+
# maximums, this can be a subset of prices.
|
|
2024
1980
|
sig { returns(T::Array[String]) }
|
|
2025
1981
|
attr_accessor :applies_to_price_ids
|
|
2026
1982
|
|
|
@@ -2032,17 +1988,15 @@ module Orb
|
|
|
2032
1988
|
sig do
|
|
2033
1989
|
params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
|
|
2034
1990
|
end
|
|
2035
|
-
def self.new(applies_to_price_ids:, maximum_amount:)
|
|
2036
|
-
end
|
|
1991
|
+
def self.new(applies_to_price_ids:, maximum_amount:); end
|
|
2037
1992
|
|
|
2038
1993
|
sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
|
|
2039
|
-
def to_hash
|
|
2040
|
-
end
|
|
1994
|
+
def to_hash; end
|
|
2041
1995
|
end
|
|
2042
1996
|
|
|
2043
1997
|
class Minimum < Orb::Internal::Type::BaseModel
|
|
2044
1998
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
|
2045
|
-
#
|
|
1999
|
+
# minimums, this can be a subset of prices.
|
|
2046
2000
|
sig { returns(T::Array[String]) }
|
|
2047
2001
|
attr_accessor :applies_to_price_ids
|
|
2048
2002
|
|
|
@@ -2054,12 +2008,10 @@ module Orb
|
|
|
2054
2008
|
sig do
|
|
2055
2009
|
params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
|
|
2056
2010
|
end
|
|
2057
|
-
def self.new(applies_to_price_ids:, minimum_amount:)
|
|
2058
|
-
end
|
|
2011
|
+
def self.new(applies_to_price_ids:, minimum_amount:); end
|
|
2059
2012
|
|
|
2060
2013
|
sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
|
|
2061
|
-
def to_hash
|
|
2062
|
-
end
|
|
2014
|
+
def to_hash; end
|
|
2063
2015
|
end
|
|
2064
2016
|
|
|
2065
2017
|
module SubLineItem
|
|
@@ -2132,8 +2084,7 @@ module Orb
|
|
|
2132
2084
|
)
|
|
2133
2085
|
.returns(T.attached_class)
|
|
2134
2086
|
end
|
|
2135
|
-
def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
|
2136
|
-
end
|
|
2087
|
+
def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end
|
|
2137
2088
|
|
|
2138
2089
|
sig do
|
|
2139
2090
|
override
|
|
@@ -2148,8 +2099,7 @@ module Orb
|
|
|
2148
2099
|
}
|
|
2149
2100
|
)
|
|
2150
2101
|
end
|
|
2151
|
-
def to_hash
|
|
2152
|
-
end
|
|
2102
|
+
def to_hash; end
|
|
2153
2103
|
|
|
2154
2104
|
class Grouping < Orb::Internal::Type::BaseModel
|
|
2155
2105
|
sig { returns(String) }
|
|
@@ -2160,12 +2110,10 @@ module Orb
|
|
|
2160
2110
|
attr_accessor :value
|
|
2161
2111
|
|
|
2162
2112
|
sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
|
|
2163
|
-
def self.new(key:, value:)
|
|
2164
|
-
end
|
|
2113
|
+
def self.new(key:, value:); end
|
|
2165
2114
|
|
|
2166
2115
|
sig { override.returns({key: String, value: T.nilable(String)}) }
|
|
2167
|
-
def to_hash
|
|
2168
|
-
end
|
|
2116
|
+
def to_hash; end
|
|
2169
2117
|
end
|
|
2170
2118
|
|
|
2171
2119
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
|
@@ -2174,12 +2122,10 @@ module Orb
|
|
|
2174
2122
|
attr_accessor :dimension_values
|
|
2175
2123
|
|
|
2176
2124
|
sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) }
|
|
2177
|
-
def self.new(dimension_values:)
|
|
2178
|
-
end
|
|
2125
|
+
def self.new(dimension_values:); end
|
|
2179
2126
|
|
|
2180
2127
|
sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) }
|
|
2181
|
-
def to_hash
|
|
2182
|
-
end
|
|
2128
|
+
def to_hash; end
|
|
2183
2129
|
end
|
|
2184
2130
|
end
|
|
2185
2131
|
|
|
@@ -2250,8 +2196,7 @@ module Orb
|
|
|
2250
2196
|
)
|
|
2251
2197
|
.returns(T.attached_class)
|
|
2252
2198
|
end
|
|
2253
|
-
def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
|
2254
|
-
end
|
|
2199
|
+
def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end
|
|
2255
2200
|
|
|
2256
2201
|
sig do
|
|
2257
2202
|
override
|
|
@@ -2266,8 +2211,7 @@ module Orb
|
|
|
2266
2211
|
}
|
|
2267
2212
|
)
|
|
2268
2213
|
end
|
|
2269
|
-
def to_hash
|
|
2270
|
-
end
|
|
2214
|
+
def to_hash; end
|
|
2271
2215
|
|
|
2272
2216
|
class Grouping < Orb::Internal::Type::BaseModel
|
|
2273
2217
|
sig { returns(String) }
|
|
@@ -2278,12 +2222,10 @@ module Orb
|
|
|
2278
2222
|
attr_accessor :value
|
|
2279
2223
|
|
|
2280
2224
|
sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
|
|
2281
|
-
def self.new(key:, value:)
|
|
2282
|
-
end
|
|
2225
|
+
def self.new(key:, value:); end
|
|
2283
2226
|
|
|
2284
2227
|
sig { override.returns({key: String, value: T.nilable(String)}) }
|
|
2285
|
-
def to_hash
|
|
2286
|
-
end
|
|
2228
|
+
def to_hash; end
|
|
2287
2229
|
end
|
|
2288
2230
|
|
|
2289
2231
|
class TierConfig < Orb::Internal::Type::BaseModel
|
|
@@ -2303,12 +2245,10 @@ module Orb
|
|
|
2303
2245
|
unit_amount: String
|
|
2304
2246
|
).returns(T.attached_class)
|
|
2305
2247
|
end
|
|
2306
|
-
def self.new(first_unit:, last_unit:, unit_amount:)
|
|
2307
|
-
end
|
|
2248
|
+
def self.new(first_unit:, last_unit:, unit_amount:); end
|
|
2308
2249
|
|
|
2309
2250
|
sig { override.returns({first_unit: Float, last_unit: T.nilable(Float), unit_amount: String}) }
|
|
2310
|
-
def to_hash
|
|
2311
|
-
end
|
|
2251
|
+
def to_hash; end
|
|
2312
2252
|
end
|
|
2313
2253
|
end
|
|
2314
2254
|
|
|
@@ -2361,8 +2301,7 @@ module Orb
|
|
|
2361
2301
|
)
|
|
2362
2302
|
.returns(T.attached_class)
|
|
2363
2303
|
end
|
|
2364
|
-
def self.new(amount:, grouping:, name:, quantity:, type: :"'null'")
|
|
2365
|
-
end
|
|
2304
|
+
def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end
|
|
2366
2305
|
|
|
2367
2306
|
sig do
|
|
2368
2307
|
override
|
|
@@ -2376,8 +2315,7 @@ module Orb
|
|
|
2376
2315
|
}
|
|
2377
2316
|
)
|
|
2378
2317
|
end
|
|
2379
|
-
def to_hash
|
|
2380
|
-
end
|
|
2318
|
+
def to_hash; end
|
|
2381
2319
|
|
|
2382
2320
|
class Grouping < Orb::Internal::Type::BaseModel
|
|
2383
2321
|
sig { returns(String) }
|
|
@@ -2388,12 +2326,10 @@ module Orb
|
|
|
2388
2326
|
attr_accessor :value
|
|
2389
2327
|
|
|
2390
2328
|
sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
|
|
2391
|
-
def self.new(key:, value:)
|
|
2392
|
-
end
|
|
2329
|
+
def self.new(key:, value:); end
|
|
2393
2330
|
|
|
2394
2331
|
sig { override.returns({key: String, value: T.nilable(String)}) }
|
|
2395
|
-
def to_hash
|
|
2396
|
-
end
|
|
2332
|
+
def to_hash; end
|
|
2397
2333
|
end
|
|
2398
2334
|
end
|
|
2399
2335
|
|
|
@@ -2403,8 +2339,7 @@ module Orb
|
|
|
2403
2339
|
[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem]
|
|
2404
2340
|
)
|
|
2405
2341
|
end
|
|
2406
|
-
def self.variants
|
|
2407
|
-
end
|
|
2342
|
+
def self.variants; end
|
|
2408
2343
|
end
|
|
2409
2344
|
|
|
2410
2345
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
|
@@ -2424,8 +2359,7 @@ module Orb
|
|
|
2424
2359
|
params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String))
|
|
2425
2360
|
.returns(T.attached_class)
|
|
2426
2361
|
end
|
|
2427
|
-
def self.new(amount:, tax_rate_description:, tax_rate_percentage:)
|
|
2428
|
-
end
|
|
2362
|
+
def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end
|
|
2429
2363
|
|
|
2430
2364
|
sig do
|
|
2431
2365
|
override.returns(
|
|
@@ -2436,14 +2370,13 @@ module Orb
|
|
|
2436
2370
|
}
|
|
2437
2371
|
)
|
|
2438
2372
|
end
|
|
2439
|
-
def to_hash
|
|
2440
|
-
end
|
|
2373
|
+
def to_hash; end
|
|
2441
2374
|
end
|
|
2442
2375
|
end
|
|
2443
2376
|
|
|
2444
2377
|
class Maximum < Orb::Internal::Type::BaseModel
|
|
2445
2378
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
|
2446
|
-
#
|
|
2379
|
+
# maximums, this can be a subset of prices.
|
|
2447
2380
|
sig { returns(T::Array[String]) }
|
|
2448
2381
|
attr_accessor :applies_to_price_ids
|
|
2449
2382
|
|
|
@@ -2454,17 +2387,15 @@ module Orb
|
|
|
2454
2387
|
sig do
|
|
2455
2388
|
params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
|
|
2456
2389
|
end
|
|
2457
|
-
def self.new(applies_to_price_ids:, maximum_amount:)
|
|
2458
|
-
end
|
|
2390
|
+
def self.new(applies_to_price_ids:, maximum_amount:); end
|
|
2459
2391
|
|
|
2460
2392
|
sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
|
|
2461
|
-
def to_hash
|
|
2462
|
-
end
|
|
2393
|
+
def to_hash; end
|
|
2463
2394
|
end
|
|
2464
2395
|
|
|
2465
2396
|
class Minimum < Orb::Internal::Type::BaseModel
|
|
2466
2397
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
|
2467
|
-
#
|
|
2398
|
+
# minimums, this can be a subset of prices.
|
|
2468
2399
|
sig { returns(T::Array[String]) }
|
|
2469
2400
|
attr_accessor :applies_to_price_ids
|
|
2470
2401
|
|
|
@@ -2475,12 +2406,10 @@ module Orb
|
|
|
2475
2406
|
sig do
|
|
2476
2407
|
params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
|
|
2477
2408
|
end
|
|
2478
|
-
def self.new(applies_to_price_ids:, minimum_amount:)
|
|
2479
|
-
end
|
|
2409
|
+
def self.new(applies_to_price_ids:, minimum_amount:); end
|
|
2480
2410
|
|
|
2481
2411
|
sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
|
|
2482
|
-
def to_hash
|
|
2483
|
-
end
|
|
2412
|
+
def to_hash; end
|
|
2484
2413
|
end
|
|
2485
2414
|
|
|
2486
2415
|
class PaymentAttempt < Orb::Internal::Type::BaseModel
|
|
@@ -2523,8 +2452,7 @@ module Orb
|
|
|
2523
2452
|
)
|
|
2524
2453
|
.returns(T.attached_class)
|
|
2525
2454
|
end
|
|
2526
|
-
def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:)
|
|
2527
|
-
end
|
|
2455
|
+
def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:); end
|
|
2528
2456
|
|
|
2529
2457
|
sig do
|
|
2530
2458
|
override
|
|
@@ -2539,8 +2467,7 @@ module Orb
|
|
|
2539
2467
|
}
|
|
2540
2468
|
)
|
|
2541
2469
|
end
|
|
2542
|
-
def to_hash
|
|
2543
|
-
end
|
|
2470
|
+
def to_hash; end
|
|
2544
2471
|
|
|
2545
2472
|
# The payment provider that attempted to collect the payment.
|
|
2546
2473
|
module PaymentProvider
|
|
@@ -2566,8 +2493,7 @@ module Orb
|
|
|
2566
2493
|
T::Array[Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider::TaggedSymbol]
|
|
2567
2494
|
)
|
|
2568
2495
|
end
|
|
2569
|
-
def self.values
|
|
2570
|
-
end
|
|
2496
|
+
def self.values; end
|
|
2571
2497
|
end
|
|
2572
2498
|
end
|
|
2573
2499
|
|
|
@@ -2601,8 +2527,7 @@ module Orb
|
|
|
2601
2527
|
)
|
|
2602
2528
|
.returns(T.attached_class)
|
|
2603
2529
|
end
|
|
2604
|
-
def self.new(city:, country:, line1:, line2:, postal_code:, state:)
|
|
2605
|
-
end
|
|
2530
|
+
def self.new(city:, country:, line1:, line2:, postal_code:, state:); end
|
|
2606
2531
|
|
|
2607
2532
|
sig do
|
|
2608
2533
|
override
|
|
@@ -2617,8 +2542,7 @@ module Orb
|
|
|
2617
2542
|
}
|
|
2618
2543
|
)
|
|
2619
2544
|
end
|
|
2620
|
-
def to_hash
|
|
2621
|
-
end
|
|
2545
|
+
def to_hash; end
|
|
2622
2546
|
end
|
|
2623
2547
|
|
|
2624
2548
|
module Status
|
|
@@ -2635,8 +2559,7 @@ module Orb
|
|
|
2635
2559
|
DRAFT = T.let(:draft, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol)
|
|
2636
2560
|
|
|
2637
2561
|
sig { override.returns(T::Array[Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol]) }
|
|
2638
|
-
def self.values
|
|
2639
|
-
end
|
|
2562
|
+
def self.values; end
|
|
2640
2563
|
end
|
|
2641
2564
|
|
|
2642
2565
|
class Subscription < Orb::Internal::Type::BaseModel
|
|
@@ -2644,12 +2567,10 @@ module Orb
|
|
|
2644
2567
|
attr_accessor :id
|
|
2645
2568
|
|
|
2646
2569
|
sig { params(id: String).returns(T.attached_class) }
|
|
2647
|
-
def self.new(id:)
|
|
2648
|
-
end
|
|
2570
|
+
def self.new(id:); end
|
|
2649
2571
|
|
|
2650
2572
|
sig { override.returns({id: String}) }
|
|
2651
|
-
def to_hash
|
|
2652
|
-
end
|
|
2573
|
+
def to_hash; end
|
|
2653
2574
|
end
|
|
2654
2575
|
end
|
|
2655
2576
|
end
|