orb-billing 0.5.1 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/orb/internal/type/array_of.rb +8 -0
- data/lib/orb/internal/type/base_model.rb +7 -0
- data/lib/orb/internal/type/boolean.rb +8 -0
- data/lib/orb/internal/type/enum.rb +12 -0
- data/lib/orb/internal/type/file_input.rb +7 -0
- data/lib/orb/internal/type/hash_of.rb +8 -0
- data/lib/orb/internal/type/union.rb +12 -0
- data/lib/orb/internal/type/unknown.rb +8 -0
- data/lib/orb/internal/util.rb +45 -0
- data/lib/orb/internal.rb +3 -0
- data/lib/orb/models/alert.rb +23 -23
- data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +5 -5
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +6 -10
- data/lib/orb/models/coupon_create_params.rb +3 -9
- data/lib/orb/models/credit_note.rb +33 -33
- data/lib/orb/models/credit_note_create_params.rb +4 -4
- data/lib/orb/models/customer.rb +39 -39
- data/lib/orb/models/customer_create_params.rb +26 -35
- data/lib/orb/models/customer_update_by_external_id_params.rb +26 -35
- data/lib/orb/models/customer_update_params.rb +26 -35
- data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -14
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/dimensional_price_groups.rb +4 -4
- data/lib/orb/models/discount.rb +1 -7
- data/lib/orb/models/evaluate_price_group.rb +0 -4
- data/lib/orb/models/event_ingest_params.rb +3 -3
- data/lib/orb/models/events/event_volumes.rb +2 -2
- data/lib/orb/models/invoice.rb +114 -135
- data/lib/orb/models/invoice_create_params.rb +10 -10
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -28
- data/lib/orb/models/invoice_level_discount.rb +1 -5
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -26
- data/lib/orb/models/invoice_list_params.rb +4 -4
- data/lib/orb/models/item.rb +5 -5
- data/lib/orb/models/item_update_params.rb +5 -5
- data/lib/orb/models/percentage_discount.rb +5 -5
- data/lib/orb/models/plan.rb +58 -70
- data/lib/orb/models/plan_create_params.rb +448 -476
- data/lib/orb/models/plan_list_params.rb +2 -2
- data/lib/orb/models/price.rb +1204 -1239
- data/lib/orb/models/price_create_params.rb +50 -50
- data/lib/orb/models/price_evaluate_response.rb +2 -2
- data/lib/orb/models/subscription.rb +58 -78
- data/lib/orb/models/subscription_cancel_params.rb +2 -2
- data/lib/orb/models/subscription_cancel_response.rb +14 -36
- data/lib/orb/models/subscription_change_apply_response.rb +14 -36
- data/lib/orb/models/subscription_change_cancel_response.rb +14 -36
- data/lib/orb/models/subscription_change_retrieve_response.rb +14 -36
- data/lib/orb/models/subscription_create_params.rb +1002 -1075
- data/lib/orb/models/subscription_create_response.rb +14 -36
- data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
- data/lib/orb/models/subscription_list_params.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +596 -674
- data/lib/orb/models/subscription_price_intervals_response.rb +14 -36
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -1059
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -36
- data/lib/orb/models/subscription_trigger_phase_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -36
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -36
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +14 -36
- data/lib/orb/models/subscription_usage.rb +26 -35
- data/lib/orb/models/subscriptions.rb +4 -4
- data/lib/orb/models/trial_discount.rb +5 -5
- data/lib/orb/models/usage_discount.rb +5 -5
- data/lib/orb/models.rb +30 -16
- data/lib/orb/resources/alerts.rb +15 -15
- data/lib/orb/resources/coupons/subscriptions.rb +1 -1
- data/lib/orb/resources/coupons.rb +5 -5
- data/lib/orb/resources/credit_notes.rb +5 -5
- data/lib/orb/resources/customers/balance_transactions.rb +1 -1
- data/lib/orb/resources/customers/costs.rb +2 -2
- data/lib/orb/resources/customers/credits/ledger.rb +10 -10
- data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
- data/lib/orb/resources/customers.rb +30 -30
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
- data/lib/orb/resources/dimensional_price_groups.rb +3 -3
- data/lib/orb/resources/events/volume.rb +1 -1
- data/lib/orb/resources/events.rb +1 -1
- data/lib/orb/resources/invoices.rb +12 -12
- data/lib/orb/resources/items.rb +5 -5
- data/lib/orb/resources/metrics.rb +4 -4
- data/lib/orb/resources/plans/external_plan_id.rb +2 -2
- data/lib/orb/resources/plans.rb +7 -7
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +17 -17
- data/lib/orb/resources/subscriptions.rb +32 -32
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/internal/type/array_of.rbi +6 -0
- data/rbi/orb/internal/type/base_model.rbi +5 -0
- data/rbi/orb/internal/type/boolean.rbi +6 -0
- data/rbi/orb/internal/type/enum.rbi +5 -0
- data/rbi/orb/internal/type/file_input.rbi +5 -0
- data/rbi/orb/internal/type/hash_of.rbi +6 -0
- data/rbi/orb/internal/type/union.rbi +5 -0
- data/rbi/orb/internal/type/unknown.rbi +6 -0
- data/rbi/orb/internal/util.rbi +30 -0
- data/rbi/orb/internal.rbi +3 -0
- data/rbi/orb/models/coupon.rbi +2 -2
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +2 -65
- data/rbi/orb/models/customers/cost_list_response.rbi +2 -65
- data/rbi/orb/models/evaluate_price_group.rbi +7 -3
- data/rbi/orb/models/invoice.rbi +10 -149
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +10 -133
- data/rbi/orb/models/invoice_line_item_create_response.rbi +8 -114
- data/rbi/orb/models/plan.rbi +8 -134
- data/rbi/orb/models/price.rbi +56 -588
- data/rbi/orb/models/subscription.rbi +6 -99
- data/rbi/orb/models/subscription_cancel_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_apply_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_cancel_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +6 -89
- data/rbi/orb/models/subscription_create_response.rbi +6 -89
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +2 -65
- data/rbi/orb/models/subscription_price_intervals_response.rbi +6 -89
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +6 -89
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +6 -89
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +6 -89
- data/rbi/orb/models/subscription_update_trial_response.rbi +6 -89
- data/rbi/orb/resources/customers/credits/ledger.rbi +4 -36
- data/rbi/orb/resources/prices/external_price_id.rbi +2 -64
- data/rbi/orb/resources/prices.rbi +4 -130
- data/rbi/orb/resources/subscriptions.rbi +1 -6
- data/sig/orb/internal/page.rbs +2 -0
- data/sig/orb/internal/type/array_of.rbs +3 -0
- data/sig/orb/internal/type/base_model.rbs +2 -0
- data/sig/orb/internal/type/boolean.rbs +3 -0
- data/sig/orb/internal/type/enum.rbs +2 -0
- data/sig/orb/internal/type/file_input.rbs +2 -0
- data/sig/orb/internal/type/hash_of.rbs +3 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/type/unknown.rbs +3 -0
- data/sig/orb/internal/util.rbs +12 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +32 -4
- data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
- data/sig/orb/models/alert_disable_params.rbs +5 -0
- data/sig/orb/models/alert_enable_params.rbs +5 -0
- data/sig/orb/models/alert_list_params.rbs +13 -0
- data/sig/orb/models/alert_retrieve_params.rbs +2 -0
- data/sig/orb/models/alert_update_params.rbs +7 -0
- data/sig/orb/models/amount_discount.rbs +11 -4
- data/sig/orb/models/billable_metric.rbs +13 -4
- data/sig/orb/models/coupon.rbs +14 -4
- data/sig/orb/models/coupon_archive_params.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +15 -0
- data/sig/orb/models/coupon_fetch_params.rbs +2 -0
- data/sig/orb/models/coupon_list_params.rbs +8 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
- data/sig/orb/models/credit_note.rbs +88 -20
- data/sig/orb/models/credit_note_create_params.rbs +9 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
- data/sig/orb/models/credit_note_list_params.rbs +10 -0
- data/sig/orb/models/customer.rbs +86 -16
- data/sig/orb/models/customer_create_params.rbs +79 -8
- data/sig/orb/models/customer_delete_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_params.rbs +2 -0
- data/sig/orb/models/customer_list_params.rbs +10 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
- data/sig/orb/models/customer_update_params.rbs +78 -8
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
- data/sig/orb/models/customers/cost_list_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_response.rbs +20 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
- data/sig/orb/models/customers/credit_list_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_response.rbs +10 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
- data/sig/orb/models/dimensional_price_group.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups.rbs +5 -0
- data/sig/orb/models/evaluate_price_group.rbs +10 -4
- data/sig/orb/models/event_deprecate_params.rbs +2 -0
- data/sig/orb/models/event_deprecate_response.rbs +2 -0
- data/sig/orb/models/event_ingest_params.rbs +16 -0
- data/sig/orb/models/event_ingest_response.rbs +15 -0
- data/sig/orb/models/event_search_params.rbs +7 -0
- data/sig/orb/models/event_search_response.rbs +12 -0
- data/sig/orb/models/event_update_params.rbs +9 -0
- data/sig/orb/models/event_update_response.rbs +2 -0
- data/sig/orb/models/events/backfill_close_params.rbs +2 -0
- data/sig/orb/models/events/backfill_close_response.rbs +14 -0
- data/sig/orb/models/events/backfill_create_params.rbs +11 -0
- data/sig/orb/models/events/backfill_create_response.rbs +14 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
- data/sig/orb/models/events/backfill_list_params.rbs +6 -0
- data/sig/orb/models/events/backfill_list_response.rbs +14 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
- data/sig/orb/models/events/event_volumes.rbs +8 -0
- data/sig/orb/models/events/volume_list_params.rbs +8 -0
- data/sig/orb/models/invoice.rbs +293 -36
- data/sig/orb/models/invoice_create_params.rbs +30 -4
- data/sig/orb/models/invoice_fetch_params.rbs +2 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
- data/sig/orb/models/invoice_issue_params.rbs +5 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
- data/sig/orb/models/invoice_list_params.rbs +27 -4
- data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
- data/sig/orb/models/invoice_pay_params.rbs +2 -0
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +2 -0
- data/sig/orb/models/item.rbs +16 -4
- data/sig/orb/models/item_create_params.rbs +2 -0
- data/sig/orb/models/item_fetch_params.rbs +2 -0
- data/sig/orb/models/item_list_params.rbs +6 -0
- data/sig/orb/models/item_update_params.rbs +15 -4
- data/sig/orb/models/metric_create_params.rbs +9 -0
- data/sig/orb/models/metric_fetch_params.rbs +2 -0
- data/sig/orb/models/metric_list_params.rbs +10 -0
- data/sig/orb/models/metric_update_params.rbs +5 -0
- data/sig/orb/models/pagination_metadata.rbs +2 -0
- data/sig/orb/models/percentage_discount.rbs +11 -4
- data/sig/orb/models/plan.rbs +141 -16
- data/sig/orb/models/plan_create_params.rbs +1070 -304
- data/sig/orb/models/plan_fetch_params.rbs +2 -0
- data/sig/orb/models/plan_list_params.rbs +11 -0
- data/sig/orb/models/plan_update_params.rbs +6 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
- data/sig/orb/models/price.rbs +2148 -460
- data/sig/orb/models/price_create_params.rbs +130 -8
- data/sig/orb/models/price_evaluate_params.rbs +10 -0
- data/sig/orb/models/price_evaluate_response.rbs +2 -0
- data/sig/orb/models/price_fetch_params.rbs +2 -0
- data/sig/orb/models/price_list_params.rbs +6 -0
- data/sig/orb/models/price_update_params.rbs +5 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
- data/sig/orb/models/subscription.rbs +177 -12
- data/sig/orb/models/subscription_cancel_params.rbs +7 -0
- data/sig/orb/models/subscription_cancel_response.rbs +173 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
- data/sig/orb/models/subscription_create_params.rbs +2368 -632
- data/sig/orb/models/subscription_create_response.rbs +173 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
- data/sig/orb/models/subscription_fetch_params.rbs +2 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
- data/sig/orb/models/subscription_list_params.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
- data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
- data/sig/orb/models/subscription_update_params.rbs +9 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
- data/sig/orb/models/subscription_usage.rbs +48 -8
- data/sig/orb/models/subscriptions.rbs +5 -0
- data/sig/orb/models/top_level_ping_params.rbs +2 -0
- data/sig/orb/models/top_level_ping_response.rbs +2 -0
- data/sig/orb/models/trial_discount.rbs +12 -4
- data/sig/orb/models/usage_discount.rbs +11 -4
- data/sig/orb/resources/invoices.rbs +1 -1
- data/sig/orb/resources/plans.rbs +1 -1
- metadata +2 -2
data/lib/orb/models/invoice.rb
CHANGED
@@ -18,12 +18,12 @@ module Orb
|
|
18
18
|
|
19
19
|
# @!attribute auto_collection
|
20
20
|
#
|
21
|
-
# @return [Orb::Invoice::AutoCollection]
|
21
|
+
# @return [Orb::Models::Invoice::AutoCollection]
|
22
22
|
required :auto_collection, -> { Orb::Invoice::AutoCollection }
|
23
23
|
|
24
24
|
# @!attribute billing_address
|
25
25
|
#
|
26
|
-
# @return [Orb::Invoice::BillingAddress, nil]
|
26
|
+
# @return [Orb::Models::Invoice::BillingAddress, nil]
|
27
27
|
required :billing_address, -> { Orb::Invoice::BillingAddress }, nil?: true
|
28
28
|
|
29
29
|
# @!attribute created_at
|
@@ -35,7 +35,7 @@ module Orb
|
|
35
35
|
# @!attribute credit_notes
|
36
36
|
# A list of credit notes associated with the invoice
|
37
37
|
#
|
38
|
-
# @return [Array<Orb::Invoice::CreditNote>]
|
38
|
+
# @return [Array<Orb::Models::Invoice::CreditNote>]
|
39
39
|
required :credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::CreditNote] }
|
40
40
|
|
41
41
|
# @!attribute currency
|
@@ -46,12 +46,12 @@ module Orb
|
|
46
46
|
|
47
47
|
# @!attribute customer
|
48
48
|
#
|
49
|
-
# @return [Orb::Invoice::Customer]
|
49
|
+
# @return [Orb::Models::Invoice::Customer]
|
50
50
|
required :customer, -> { Orb::Invoice::Customer }
|
51
51
|
|
52
52
|
# @!attribute customer_balance_transactions
|
53
53
|
#
|
54
|
-
# @return [Array<Orb::Invoice::CustomerBalanceTransaction>]
|
54
|
+
# @return [Array<Orb::Models::Invoice::CustomerBalanceTransaction>]
|
55
55
|
required :customer_balance_transactions,
|
56
56
|
-> { Orb::Internal::Type::ArrayOf[Orb::Invoice::CustomerBalanceTransaction] }
|
57
57
|
|
@@ -162,7 +162,7 @@ module Orb
|
|
162
162
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
163
163
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
164
164
|
#
|
165
|
-
# @return [Orb::Invoice::CustomerTaxID, nil]
|
165
|
+
# @return [Orb::Models::Invoice::CustomerTaxID, nil]
|
166
166
|
required :customer_tax_id, -> { Orb::Invoice::CustomerTaxID }, nil?: true
|
167
167
|
|
168
168
|
# @!attribute discount
|
@@ -177,7 +177,7 @@ module Orb
|
|
177
177
|
|
178
178
|
# @!attribute discounts
|
179
179
|
#
|
180
|
-
# @return [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
|
180
|
+
# @return [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
|
181
181
|
required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::InvoiceLevelDiscount] }
|
182
182
|
|
183
183
|
# @!attribute due_date
|
@@ -224,7 +224,7 @@ module Orb
|
|
224
224
|
|
225
225
|
# @!attribute invoice_source
|
226
226
|
#
|
227
|
-
# @return [Symbol, Orb::Invoice::InvoiceSource]
|
227
|
+
# @return [Symbol, Orb::Models::Invoice::InvoiceSource]
|
228
228
|
required :invoice_source, enum: -> { Orb::Invoice::InvoiceSource }
|
229
229
|
|
230
230
|
# @!attribute issue_failed_at
|
@@ -244,12 +244,12 @@ module Orb
|
|
244
244
|
# @!attribute line_items
|
245
245
|
# The breakdown of prices in this invoice.
|
246
246
|
#
|
247
|
-
# @return [Array<Orb::Invoice::LineItem>]
|
247
|
+
# @return [Array<Orb::Models::Invoice::LineItem>]
|
248
248
|
required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem] }
|
249
249
|
|
250
250
|
# @!attribute maximum
|
251
251
|
#
|
252
|
-
# @return [Orb::Invoice::Maximum, nil]
|
252
|
+
# @return [Orb::Models::Invoice::Maximum, nil]
|
253
253
|
required :maximum, -> { Orb::Invoice::Maximum }, nil?: true
|
254
254
|
|
255
255
|
# @!attribute maximum_amount
|
@@ -274,7 +274,7 @@ module Orb
|
|
274
274
|
|
275
275
|
# @!attribute minimum
|
276
276
|
#
|
277
|
-
# @return [Orb::Invoice::Minimum, nil]
|
277
|
+
# @return [Orb::Models::Invoice::Minimum, nil]
|
278
278
|
required :minimum, -> { Orb::Invoice::Minimum }, nil?: true
|
279
279
|
|
280
280
|
# @!attribute minimum_amount
|
@@ -292,7 +292,7 @@ module Orb
|
|
292
292
|
# @!attribute payment_attempts
|
293
293
|
# A list of payment attempts associated with the invoice
|
294
294
|
#
|
295
|
-
# @return [Array<Orb::Invoice::PaymentAttempt>]
|
295
|
+
# @return [Array<Orb::Models::Invoice::PaymentAttempt>]
|
296
296
|
required :payment_attempts, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::PaymentAttempt] }
|
297
297
|
|
298
298
|
# @!attribute payment_failed_at
|
@@ -319,17 +319,17 @@ module Orb
|
|
319
319
|
|
320
320
|
# @!attribute shipping_address
|
321
321
|
#
|
322
|
-
# @return [Orb::Invoice::ShippingAddress, nil]
|
322
|
+
# @return [Orb::Models::Invoice::ShippingAddress, nil]
|
323
323
|
required :shipping_address, -> { Orb::Invoice::ShippingAddress }, nil?: true
|
324
324
|
|
325
325
|
# @!attribute status
|
326
326
|
#
|
327
|
-
# @return [Symbol, Orb::Invoice::Status]
|
327
|
+
# @return [Symbol, Orb::Models::Invoice::Status]
|
328
328
|
required :status, enum: -> { Orb::Invoice::Status }
|
329
329
|
|
330
330
|
# @!attribute subscription
|
331
331
|
#
|
332
|
-
# @return [Orb::Invoice::Subscription, nil]
|
332
|
+
# @return [Orb::Models::Invoice::Subscription, nil]
|
333
333
|
required :subscription, -> { Orb::Invoice::Subscription }, nil?: true
|
334
334
|
|
335
335
|
# @!attribute subtotal
|
@@ -367,8 +367,8 @@ module Orb
|
|
367
367
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
368
368
|
|
369
369
|
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
370
|
-
# Some parameter documentations has been truncated, see {Orb::Invoice} for
|
371
|
-
# details.
|
370
|
+
# Some parameter documentations has been truncated, see {Orb::Models::Invoice} for
|
371
|
+
# more details.
|
372
372
|
#
|
373
373
|
# An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
374
374
|
# representing the request for payment for a single subscription. This includes a
|
@@ -380,25 +380,25 @@ module Orb
|
|
380
380
|
#
|
381
381
|
# @param amount_due [String] This is the final amount required to be charged to the customer and reflects the
|
382
382
|
#
|
383
|
-
# @param auto_collection [Orb::Invoice::AutoCollection]
|
383
|
+
# @param auto_collection [Orb::Models::Invoice::AutoCollection]
|
384
384
|
#
|
385
|
-
# @param billing_address [Orb::Invoice::BillingAddress, nil]
|
385
|
+
# @param billing_address [Orb::Models::Invoice::BillingAddress, nil]
|
386
386
|
#
|
387
387
|
# @param created_at [Time] The creation time of the resource in Orb.
|
388
388
|
#
|
389
|
-
# @param credit_notes [Array<Orb::Invoice::CreditNote>] A list of credit notes associated with the invoice
|
389
|
+
# @param credit_notes [Array<Orb::Models::Invoice::CreditNote>] A list of credit notes associated with the invoice
|
390
390
|
#
|
391
391
|
# @param currency [String] An ISO 4217 currency string or `credits`
|
392
392
|
#
|
393
|
-
# @param customer [Orb::Invoice::Customer]
|
393
|
+
# @param customer [Orb::Models::Invoice::Customer]
|
394
394
|
#
|
395
|
-
# @param customer_balance_transactions [Array<Orb::Invoice::CustomerBalanceTransaction>]
|
395
|
+
# @param customer_balance_transactions [Array<Orb::Models::Invoice::CustomerBalanceTransaction>]
|
396
396
|
#
|
397
|
-
# @param customer_tax_id [Orb::Invoice::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
397
|
+
# @param customer_tax_id [Orb::Models::Invoice::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
398
398
|
#
|
399
399
|
# @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
|
400
400
|
#
|
401
|
-
# @param discounts [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
|
401
|
+
# @param discounts [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
|
402
402
|
#
|
403
403
|
# @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
|
404
404
|
#
|
@@ -412,15 +412,15 @@ module Orb
|
|
412
412
|
#
|
413
413
|
# @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`.
|
414
414
|
#
|
415
|
-
# @param invoice_source [Symbol, Orb::Invoice::InvoiceSource]
|
415
|
+
# @param invoice_source [Symbol, Orb::Models::Invoice::InvoiceSource]
|
416
416
|
#
|
417
417
|
# @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e
|
418
418
|
#
|
419
419
|
# @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued
|
420
420
|
#
|
421
|
-
# @param line_items [Array<Orb::Invoice::LineItem>] The breakdown of prices in this invoice.
|
421
|
+
# @param line_items [Array<Orb::Models::Invoice::LineItem>] The breakdown of prices in this invoice.
|
422
422
|
#
|
423
|
-
# @param maximum [Orb::Invoice::Maximum, nil]
|
423
|
+
# @param maximum [Orb::Models::Invoice::Maximum, nil]
|
424
424
|
#
|
425
425
|
# @param maximum_amount [String, nil]
|
426
426
|
#
|
@@ -428,13 +428,13 @@ module Orb
|
|
428
428
|
#
|
429
429
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
430
430
|
#
|
431
|
-
# @param minimum [Orb::Invoice::Minimum, nil]
|
431
|
+
# @param minimum [Orb::Models::Invoice::Minimum, nil]
|
432
432
|
#
|
433
433
|
# @param minimum_amount [String, nil]
|
434
434
|
#
|
435
435
|
# @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w
|
436
436
|
#
|
437
|
-
# @param payment_attempts [Array<Orb::Invoice::PaymentAttempt>] A list of payment attempts associated with the invoice
|
437
|
+
# @param payment_attempts [Array<Orb::Models::Invoice::PaymentAttempt>] A list of payment attempts associated with the invoice
|
438
438
|
#
|
439
439
|
# @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
|
440
440
|
#
|
@@ -442,11 +442,11 @@ module Orb
|
|
442
442
|
#
|
443
443
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
444
444
|
#
|
445
|
-
# @param shipping_address [Orb::Invoice::ShippingAddress, nil]
|
445
|
+
# @param shipping_address [Orb::Models::Invoice::ShippingAddress, nil]
|
446
446
|
#
|
447
|
-
# @param status [Symbol, Orb::Invoice::Status]
|
447
|
+
# @param status [Symbol, Orb::Models::Invoice::Status]
|
448
448
|
#
|
449
|
-
# @param subscription [Orb::Invoice::Subscription, nil]
|
449
|
+
# @param subscription [Orb::Models::Invoice::Subscription, nil]
|
450
450
|
#
|
451
451
|
# @param subtotal [String] The total before any discounts and minimums are applied.
|
452
452
|
#
|
@@ -458,7 +458,7 @@ module Orb
|
|
458
458
|
#
|
459
459
|
# @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals
|
460
460
|
|
461
|
-
# @see Orb::Invoice#auto_collection
|
461
|
+
# @see Orb::Models::Invoice#auto_collection
|
462
462
|
class AutoCollection < Orb::Internal::Type::BaseModel
|
463
463
|
# @!attribute enabled
|
464
464
|
# True only if auto-collection is enabled for this invoice.
|
@@ -493,7 +493,7 @@ module Orb
|
|
493
493
|
|
494
494
|
# @!method initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:)
|
495
495
|
# Some parameter documentations has been truncated, see
|
496
|
-
# {Orb::Invoice::AutoCollection} for more details.
|
496
|
+
# {Orb::Models::Invoice::AutoCollection} for more details.
|
497
497
|
#
|
498
498
|
# @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice.
|
499
499
|
#
|
@@ -504,7 +504,7 @@ module Orb
|
|
504
504
|
# @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
|
505
505
|
end
|
506
506
|
|
507
|
-
# @see Orb::Invoice#billing_address
|
507
|
+
# @see Orb::Models::Invoice#billing_address
|
508
508
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
509
509
|
# @!attribute city
|
510
510
|
#
|
@@ -585,8 +585,8 @@ module Orb
|
|
585
585
|
required :voided_at, Time, nil?: true
|
586
586
|
|
587
587
|
# @!method initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:)
|
588
|
-
# Some parameter documentations has been truncated, see
|
589
|
-
# for more details.
|
588
|
+
# Some parameter documentations has been truncated, see
|
589
|
+
# {Orb::Models::Invoice::CreditNote} for more details.
|
590
590
|
#
|
591
591
|
# @param id [String]
|
592
592
|
#
|
@@ -603,7 +603,7 @@ module Orb
|
|
603
603
|
# @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
|
604
604
|
end
|
605
605
|
|
606
|
-
# @see Orb::Invoice#customer
|
606
|
+
# @see Orb::Models::Invoice#customer
|
607
607
|
class Customer < Orb::Internal::Type::BaseModel
|
608
608
|
# @!attribute id
|
609
609
|
#
|
@@ -629,7 +629,7 @@ module Orb
|
|
629
629
|
|
630
630
|
# @!attribute action
|
631
631
|
#
|
632
|
-
# @return [Symbol, Orb::Invoice::CustomerBalanceTransaction::Action]
|
632
|
+
# @return [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action]
|
633
633
|
required :action, enum: -> { Orb::Invoice::CustomerBalanceTransaction::Action }
|
634
634
|
|
635
635
|
# @!attribute amount
|
@@ -646,7 +646,7 @@ module Orb
|
|
646
646
|
|
647
647
|
# @!attribute credit_note
|
648
648
|
#
|
649
|
-
# @return [Orb::Invoice::CustomerBalanceTransaction::CreditNote, nil]
|
649
|
+
# @return [Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote, nil]
|
650
650
|
required :credit_note, -> { Orb::Invoice::CustomerBalanceTransaction::CreditNote }, nil?: true
|
651
651
|
|
652
652
|
# @!attribute description
|
@@ -664,7 +664,7 @@ module Orb
|
|
664
664
|
|
665
665
|
# @!attribute invoice
|
666
666
|
#
|
667
|
-
# @return [Orb::Invoice::CustomerBalanceTransaction::Invoice, nil]
|
667
|
+
# @return [Orb::Models::Invoice::CustomerBalanceTransaction::Invoice, nil]
|
668
668
|
required :invoice, -> { Orb::Invoice::CustomerBalanceTransaction::Invoice }, nil?: true
|
669
669
|
|
670
670
|
# @!attribute starting_balance
|
@@ -676,34 +676,34 @@ module Orb
|
|
676
676
|
|
677
677
|
# @!attribute type
|
678
678
|
#
|
679
|
-
# @return [Symbol, Orb::Invoice::CustomerBalanceTransaction::Type]
|
679
|
+
# @return [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type]
|
680
680
|
required :type, enum: -> { Orb::Invoice::CustomerBalanceTransaction::Type }
|
681
681
|
|
682
682
|
# @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
|
683
683
|
# Some parameter documentations has been truncated, see
|
684
|
-
# {Orb::Invoice::CustomerBalanceTransaction} for more details.
|
684
|
+
# {Orb::Models::Invoice::CustomerBalanceTransaction} for more details.
|
685
685
|
#
|
686
686
|
# @param id [String] A unique id for this transaction.
|
687
687
|
#
|
688
|
-
# @param action [Symbol, Orb::Invoice::CustomerBalanceTransaction::Action]
|
688
|
+
# @param action [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action]
|
689
689
|
#
|
690
690
|
# @param amount [String] The value of the amount changed in the transaction.
|
691
691
|
#
|
692
692
|
# @param created_at [Time] The creation time of this transaction.
|
693
693
|
#
|
694
|
-
# @param credit_note [Orb::Invoice::CustomerBalanceTransaction::CreditNote, nil]
|
694
|
+
# @param credit_note [Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote, nil]
|
695
695
|
#
|
696
696
|
# @param description [String, nil] An optional description provided for manual customer balance adjustments.
|
697
697
|
#
|
698
698
|
# @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
|
699
699
|
#
|
700
|
-
# @param invoice [Orb::Invoice::CustomerBalanceTransaction::Invoice, nil]
|
700
|
+
# @param invoice [Orb::Models::Invoice::CustomerBalanceTransaction::Invoice, nil]
|
701
701
|
#
|
702
702
|
# @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
|
703
703
|
#
|
704
|
-
# @param type [Symbol, Orb::Invoice::CustomerBalanceTransaction::Type]
|
704
|
+
# @param type [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type]
|
705
705
|
|
706
|
-
# @see Orb::Invoice::CustomerBalanceTransaction#action
|
706
|
+
# @see Orb::Models::Invoice::CustomerBalanceTransaction#action
|
707
707
|
module Action
|
708
708
|
extend Orb::Internal::Type::Enum
|
709
709
|
|
@@ -721,7 +721,7 @@ module Orb
|
|
721
721
|
# @return [Array<Symbol>]
|
722
722
|
end
|
723
723
|
|
724
|
-
# @see Orb::Invoice::CustomerBalanceTransaction#credit_note
|
724
|
+
# @see Orb::Models::Invoice::CustomerBalanceTransaction#credit_note
|
725
725
|
class CreditNote < Orb::Internal::Type::BaseModel
|
726
726
|
# @!attribute id
|
727
727
|
# The id of the Credit note
|
@@ -733,7 +733,7 @@ module Orb
|
|
733
733
|
# @param id [String] The id of the Credit note
|
734
734
|
end
|
735
735
|
|
736
|
-
# @see Orb::Invoice::CustomerBalanceTransaction#invoice
|
736
|
+
# @see Orb::Models::Invoice::CustomerBalanceTransaction#invoice
|
737
737
|
class Invoice < Orb::Internal::Type::BaseModel
|
738
738
|
# @!attribute id
|
739
739
|
# The Invoice id
|
@@ -745,7 +745,7 @@ module Orb
|
|
745
745
|
# @param id [String] The Invoice id
|
746
746
|
end
|
747
747
|
|
748
|
-
# @see Orb::Invoice::CustomerBalanceTransaction#type
|
748
|
+
# @see Orb::Models::Invoice::CustomerBalanceTransaction#type
|
749
749
|
module Type
|
750
750
|
extend Orb::Internal::Type::Enum
|
751
751
|
|
@@ -757,16 +757,16 @@ module Orb
|
|
757
757
|
end
|
758
758
|
end
|
759
759
|
|
760
|
-
# @see Orb::Invoice#customer_tax_id
|
760
|
+
# @see Orb::Models::Invoice#customer_tax_id
|
761
761
|
class CustomerTaxID < Orb::Internal::Type::BaseModel
|
762
762
|
# @!attribute country
|
763
763
|
#
|
764
|
-
# @return [Symbol, Orb::Invoice::CustomerTaxID::Country]
|
764
|
+
# @return [Symbol, Orb::Models::Invoice::CustomerTaxID::Country]
|
765
765
|
required :country, enum: -> { Orb::Invoice::CustomerTaxID::Country }
|
766
766
|
|
767
767
|
# @!attribute type
|
768
768
|
#
|
769
|
-
# @return [Symbol, Orb::Invoice::CustomerTaxID::Type]
|
769
|
+
# @return [Symbol, Orb::Models::Invoice::CustomerTaxID::Type]
|
770
770
|
required :type, enum: -> { Orb::Invoice::CustomerTaxID::Type }
|
771
771
|
|
772
772
|
# @!attribute value
|
@@ -881,11 +881,11 @@ module Orb
|
|
881
881
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
882
882
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
883
883
|
#
|
884
|
-
# @param country [Symbol, Orb::Invoice::CustomerTaxID::Country]
|
885
|
-
# @param type [Symbol, Orb::Invoice::CustomerTaxID::Type]
|
884
|
+
# @param country [Symbol, Orb::Models::Invoice::CustomerTaxID::Country]
|
885
|
+
# @param type [Symbol, Orb::Models::Invoice::CustomerTaxID::Type]
|
886
886
|
# @param value [String]
|
887
887
|
|
888
|
-
# @see Orb::Invoice::CustomerTaxID#country
|
888
|
+
# @see Orb::Models::Invoice::CustomerTaxID#country
|
889
889
|
module Country
|
890
890
|
extend Orb::Internal::Type::Enum
|
891
891
|
|
@@ -972,7 +972,7 @@ module Orb
|
|
972
972
|
# @return [Array<Symbol>]
|
973
973
|
end
|
974
974
|
|
975
|
-
# @see Orb::Invoice::CustomerTaxID#type
|
975
|
+
# @see Orb::Models::Invoice::CustomerTaxID#type
|
976
976
|
module Type
|
977
977
|
extend Orb::Internal::Type::Enum
|
978
978
|
|
@@ -1053,7 +1053,7 @@ module Orb
|
|
1053
1053
|
end
|
1054
1054
|
end
|
1055
1055
|
|
1056
|
-
# @see Orb::Invoice#invoice_source
|
1056
|
+
# @see Orb::Models::Invoice#invoice_source
|
1057
1057
|
module InvoiceSource
|
1058
1058
|
extend Orb::Internal::Type::Enum
|
1059
1059
|
|
@@ -1084,7 +1084,7 @@ module Orb
|
|
1084
1084
|
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
1085
1085
|
# discounts -> minimums -> maximums).
|
1086
1086
|
#
|
1087
|
-
# @return [Array<Orb::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Invoice::LineItem::Adjustment::Minimum, Orb::Invoice::LineItem::Adjustment::Maximum>]
|
1087
|
+
# @return [Array<Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Models::Invoice::LineItem::Adjustment::Minimum, Orb::Models::Invoice::LineItem::Adjustment::Maximum>]
|
1088
1088
|
required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Invoice::LineItem::Adjustment] }
|
1089
1089
|
|
1090
1090
|
# @!attribute amount
|
@@ -1102,7 +1102,7 @@ module Orb
|
|
1102
1102
|
|
1103
1103
|
# @!attribute discount
|
1104
1104
|
#
|
1105
|
-
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
1105
|
+
# @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
1106
1106
|
required :discount, union: -> { Orb::Discount }, nil?: true
|
1107
1107
|
|
1108
1108
|
# @!attribute end_date
|
@@ -1130,7 +1130,7 @@ module Orb
|
|
1130
1130
|
#
|
1131
1131
|
# This field is deprecated in favor of `adjustments`.
|
1132
1132
|
#
|
1133
|
-
# @return [Orb::Invoice::LineItem::Maximum, nil]
|
1133
|
+
# @return [Orb::Models::Invoice::LineItem::Maximum, nil]
|
1134
1134
|
required :maximum, -> { Orb::Invoice::LineItem::Maximum }, nil?: true
|
1135
1135
|
|
1136
1136
|
# @!attribute maximum_amount
|
@@ -1146,7 +1146,7 @@ module Orb
|
|
1146
1146
|
#
|
1147
1147
|
# This field is deprecated in favor of `adjustments`.
|
1148
1148
|
#
|
1149
|
-
# @return [Orb::Invoice::LineItem::Minimum, nil]
|
1149
|
+
# @return [Orb::Models::Invoice::LineItem::Minimum, nil]
|
1150
1150
|
required :minimum, -> { Orb::Invoice::LineItem::Minimum }, nil?: true
|
1151
1151
|
|
1152
1152
|
# @!attribute minimum_amount
|
@@ -1181,7 +1181,7 @@ module Orb
|
|
1181
1181
|
# For more on the types of prices, see
|
1182
1182
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1183
1183
|
#
|
1184
|
-
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil]
|
1184
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, nil]
|
1185
1185
|
required :price, union: -> { Orb::Price }, nil?: true
|
1186
1186
|
|
1187
1187
|
# @!attribute quantity
|
@@ -1200,7 +1200,7 @@ module Orb
|
|
1200
1200
|
# For complex pricing structures, the line item can be broken down further in
|
1201
1201
|
# `sub_line_items`.
|
1202
1202
|
#
|
1203
|
-
# @return [Array<Orb::Invoice::LineItem::SubLineItem::Matrix, Orb::Invoice::LineItem::SubLineItem::Tier, Orb::Invoice::LineItem::SubLineItem::Null>]
|
1203
|
+
# @return [Array<Orb::Models::Invoice::LineItem::SubLineItem::Matrix, Orb::Models::Invoice::LineItem::SubLineItem::Tier, Orb::Models::Invoice::LineItem::SubLineItem::Null>]
|
1204
1204
|
required :sub_line_items,
|
1205
1205
|
-> {
|
1206
1206
|
Orb::Internal::Type::ArrayOf[union: Orb::Invoice::LineItem::SubLineItem]
|
@@ -1216,7 +1216,7 @@ module Orb
|
|
1216
1216
|
# An array of tax rates and their incurred tax amounts. Empty if no tax
|
1217
1217
|
# integration is configured.
|
1218
1218
|
#
|
1219
|
-
# @return [Array<Orb::Invoice::LineItem::TaxAmount>]
|
1219
|
+
# @return [Array<Orb::Models::Invoice::LineItem::TaxAmount>]
|
1220
1220
|
required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::TaxAmount] }
|
1221
1221
|
|
1222
1222
|
# @!attribute usage_customer_ids
|
@@ -1226,20 +1226,20 @@ module Orb
|
|
1226
1226
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
1227
1227
|
|
1228
1228
|
# @!method initialize(id:, adjusted_subtotal:, adjustments:, amount:, credits_applied:, discount:, end_date:, filter:, grouping:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, partially_invoiced_amount:, price:, quantity:, start_date:, sub_line_items:, subtotal:, tax_amounts:, usage_customer_ids:)
|
1229
|
-
# Some parameter documentations has been truncated, see
|
1230
|
-
# for more details.
|
1229
|
+
# Some parameter documentations has been truncated, see
|
1230
|
+
# {Orb::Models::Invoice::LineItem} for more details.
|
1231
1231
|
#
|
1232
1232
|
# @param id [String] A unique ID for this line item.
|
1233
1233
|
#
|
1234
1234
|
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
1235
1235
|
#
|
1236
|
-
# @param adjustments [Array<Orb::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Invoice::LineItem::Adjustment::Minimum, Orb::Invoice::LineItem::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
|
1236
|
+
# @param adjustments [Array<Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Models::Invoice::LineItem::Adjustment::Minimum, Orb::Models::Invoice::LineItem::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
|
1237
1237
|
#
|
1238
1238
|
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
1239
1239
|
#
|
1240
1240
|
# @param credits_applied [String] The number of prepaid credits applied.
|
1241
1241
|
#
|
1242
|
-
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
1242
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
1243
1243
|
#
|
1244
1244
|
# @param end_date [Time] The end date of the range of time applied for this line item's price.
|
1245
1245
|
#
|
@@ -1247,11 +1247,11 @@ module Orb
|
|
1247
1247
|
#
|
1248
1248
|
# @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
|
1249
1249
|
#
|
1250
|
-
# @param maximum [Orb::Invoice::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
1250
|
+
# @param maximum [Orb::Models::Invoice::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
1251
1251
|
#
|
1252
1252
|
# @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
1253
1253
|
#
|
1254
|
-
# @param minimum [Orb::Invoice::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`.
|
1254
|
+
# @param minimum [Orb::Models::Invoice::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`.
|
1255
1255
|
#
|
1256
1256
|
# @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
1257
1257
|
#
|
@@ -1259,17 +1259,17 @@ module Orb
|
|
1259
1259
|
#
|
1260
1260
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
1261
1261
|
#
|
1262
|
-
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil] The Price resource represents a price that can be billed on a subscription, resu
|
1262
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, nil] The Price resource represents a price that can be billed on a subscription, resu
|
1263
1263
|
#
|
1264
1264
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
1265
1265
|
#
|
1266
1266
|
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
1267
1267
|
#
|
1268
|
-
# @param sub_line_items [Array<Orb::Invoice::LineItem::SubLineItem::Matrix, Orb::Invoice::LineItem::SubLineItem::Tier, Orb::Invoice::LineItem::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
|
1268
|
+
# @param sub_line_items [Array<Orb::Models::Invoice::LineItem::SubLineItem::Matrix, Orb::Models::Invoice::LineItem::SubLineItem::Tier, Orb::Models::Invoice::LineItem::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
|
1269
1269
|
#
|
1270
1270
|
# @param subtotal [String] The line amount before before any adjustments.
|
1271
1271
|
#
|
1272
|
-
# @param tax_amounts [Array<Orb::Invoice::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
1272
|
+
# @param tax_amounts [Array<Orb::Models::Invoice::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
1273
1273
|
#
|
1274
1274
|
# @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
|
1275
1275
|
|
@@ -1333,7 +1333,7 @@ module Orb
|
|
1333
1333
|
|
1334
1334
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
1335
1335
|
# Some parameter documentations has been truncated, see
|
1336
|
-
# {Orb::Invoice::LineItem::Adjustment::UsageDiscount} for more details.
|
1336
|
+
# {Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount} for more details.
|
1337
1337
|
#
|
1338
1338
|
# @param id [String]
|
1339
1339
|
#
|
@@ -1395,7 +1395,7 @@ module Orb
|
|
1395
1395
|
|
1396
1396
|
# @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
|
1397
1397
|
# Some parameter documentations has been truncated, see
|
1398
|
-
# {Orb::Invoice::LineItem::Adjustment::AmountDiscount} for more details.
|
1398
|
+
# {Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount} for more details.
|
1399
1399
|
#
|
1400
1400
|
# @param id [String]
|
1401
1401
|
#
|
@@ -1457,7 +1457,8 @@ module Orb
|
|
1457
1457
|
|
1458
1458
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
|
1459
1459
|
# Some parameter documentations has been truncated, see
|
1460
|
-
# {Orb::Invoice::LineItem::Adjustment::PercentageDiscount} for more
|
1460
|
+
# {Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount} for more
|
1461
|
+
# details.
|
1461
1462
|
#
|
1462
1463
|
# @param id [String]
|
1463
1464
|
#
|
@@ -1525,7 +1526,7 @@ module Orb
|
|
1525
1526
|
|
1526
1527
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
|
1527
1528
|
# Some parameter documentations has been truncated, see
|
1528
|
-
# {Orb::Invoice::LineItem::Adjustment::Minimum} for more details.
|
1529
|
+
# {Orb::Models::Invoice::LineItem::Adjustment::Minimum} for more details.
|
1529
1530
|
#
|
1530
1531
|
# @param id [String]
|
1531
1532
|
#
|
@@ -1589,7 +1590,7 @@ module Orb
|
|
1589
1590
|
|
1590
1591
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
|
1591
1592
|
# Some parameter documentations has been truncated, see
|
1592
|
-
# {Orb::Invoice::LineItem::Adjustment::Maximum} for more details.
|
1593
|
+
# {Orb::Models::Invoice::LineItem::Adjustment::Maximum} for more details.
|
1593
1594
|
#
|
1594
1595
|
# @param id [String]
|
1595
1596
|
#
|
@@ -1607,24 +1608,12 @@ module Orb
|
|
1607
1608
|
end
|
1608
1609
|
|
1609
1610
|
# @!method self.variants
|
1610
|
-
# @return [Array(Orb::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Invoice::LineItem::Adjustment::Minimum, Orb::Invoice::LineItem::Adjustment::Maximum)]
|
1611
|
-
|
1612
|
-
define_sorbet_constant!(:Variants) do
|
1613
|
-
T.type_alias do
|
1614
|
-
T.any(
|
1615
|
-
Orb::Invoice::LineItem::Adjustment::UsageDiscount,
|
1616
|
-
Orb::Invoice::LineItem::Adjustment::AmountDiscount,
|
1617
|
-
Orb::Invoice::LineItem::Adjustment::PercentageDiscount,
|
1618
|
-
Orb::Invoice::LineItem::Adjustment::Minimum,
|
1619
|
-
Orb::Invoice::LineItem::Adjustment::Maximum
|
1620
|
-
)
|
1621
|
-
end
|
1622
|
-
end
|
1611
|
+
# @return [Array(Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Models::Invoice::LineItem::Adjustment::Minimum, Orb::Models::Invoice::LineItem::Adjustment::Maximum)]
|
1623
1612
|
end
|
1624
1613
|
|
1625
1614
|
# @deprecated
|
1626
1615
|
#
|
1627
|
-
# @see Orb::Invoice::LineItem#maximum
|
1616
|
+
# @see Orb::Models::Invoice::LineItem#maximum
|
1628
1617
|
class Maximum < Orb::Internal::Type::BaseModel
|
1629
1618
|
# @!attribute applies_to_price_ids
|
1630
1619
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -1641,7 +1630,7 @@ module Orb
|
|
1641
1630
|
|
1642
1631
|
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
1643
1632
|
# Some parameter documentations has been truncated, see
|
1644
|
-
# {Orb::Invoice::LineItem::Maximum} for more details.
|
1633
|
+
# {Orb::Models::Invoice::LineItem::Maximum} for more details.
|
1645
1634
|
#
|
1646
1635
|
# This field is deprecated in favor of `adjustments`.
|
1647
1636
|
#
|
@@ -1652,7 +1641,7 @@ module Orb
|
|
1652
1641
|
|
1653
1642
|
# @deprecated
|
1654
1643
|
#
|
1655
|
-
# @see Orb::Invoice::LineItem#minimum
|
1644
|
+
# @see Orb::Models::Invoice::LineItem#minimum
|
1656
1645
|
class Minimum < Orb::Internal::Type::BaseModel
|
1657
1646
|
# @!attribute applies_to_price_ids
|
1658
1647
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -1669,7 +1658,7 @@ module Orb
|
|
1669
1658
|
|
1670
1659
|
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
1671
1660
|
# Some parameter documentations has been truncated, see
|
1672
|
-
# {Orb::Invoice::LineItem::Minimum} for more details.
|
1661
|
+
# {Orb::Models::Invoice::LineItem::Minimum} for more details.
|
1673
1662
|
#
|
1674
1663
|
# This field is deprecated in favor of `adjustments`.
|
1675
1664
|
#
|
@@ -1698,12 +1687,12 @@ module Orb
|
|
1698
1687
|
|
1699
1688
|
# @!attribute grouping
|
1700
1689
|
#
|
1701
|
-
# @return [Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
|
1690
|
+
# @return [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
|
1702
1691
|
required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping }, nil?: true
|
1703
1692
|
|
1704
1693
|
# @!attribute matrix_config
|
1705
1694
|
#
|
1706
|
-
# @return [Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
|
1695
|
+
# @return [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
|
1707
1696
|
required :matrix_config, -> { Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig }
|
1708
1697
|
|
1709
1698
|
# @!attribute name
|
@@ -1724,9 +1713,9 @@ module Orb
|
|
1724
1713
|
# @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
1725
1714
|
# @param amount [String] The total amount for this sub line item.
|
1726
1715
|
#
|
1727
|
-
# @param grouping [Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
|
1716
|
+
# @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
|
1728
1717
|
#
|
1729
|
-
# @param matrix_config [Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
|
1718
|
+
# @param matrix_config [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
|
1730
1719
|
#
|
1731
1720
|
# @param name [String]
|
1732
1721
|
#
|
@@ -1734,7 +1723,7 @@ module Orb
|
|
1734
1723
|
#
|
1735
1724
|
# @param type [Symbol, :matrix]
|
1736
1725
|
|
1737
|
-
# @see Orb::Invoice::LineItem::SubLineItem::Matrix#grouping
|
1726
|
+
# @see Orb::Models::Invoice::LineItem::SubLineItem::Matrix#grouping
|
1738
1727
|
class Grouping < Orb::Internal::Type::BaseModel
|
1739
1728
|
# @!attribute key
|
1740
1729
|
#
|
@@ -1753,7 +1742,7 @@ module Orb
|
|
1753
1742
|
# @param value [String, nil] No value indicates the default group
|
1754
1743
|
end
|
1755
1744
|
|
1756
|
-
# @see Orb::Invoice::LineItem::SubLineItem::Matrix#matrix_config
|
1745
|
+
# @see Orb::Models::Invoice::LineItem::SubLineItem::Matrix#matrix_config
|
1757
1746
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
1758
1747
|
# @!attribute dimension_values
|
1759
1748
|
# The ordered dimension values for this line item.
|
@@ -1775,7 +1764,7 @@ module Orb
|
|
1775
1764
|
|
1776
1765
|
# @!attribute grouping
|
1777
1766
|
#
|
1778
|
-
# @return [Orb::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
|
1767
|
+
# @return [Orb::Models::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
|
1779
1768
|
required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Tier::Grouping }, nil?: true
|
1780
1769
|
|
1781
1770
|
# @!attribute name
|
@@ -1790,7 +1779,7 @@ module Orb
|
|
1790
1779
|
|
1791
1780
|
# @!attribute tier_config
|
1792
1781
|
#
|
1793
|
-
# @return [Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig]
|
1782
|
+
# @return [Orb::Models::Invoice::LineItem::SubLineItem::Tier::TierConfig]
|
1794
1783
|
required :tier_config, -> { Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig }
|
1795
1784
|
|
1796
1785
|
# @!attribute type
|
@@ -1801,17 +1790,17 @@ module Orb
|
|
1801
1790
|
# @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
1802
1791
|
# @param amount [String] The total amount for this sub line item.
|
1803
1792
|
#
|
1804
|
-
# @param grouping [Orb::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
|
1793
|
+
# @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
|
1805
1794
|
#
|
1806
1795
|
# @param name [String]
|
1807
1796
|
#
|
1808
1797
|
# @param quantity [Float]
|
1809
1798
|
#
|
1810
|
-
# @param tier_config [Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig]
|
1799
|
+
# @param tier_config [Orb::Models::Invoice::LineItem::SubLineItem::Tier::TierConfig]
|
1811
1800
|
#
|
1812
1801
|
# @param type [Symbol, :tier]
|
1813
1802
|
|
1814
|
-
# @see Orb::Invoice::LineItem::SubLineItem::Tier#grouping
|
1803
|
+
# @see Orb::Models::Invoice::LineItem::SubLineItem::Tier#grouping
|
1815
1804
|
class Grouping < Orb::Internal::Type::BaseModel
|
1816
1805
|
# @!attribute key
|
1817
1806
|
#
|
@@ -1830,7 +1819,7 @@ module Orb
|
|
1830
1819
|
# @param value [String, nil] No value indicates the default group
|
1831
1820
|
end
|
1832
1821
|
|
1833
|
-
# @see Orb::Invoice::LineItem::SubLineItem::Tier#tier_config
|
1822
|
+
# @see Orb::Models::Invoice::LineItem::SubLineItem::Tier#tier_config
|
1834
1823
|
class TierConfig < Orb::Internal::Type::BaseModel
|
1835
1824
|
# @!attribute first_unit
|
1836
1825
|
#
|
@@ -1863,7 +1852,7 @@ module Orb
|
|
1863
1852
|
|
1864
1853
|
# @!attribute grouping
|
1865
1854
|
#
|
1866
|
-
# @return [Orb::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
|
1855
|
+
# @return [Orb::Models::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
|
1867
1856
|
required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Null::Grouping }, nil?: true
|
1868
1857
|
|
1869
1858
|
# @!attribute name
|
@@ -1884,7 +1873,7 @@ module Orb
|
|
1884
1873
|
# @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
|
1885
1874
|
# @param amount [String] The total amount for this sub line item.
|
1886
1875
|
#
|
1887
|
-
# @param grouping [Orb::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
|
1876
|
+
# @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
|
1888
1877
|
#
|
1889
1878
|
# @param name [String]
|
1890
1879
|
#
|
@@ -1892,7 +1881,7 @@ module Orb
|
|
1892
1881
|
#
|
1893
1882
|
# @param type [Symbol, :"'null'"]
|
1894
1883
|
|
1895
|
-
# @see Orb::Invoice::LineItem::SubLineItem::Null#grouping
|
1884
|
+
# @see Orb::Models::Invoice::LineItem::SubLineItem::Null#grouping
|
1896
1885
|
class Grouping < Orb::Internal::Type::BaseModel
|
1897
1886
|
# @!attribute key
|
1898
1887
|
#
|
@@ -1913,17 +1902,7 @@ module Orb
|
|
1913
1902
|
end
|
1914
1903
|
|
1915
1904
|
# @!method self.variants
|
1916
|
-
# @return [Array(Orb::Invoice::LineItem::SubLineItem::Matrix, Orb::Invoice::LineItem::SubLineItem::Tier, Orb::Invoice::LineItem::SubLineItem::Null)]
|
1917
|
-
|
1918
|
-
define_sorbet_constant!(:Variants) do
|
1919
|
-
T.type_alias do
|
1920
|
-
T.any(
|
1921
|
-
Orb::Invoice::LineItem::SubLineItem::Matrix,
|
1922
|
-
Orb::Invoice::LineItem::SubLineItem::Tier,
|
1923
|
-
Orb::Invoice::LineItem::SubLineItem::Null
|
1924
|
-
)
|
1925
|
-
end
|
1926
|
-
end
|
1905
|
+
# @return [Array(Orb::Models::Invoice::LineItem::SubLineItem::Matrix, Orb::Models::Invoice::LineItem::SubLineItem::Tier, Orb::Models::Invoice::LineItem::SubLineItem::Null)]
|
1927
1906
|
end
|
1928
1907
|
|
1929
1908
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
@@ -1954,7 +1933,7 @@ module Orb
|
|
1954
1933
|
end
|
1955
1934
|
end
|
1956
1935
|
|
1957
|
-
# @see Orb::Invoice#maximum
|
1936
|
+
# @see Orb::Models::Invoice#maximum
|
1958
1937
|
class Maximum < Orb::Internal::Type::BaseModel
|
1959
1938
|
# @!attribute applies_to_price_ids
|
1960
1939
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -1970,15 +1949,15 @@ module Orb
|
|
1970
1949
|
required :maximum_amount, String
|
1971
1950
|
|
1972
1951
|
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
1973
|
-
# Some parameter documentations has been truncated, see
|
1974
|
-
# for more details.
|
1952
|
+
# Some parameter documentations has been truncated, see
|
1953
|
+
# {Orb::Models::Invoice::Maximum} for more details.
|
1975
1954
|
#
|
1976
1955
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
1977
1956
|
#
|
1978
1957
|
# @param maximum_amount [String] Maximum amount applied
|
1979
1958
|
end
|
1980
1959
|
|
1981
|
-
# @see Orb::Invoice#minimum
|
1960
|
+
# @see Orb::Models::Invoice#minimum
|
1982
1961
|
class Minimum < Orb::Internal::Type::BaseModel
|
1983
1962
|
# @!attribute applies_to_price_ids
|
1984
1963
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -1994,8 +1973,8 @@ module Orb
|
|
1994
1973
|
required :minimum_amount, String
|
1995
1974
|
|
1996
1975
|
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
1997
|
-
# Some parameter documentations has been truncated, see
|
1998
|
-
# for more details.
|
1976
|
+
# Some parameter documentations has been truncated, see
|
1977
|
+
# {Orb::Models::Invoice::Minimum} for more details.
|
1999
1978
|
#
|
2000
1979
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
2001
1980
|
#
|
@@ -2024,7 +2003,7 @@ module Orb
|
|
2024
2003
|
# @!attribute payment_provider
|
2025
2004
|
# The payment provider that attempted to collect the payment.
|
2026
2005
|
#
|
2027
|
-
# @return [Symbol, Orb::Invoice::PaymentAttempt::PaymentProvider, nil]
|
2006
|
+
# @return [Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider, nil]
|
2028
2007
|
required :payment_provider, enum: -> { Orb::Invoice::PaymentAttempt::PaymentProvider }, nil?: true
|
2029
2008
|
|
2030
2009
|
# @!attribute payment_provider_id
|
@@ -2046,7 +2025,7 @@ module Orb
|
|
2046
2025
|
#
|
2047
2026
|
# @param created_at [Time] The time at which the payment attempt was created.
|
2048
2027
|
#
|
2049
|
-
# @param payment_provider [Symbol, Orb::Invoice::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment.
|
2028
|
+
# @param payment_provider [Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment.
|
2050
2029
|
#
|
2051
2030
|
# @param payment_provider_id [String, nil] The ID of the payment attempt in the payment provider.
|
2052
2031
|
#
|
@@ -2054,7 +2033,7 @@ module Orb
|
|
2054
2033
|
|
2055
2034
|
# The payment provider that attempted to collect the payment.
|
2056
2035
|
#
|
2057
|
-
# @see Orb::Invoice::PaymentAttempt#payment_provider
|
2036
|
+
# @see Orb::Models::Invoice::PaymentAttempt#payment_provider
|
2058
2037
|
module PaymentProvider
|
2059
2038
|
extend Orb::Internal::Type::Enum
|
2060
2039
|
|
@@ -2065,7 +2044,7 @@ module Orb
|
|
2065
2044
|
end
|
2066
2045
|
end
|
2067
2046
|
|
2068
|
-
# @see Orb::Invoice#shipping_address
|
2047
|
+
# @see Orb::Models::Invoice#shipping_address
|
2069
2048
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
2070
2049
|
# @!attribute city
|
2071
2050
|
#
|
@@ -2106,7 +2085,7 @@ module Orb
|
|
2106
2085
|
# @param state [String, nil]
|
2107
2086
|
end
|
2108
2087
|
|
2109
|
-
# @see Orb::Invoice#status
|
2088
|
+
# @see Orb::Models::Invoice#status
|
2110
2089
|
module Status
|
2111
2090
|
extend Orb::Internal::Type::Enum
|
2112
2091
|
|
@@ -2120,7 +2099,7 @@ module Orb
|
|
2120
2099
|
# @return [Array<Symbol>]
|
2121
2100
|
end
|
2122
2101
|
|
2123
|
-
# @see Orb::Invoice#subscription
|
2102
|
+
# @see Orb::Models::Invoice#subscription
|
2124
2103
|
class Subscription < Orb::Internal::Type::BaseModel
|
2125
2104
|
# @!attribute id
|
2126
2105
|
#
|