orb-billing 0.2.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +67 -0
- data/README.md +63 -53
- data/lib/orb/client.rb +4 -4
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +7 -11
- data/lib/orb/internal/transport/base_client.rb +10 -10
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +33 -23
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +14 -11
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +19 -16
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +3 -10
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +14 -11
- data/lib/orb/internal/util.rb +88 -64
- data/lib/orb/internal.rb +0 -1
- 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 +29 -34
- 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 +216 -257
- 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 +212 -257
- data/lib/orb/models/customer_update_params.rb +212 -255
- 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 +23 -27
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +23 -27
- 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 +384 -491
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
- 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 +384 -494
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
- 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 +619 -681
- 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 +618 -669
- 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 +281 -306
- 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 +259 -291
- data/lib/orb/models/plan_create_params.rb +2070 -2466
- 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 +3842 -5005
- 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 +360 -405
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +358 -399
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +384 -418
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
- data/lib/orb/models/subscription_create_params.rb +4735 -5417
- data/lib/orb/models/subscription_create_response.rb +358 -399
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
- 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 +2560 -3040
- data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
- 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 +362 -396
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
- 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 +360 -399
- 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/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -6
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +26 -8
- 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 +112 -32
- 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 +138 -39
- 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 +9 -3
- data/lib/orb/resources/prices.rb +101 -26
- 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 → orb}/client.rbi +4 -4
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/orb/file_part.rbi +34 -0
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
- data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
- data/rbi/{lib/orb → orb}/internal.rbi +0 -1
- data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
- data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- 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 +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +230 -224
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -22,7 +22,7 @@ module Orb
|
|
22
22
|
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
23
23
|
# discounts -> minimums -> maximums).
|
24
24
|
#
|
25
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
25
|
+
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum>]
|
26
26
|
required :adjustments,
|
27
27
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::Adjustment] }
|
28
28
|
|
@@ -65,24 +65,32 @@ module Orb
|
|
65
65
|
required :grouping, String, nil?: true
|
66
66
|
|
67
67
|
# @!attribute maximum
|
68
|
+
# @deprecated
|
69
|
+
#
|
68
70
|
# This field is deprecated in favor of `adjustments`.
|
69
71
|
#
|
70
72
|
# @return [Orb::Models::InvoiceLineItemCreateResponse::Maximum, nil]
|
71
73
|
required :maximum, -> { Orb::Models::InvoiceLineItemCreateResponse::Maximum }, nil?: true
|
72
74
|
|
73
75
|
# @!attribute maximum_amount
|
76
|
+
# @deprecated
|
77
|
+
#
|
74
78
|
# This field is deprecated in favor of `adjustments`.
|
75
79
|
#
|
76
80
|
# @return [String, nil]
|
77
81
|
required :maximum_amount, String, nil?: true
|
78
82
|
|
79
83
|
# @!attribute minimum
|
84
|
+
# @deprecated
|
85
|
+
#
|
80
86
|
# This field is deprecated in favor of `adjustments`.
|
81
87
|
#
|
82
88
|
# @return [Orb::Models::InvoiceLineItemCreateResponse::Minimum, nil]
|
83
89
|
required :minimum, -> { Orb::Models::InvoiceLineItemCreateResponse::Minimum }, nil?: true
|
84
90
|
|
85
91
|
# @!attribute minimum_amount
|
92
|
+
# @deprecated
|
93
|
+
#
|
86
94
|
# This field is deprecated in favor of `adjustments`.
|
87
95
|
#
|
88
96
|
# @return [String, nil]
|
@@ -112,7 +120,7 @@ module Orb
|
|
112
120
|
# For more on the types of prices, see
|
113
121
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
114
122
|
#
|
115
|
-
# @return [Orb::Models::Price::
|
123
|
+
# @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]
|
116
124
|
required :price, union: -> { Orb::Models::Price }, nil?: true
|
117
125
|
|
118
126
|
# @!attribute quantity
|
@@ -131,7 +139,7 @@ module Orb
|
|
131
139
|
# For complex pricing structures, the line item can be broken down further in
|
132
140
|
# `sub_line_items`.
|
133
141
|
#
|
134
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
142
|
+
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null>]
|
135
143
|
required :sub_line_items,
|
136
144
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem] }
|
137
145
|
|
@@ -155,79 +163,79 @@ module Orb
|
|
155
163
|
# @return [Array<String>, nil]
|
156
164
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
157
165
|
|
158
|
-
# @!
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
#
|
167
|
-
#
|
168
|
-
#
|
169
|
-
#
|
170
|
-
#
|
171
|
-
#
|
172
|
-
#
|
173
|
-
#
|
174
|
-
#
|
175
|
-
#
|
176
|
-
#
|
177
|
-
#
|
178
|
-
#
|
179
|
-
#
|
180
|
-
#
|
181
|
-
#
|
182
|
-
#
|
183
|
-
#
|
184
|
-
#
|
185
|
-
#
|
186
|
-
#
|
187
|
-
#
|
188
|
-
#
|
189
|
-
#
|
190
|
-
#
|
191
|
-
#
|
192
|
-
#
|
193
|
-
#
|
194
|
-
#
|
195
|
-
#
|
196
|
-
#
|
197
|
-
#
|
198
|
-
#
|
199
|
-
#
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
203
|
-
#
|
204
|
-
#
|
205
|
-
#
|
206
|
-
#
|
207
|
-
#
|
208
|
-
#
|
209
|
-
|
210
|
-
#
|
166
|
+
# @!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:)
|
167
|
+
# Some parameter documentations has been truncated, see
|
168
|
+
# {Orb::Models::InvoiceLineItemCreateResponse} for more details.
|
169
|
+
#
|
170
|
+
# @param id [String] A unique ID for this line item.
|
171
|
+
#
|
172
|
+
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
173
|
+
# ...
|
174
|
+
#
|
175
|
+
# @param adjustments [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
|
176
|
+
# ...
|
177
|
+
#
|
178
|
+
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
179
|
+
# ...
|
180
|
+
#
|
181
|
+
# @param credits_applied [String] The number of prepaid credits applied.
|
182
|
+
#
|
183
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
184
|
+
#
|
185
|
+
# @param end_date [Time] The end date of the range of time applied for this line item's price.
|
186
|
+
#
|
187
|
+
# @param filter [String, nil] An additional filter that was used to calculate the usage for this line item.
|
188
|
+
#
|
189
|
+
# @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
|
190
|
+
# ...
|
191
|
+
#
|
192
|
+
# @param maximum [Orb::Models::InvoiceLineItemCreateResponse::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
193
|
+
#
|
194
|
+
# @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
195
|
+
#
|
196
|
+
# @param minimum [Orb::Models::InvoiceLineItemCreateResponse::Minimum, nil] This field is deprecated in favor of `adjustments`.
|
197
|
+
#
|
198
|
+
# @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
199
|
+
#
|
200
|
+
# @param name [String] The name of the price associated with this line item.
|
201
|
+
#
|
202
|
+
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
203
|
+
#
|
204
|
+
# @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
|
205
|
+
# ...
|
206
|
+
#
|
207
|
+
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
208
|
+
#
|
209
|
+
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
210
|
+
#
|
211
|
+
# @param sub_line_items [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
|
212
|
+
# ...
|
213
|
+
#
|
214
|
+
# @param subtotal [String] The line amount before before any adjustments.
|
215
|
+
#
|
216
|
+
# @param tax_amounts [Array<Orb::Models::InvoiceLineItemCreateResponse::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
217
|
+
# ...
|
218
|
+
#
|
219
|
+
# @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
|
220
|
+
# ...
|
211
221
|
|
212
222
|
module Adjustment
|
213
223
|
extend Orb::Internal::Type::Union
|
214
224
|
|
215
225
|
discriminator :adjustment_type
|
216
226
|
|
217
|
-
variant :usage_discount,
|
218
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment }
|
227
|
+
variant :usage_discount, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount }
|
219
228
|
|
220
|
-
variant :amount_discount,
|
221
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment }
|
229
|
+
variant :amount_discount, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount }
|
222
230
|
|
223
231
|
variant :percentage_discount,
|
224
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
232
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount }
|
225
233
|
|
226
|
-
variant :minimum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
234
|
+
variant :minimum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum }
|
227
235
|
|
228
|
-
variant :maximum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
236
|
+
variant :maximum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum }
|
229
237
|
|
230
|
-
class
|
238
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
231
239
|
# @!attribute id
|
232
240
|
#
|
233
241
|
# @return [String]
|
@@ -270,32 +278,29 @@ module Orb
|
|
270
278
|
# @return [Float]
|
271
279
|
required :usage_discount, Float
|
272
280
|
|
273
|
-
# @!
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
#
|
287
|
-
#
|
288
|
-
#
|
289
|
-
#
|
290
|
-
#
|
291
|
-
#
|
292
|
-
#
|
293
|
-
# end
|
294
|
-
|
295
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
281
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
282
|
+
# Some parameter documentations has been truncated, see
|
283
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount} for more
|
284
|
+
# details.
|
285
|
+
#
|
286
|
+
# @param id [String]
|
287
|
+
#
|
288
|
+
# @param amount [String] The value applied by an adjustment.
|
289
|
+
#
|
290
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
291
|
+
#
|
292
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
293
|
+
# ...
|
294
|
+
#
|
295
|
+
# @param reason [String, nil] The reason for the adjustment.
|
296
|
+
#
|
297
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
298
|
+
# ...
|
299
|
+
#
|
300
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
296
301
|
end
|
297
302
|
|
298
|
-
class
|
303
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
299
304
|
# @!attribute id
|
300
305
|
#
|
301
306
|
# @return [String]
|
@@ -338,32 +343,29 @@ module Orb
|
|
338
343
|
# @return [String, nil]
|
339
344
|
required :reason, String, nil?: true
|
340
345
|
|
341
|
-
# @!
|
342
|
-
#
|
343
|
-
#
|
344
|
-
#
|
345
|
-
#
|
346
|
-
#
|
347
|
-
#
|
348
|
-
#
|
349
|
-
#
|
350
|
-
#
|
351
|
-
#
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
#
|
360
|
-
#
|
361
|
-
# end
|
362
|
-
|
363
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
346
|
+
# @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
|
347
|
+
# Some parameter documentations has been truncated, see
|
348
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount} for
|
349
|
+
# more details.
|
350
|
+
#
|
351
|
+
# @param id [String]
|
352
|
+
#
|
353
|
+
# @param amount [String] The value applied by an adjustment.
|
354
|
+
#
|
355
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
356
|
+
# ...
|
357
|
+
#
|
358
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
359
|
+
#
|
360
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
361
|
+
# ...
|
362
|
+
#
|
363
|
+
# @param reason [String, nil] The reason for the adjustment.
|
364
|
+
#
|
365
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
364
366
|
end
|
365
367
|
|
366
|
-
class
|
368
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
367
369
|
# @!attribute id
|
368
370
|
#
|
369
371
|
# @return [String]
|
@@ -406,32 +408,29 @@ module Orb
|
|
406
408
|
# @return [String, nil]
|
407
409
|
required :reason, String, nil?: true
|
408
410
|
|
409
|
-
# @!
|
410
|
-
#
|
411
|
-
#
|
412
|
-
#
|
413
|
-
#
|
414
|
-
#
|
415
|
-
#
|
416
|
-
#
|
417
|
-
#
|
418
|
-
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
#
|
422
|
-
#
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
428
|
-
#
|
429
|
-
# end
|
430
|
-
|
431
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
411
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
|
412
|
+
# Some parameter documentations has been truncated, see
|
413
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount} for
|
414
|
+
# more details.
|
415
|
+
#
|
416
|
+
# @param id [String]
|
417
|
+
#
|
418
|
+
# @param amount [String] The value applied by an adjustment.
|
419
|
+
#
|
420
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
421
|
+
#
|
422
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
423
|
+
# ...
|
424
|
+
#
|
425
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
426
|
+
# ...
|
427
|
+
#
|
428
|
+
# @param reason [String, nil] The reason for the adjustment.
|
429
|
+
#
|
430
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
432
431
|
end
|
433
432
|
|
434
|
-
class
|
433
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
435
434
|
# @!attribute id
|
436
435
|
#
|
437
436
|
# @return [String]
|
@@ -480,34 +479,31 @@ module Orb
|
|
480
479
|
# @return [String, nil]
|
481
480
|
required :reason, String, nil?: true
|
482
481
|
|
483
|
-
# @!
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
#
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
505
|
-
# end
|
506
|
-
|
507
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
482
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
|
483
|
+
# Some parameter documentations has been truncated, see
|
484
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum} for more
|
485
|
+
# details.
|
486
|
+
#
|
487
|
+
# @param id [String]
|
488
|
+
#
|
489
|
+
# @param amount [String] The value applied by an adjustment.
|
490
|
+
#
|
491
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
492
|
+
#
|
493
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
494
|
+
# ...
|
495
|
+
#
|
496
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
497
|
+
#
|
498
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
499
|
+
# ...
|
500
|
+
#
|
501
|
+
# @param reason [String, nil] The reason for the adjustment.
|
502
|
+
#
|
503
|
+
# @param adjustment_type [Symbol, :minimum]
|
508
504
|
end
|
509
505
|
|
510
|
-
class
|
506
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
511
507
|
# @!attribute id
|
512
508
|
#
|
513
509
|
# @return [String]
|
@@ -550,34 +546,30 @@ module Orb
|
|
550
546
|
# @return [String, nil]
|
551
547
|
required :reason, String, nil?: true
|
552
548
|
|
553
|
-
# @!
|
554
|
-
#
|
555
|
-
#
|
556
|
-
#
|
557
|
-
#
|
558
|
-
#
|
559
|
-
#
|
560
|
-
#
|
561
|
-
#
|
562
|
-
#
|
563
|
-
#
|
564
|
-
#
|
565
|
-
#
|
566
|
-
#
|
567
|
-
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
571
|
-
#
|
572
|
-
#
|
573
|
-
# end
|
574
|
-
|
575
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
549
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
|
550
|
+
# Some parameter documentations has been truncated, see
|
551
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum} for more
|
552
|
+
# details.
|
553
|
+
#
|
554
|
+
# @param id [String]
|
555
|
+
#
|
556
|
+
# @param amount [String] The value applied by an adjustment.
|
557
|
+
#
|
558
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
559
|
+
#
|
560
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
561
|
+
# ...
|
562
|
+
#
|
563
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
564
|
+
# ...
|
565
|
+
#
|
566
|
+
# @param reason [String, nil] The reason for the adjustment.
|
567
|
+
#
|
568
|
+
# @param adjustment_type [Symbol, :maximum]
|
576
569
|
end
|
577
570
|
|
578
|
-
# @!
|
579
|
-
#
|
580
|
-
# def self.variants; end
|
571
|
+
# @!method self.variants
|
572
|
+
# @return [Array(Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum)]
|
581
573
|
end
|
582
574
|
|
583
575
|
# @deprecated
|
@@ -597,15 +589,16 @@ module Orb
|
|
597
589
|
# @return [String]
|
598
590
|
required :maximum_amount, String
|
599
591
|
|
600
|
-
# @!
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
|
608
|
-
#
|
592
|
+
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
593
|
+
# Some parameter documentations has been truncated, see
|
594
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Maximum} for more details.
|
595
|
+
#
|
596
|
+
# This field is deprecated in favor of `adjustments`.
|
597
|
+
#
|
598
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
599
|
+
# ...
|
600
|
+
#
|
601
|
+
# @param maximum_amount [String] Maximum amount applied
|
609
602
|
end
|
610
603
|
|
611
604
|
# @deprecated
|
@@ -625,15 +618,16 @@ module Orb
|
|
625
618
|
# @return [String]
|
626
619
|
required :minimum_amount, String
|
627
620
|
|
628
|
-
# @!
|
629
|
-
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
635
|
-
|
636
|
-
#
|
621
|
+
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
622
|
+
# Some parameter documentations has been truncated, see
|
623
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Minimum} for more details.
|
624
|
+
#
|
625
|
+
# This field is deprecated in favor of `adjustments`.
|
626
|
+
#
|
627
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
628
|
+
# ...
|
629
|
+
#
|
630
|
+
# @param minimum_amount [String] Minimum amount applied
|
637
631
|
end
|
638
632
|
|
639
633
|
module SubLineItem
|
@@ -641,13 +635,13 @@ module Orb
|
|
641
635
|
|
642
636
|
discriminator :type
|
643
637
|
|
644
|
-
variant :matrix, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
638
|
+
variant :matrix, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix }
|
645
639
|
|
646
|
-
variant :tier, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
640
|
+
variant :tier, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier }
|
647
641
|
|
648
|
-
variant :"'null'", -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
642
|
+
variant :"'null'", -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null }
|
649
643
|
|
650
|
-
class
|
644
|
+
class Matrix < Orb::Internal::Type::BaseModel
|
651
645
|
# @!attribute amount
|
652
646
|
# The total amount for this sub line item.
|
653
647
|
#
|
@@ -656,16 +650,16 @@ module Orb
|
|
656
650
|
|
657
651
|
# @!attribute grouping
|
658
652
|
#
|
659
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
653
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping, nil]
|
660
654
|
required :grouping,
|
661
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
655
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping },
|
662
656
|
nil?: true
|
663
657
|
|
664
658
|
# @!attribute matrix_config
|
665
659
|
#
|
666
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
660
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig]
|
667
661
|
required :matrix_config,
|
668
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
662
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig }
|
669
663
|
|
670
664
|
# @!attribute name
|
671
665
|
#
|
@@ -682,19 +676,20 @@ module Orb
|
|
682
676
|
# @return [Symbol, :matrix]
|
683
677
|
required :type, const: :matrix
|
684
678
|
|
685
|
-
# @!
|
686
|
-
#
|
687
|
-
#
|
688
|
-
#
|
689
|
-
#
|
690
|
-
#
|
691
|
-
#
|
692
|
-
#
|
693
|
-
#
|
694
|
-
|
695
|
-
#
|
679
|
+
# @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
680
|
+
# @param amount [String] The total amount for this sub line item.
|
681
|
+
#
|
682
|
+
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping, nil]
|
683
|
+
#
|
684
|
+
# @param matrix_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig]
|
685
|
+
#
|
686
|
+
# @param name [String]
|
687
|
+
#
|
688
|
+
# @param quantity [Float]
|
689
|
+
#
|
690
|
+
# @param type [Symbol, :matrix]
|
696
691
|
|
697
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
692
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix#grouping
|
698
693
|
class Grouping < Orb::Internal::Type::BaseModel
|
699
694
|
# @!attribute key
|
700
695
|
#
|
@@ -707,16 +702,13 @@ module Orb
|
|
707
702
|
# @return [String, nil]
|
708
703
|
required :value, String, nil?: true
|
709
704
|
|
710
|
-
# @!
|
711
|
-
#
|
712
|
-
#
|
713
|
-
#
|
714
|
-
# def initialize(key:, value:, **) = super
|
715
|
-
|
716
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
705
|
+
# @!method initialize(key:, value:)
|
706
|
+
# @param key [String]
|
707
|
+
#
|
708
|
+
# @param value [String, nil] No value indicates the default group
|
717
709
|
end
|
718
710
|
|
719
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
711
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix#matrix_config
|
720
712
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
721
713
|
# @!attribute dimension_values
|
722
714
|
# The ordered dimension values for this line item.
|
@@ -724,16 +716,12 @@ module Orb
|
|
724
716
|
# @return [Array<String, nil>]
|
725
717
|
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
726
718
|
|
727
|
-
# @!
|
728
|
-
#
|
729
|
-
# #
|
730
|
-
# def initialize(dimension_values:, **) = super
|
731
|
-
|
732
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
719
|
+
# @!method initialize(dimension_values:)
|
720
|
+
# @param dimension_values [Array<String, nil>] The ordered dimension values for this line item.
|
733
721
|
end
|
734
722
|
end
|
735
723
|
|
736
|
-
class
|
724
|
+
class Tier < Orb::Internal::Type::BaseModel
|
737
725
|
# @!attribute amount
|
738
726
|
# The total amount for this sub line item.
|
739
727
|
#
|
@@ -742,9 +730,9 @@ module Orb
|
|
742
730
|
|
743
731
|
# @!attribute grouping
|
744
732
|
#
|
745
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
733
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping, nil]
|
746
734
|
required :grouping,
|
747
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
735
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping },
|
748
736
|
nil?: true
|
749
737
|
|
750
738
|
# @!attribute name
|
@@ -759,28 +747,28 @@ module Orb
|
|
759
747
|
|
760
748
|
# @!attribute tier_config
|
761
749
|
#
|
762
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
763
|
-
required :tier_config,
|
764
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig }
|
750
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig]
|
751
|
+
required :tier_config, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig }
|
765
752
|
|
766
753
|
# @!attribute type
|
767
754
|
#
|
768
755
|
# @return [Symbol, :tier]
|
769
756
|
required :type, const: :tier
|
770
757
|
|
771
|
-
# @!
|
772
|
-
#
|
773
|
-
#
|
774
|
-
#
|
775
|
-
#
|
776
|
-
#
|
777
|
-
#
|
778
|
-
#
|
779
|
-
#
|
780
|
-
|
781
|
-
#
|
758
|
+
# @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
759
|
+
# @param amount [String] The total amount for this sub line item.
|
760
|
+
#
|
761
|
+
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping, nil]
|
762
|
+
#
|
763
|
+
# @param name [String]
|
764
|
+
#
|
765
|
+
# @param quantity [Float]
|
766
|
+
#
|
767
|
+
# @param tier_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig]
|
768
|
+
#
|
769
|
+
# @param type [Symbol, :tier]
|
782
770
|
|
783
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
771
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier#grouping
|
784
772
|
class Grouping < Orb::Internal::Type::BaseModel
|
785
773
|
# @!attribute key
|
786
774
|
#
|
@@ -793,16 +781,13 @@ module Orb
|
|
793
781
|
# @return [String, nil]
|
794
782
|
required :value, String, nil?: true
|
795
783
|
|
796
|
-
# @!
|
797
|
-
#
|
798
|
-
#
|
799
|
-
#
|
800
|
-
# def initialize(key:, value:, **) = super
|
801
|
-
|
802
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
784
|
+
# @!method initialize(key:, value:)
|
785
|
+
# @param key [String]
|
786
|
+
#
|
787
|
+
# @param value [String, nil] No value indicates the default group
|
803
788
|
end
|
804
789
|
|
805
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
790
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier#tier_config
|
806
791
|
class TierConfig < Orb::Internal::Type::BaseModel
|
807
792
|
# @!attribute first_unit
|
808
793
|
#
|
@@ -819,18 +804,14 @@ module Orb
|
|
819
804
|
# @return [String]
|
820
805
|
required :unit_amount, String
|
821
806
|
|
822
|
-
# @!
|
823
|
-
#
|
824
|
-
#
|
825
|
-
#
|
826
|
-
# #
|
827
|
-
# def initialize(first_unit:, last_unit:, unit_amount:, **) = super
|
828
|
-
|
829
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
807
|
+
# @!method initialize(first_unit:, last_unit:, unit_amount:)
|
808
|
+
# @param first_unit [Float]
|
809
|
+
# @param last_unit [Float, nil]
|
810
|
+
# @param unit_amount [String]
|
830
811
|
end
|
831
812
|
end
|
832
813
|
|
833
|
-
class
|
814
|
+
class Null < Orb::Internal::Type::BaseModel
|
834
815
|
# @!attribute amount
|
835
816
|
# The total amount for this sub line item.
|
836
817
|
#
|
@@ -839,9 +820,9 @@ module Orb
|
|
839
820
|
|
840
821
|
# @!attribute grouping
|
841
822
|
#
|
842
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
823
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping, nil]
|
843
824
|
required :grouping,
|
844
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
825
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping },
|
845
826
|
nil?: true
|
846
827
|
|
847
828
|
# @!attribute name
|
@@ -859,18 +840,18 @@ module Orb
|
|
859
840
|
# @return [Symbol, :"'null'"]
|
860
841
|
required :type, const: :"'null'"
|
861
842
|
|
862
|
-
# @!
|
863
|
-
#
|
864
|
-
#
|
865
|
-
#
|
866
|
-
#
|
867
|
-
#
|
868
|
-
#
|
869
|
-
#
|
870
|
-
|
871
|
-
#
|
843
|
+
# @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
|
844
|
+
# @param amount [String] The total amount for this sub line item.
|
845
|
+
#
|
846
|
+
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping, nil]
|
847
|
+
#
|
848
|
+
# @param name [String]
|
849
|
+
#
|
850
|
+
# @param quantity [Float]
|
851
|
+
#
|
852
|
+
# @param type [Symbol, :"'null'"]
|
872
853
|
|
873
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
854
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null#grouping
|
874
855
|
class Grouping < Orb::Internal::Type::BaseModel
|
875
856
|
# @!attribute key
|
876
857
|
#
|
@@ -883,19 +864,15 @@ module Orb
|
|
883
864
|
# @return [String, nil]
|
884
865
|
required :value, String, nil?: true
|
885
866
|
|
886
|
-
# @!
|
887
|
-
#
|
888
|
-
#
|
889
|
-
#
|
890
|
-
# def initialize(key:, value:, **) = super
|
891
|
-
|
892
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
867
|
+
# @!method initialize(key:, value:)
|
868
|
+
# @param key [String]
|
869
|
+
#
|
870
|
+
# @param value [String, nil] No value indicates the default group
|
893
871
|
end
|
894
872
|
end
|
895
873
|
|
896
|
-
# @!
|
897
|
-
#
|
898
|
-
# def self.variants; end
|
874
|
+
# @!method self.variants
|
875
|
+
# @return [Array(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null)]
|
899
876
|
end
|
900
877
|
|
901
878
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
@@ -917,14 +894,12 @@ module Orb
|
|
917
894
|
# @return [String, nil]
|
918
895
|
required :tax_rate_percentage, String, nil?: true
|
919
896
|
|
920
|
-
# @!
|
921
|
-
#
|
922
|
-
#
|
923
|
-
#
|
924
|
-
#
|
925
|
-
#
|
926
|
-
|
927
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
897
|
+
# @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
|
898
|
+
# @param amount [String] The amount of additional tax incurred by this tax rate.
|
899
|
+
#
|
900
|
+
# @param tax_rate_description [String] The human-readable description of the applied tax rate.
|
901
|
+
#
|
902
|
+
# @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
|
928
903
|
end
|
929
904
|
end
|
930
905
|
end
|