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
@@ -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]
|
@@ -155,59 +163,61 @@ 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::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment>] 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::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
|
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::MatrixSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem>] 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
|
@@ -270,29 +280,26 @@ module Orb
|
|
270
280
|
# @return [Float]
|
271
281
|
required :usage_discount, Float
|
272
282
|
|
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
|
283
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
284
|
+
# Some parameter documentations has been truncated, see
|
285
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment}
|
286
|
+
# for more details.
|
287
|
+
#
|
288
|
+
# @param id [String]
|
289
|
+
#
|
290
|
+
# @param amount [String] The value applied by an adjustment.
|
291
|
+
#
|
292
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
293
|
+
#
|
294
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
295
|
+
# ...
|
296
|
+
#
|
297
|
+
# @param reason [String, nil] The reason for the adjustment.
|
298
|
+
#
|
299
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
300
|
+
# ...
|
301
|
+
#
|
302
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
296
303
|
end
|
297
304
|
|
298
305
|
class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -338,29 +345,26 @@ module Orb
|
|
338
345
|
# @return [String, nil]
|
339
346
|
required :reason, String, nil?: true
|
340
347
|
|
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
|
348
|
+
# @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
|
349
|
+
# Some parameter documentations has been truncated, see
|
350
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment}
|
351
|
+
# for more details.
|
352
|
+
#
|
353
|
+
# @param id [String]
|
354
|
+
#
|
355
|
+
# @param amount [String] The value applied by an adjustment.
|
356
|
+
#
|
357
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
358
|
+
# ...
|
359
|
+
#
|
360
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
361
|
+
#
|
362
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
363
|
+
# ...
|
364
|
+
#
|
365
|
+
# @param reason [String, nil] The reason for the adjustment.
|
366
|
+
#
|
367
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
364
368
|
end
|
365
369
|
|
366
370
|
class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -406,29 +410,26 @@ module Orb
|
|
406
410
|
# @return [String, nil]
|
407
411
|
required :reason, String, nil?: true
|
408
412
|
|
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
|
413
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
|
414
|
+
# Some parameter documentations has been truncated, see
|
415
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment}
|
416
|
+
# for more details.
|
417
|
+
#
|
418
|
+
# @param id [String]
|
419
|
+
#
|
420
|
+
# @param amount [String] The value applied by an adjustment.
|
421
|
+
#
|
422
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
423
|
+
#
|
424
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
425
|
+
# ...
|
426
|
+
#
|
427
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
428
|
+
# ...
|
429
|
+
#
|
430
|
+
# @param reason [String, nil] The reason for the adjustment.
|
431
|
+
#
|
432
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
432
433
|
end
|
433
434
|
|
434
435
|
class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -480,31 +481,28 @@ module Orb
|
|
480
481
|
# @return [String, nil]
|
481
482
|
required :reason, String, nil?: true
|
482
483
|
|
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
|
484
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
|
485
|
+
# Some parameter documentations has been truncated, see
|
486
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment}
|
487
|
+
# for more details.
|
488
|
+
#
|
489
|
+
# @param id [String]
|
490
|
+
#
|
491
|
+
# @param amount [String] The value applied by an adjustment.
|
492
|
+
#
|
493
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
494
|
+
#
|
495
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
496
|
+
# ...
|
497
|
+
#
|
498
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
499
|
+
#
|
500
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
501
|
+
# ...
|
502
|
+
#
|
503
|
+
# @param reason [String, nil] The reason for the adjustment.
|
504
|
+
#
|
505
|
+
# @param adjustment_type [Symbol, :minimum]
|
508
506
|
end
|
509
507
|
|
510
508
|
class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -550,34 +548,30 @@ module Orb
|
|
550
548
|
# @return [String, nil]
|
551
549
|
required :reason, String, nil?: true
|
552
550
|
|
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
|
551
|
+
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
|
552
|
+
# Some parameter documentations has been truncated, see
|
553
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment}
|
554
|
+
# for more details.
|
555
|
+
#
|
556
|
+
# @param id [String]
|
557
|
+
#
|
558
|
+
# @param amount [String] The value applied by an adjustment.
|
559
|
+
#
|
560
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
561
|
+
#
|
562
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
563
|
+
# ...
|
564
|
+
#
|
565
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
566
|
+
# ...
|
567
|
+
#
|
568
|
+
# @param reason [String, nil] The reason for the adjustment.
|
569
|
+
#
|
570
|
+
# @param adjustment_type [Symbol, :maximum]
|
576
571
|
end
|
577
572
|
|
578
|
-
# @!
|
579
|
-
#
|
580
|
-
# def self.variants; end
|
573
|
+
# @!method self.variants
|
574
|
+
# @return [Array(Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment)]
|
581
575
|
end
|
582
576
|
|
583
577
|
# @deprecated
|
@@ -597,15 +591,16 @@ module Orb
|
|
597
591
|
# @return [String]
|
598
592
|
required :maximum_amount, String
|
599
593
|
|
600
|
-
# @!
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
|
608
|
-
#
|
594
|
+
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
595
|
+
# Some parameter documentations has been truncated, see
|
596
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Maximum} for more details.
|
597
|
+
#
|
598
|
+
# This field is deprecated in favor of `adjustments`.
|
599
|
+
#
|
600
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
601
|
+
# ...
|
602
|
+
#
|
603
|
+
# @param maximum_amount [String] Maximum amount applied
|
609
604
|
end
|
610
605
|
|
611
606
|
# @deprecated
|
@@ -625,15 +620,16 @@ module Orb
|
|
625
620
|
# @return [String]
|
626
621
|
required :minimum_amount, String
|
627
622
|
|
628
|
-
# @!
|
629
|
-
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
635
|
-
|
636
|
-
#
|
623
|
+
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
624
|
+
# Some parameter documentations has been truncated, see
|
625
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Minimum} for more details.
|
626
|
+
#
|
627
|
+
# This field is deprecated in favor of `adjustments`.
|
628
|
+
#
|
629
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
630
|
+
# ...
|
631
|
+
#
|
632
|
+
# @param minimum_amount [String] Minimum amount applied
|
637
633
|
end
|
638
634
|
|
639
635
|
module SubLineItem
|
@@ -682,17 +678,18 @@ module Orb
|
|
682
678
|
# @return [Symbol, :matrix]
|
683
679
|
required :type, const: :matrix
|
684
680
|
|
685
|
-
# @!
|
686
|
-
#
|
687
|
-
#
|
688
|
-
#
|
689
|
-
#
|
690
|
-
#
|
691
|
-
#
|
692
|
-
#
|
693
|
-
#
|
694
|
-
|
695
|
-
#
|
681
|
+
# @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
682
|
+
# @param amount [String] The total amount for this sub line item.
|
683
|
+
#
|
684
|
+
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping, nil]
|
685
|
+
#
|
686
|
+
# @param matrix_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig]
|
687
|
+
#
|
688
|
+
# @param name [String]
|
689
|
+
#
|
690
|
+
# @param quantity [Float]
|
691
|
+
#
|
692
|
+
# @param type [Symbol, :matrix]
|
696
693
|
|
697
694
|
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem#grouping
|
698
695
|
class Grouping < Orb::Internal::Type::BaseModel
|
@@ -707,13 +704,10 @@ module Orb
|
|
707
704
|
# @return [String, nil]
|
708
705
|
required :value, String, nil?: true
|
709
706
|
|
710
|
-
# @!
|
711
|
-
#
|
712
|
-
#
|
713
|
-
#
|
714
|
-
# def initialize(key:, value:, **) = super
|
715
|
-
|
716
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
707
|
+
# @!method initialize(key:, value:)
|
708
|
+
# @param key [String]
|
709
|
+
#
|
710
|
+
# @param value [String, nil] No value indicates the default group
|
717
711
|
end
|
718
712
|
|
719
713
|
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem#matrix_config
|
@@ -724,12 +718,8 @@ module Orb
|
|
724
718
|
# @return [Array<String, nil>]
|
725
719
|
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
726
720
|
|
727
|
-
# @!
|
728
|
-
#
|
729
|
-
# #
|
730
|
-
# def initialize(dimension_values:, **) = super
|
731
|
-
|
732
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
721
|
+
# @!method initialize(dimension_values:)
|
722
|
+
# @param dimension_values [Array<String, nil>] The ordered dimension values for this line item.
|
733
723
|
end
|
734
724
|
end
|
735
725
|
|
@@ -768,17 +758,18 @@ module Orb
|
|
768
758
|
# @return [Symbol, :tier]
|
769
759
|
required :type, const: :tier
|
770
760
|
|
771
|
-
# @!
|
772
|
-
#
|
773
|
-
#
|
774
|
-
#
|
775
|
-
#
|
776
|
-
#
|
777
|
-
#
|
778
|
-
#
|
779
|
-
#
|
780
|
-
|
781
|
-
#
|
761
|
+
# @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
762
|
+
# @param amount [String] The total amount for this sub line item.
|
763
|
+
#
|
764
|
+
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping, nil]
|
765
|
+
#
|
766
|
+
# @param name [String]
|
767
|
+
#
|
768
|
+
# @param quantity [Float]
|
769
|
+
#
|
770
|
+
# @param tier_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig]
|
771
|
+
#
|
772
|
+
# @param type [Symbol, :tier]
|
782
773
|
|
783
774
|
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem#grouping
|
784
775
|
class Grouping < Orb::Internal::Type::BaseModel
|
@@ -793,13 +784,10 @@ module Orb
|
|
793
784
|
# @return [String, nil]
|
794
785
|
required :value, String, nil?: true
|
795
786
|
|
796
|
-
# @!
|
797
|
-
#
|
798
|
-
#
|
799
|
-
#
|
800
|
-
# def initialize(key:, value:, **) = super
|
801
|
-
|
802
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
787
|
+
# @!method initialize(key:, value:)
|
788
|
+
# @param key [String]
|
789
|
+
#
|
790
|
+
# @param value [String, nil] No value indicates the default group
|
803
791
|
end
|
804
792
|
|
805
793
|
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem#tier_config
|
@@ -819,14 +807,10 @@ module Orb
|
|
819
807
|
# @return [String]
|
820
808
|
required :unit_amount, String
|
821
809
|
|
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
|
810
|
+
# @!method initialize(first_unit:, last_unit:, unit_amount:)
|
811
|
+
# @param first_unit [Float]
|
812
|
+
# @param last_unit [Float, nil]
|
813
|
+
# @param unit_amount [String]
|
830
814
|
end
|
831
815
|
end
|
832
816
|
|
@@ -859,16 +843,16 @@ module Orb
|
|
859
843
|
# @return [Symbol, :"'null'"]
|
860
844
|
required :type, const: :"'null'"
|
861
845
|
|
862
|
-
# @!
|
863
|
-
#
|
864
|
-
#
|
865
|
-
#
|
866
|
-
#
|
867
|
-
#
|
868
|
-
#
|
869
|
-
#
|
870
|
-
|
871
|
-
#
|
846
|
+
# @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
|
847
|
+
# @param amount [String] The total amount for this sub line item.
|
848
|
+
#
|
849
|
+
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping, nil]
|
850
|
+
#
|
851
|
+
# @param name [String]
|
852
|
+
#
|
853
|
+
# @param quantity [Float]
|
854
|
+
#
|
855
|
+
# @param type [Symbol, :"'null'"]
|
872
856
|
|
873
857
|
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem#grouping
|
874
858
|
class Grouping < Orb::Internal::Type::BaseModel
|
@@ -883,19 +867,15 @@ module Orb
|
|
883
867
|
# @return [String, nil]
|
884
868
|
required :value, String, nil?: true
|
885
869
|
|
886
|
-
# @!
|
887
|
-
#
|
888
|
-
#
|
889
|
-
#
|
890
|
-
# def initialize(key:, value:, **) = super
|
891
|
-
|
892
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
870
|
+
# @!method initialize(key:, value:)
|
871
|
+
# @param key [String]
|
872
|
+
#
|
873
|
+
# @param value [String, nil] No value indicates the default group
|
893
874
|
end
|
894
875
|
end
|
895
876
|
|
896
|
-
# @!
|
897
|
-
#
|
898
|
-
# def self.variants; end
|
877
|
+
# @!method self.variants
|
878
|
+
# @return [Array(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem)]
|
899
879
|
end
|
900
880
|
|
901
881
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
@@ -917,14 +897,12 @@ module Orb
|
|
917
897
|
# @return [String, nil]
|
918
898
|
required :tax_rate_percentage, String, nil?: true
|
919
899
|
|
920
|
-
# @!
|
921
|
-
#
|
922
|
-
#
|
923
|
-
#
|
924
|
-
#
|
925
|
-
#
|
926
|
-
|
927
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
900
|
+
# @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
|
901
|
+
# @param amount [String] The amount of additional tax incurred by this tax rate.
|
902
|
+
#
|
903
|
+
# @param tax_rate_description [String] The human-readable description of the applied tax rate.
|
904
|
+
#
|
905
|
+
# @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
|
928
906
|
end
|
929
907
|
end
|
930
908
|
end
|