orb-billing 0.1.3 → 0.3.0
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/.ignore +2 -0
- data/CHANGELOG.md +65 -0
- data/README.md +61 -51
- data/lib/orb/client.rb +7 -6
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +37 -39
- data/lib/orb/internal/transport/base_client.rb +21 -11
- data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
- data/lib/orb/internal/type/array_of.rb +28 -2
- data/lib/orb/internal/type/base_model.rb +83 -21
- data/lib/orb/internal/type/base_page.rb +10 -1
- data/lib/orb/internal/type/boolean.rb +6 -0
- data/lib/orb/internal/type/converter.rb +28 -1
- data/lib/orb/internal/type/enum.rb +28 -8
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
- data/lib/orb/internal/type/hash_of.rb +28 -2
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +27 -4
- data/lib/orb/internal/type/unknown.rb +6 -0
- data/lib/orb/internal/util.rb +105 -70
- data/lib/orb/internal.rb +5 -2
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +24 -29
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +211 -252
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +589 -637
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +2709 -3820
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +341 -377
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +108 -28
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +135 -36
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/lib/orb/client.rbi +7 -6
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/page.rbi +1 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
- data/rbi/lib/orb/internal/type/converter.rbi +8 -0
- data/rbi/lib/orb/internal/type/enum.rbi +7 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
- data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/union.rbi +7 -0
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
- data/rbi/lib/orb/internal/util.rbi +39 -19
- data/rbi/lib/orb/internal.rbi +1 -2
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +4 -0
- data/sig/orb/internal/type/base_model.rbs +12 -0
- data/sig/orb/internal/type/converter.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +4 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +4 -0
- data/sig/orb/internal/type/union.rbs +4 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/internal.rbs +1 -1
- metadata +9 -5
@@ -167,6 +167,8 @@ module Orb
|
|
167
167
|
required :customer_tax_id, -> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID }, nil?: true
|
168
168
|
|
169
169
|
# @!attribute discount
|
170
|
+
# @deprecated
|
171
|
+
#
|
170
172
|
# This field is deprecated in favor of `discounts`. If a `discounts` list is
|
171
173
|
# provided, the first discount in the list will be returned. If the list is empty,
|
172
174
|
# `None` will be returned.
|
@@ -367,97 +369,109 @@ module Orb
|
|
367
369
|
# @return [Boolean]
|
368
370
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
369
371
|
|
370
|
-
# @!
|
371
|
-
#
|
372
|
-
#
|
373
|
-
#
|
374
|
-
#
|
375
|
-
#
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
#
|
404
|
-
#
|
405
|
-
#
|
406
|
-
#
|
407
|
-
#
|
408
|
-
#
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
#
|
413
|
-
#
|
414
|
-
#
|
415
|
-
#
|
416
|
-
#
|
417
|
-
#
|
418
|
-
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
#
|
422
|
-
#
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
428
|
-
#
|
429
|
-
#
|
430
|
-
#
|
431
|
-
#
|
432
|
-
#
|
433
|
-
#
|
434
|
-
#
|
435
|
-
#
|
436
|
-
#
|
437
|
-
#
|
438
|
-
#
|
439
|
-
#
|
440
|
-
#
|
441
|
-
#
|
442
|
-
#
|
443
|
-
#
|
444
|
-
#
|
445
|
-
#
|
446
|
-
#
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
|
460
|
-
#
|
372
|
+
# @!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_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:, target_date:, total:, voided_at:, will_auto_issue:)
|
373
|
+
# Some parameter documentations has been truncated, see
|
374
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse} for more details.
|
375
|
+
#
|
376
|
+
# @param id [String]
|
377
|
+
#
|
378
|
+
# @param amount_due [String] This is the final amount required to be charged to the customer and reflects the
|
379
|
+
# ...
|
380
|
+
#
|
381
|
+
# @param auto_collection [Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection]
|
382
|
+
#
|
383
|
+
# @param billing_address [Orb::Models::InvoiceFetchUpcomingResponse::BillingAddress, nil]
|
384
|
+
#
|
385
|
+
# @param created_at [Time] The creation time of the resource in Orb.
|
386
|
+
#
|
387
|
+
# @param credit_notes [Array<Orb::Models::InvoiceFetchUpcomingResponse::CreditNote>] A list of credit notes associated with the invoice
|
388
|
+
#
|
389
|
+
# @param currency [String] An ISO 4217 currency string or `credits`
|
390
|
+
#
|
391
|
+
# @param customer [Orb::Models::InvoiceFetchUpcomingResponse::Customer]
|
392
|
+
#
|
393
|
+
# @param customer_balance_transactions [Array<Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction>]
|
394
|
+
#
|
395
|
+
# @param customer_tax_id [Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
396
|
+
# ...
|
397
|
+
#
|
398
|
+
# @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
|
399
|
+
# ...
|
400
|
+
#
|
401
|
+
# @param discounts [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
|
402
|
+
#
|
403
|
+
# @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
|
404
|
+
# ...
|
405
|
+
#
|
406
|
+
# @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
|
407
|
+
# ...
|
408
|
+
#
|
409
|
+
# @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 30 days after the
|
410
|
+
# ...
|
411
|
+
#
|
412
|
+
# @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv
|
413
|
+
# ...
|
414
|
+
#
|
415
|
+
# @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`.
|
416
|
+
#
|
417
|
+
# @param invoice_source [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource]
|
418
|
+
#
|
419
|
+
# @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e
|
420
|
+
# ...
|
421
|
+
#
|
422
|
+
# @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued
|
423
|
+
# ...
|
424
|
+
#
|
425
|
+
# @param line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem>] The breakdown of prices in this invoice.
|
426
|
+
#
|
427
|
+
# @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::Maximum, nil]
|
428
|
+
#
|
429
|
+
# @param maximum_amount [String, nil]
|
430
|
+
#
|
431
|
+
# @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
432
|
+
# ...
|
433
|
+
#
|
434
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
435
|
+
# ...
|
436
|
+
#
|
437
|
+
# @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::Minimum, nil]
|
438
|
+
#
|
439
|
+
# @param minimum_amount [String, nil]
|
440
|
+
#
|
441
|
+
# @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w
|
442
|
+
# ...
|
443
|
+
#
|
444
|
+
# @param payment_attempts [Array<Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt>] A list of payment attempts associated with the invoice
|
445
|
+
#
|
446
|
+
# @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
|
447
|
+
# ...
|
448
|
+
#
|
449
|
+
# @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
|
450
|
+
# ...
|
451
|
+
#
|
452
|
+
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
453
|
+
# ...
|
454
|
+
#
|
455
|
+
# @param shipping_address [Orb::Models::InvoiceFetchUpcomingResponse::ShippingAddress, nil]
|
456
|
+
#
|
457
|
+
# @param status [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status]
|
458
|
+
#
|
459
|
+
# @param subscription [Orb::Models::InvoiceFetchUpcomingResponse::Subscription, nil]
|
460
|
+
#
|
461
|
+
# @param subtotal [String] The total before any discounts and minimums are applied.
|
462
|
+
#
|
463
|
+
# @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing
|
464
|
+
# ...
|
465
|
+
#
|
466
|
+
# @param target_date [Time] The scheduled date of the invoice
|
467
|
+
#
|
468
|
+
# @param total [String] The total after any minimums and discounts have been applied.
|
469
|
+
#
|
470
|
+
# @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w
|
471
|
+
# ...
|
472
|
+
#
|
473
|
+
# @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals
|
474
|
+
# ...
|
461
475
|
|
462
476
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#auto_collection
|
463
477
|
class AutoCollection < Orb::Internal::Type::BaseModel
|
@@ -492,15 +506,19 @@ module Orb
|
|
492
506
|
# @return [Time, nil]
|
493
507
|
required :previously_attempted_at, Time, nil?: true
|
494
508
|
|
495
|
-
# @!
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
|
503
|
-
#
|
509
|
+
# @!method initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:)
|
510
|
+
# Some parameter documentations has been truncated, see
|
511
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection} for more details.
|
512
|
+
#
|
513
|
+
# @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice.
|
514
|
+
#
|
515
|
+
# @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th
|
516
|
+
# ...
|
517
|
+
#
|
518
|
+
# @param num_attempts [Integer, nil] Number of auto-collection payment attempts.
|
519
|
+
#
|
520
|
+
# @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
|
521
|
+
# ...
|
504
522
|
end
|
505
523
|
|
506
524
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#billing_address
|
@@ -535,17 +553,13 @@ module Orb
|
|
535
553
|
# @return [String, nil]
|
536
554
|
required :state, String, nil?: true
|
537
555
|
|
538
|
-
# @!
|
539
|
-
#
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
# #
|
546
|
-
# def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super
|
547
|
-
|
548
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
556
|
+
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
557
|
+
# @param city [String, nil]
|
558
|
+
# @param country [String, nil]
|
559
|
+
# @param line1 [String, nil]
|
560
|
+
# @param line2 [String, nil]
|
561
|
+
# @param postal_code [String, nil]
|
562
|
+
# @param state [String, nil]
|
549
563
|
end
|
550
564
|
|
551
565
|
class CreditNote < Orb::Internal::Type::BaseModel
|
@@ -587,18 +601,24 @@ module Orb
|
|
587
601
|
# @return [Time, nil]
|
588
602
|
required :voided_at, Time, nil?: true
|
589
603
|
|
590
|
-
# @!
|
591
|
-
#
|
592
|
-
#
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
#
|
599
|
-
#
|
600
|
-
|
601
|
-
#
|
604
|
+
# @!method initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:)
|
605
|
+
# Some parameter documentations has been truncated, see
|
606
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::CreditNote} for more details.
|
607
|
+
#
|
608
|
+
# @param id [String]
|
609
|
+
#
|
610
|
+
# @param credit_note_number [String]
|
611
|
+
#
|
612
|
+
# @param memo [String, nil] An optional memo supplied on the credit note.
|
613
|
+
#
|
614
|
+
# @param reason [String]
|
615
|
+
#
|
616
|
+
# @param total [String]
|
617
|
+
#
|
618
|
+
# @param type [String]
|
619
|
+
#
|
620
|
+
# @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
|
621
|
+
# ...
|
602
622
|
end
|
603
623
|
|
604
624
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#customer
|
@@ -613,13 +633,9 @@ module Orb
|
|
613
633
|
# @return [String, nil]
|
614
634
|
required :external_customer_id, String, nil?: true
|
615
635
|
|
616
|
-
# @!
|
617
|
-
#
|
618
|
-
#
|
619
|
-
# #
|
620
|
-
# def initialize(id:, external_customer_id:, **) = super
|
621
|
-
|
622
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
636
|
+
# @!method initialize(id:, external_customer_id:)
|
637
|
+
# @param id [String]
|
638
|
+
# @param external_customer_id [String, nil]
|
623
639
|
end
|
624
640
|
|
625
641
|
class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
|
@@ -686,35 +702,32 @@ module Orb
|
|
686
702
|
# @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type]
|
687
703
|
required :type, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type }
|
688
704
|
|
689
|
-
# @!
|
690
|
-
#
|
691
|
-
#
|
692
|
-
#
|
693
|
-
#
|
694
|
-
#
|
695
|
-
#
|
696
|
-
#
|
697
|
-
#
|
698
|
-
#
|
699
|
-
#
|
700
|
-
#
|
701
|
-
#
|
702
|
-
#
|
703
|
-
#
|
704
|
-
#
|
705
|
-
#
|
706
|
-
#
|
707
|
-
#
|
708
|
-
#
|
709
|
-
#
|
710
|
-
#
|
711
|
-
#
|
712
|
-
#
|
713
|
-
#
|
714
|
-
#
|
715
|
-
# end
|
716
|
-
|
717
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
705
|
+
# @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
|
706
|
+
# Some parameter documentations has been truncated, see
|
707
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction} for more
|
708
|
+
# details.
|
709
|
+
#
|
710
|
+
# @param id [String] A unique id for this transaction.
|
711
|
+
#
|
712
|
+
# @param action [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action]
|
713
|
+
#
|
714
|
+
# @param amount [String] The value of the amount changed in the transaction.
|
715
|
+
#
|
716
|
+
# @param created_at [Time] The creation time of this transaction.
|
717
|
+
#
|
718
|
+
# @param credit_note [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::CreditNote, nil]
|
719
|
+
#
|
720
|
+
# @param description [String, nil] An optional description provided for manual customer balance adjustments.
|
721
|
+
#
|
722
|
+
# @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
|
723
|
+
# ...
|
724
|
+
#
|
725
|
+
# @param invoice [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Invoice, nil]
|
726
|
+
#
|
727
|
+
# @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
|
728
|
+
# ...
|
729
|
+
#
|
730
|
+
# @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type]
|
718
731
|
|
719
732
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#action
|
720
733
|
module Action
|
@@ -730,11 +743,8 @@ module Orb
|
|
730
743
|
OVERPAYMENT_REFUND = :overpayment_refund
|
731
744
|
EXTERNAL_PAYMENT = :external_payment
|
732
745
|
|
733
|
-
|
734
|
-
|
735
|
-
# @!parse
|
736
|
-
# # @return [Array<Symbol>]
|
737
|
-
# def self.values; end
|
746
|
+
# @!method self.values
|
747
|
+
# @return [Array<Symbol>]
|
738
748
|
end
|
739
749
|
|
740
750
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#credit_note
|
@@ -745,12 +755,8 @@ module Orb
|
|
745
755
|
# @return [String]
|
746
756
|
required :id, String
|
747
757
|
|
748
|
-
# @!
|
749
|
-
#
|
750
|
-
# #
|
751
|
-
# def initialize(id:, **) = super
|
752
|
-
|
753
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
758
|
+
# @!method initialize(id:)
|
759
|
+
# @param id [String] The id of the Credit note
|
754
760
|
end
|
755
761
|
|
756
762
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#invoice
|
@@ -761,12 +767,8 @@ module Orb
|
|
761
767
|
# @return [String]
|
762
768
|
required :id, String
|
763
769
|
|
764
|
-
# @!
|
765
|
-
#
|
766
|
-
# #
|
767
|
-
# def initialize(id:, **) = super
|
768
|
-
|
769
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
770
|
+
# @!method initialize(id:)
|
771
|
+
# @param id [String] The Invoice id
|
770
772
|
end
|
771
773
|
|
772
774
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#type
|
@@ -776,11 +778,8 @@ module Orb
|
|
776
778
|
INCREMENT = :increment
|
777
779
|
DECREMENT = :decrement
|
778
780
|
|
779
|
-
|
780
|
-
|
781
|
-
# @!parse
|
782
|
-
# # @return [Array<Symbol>]
|
783
|
-
# def self.values; end
|
781
|
+
# @!method self.values
|
782
|
+
# @return [Array<Symbol>]
|
784
783
|
end
|
785
784
|
end
|
786
785
|
|
@@ -801,120 +800,116 @@ module Orb
|
|
801
800
|
# @return [String]
|
802
801
|
required :value, String
|
803
802
|
|
804
|
-
# @!
|
805
|
-
#
|
806
|
-
#
|
807
|
-
#
|
808
|
-
#
|
809
|
-
#
|
810
|
-
#
|
811
|
-
#
|
812
|
-
#
|
813
|
-
#
|
814
|
-
#
|
815
|
-
#
|
816
|
-
#
|
817
|
-
#
|
818
|
-
#
|
819
|
-
#
|
820
|
-
#
|
821
|
-
#
|
822
|
-
#
|
823
|
-
#
|
824
|
-
#
|
825
|
-
#
|
826
|
-
#
|
827
|
-
#
|
828
|
-
#
|
829
|
-
#
|
830
|
-
#
|
831
|
-
#
|
832
|
-
#
|
833
|
-
#
|
834
|
-
#
|
835
|
-
#
|
836
|
-
#
|
837
|
-
#
|
838
|
-
#
|
839
|
-
#
|
840
|
-
#
|
841
|
-
#
|
842
|
-
#
|
843
|
-
#
|
844
|
-
#
|
845
|
-
#
|
846
|
-
#
|
847
|
-
#
|
848
|
-
#
|
849
|
-
#
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
#
|
858
|
-
#
|
859
|
-
#
|
860
|
-
#
|
861
|
-
#
|
862
|
-
#
|
863
|
-
#
|
864
|
-
#
|
865
|
-
#
|
866
|
-
#
|
867
|
-
#
|
868
|
-
#
|
869
|
-
#
|
870
|
-
#
|
871
|
-
#
|
872
|
-
#
|
873
|
-
#
|
874
|
-
#
|
875
|
-
#
|
876
|
-
#
|
877
|
-
#
|
878
|
-
#
|
879
|
-
#
|
880
|
-
#
|
881
|
-
#
|
882
|
-
#
|
883
|
-
#
|
884
|
-
#
|
885
|
-
#
|
886
|
-
#
|
887
|
-
#
|
888
|
-
#
|
889
|
-
#
|
890
|
-
#
|
891
|
-
#
|
892
|
-
#
|
893
|
-
#
|
894
|
-
#
|
895
|
-
#
|
896
|
-
#
|
897
|
-
#
|
898
|
-
#
|
899
|
-
#
|
900
|
-
#
|
901
|
-
#
|
902
|
-
#
|
903
|
-
#
|
904
|
-
#
|
905
|
-
#
|
906
|
-
#
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
913
|
-
#
|
914
|
-
# #
|
915
|
-
# def initialize(country:, type:, value:, **) = super
|
916
|
-
|
917
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
803
|
+
# @!method initialize(country:, type:, value:)
|
804
|
+
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
805
|
+
# added to the headers of invoices.
|
806
|
+
#
|
807
|
+
# ### Supported Tax ID Countries and Types
|
808
|
+
#
|
809
|
+
# | Country | Type | Description |
|
810
|
+
# | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
|
811
|
+
# | Andorra | `ad_nrt` | Andorran NRT Number |
|
812
|
+
# | Argentina | `ar_cuit` | Argentinian Tax ID Number |
|
813
|
+
# | Australia | `au_abn` | Australian Business Number (AU ABN) |
|
814
|
+
# | Australia | `au_arn` | Australian Taxation Office Reference Number |
|
815
|
+
# | Austria | `eu_vat` | European VAT Number |
|
816
|
+
# | Bahrain | `bh_vat` | Bahraini VAT Number |
|
817
|
+
# | Belgium | `eu_vat` | European VAT Number |
|
818
|
+
# | Bolivia | `bo_tin` | Bolivian Tax ID |
|
819
|
+
# | Brazil | `br_cnpj` | Brazilian CNPJ Number |
|
820
|
+
# | Brazil | `br_cpf` | Brazilian CPF Number |
|
821
|
+
# | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
|
822
|
+
# | Bulgaria | `eu_vat` | European VAT Number |
|
823
|
+
# | Canada | `ca_bn` | Canadian BN |
|
824
|
+
# | Canada | `ca_gst_hst` | Canadian GST/HST Number |
|
825
|
+
# | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
|
826
|
+
# | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
|
827
|
+
# | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
|
828
|
+
# | Canada | `ca_qst` | Canadian QST Number (Québec) |
|
829
|
+
# | Chile | `cl_tin` | Chilean TIN |
|
830
|
+
# | China | `cn_tin` | Chinese Tax ID |
|
831
|
+
# | Colombia | `co_nit` | Colombian NIT Number |
|
832
|
+
# | Costa Rica | `cr_tin` | Costa Rican Tax ID |
|
833
|
+
# | Croatia | `eu_vat` | European VAT Number |
|
834
|
+
# | Cyprus | `eu_vat` | European VAT Number |
|
835
|
+
# | Czech Republic | `eu_vat` | European VAT Number |
|
836
|
+
# | Denmark | `eu_vat` | European VAT Number |
|
837
|
+
# | Dominican Republic | `do_rcn` | Dominican RCN Number |
|
838
|
+
# | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
|
839
|
+
# | Egypt | `eg_tin` | Egyptian Tax Identification Number |
|
840
|
+
# | El Salvador | `sv_nit` | El Salvadorian NIT Number |
|
841
|
+
# | Estonia | `eu_vat` | European VAT Number |
|
842
|
+
# | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
|
843
|
+
# | Finland | `eu_vat` | European VAT Number |
|
844
|
+
# | France | `eu_vat` | European VAT Number |
|
845
|
+
# | Georgia | `ge_vat` | Georgian VAT |
|
846
|
+
# | Germany | `eu_vat` | European VAT Number |
|
847
|
+
# | Greece | `eu_vat` | European VAT Number |
|
848
|
+
# | Hong Kong | `hk_br` | Hong Kong BR Number |
|
849
|
+
# | Hungary | `eu_vat` | European VAT Number |
|
850
|
+
# | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
|
851
|
+
# | Iceland | `is_vat` | Icelandic VAT |
|
852
|
+
# | India | `in_gst` | Indian GST Number |
|
853
|
+
# | Indonesia | `id_npwp` | Indonesian NPWP Number |
|
854
|
+
# | Ireland | `eu_vat` | European VAT Number |
|
855
|
+
# | Israel | `il_vat` | Israel VAT |
|
856
|
+
# | Italy | `eu_vat` | European VAT Number |
|
857
|
+
# | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
|
858
|
+
# | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
|
859
|
+
# | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
|
860
|
+
# | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
|
861
|
+
# | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
|
862
|
+
# | Latvia | `eu_vat` | European VAT Number |
|
863
|
+
# | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
|
864
|
+
# | Lithuania | `eu_vat` | European VAT Number |
|
865
|
+
# | Luxembourg | `eu_vat` | European VAT Number |
|
866
|
+
# | Malaysia | `my_frp` | Malaysian FRP Number |
|
867
|
+
# | Malaysia | `my_itn` | Malaysian ITN |
|
868
|
+
# | Malaysia | `my_sst` | Malaysian SST Number |
|
869
|
+
# | Malta | `eu_vat ` | European VAT Number |
|
870
|
+
# | Mexico | `mx_rfc` | Mexican RFC Number |
|
871
|
+
# | Netherlands | `eu_vat` | European VAT Number |
|
872
|
+
# | New Zealand | `nz_gst` | New Zealand GST Number |
|
873
|
+
# | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
|
874
|
+
# | Norway | `no_vat` | Norwegian VAT Number |
|
875
|
+
# | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
|
876
|
+
# | Oman | `om_vat` | Omani VAT Number |
|
877
|
+
# | Peru | `pe_ruc` | Peruvian RUC Number |
|
878
|
+
# | Philippines | `ph_tin ` | Philippines Tax Identification Number |
|
879
|
+
# | Poland | `eu_vat` | European VAT Number |
|
880
|
+
# | Portugal | `eu_vat` | European VAT Number |
|
881
|
+
# | Romania | `eu_vat` | European VAT Number |
|
882
|
+
# | Romania | `ro_tin` | Romanian Tax ID Number |
|
883
|
+
# | Russia | `ru_inn` | Russian INN |
|
884
|
+
# | Russia | `ru_kpp` | Russian KPP |
|
885
|
+
# | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
|
886
|
+
# | Serbia | `rs_pib` | Serbian PIB Number |
|
887
|
+
# | Singapore | `sg_gst` | Singaporean GST |
|
888
|
+
# | Singapore | `sg_uen` | Singaporean UEN |
|
889
|
+
# | Slovakia | `eu_vat` | European VAT Number |
|
890
|
+
# | Slovenia | `eu_vat` | European VAT Number |
|
891
|
+
# | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
|
892
|
+
# | South Africa | `za_vat` | South African VAT Number |
|
893
|
+
# | South Korea | `kr_brn` | Korean BRN |
|
894
|
+
# | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
|
895
|
+
# | Spain | `eu_vat` | European VAT Number |
|
896
|
+
# | Sweden | `eu_vat` | European VAT Number |
|
897
|
+
# | Switzerland | `ch_vat` | Switzerland VAT Number |
|
898
|
+
# | Taiwan | `tw_vat` | Taiwanese VAT |
|
899
|
+
# | Thailand | `th_vat` | Thai VAT |
|
900
|
+
# | Turkey | `tr_tin` | Turkish Tax Identification Number |
|
901
|
+
# | Ukraine | `ua_vat` | Ukrainian VAT |
|
902
|
+
# | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
|
903
|
+
# | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
|
904
|
+
# | United Kingdom | `gb_vat` | United Kingdom VAT Number |
|
905
|
+
# | United States | `us_ein` | United States EIN |
|
906
|
+
# | Uruguay | `uy_ruc` | Uruguayan RUC Number |
|
907
|
+
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
908
|
+
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
909
|
+
#
|
910
|
+
# @param country [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country]
|
911
|
+
# @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type]
|
912
|
+
# @param value [String]
|
918
913
|
|
919
914
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID#country
|
920
915
|
module Country
|
@@ -999,11 +994,8 @@ module Orb
|
|
999
994
|
VN = :VN
|
1000
995
|
ZA = :ZA
|
1001
996
|
|
1002
|
-
|
1003
|
-
|
1004
|
-
# @!parse
|
1005
|
-
# # @return [Array<Symbol>]
|
1006
|
-
# def self.values; end
|
997
|
+
# @!method self.values
|
998
|
+
# @return [Array<Symbol>]
|
1007
999
|
end
|
1008
1000
|
|
1009
1001
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID#type
|
@@ -1082,11 +1074,8 @@ module Orb
|
|
1082
1074
|
VN_TIN = :vn_tin
|
1083
1075
|
ZA_VAT = :za_vat
|
1084
1076
|
|
1085
|
-
|
1086
|
-
|
1087
|
-
# @!parse
|
1088
|
-
# # @return [Array<Symbol>]
|
1089
|
-
# def self.values; end
|
1077
|
+
# @!method self.values
|
1078
|
+
# @return [Array<Symbol>]
|
1090
1079
|
end
|
1091
1080
|
end
|
1092
1081
|
|
@@ -1098,11 +1087,8 @@ module Orb
|
|
1098
1087
|
PARTIAL = :partial
|
1099
1088
|
ONE_OFF = :one_off
|
1100
1089
|
|
1101
|
-
|
1102
|
-
|
1103
|
-
# @!parse
|
1104
|
-
# # @return [Array<Symbol>]
|
1105
|
-
# def self.values; end
|
1090
|
+
# @!method self.values
|
1091
|
+
# @return [Array<Symbol>]
|
1106
1092
|
end
|
1107
1093
|
|
1108
1094
|
class LineItem < Orb::Internal::Type::BaseModel
|
@@ -1167,24 +1153,32 @@ module Orb
|
|
1167
1153
|
required :grouping, String, nil?: true
|
1168
1154
|
|
1169
1155
|
# @!attribute maximum
|
1156
|
+
# @deprecated
|
1157
|
+
#
|
1170
1158
|
# This field is deprecated in favor of `adjustments`.
|
1171
1159
|
#
|
1172
1160
|
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum, nil]
|
1173
1161
|
required :maximum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum }, nil?: true
|
1174
1162
|
|
1175
1163
|
# @!attribute maximum_amount
|
1164
|
+
# @deprecated
|
1165
|
+
#
|
1176
1166
|
# This field is deprecated in favor of `adjustments`.
|
1177
1167
|
#
|
1178
1168
|
# @return [String, nil]
|
1179
1169
|
required :maximum_amount, String, nil?: true
|
1180
1170
|
|
1181
1171
|
# @!attribute minimum
|
1172
|
+
# @deprecated
|
1173
|
+
#
|
1182
1174
|
# This field is deprecated in favor of `adjustments`.
|
1183
1175
|
#
|
1184
1176
|
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum, nil]
|
1185
1177
|
required :minimum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum }, nil?: true
|
1186
1178
|
|
1187
1179
|
# @!attribute minimum_amount
|
1180
|
+
# @deprecated
|
1181
|
+
#
|
1188
1182
|
# This field is deprecated in favor of `adjustments`.
|
1189
1183
|
#
|
1190
1184
|
# @return [String, nil]
|
@@ -1257,59 +1251,61 @@ module Orb
|
|
1257
1251
|
# @return [Array<String>, nil]
|
1258
1252
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
1259
1253
|
|
1260
|
-
# @!
|
1261
|
-
#
|
1262
|
-
#
|
1263
|
-
#
|
1264
|
-
#
|
1265
|
-
#
|
1266
|
-
#
|
1267
|
-
#
|
1268
|
-
#
|
1269
|
-
#
|
1270
|
-
#
|
1271
|
-
#
|
1272
|
-
#
|
1273
|
-
#
|
1274
|
-
#
|
1275
|
-
#
|
1276
|
-
#
|
1277
|
-
#
|
1278
|
-
#
|
1279
|
-
#
|
1280
|
-
#
|
1281
|
-
#
|
1282
|
-
#
|
1283
|
-
#
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
#
|
1287
|
-
#
|
1288
|
-
#
|
1289
|
-
#
|
1290
|
-
#
|
1291
|
-
#
|
1292
|
-
#
|
1293
|
-
#
|
1294
|
-
#
|
1295
|
-
#
|
1296
|
-
#
|
1297
|
-
#
|
1298
|
-
#
|
1299
|
-
#
|
1300
|
-
#
|
1301
|
-
#
|
1302
|
-
#
|
1303
|
-
#
|
1304
|
-
#
|
1305
|
-
#
|
1306
|
-
#
|
1307
|
-
#
|
1308
|
-
#
|
1309
|
-
#
|
1310
|
-
#
|
1311
|
-
|
1312
|
-
#
|
1254
|
+
# @!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:)
|
1255
|
+
# Some parameter documentations has been truncated, see
|
1256
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem} for more details.
|
1257
|
+
#
|
1258
|
+
# @param id [String] A unique ID for this line item.
|
1259
|
+
#
|
1260
|
+
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
1261
|
+
# ...
|
1262
|
+
#
|
1263
|
+
# @param adjustments [Array<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>] All adjustments applied to the line item in the order they were applied based on
|
1264
|
+
# ...
|
1265
|
+
#
|
1266
|
+
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
1267
|
+
# ...
|
1268
|
+
#
|
1269
|
+
# @param credits_applied [String] The number of prepaid credits applied.
|
1270
|
+
#
|
1271
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
1272
|
+
#
|
1273
|
+
# @param end_date [Time] The end date of the range of time applied for this line item's price.
|
1274
|
+
#
|
1275
|
+
# @param filter [String, nil] An additional filter that was used to calculate the usage for this line item.
|
1276
|
+
#
|
1277
|
+
# @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
|
1278
|
+
# ...
|
1279
|
+
#
|
1280
|
+
# @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
1281
|
+
#
|
1282
|
+
# @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
1283
|
+
#
|
1284
|
+
# @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`.
|
1285
|
+
#
|
1286
|
+
# @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
1287
|
+
#
|
1288
|
+
# @param name [String] The name of the price associated with this line item.
|
1289
|
+
#
|
1290
|
+
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
1291
|
+
#
|
1292
|
+
# @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil] The Price resource represents a price that can be billed on a subscription, resu
|
1293
|
+
# ...
|
1294
|
+
#
|
1295
|
+
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
1296
|
+
#
|
1297
|
+
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
1298
|
+
#
|
1299
|
+
# @param sub_line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem>] For complex pricing structures, the line item can be broken down further in `sub
|
1300
|
+
# ...
|
1301
|
+
#
|
1302
|
+
# @param subtotal [String] The line amount before before any adjustments.
|
1303
|
+
#
|
1304
|
+
# @param tax_amounts [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
1305
|
+
# ...
|
1306
|
+
#
|
1307
|
+
# @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
|
1308
|
+
# ...
|
1313
1309
|
|
1314
1310
|
module Adjustment
|
1315
1311
|
extend Orb::Internal::Type::Union
|
@@ -1374,29 +1370,26 @@ module Orb
|
|
1374
1370
|
# @return [Float]
|
1375
1371
|
required :usage_discount, Float
|
1376
1372
|
|
1377
|
-
# @!
|
1378
|
-
#
|
1379
|
-
#
|
1380
|
-
#
|
1381
|
-
#
|
1382
|
-
#
|
1383
|
-
#
|
1384
|
-
#
|
1385
|
-
#
|
1386
|
-
#
|
1387
|
-
#
|
1388
|
-
#
|
1389
|
-
#
|
1390
|
-
#
|
1391
|
-
#
|
1392
|
-
#
|
1393
|
-
#
|
1394
|
-
#
|
1395
|
-
#
|
1396
|
-
#
|
1397
|
-
# end
|
1398
|
-
|
1399
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1373
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
1374
|
+
# Some parameter documentations has been truncated, see
|
1375
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment}
|
1376
|
+
# for more details.
|
1377
|
+
#
|
1378
|
+
# @param id [String]
|
1379
|
+
#
|
1380
|
+
# @param amount [String] The value applied by an adjustment.
|
1381
|
+
#
|
1382
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1383
|
+
#
|
1384
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1385
|
+
# ...
|
1386
|
+
#
|
1387
|
+
# @param reason [String, nil] The reason for the adjustment.
|
1388
|
+
#
|
1389
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
1390
|
+
# ...
|
1391
|
+
#
|
1392
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
1400
1393
|
end
|
1401
1394
|
|
1402
1395
|
class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -1442,29 +1435,26 @@ module Orb
|
|
1442
1435
|
# @return [String, nil]
|
1443
1436
|
required :reason, String, nil?: true
|
1444
1437
|
|
1445
|
-
# @!
|
1446
|
-
#
|
1447
|
-
#
|
1448
|
-
#
|
1449
|
-
#
|
1450
|
-
#
|
1451
|
-
#
|
1452
|
-
#
|
1453
|
-
#
|
1454
|
-
#
|
1455
|
-
#
|
1456
|
-
#
|
1457
|
-
#
|
1458
|
-
#
|
1459
|
-
#
|
1460
|
-
#
|
1461
|
-
#
|
1462
|
-
#
|
1463
|
-
#
|
1464
|
-
#
|
1465
|
-
# end
|
1466
|
-
|
1467
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1438
|
+
# @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
|
1439
|
+
# Some parameter documentations has been truncated, see
|
1440
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment}
|
1441
|
+
# for more details.
|
1442
|
+
#
|
1443
|
+
# @param id [String]
|
1444
|
+
#
|
1445
|
+
# @param amount [String] The value applied by an adjustment.
|
1446
|
+
#
|
1447
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
1448
|
+
# ...
|
1449
|
+
#
|
1450
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1451
|
+
#
|
1452
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1453
|
+
# ...
|
1454
|
+
#
|
1455
|
+
# @param reason [String, nil] The reason for the adjustment.
|
1456
|
+
#
|
1457
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
1468
1458
|
end
|
1469
1459
|
|
1470
1460
|
class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -1510,29 +1500,26 @@ module Orb
|
|
1510
1500
|
# @return [String, nil]
|
1511
1501
|
required :reason, String, nil?: true
|
1512
1502
|
|
1513
|
-
# @!
|
1514
|
-
#
|
1515
|
-
#
|
1516
|
-
#
|
1517
|
-
#
|
1518
|
-
#
|
1519
|
-
#
|
1520
|
-
#
|
1521
|
-
#
|
1522
|
-
#
|
1523
|
-
#
|
1524
|
-
#
|
1525
|
-
#
|
1526
|
-
#
|
1527
|
-
#
|
1528
|
-
#
|
1529
|
-
#
|
1530
|
-
#
|
1531
|
-
#
|
1532
|
-
#
|
1533
|
-
# end
|
1534
|
-
|
1535
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1503
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
|
1504
|
+
# Some parameter documentations has been truncated, see
|
1505
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment}
|
1506
|
+
# for more details.
|
1507
|
+
#
|
1508
|
+
# @param id [String]
|
1509
|
+
#
|
1510
|
+
# @param amount [String] The value applied by an adjustment.
|
1511
|
+
#
|
1512
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1513
|
+
#
|
1514
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1515
|
+
# ...
|
1516
|
+
#
|
1517
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
1518
|
+
# ...
|
1519
|
+
#
|
1520
|
+
# @param reason [String, nil] The reason for the adjustment.
|
1521
|
+
#
|
1522
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
1536
1523
|
end
|
1537
1524
|
|
1538
1525
|
class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -1584,31 +1571,28 @@ module Orb
|
|
1584
1571
|
# @return [String, nil]
|
1585
1572
|
required :reason, String, nil?: true
|
1586
1573
|
|
1587
|
-
# @!
|
1588
|
-
#
|
1589
|
-
#
|
1590
|
-
#
|
1591
|
-
#
|
1592
|
-
#
|
1593
|
-
#
|
1594
|
-
#
|
1595
|
-
#
|
1596
|
-
#
|
1597
|
-
#
|
1598
|
-
#
|
1599
|
-
#
|
1600
|
-
#
|
1601
|
-
#
|
1602
|
-
#
|
1603
|
-
#
|
1604
|
-
#
|
1605
|
-
#
|
1606
|
-
#
|
1607
|
-
#
|
1608
|
-
#
|
1609
|
-
# end
|
1610
|
-
|
1611
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1574
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
|
1575
|
+
# Some parameter documentations has been truncated, see
|
1576
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment}
|
1577
|
+
# for more details.
|
1578
|
+
#
|
1579
|
+
# @param id [String]
|
1580
|
+
#
|
1581
|
+
# @param amount [String] The value applied by an adjustment.
|
1582
|
+
#
|
1583
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1584
|
+
#
|
1585
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1586
|
+
# ...
|
1587
|
+
#
|
1588
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
1589
|
+
#
|
1590
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
1591
|
+
# ...
|
1592
|
+
#
|
1593
|
+
# @param reason [String, nil] The reason for the adjustment.
|
1594
|
+
#
|
1595
|
+
# @param adjustment_type [Symbol, :minimum]
|
1612
1596
|
end
|
1613
1597
|
|
1614
1598
|
class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -1654,34 +1638,30 @@ module Orb
|
|
1654
1638
|
# @return [String, nil]
|
1655
1639
|
required :reason, String, nil?: true
|
1656
1640
|
|
1657
|
-
# @!
|
1658
|
-
#
|
1659
|
-
#
|
1660
|
-
#
|
1661
|
-
#
|
1662
|
-
#
|
1663
|
-
#
|
1664
|
-
#
|
1665
|
-
#
|
1666
|
-
#
|
1667
|
-
#
|
1668
|
-
#
|
1669
|
-
#
|
1670
|
-
#
|
1671
|
-
#
|
1672
|
-
#
|
1673
|
-
#
|
1674
|
-
#
|
1675
|
-
#
|
1676
|
-
#
|
1677
|
-
# end
|
1678
|
-
|
1679
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1641
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
|
1642
|
+
# Some parameter documentations has been truncated, see
|
1643
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment}
|
1644
|
+
# for more details.
|
1645
|
+
#
|
1646
|
+
# @param id [String]
|
1647
|
+
#
|
1648
|
+
# @param amount [String] The value applied by an adjustment.
|
1649
|
+
#
|
1650
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1651
|
+
#
|
1652
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1653
|
+
# ...
|
1654
|
+
#
|
1655
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
1656
|
+
# ...
|
1657
|
+
#
|
1658
|
+
# @param reason [String, nil] The reason for the adjustment.
|
1659
|
+
#
|
1660
|
+
# @param adjustment_type [Symbol, :maximum]
|
1680
1661
|
end
|
1681
1662
|
|
1682
|
-
# @!
|
1683
|
-
#
|
1684
|
-
# def self.variants; end
|
1663
|
+
# @!method self.variants
|
1664
|
+
# @return [Array(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)]
|
1685
1665
|
end
|
1686
1666
|
|
1687
1667
|
# @deprecated
|
@@ -1701,15 +1681,16 @@ module Orb
|
|
1701
1681
|
# @return [String]
|
1702
1682
|
required :maximum_amount, String
|
1703
1683
|
|
1704
|
-
# @!
|
1705
|
-
#
|
1706
|
-
#
|
1707
|
-
#
|
1708
|
-
#
|
1709
|
-
#
|
1710
|
-
#
|
1711
|
-
|
1712
|
-
#
|
1684
|
+
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
1685
|
+
# Some parameter documentations has been truncated, see
|
1686
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum} for more details.
|
1687
|
+
#
|
1688
|
+
# This field is deprecated in favor of `adjustments`.
|
1689
|
+
#
|
1690
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
1691
|
+
# ...
|
1692
|
+
#
|
1693
|
+
# @param maximum_amount [String] Maximum amount applied
|
1713
1694
|
end
|
1714
1695
|
|
1715
1696
|
# @deprecated
|
@@ -1729,15 +1710,16 @@ module Orb
|
|
1729
1710
|
# @return [String]
|
1730
1711
|
required :minimum_amount, String
|
1731
1712
|
|
1732
|
-
# @!
|
1733
|
-
#
|
1734
|
-
#
|
1735
|
-
#
|
1736
|
-
#
|
1737
|
-
#
|
1738
|
-
#
|
1739
|
-
|
1740
|
-
#
|
1713
|
+
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
1714
|
+
# Some parameter documentations has been truncated, see
|
1715
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum} for more details.
|
1716
|
+
#
|
1717
|
+
# This field is deprecated in favor of `adjustments`.
|
1718
|
+
#
|
1719
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
1720
|
+
# ...
|
1721
|
+
#
|
1722
|
+
# @param minimum_amount [String] Minimum amount applied
|
1741
1723
|
end
|
1742
1724
|
|
1743
1725
|
module SubLineItem
|
@@ -1788,17 +1770,18 @@ module Orb
|
|
1788
1770
|
# @return [Symbol, :matrix]
|
1789
1771
|
required :type, const: :matrix
|
1790
1772
|
|
1791
|
-
# @!
|
1792
|
-
#
|
1793
|
-
#
|
1794
|
-
#
|
1795
|
-
#
|
1796
|
-
#
|
1797
|
-
#
|
1798
|
-
#
|
1799
|
-
#
|
1800
|
-
|
1801
|
-
#
|
1773
|
+
# @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
1774
|
+
# @param amount [String] The total amount for this sub line item.
|
1775
|
+
#
|
1776
|
+
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping, nil]
|
1777
|
+
#
|
1778
|
+
# @param matrix_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig]
|
1779
|
+
#
|
1780
|
+
# @param name [String]
|
1781
|
+
#
|
1782
|
+
# @param quantity [Float]
|
1783
|
+
#
|
1784
|
+
# @param type [Symbol, :matrix]
|
1802
1785
|
|
1803
1786
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem#grouping
|
1804
1787
|
class Grouping < Orb::Internal::Type::BaseModel
|
@@ -1813,13 +1796,10 @@ module Orb
|
|
1813
1796
|
# @return [String, nil]
|
1814
1797
|
required :value, String, nil?: true
|
1815
1798
|
|
1816
|
-
# @!
|
1817
|
-
#
|
1818
|
-
#
|
1819
|
-
#
|
1820
|
-
# def initialize(key:, value:, **) = super
|
1821
|
-
|
1822
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1799
|
+
# @!method initialize(key:, value:)
|
1800
|
+
# @param key [String]
|
1801
|
+
#
|
1802
|
+
# @param value [String, nil] No value indicates the default group
|
1823
1803
|
end
|
1824
1804
|
|
1825
1805
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem#matrix_config
|
@@ -1830,12 +1810,8 @@ module Orb
|
|
1830
1810
|
# @return [Array<String, nil>]
|
1831
1811
|
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
1832
1812
|
|
1833
|
-
# @!
|
1834
|
-
#
|
1835
|
-
# #
|
1836
|
-
# def initialize(dimension_values:, **) = super
|
1837
|
-
|
1838
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1813
|
+
# @!method initialize(dimension_values:)
|
1814
|
+
# @param dimension_values [Array<String, nil>] The ordered dimension values for this line item.
|
1839
1815
|
end
|
1840
1816
|
end
|
1841
1817
|
|
@@ -1874,17 +1850,18 @@ module Orb
|
|
1874
1850
|
# @return [Symbol, :tier]
|
1875
1851
|
required :type, const: :tier
|
1876
1852
|
|
1877
|
-
# @!
|
1878
|
-
#
|
1879
|
-
#
|
1880
|
-
#
|
1881
|
-
#
|
1882
|
-
#
|
1883
|
-
#
|
1884
|
-
#
|
1885
|
-
#
|
1886
|
-
|
1887
|
-
#
|
1853
|
+
# @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
1854
|
+
# @param amount [String] The total amount for this sub line item.
|
1855
|
+
#
|
1856
|
+
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping, nil]
|
1857
|
+
#
|
1858
|
+
# @param name [String]
|
1859
|
+
#
|
1860
|
+
# @param quantity [Float]
|
1861
|
+
#
|
1862
|
+
# @param tier_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig]
|
1863
|
+
#
|
1864
|
+
# @param type [Symbol, :tier]
|
1888
1865
|
|
1889
1866
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem#grouping
|
1890
1867
|
class Grouping < Orb::Internal::Type::BaseModel
|
@@ -1899,13 +1876,10 @@ module Orb
|
|
1899
1876
|
# @return [String, nil]
|
1900
1877
|
required :value, String, nil?: true
|
1901
1878
|
|
1902
|
-
# @!
|
1903
|
-
#
|
1904
|
-
#
|
1905
|
-
#
|
1906
|
-
# def initialize(key:, value:, **) = super
|
1907
|
-
|
1908
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1879
|
+
# @!method initialize(key:, value:)
|
1880
|
+
# @param key [String]
|
1881
|
+
#
|
1882
|
+
# @param value [String, nil] No value indicates the default group
|
1909
1883
|
end
|
1910
1884
|
|
1911
1885
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem#tier_config
|
@@ -1925,14 +1899,10 @@ module Orb
|
|
1925
1899
|
# @return [String]
|
1926
1900
|
required :unit_amount, String
|
1927
1901
|
|
1928
|
-
# @!
|
1929
|
-
#
|
1930
|
-
#
|
1931
|
-
#
|
1932
|
-
# #
|
1933
|
-
# def initialize(first_unit:, last_unit:, unit_amount:, **) = super
|
1934
|
-
|
1935
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1902
|
+
# @!method initialize(first_unit:, last_unit:, unit_amount:)
|
1903
|
+
# @param first_unit [Float]
|
1904
|
+
# @param last_unit [Float, nil]
|
1905
|
+
# @param unit_amount [String]
|
1936
1906
|
end
|
1937
1907
|
end
|
1938
1908
|
|
@@ -1965,16 +1935,16 @@ module Orb
|
|
1965
1935
|
# @return [Symbol, :"'null'"]
|
1966
1936
|
required :type, const: :"'null'"
|
1967
1937
|
|
1968
|
-
# @!
|
1969
|
-
#
|
1970
|
-
#
|
1971
|
-
#
|
1972
|
-
#
|
1973
|
-
#
|
1974
|
-
#
|
1975
|
-
#
|
1976
|
-
|
1977
|
-
#
|
1938
|
+
# @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
|
1939
|
+
# @param amount [String] The total amount for this sub line item.
|
1940
|
+
#
|
1941
|
+
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping, nil]
|
1942
|
+
#
|
1943
|
+
# @param name [String]
|
1944
|
+
#
|
1945
|
+
# @param quantity [Float]
|
1946
|
+
#
|
1947
|
+
# @param type [Symbol, :"'null'"]
|
1978
1948
|
|
1979
1949
|
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem#grouping
|
1980
1950
|
class Grouping < Orb::Internal::Type::BaseModel
|
@@ -1989,19 +1959,15 @@ module Orb
|
|
1989
1959
|
# @return [String, nil]
|
1990
1960
|
required :value, String, nil?: true
|
1991
1961
|
|
1992
|
-
# @!
|
1993
|
-
#
|
1994
|
-
#
|
1995
|
-
#
|
1996
|
-
# def initialize(key:, value:, **) = super
|
1997
|
-
|
1998
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1962
|
+
# @!method initialize(key:, value:)
|
1963
|
+
# @param key [String]
|
1964
|
+
#
|
1965
|
+
# @param value [String, nil] No value indicates the default group
|
1999
1966
|
end
|
2000
1967
|
end
|
2001
1968
|
|
2002
|
-
# @!
|
2003
|
-
#
|
2004
|
-
# def self.variants; end
|
1969
|
+
# @!method self.variants
|
1970
|
+
# @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem)]
|
2005
1971
|
end
|
2006
1972
|
|
2007
1973
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
@@ -2023,14 +1989,12 @@ module Orb
|
|
2023
1989
|
# @return [String, nil]
|
2024
1990
|
required :tax_rate_percentage, String, nil?: true
|
2025
1991
|
|
2026
|
-
# @!
|
2027
|
-
#
|
2028
|
-
#
|
2029
|
-
#
|
2030
|
-
#
|
2031
|
-
#
|
2032
|
-
|
2033
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
1992
|
+
# @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
|
1993
|
+
# @param amount [String] The amount of additional tax incurred by this tax rate.
|
1994
|
+
#
|
1995
|
+
# @param tax_rate_description [String] The human-readable description of the applied tax rate.
|
1996
|
+
#
|
1997
|
+
# @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
|
2034
1998
|
end
|
2035
1999
|
end
|
2036
2000
|
|
@@ -2049,13 +2013,14 @@ module Orb
|
|
2049
2013
|
# @return [String]
|
2050
2014
|
required :maximum_amount, String
|
2051
2015
|
|
2052
|
-
# @!
|
2053
|
-
#
|
2054
|
-
#
|
2055
|
-
#
|
2056
|
-
#
|
2057
|
-
|
2058
|
-
#
|
2016
|
+
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
2017
|
+
# Some parameter documentations has been truncated, see
|
2018
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::Maximum} for more details.
|
2019
|
+
#
|
2020
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
2021
|
+
# ...
|
2022
|
+
#
|
2023
|
+
# @param maximum_amount [String] Maximum amount applied
|
2059
2024
|
end
|
2060
2025
|
|
2061
2026
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#minimum
|
@@ -2073,13 +2038,14 @@ module Orb
|
|
2073
2038
|
# @return [String]
|
2074
2039
|
required :minimum_amount, String
|
2075
2040
|
|
2076
|
-
# @!
|
2077
|
-
#
|
2078
|
-
#
|
2079
|
-
#
|
2080
|
-
#
|
2081
|
-
|
2082
|
-
#
|
2041
|
+
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
2042
|
+
# Some parameter documentations has been truncated, see
|
2043
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::Minimum} for more details.
|
2044
|
+
#
|
2045
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
2046
|
+
# ...
|
2047
|
+
#
|
2048
|
+
# @param minimum_amount [String] Minimum amount applied
|
2083
2049
|
end
|
2084
2050
|
|
2085
2051
|
class PaymentAttempt < Orb::Internal::Type::BaseModel
|
@@ -2121,17 +2087,18 @@ module Orb
|
|
2121
2087
|
# @return [Boolean]
|
2122
2088
|
required :succeeded, Orb::Internal::Type::Boolean
|
2123
2089
|
|
2124
|
-
# @!
|
2125
|
-
#
|
2126
|
-
#
|
2127
|
-
#
|
2128
|
-
#
|
2129
|
-
#
|
2130
|
-
#
|
2131
|
-
#
|
2132
|
-
#
|
2133
|
-
|
2134
|
-
#
|
2090
|
+
# @!method initialize(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:)
|
2091
|
+
# @param id [String] The ID of the payment attempt.
|
2092
|
+
#
|
2093
|
+
# @param amount [String] The amount of the payment attempt.
|
2094
|
+
#
|
2095
|
+
# @param created_at [Time] The time at which the payment attempt was created.
|
2096
|
+
#
|
2097
|
+
# @param payment_provider [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment.
|
2098
|
+
#
|
2099
|
+
# @param payment_provider_id [String, nil] The ID of the payment attempt in the payment provider.
|
2100
|
+
#
|
2101
|
+
# @param succeeded [Boolean] Whether the payment attempt succeeded.
|
2135
2102
|
|
2136
2103
|
# The payment provider that attempted to collect the payment.
|
2137
2104
|
#
|
@@ -2141,11 +2108,8 @@ module Orb
|
|
2141
2108
|
|
2142
2109
|
STRIPE = :stripe
|
2143
2110
|
|
2144
|
-
|
2145
|
-
|
2146
|
-
# @!parse
|
2147
|
-
# # @return [Array<Symbol>]
|
2148
|
-
# def self.values; end
|
2111
|
+
# @!method self.values
|
2112
|
+
# @return [Array<Symbol>]
|
2149
2113
|
end
|
2150
2114
|
end
|
2151
2115
|
|
@@ -2181,17 +2145,13 @@ module Orb
|
|
2181
2145
|
# @return [String, nil]
|
2182
2146
|
required :state, String, nil?: true
|
2183
2147
|
|
2184
|
-
# @!
|
2185
|
-
#
|
2186
|
-
#
|
2187
|
-
#
|
2188
|
-
#
|
2189
|
-
#
|
2190
|
-
#
|
2191
|
-
# #
|
2192
|
-
# def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super
|
2193
|
-
|
2194
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2148
|
+
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
2149
|
+
# @param city [String, nil]
|
2150
|
+
# @param country [String, nil]
|
2151
|
+
# @param line1 [String, nil]
|
2152
|
+
# @param line2 [String, nil]
|
2153
|
+
# @param postal_code [String, nil]
|
2154
|
+
# @param state [String, nil]
|
2195
2155
|
end
|
2196
2156
|
|
2197
2157
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#status
|
@@ -2204,11 +2164,8 @@ module Orb
|
|
2204
2164
|
VOID = :void
|
2205
2165
|
DRAFT = :draft
|
2206
2166
|
|
2207
|
-
|
2208
|
-
|
2209
|
-
# @!parse
|
2210
|
-
# # @return [Array<Symbol>]
|
2211
|
-
# def self.values; end
|
2167
|
+
# @!method self.values
|
2168
|
+
# @return [Array<Symbol>]
|
2212
2169
|
end
|
2213
2170
|
|
2214
2171
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#subscription
|
@@ -2218,12 +2175,8 @@ module Orb
|
|
2218
2175
|
# @return [String]
|
2219
2176
|
required :id, String
|
2220
2177
|
|
2221
|
-
# @!
|
2222
|
-
#
|
2223
|
-
# #
|
2224
|
-
# def initialize(id:, **) = super
|
2225
|
-
|
2226
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
2178
|
+
# @!method initialize(id:)
|
2179
|
+
# @param id [String]
|
2227
2180
|
end
|
2228
2181
|
end
|
2229
2182
|
end
|