orb-billing 0.3.0 → 0.3.2
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 +47 -0
- data/README.md +7 -7
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/page.rb +3 -3
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/type/base_model.rb +1 -9
- data/lib/orb/internal/type/boolean.rb +10 -11
- data/lib/orb/internal/type/enum.rb +13 -14
- data/lib/orb/internal/type/request_parameters.rb +6 -12
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +21 -5
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +8 -10
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +43 -55
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +43 -57
- data/lib/orb/models/customer_update_params.rb +43 -53
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -114
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -126
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -121
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -131
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +165 -224
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +58 -107
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +58 -81
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +83 -111
- data/lib/orb/models/plan_create_params.rb +753 -861
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1699 -1804
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +94 -136
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +52 -91
- data/lib/orb/models/subscription_change_apply_response.rb +50 -88
- data/lib/orb/models/subscription_change_cancel_response.rb +50 -87
- data/lib/orb/models/subscription_change_retrieve_response.rb +50 -87
- data/lib/orb/models/subscription_create_params.rb +1927 -1928
- data/lib/orb/models/subscription_create_response.rb +52 -91
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1141 -1079
- data/lib/orb/models/subscription_price_intervals_response.rb +51 -90
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1966 -1906
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +50 -88
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +51 -90
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +50 -88
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +50 -86
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +50 -86
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +50 -88
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +52 -91
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -5
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +18 -37
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/{lib/orb → orb}/client.rbi +5 -4
- data/rbi/{lib/orb → orb}/errors.rbi +58 -27
- data/rbi/{lib/orb → orb}/file_part.rbi +9 -6
- data/rbi/{lib/orb → orb}/internal/page.rbi +19 -6
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +131 -73
- data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +98 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +124 -65
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +11 -7
- data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +16 -10
- data/rbi/{lib/orb → orb}/internal/type/converter.rbi +66 -31
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +27 -15
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +12 -10
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +29 -0
- data/rbi/orb/internal/type/union.rbi +110 -0
- data/rbi/orb/internal/type/unknown.rbi +50 -0
- data/rbi/orb/internal/util.rbi +424 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +107 -70
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +25 -14
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +28 -19
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +74 -40
- data/rbi/orb/models/coupon_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +117 -0
- data/rbi/orb/models/credit_note_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/customer.rbi +430 -329
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +664 -327
- data/rbi/orb/models/customer_delete_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +24 -0
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +1138 -338
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +663 -326
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +94 -0
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +263 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +254 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +110 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +44 -21
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_params.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi} +118 -60
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +685 -468
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi → orb/models/customers/credits/ledger_create_entry_params.rbi} +107 -69
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +643 -470
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +658 -469
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_response.rbi +708 -459
- data/rbi/{lib/orb/models/customers/credits/top_up_create_params.rbi → orb/models/customers/credits/top_up_create_by_external_id_params.rbi} +87 -46
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/{lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi → orb/models/customers/credits/top_up_create_params.rbi} +73 -54
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +36 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +24 -0
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +26 -0
- data/rbi/orb/models/dimensional_price_groups.rbi +38 -0
- data/rbi/orb/models/discount.rbi +23 -0
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +8 -3
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +37 -31
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +63 -23
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +17 -14
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +33 -21
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +21 -18
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +34 -12
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/invoice.rbi +1294 -831
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +24 -0
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +32 -0
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +2003 -885
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +22 -0
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +594 -421
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +67 -47
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +24 -0
- data/rbi/orb/models/item.rbi +143 -0
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +141 -0
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +31 -0
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +32 -19
- data/rbi/{lib/orb → orb}/models/plan.rbi +501 -370
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +4243 -3094
- data/rbi/orb/models/plan_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +34 -27
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +19414 -0
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +501 -245
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +24 -0
- data/rbi/orb/models/price_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/{lib/orb → orb}/models/subscription.rbi +586 -428
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +44 -22
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +808 -528
- data/rbi/orb/models/subscription_change_cancel_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +807 -538
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +806 -548
- data/rbi/{lib/orb/models/subscription_schedule_plan_change_params.rbi → orb/models/subscription_create_params.rbi} +8466 -7080
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +252 -0
- data/rbi/orb/models/subscription_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +39 -28
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +4973 -3944
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +744 -477
- data/rbi/{lib/orb/models/subscription_create_params.rbi → orb/models/subscription_schedule_plan_change_params.rbi} +8649 -7019
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +742 -491
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +736 -472
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +717 -526
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +732 -521
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +104 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +736 -471
- data/rbi/orb/models/subscription_usage.rbi +446 -0
- data/rbi/orb/models/subscriptions.rbi +38 -0
- data/rbi/orb/models/top_level_ping_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +7 -3
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +29 -20
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +231 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +12 -4
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +57 -42
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +25 -22
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +18 -15
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +18 -11
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +53 -29
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +16 -7
- data/rbi/{lib/orb → orb}/resources/customers.rbi +117 -82
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +6 -5
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +21 -14
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +25 -20
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/events.rbi +22 -18
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +55 -49
- data/rbi/{lib/orb → orb}/resources/items.rbi +31 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +21 -17
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +11 -9
- data/rbi/{lib/orb → orb}/resources/plans.rbi +53 -49
- data/rbi/orb/resources/prices/external_price_id.rbi +108 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +170 -157
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +15 -13
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +188 -118
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +7 -4
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/util.rbs +2 -0
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +7 -14
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +36 -57
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +36 -57
- data/sig/orb/models/customer_update_params.rbs +36 -57
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +92 -134
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +126 -188
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +41 -103
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +41 -75
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +55 -83
- data/sig/orb/models/plan_create_params.rbs +568 -746
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1250 -1790
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +72 -110
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +44 -84
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +44 -86
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +44 -86
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +44 -86
- data/sig/orb/models/subscription_create_params.rbs +1223 -1619
- data/sig/orb/models/subscription_create_response.rbs +44 -84
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +738 -970
- data/sig/orb/models/subscription_price_intervals_response.rbs +44 -84
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1223 -1619
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +44 -84
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +44 -84
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +44 -84
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +44 -84
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/models.rbs +215 -0
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +226 -223
- data/rbi/lib/orb/internal/type/array_of.rbi +0 -90
- data/rbi/lib/orb/internal/type/request_parameters.rbi +0 -21
- data/rbi/lib/orb/internal/type/union.rbi +0 -75
- data/rbi/lib/orb/internal/type/unknown.rbi +0 -42
- data/rbi/lib/orb/internal/util.rbi +0 -299
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +0 -18
- data/rbi/lib/orb/models/coupon_archive_params.rbi +0 -18
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/credit_note_create_params.rbi +0 -88
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_delete_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -18
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +0 -65
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +0 -196
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -225
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -223
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +0 -84
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -166
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +0 -141
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +0 -26
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -25
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +0 -33
- data/rbi/lib/orb/models/discount.rbi +0 -17
- data/rbi/lib/orb/models/event_deprecate_params.rbi +0 -18
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +0 -25
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +0 -22
- data/rbi/lib/orb/models/invoice_level_discount.rbi +0 -15
- data/rbi/lib/orb/models/invoice_pay_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_void_params.rbi +0 -18
- data/rbi/lib/orb/models/item.rbi +0 -95
- data/rbi/lib/orb/models/item_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/item_update_params.rbi +0 -101
- data/rbi/lib/orb/models/metric_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/pagination_metadata.rbi +0 -19
- data/rbi/lib/orb/models/plan_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/price.rbi +0 -14861
- data/rbi/lib/orb/models/price_evaluate_response.rbi +0 -19
- data/rbi/lib/orb/models/price_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -221
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +0 -66
- data/rbi/lib/orb/models/subscription_usage.rbi +0 -296
- data/rbi/lib/orb/models/subscriptions.rbi +0 -31
- data/rbi/lib/orb/models/top_level_ping_params.rbi +0 -18
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -178,8 +178,8 @@ module Orb
|
|
178
178
|
|
179
179
|
# @!attribute discounts
|
180
180
|
#
|
181
|
-
# @return [Array<Orb::
|
182
|
-
required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::
|
181
|
+
# @return [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
|
182
|
+
required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::InvoiceLevelDiscount] }
|
183
183
|
|
184
184
|
# @!attribute due_date
|
185
185
|
# When the invoice payment is due. The due date is null if the invoice is not yet
|
@@ -376,7 +376,6 @@ module Orb
|
|
376
376
|
# @param id [String]
|
377
377
|
#
|
378
378
|
# @param amount_due [String] This is the final amount required to be charged to the customer and reflects the
|
379
|
-
# ...
|
380
379
|
#
|
381
380
|
# @param auto_collection [Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection]
|
382
381
|
#
|
@@ -393,34 +392,26 @@ module Orb
|
|
393
392
|
# @param customer_balance_transactions [Array<Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction>]
|
394
393
|
#
|
395
394
|
# @param customer_tax_id [Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
396
|
-
# ...
|
397
395
|
#
|
398
396
|
# @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
|
399
|
-
# ...
|
400
397
|
#
|
401
|
-
# @param discounts [Array<Orb::
|
398
|
+
# @param discounts [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
|
402
399
|
#
|
403
400
|
# @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
|
404
|
-
# ...
|
405
401
|
#
|
406
402
|
# @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
|
407
|
-
# ...
|
408
403
|
#
|
409
404
|
# @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 30 days after the
|
410
|
-
# ...
|
411
405
|
#
|
412
406
|
# @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv
|
413
|
-
# ...
|
414
407
|
#
|
415
408
|
# @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`.
|
416
409
|
#
|
417
410
|
# @param invoice_source [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource]
|
418
411
|
#
|
419
412
|
# @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e
|
420
|
-
# ...
|
421
413
|
#
|
422
414
|
# @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued
|
423
|
-
# ...
|
424
415
|
#
|
425
416
|
# @param line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem>] The breakdown of prices in this invoice.
|
426
417
|
#
|
@@ -429,28 +420,22 @@ module Orb
|
|
429
420
|
# @param maximum_amount [String, nil]
|
430
421
|
#
|
431
422
|
# @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
432
|
-
# ...
|
433
423
|
#
|
434
424
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
435
|
-
# ...
|
436
425
|
#
|
437
426
|
# @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::Minimum, nil]
|
438
427
|
#
|
439
428
|
# @param minimum_amount [String, nil]
|
440
429
|
#
|
441
430
|
# @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w
|
442
|
-
# ...
|
443
431
|
#
|
444
432
|
# @param payment_attempts [Array<Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt>] A list of payment attempts associated with the invoice
|
445
433
|
#
|
446
434
|
# @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
|
447
|
-
# ...
|
448
435
|
#
|
449
436
|
# @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
|
450
|
-
# ...
|
451
437
|
#
|
452
438
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
453
|
-
# ...
|
454
439
|
#
|
455
440
|
# @param shipping_address [Orb::Models::InvoiceFetchUpcomingResponse::ShippingAddress, nil]
|
456
441
|
#
|
@@ -461,17 +446,14 @@ module Orb
|
|
461
446
|
# @param subtotal [String] The total before any discounts and minimums are applied.
|
462
447
|
#
|
463
448
|
# @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing
|
464
|
-
# ...
|
465
449
|
#
|
466
450
|
# @param target_date [Time] The scheduled date of the invoice
|
467
451
|
#
|
468
452
|
# @param total [String] The total after any minimums and discounts have been applied.
|
469
453
|
#
|
470
454
|
# @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w
|
471
|
-
# ...
|
472
455
|
#
|
473
456
|
# @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals
|
474
|
-
# ...
|
475
457
|
|
476
458
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#auto_collection
|
477
459
|
class AutoCollection < Orb::Internal::Type::BaseModel
|
@@ -513,12 +495,10 @@ module Orb
|
|
513
495
|
# @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice.
|
514
496
|
#
|
515
497
|
# @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th
|
516
|
-
# ...
|
517
498
|
#
|
518
499
|
# @param num_attempts [Integer, nil] Number of auto-collection payment attempts.
|
519
500
|
#
|
520
501
|
# @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
|
521
|
-
# ...
|
522
502
|
end
|
523
503
|
|
524
504
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#billing_address
|
@@ -618,7 +598,6 @@ module Orb
|
|
618
598
|
# @param type [String]
|
619
599
|
#
|
620
600
|
# @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
|
621
|
-
# ...
|
622
601
|
end
|
623
602
|
|
624
603
|
# @see Orb::Models::InvoiceFetchUpcomingResponse#customer
|
@@ -720,12 +699,10 @@ module Orb
|
|
720
699
|
# @param description [String, nil] An optional description provided for manual customer balance adjustments.
|
721
700
|
#
|
722
701
|
# @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
|
723
|
-
# ...
|
724
702
|
#
|
725
703
|
# @param invoice [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Invoice, nil]
|
726
704
|
#
|
727
705
|
# @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
|
728
|
-
# ...
|
729
706
|
#
|
730
707
|
# @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type]
|
731
708
|
|
@@ -1110,7 +1087,7 @@ module Orb
|
|
1110
1087
|
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
1111
1088
|
# discounts -> minimums -> maximums).
|
1112
1089
|
#
|
1113
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1090
|
+
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum>]
|
1114
1091
|
required :adjustments,
|
1115
1092
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment] }
|
1116
1093
|
|
@@ -1129,8 +1106,8 @@ module Orb
|
|
1129
1106
|
|
1130
1107
|
# @!attribute discount
|
1131
1108
|
#
|
1132
|
-
# @return [Orb::
|
1133
|
-
required :discount, union: -> { Orb::
|
1109
|
+
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
1110
|
+
required :discount, union: -> { Orb::Discount }, nil?: true
|
1134
1111
|
|
1135
1112
|
# @!attribute end_date
|
1136
1113
|
# The end date of the range of time applied for this line item's price.
|
@@ -1208,8 +1185,8 @@ module Orb
|
|
1208
1185
|
# For more on the types of prices, see
|
1209
1186
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1210
1187
|
#
|
1211
|
-
# @return [Orb::
|
1212
|
-
required :price, union: -> { Orb::
|
1188
|
+
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil]
|
1189
|
+
required :price, union: -> { Orb::Price }, nil?: true
|
1213
1190
|
|
1214
1191
|
# @!attribute quantity
|
1215
1192
|
# Either the fixed fee quantity or the usage during the service period.
|
@@ -1227,7 +1204,7 @@ module Orb
|
|
1227
1204
|
# For complex pricing structures, the line item can be broken down further in
|
1228
1205
|
# `sub_line_items`.
|
1229
1206
|
#
|
1230
|
-
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1207
|
+
# @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null>]
|
1231
1208
|
required :sub_line_items,
|
1232
1209
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem] }
|
1233
1210
|
|
@@ -1258,24 +1235,20 @@ module Orb
|
|
1258
1235
|
# @param id [String] A unique ID for this line item.
|
1259
1236
|
#
|
1260
1237
|
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
1261
|
-
# ...
|
1262
1238
|
#
|
1263
|
-
# @param adjustments [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1264
|
-
# ...
|
1239
|
+
# @param adjustments [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
|
1265
1240
|
#
|
1266
1241
|
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
1267
|
-
# ...
|
1268
1242
|
#
|
1269
1243
|
# @param credits_applied [String] The number of prepaid credits applied.
|
1270
1244
|
#
|
1271
|
-
# @param discount [Orb::
|
1245
|
+
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
1272
1246
|
#
|
1273
1247
|
# @param end_date [Time] The end date of the range of time applied for this line item's price.
|
1274
1248
|
#
|
1275
1249
|
# @param filter [String, nil] An additional filter that was used to calculate the usage for this line item.
|
1276
1250
|
#
|
1277
1251
|
# @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
|
1278
|
-
# ...
|
1279
1252
|
#
|
1280
1253
|
# @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
1281
1254
|
#
|
@@ -1289,23 +1262,19 @@ module Orb
|
|
1289
1262
|
#
|
1290
1263
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
1291
1264
|
#
|
1292
|
-
# @param price [Orb::
|
1293
|
-
# ...
|
1265
|
+
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil] The Price resource represents a price that can be billed on a subscription, resu
|
1294
1266
|
#
|
1295
1267
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
1296
1268
|
#
|
1297
1269
|
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
1298
1270
|
#
|
1299
|
-
# @param sub_line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1300
|
-
# ...
|
1271
|
+
# @param sub_line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
|
1301
1272
|
#
|
1302
1273
|
# @param subtotal [String] The line amount before before any adjustments.
|
1303
1274
|
#
|
1304
1275
|
# @param tax_amounts [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
1305
|
-
# ...
|
1306
1276
|
#
|
1307
1277
|
# @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
|
1308
|
-
# ...
|
1309
1278
|
|
1310
1279
|
module Adjustment
|
1311
1280
|
extend Orb::Internal::Type::Union
|
@@ -1313,21 +1282,19 @@ module Orb
|
|
1313
1282
|
discriminator :adjustment_type
|
1314
1283
|
|
1315
1284
|
variant :usage_discount,
|
1316
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1285
|
+
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount }
|
1317
1286
|
|
1318
1287
|
variant :amount_discount,
|
1319
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1288
|
+
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount }
|
1320
1289
|
|
1321
1290
|
variant :percentage_discount,
|
1322
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1291
|
+
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount }
|
1323
1292
|
|
1324
|
-
variant :minimum,
|
1325
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment }
|
1293
|
+
variant :minimum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum }
|
1326
1294
|
|
1327
|
-
variant :maximum,
|
1328
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment }
|
1295
|
+
variant :maximum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum }
|
1329
1296
|
|
1330
|
-
class
|
1297
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
1331
1298
|
# @!attribute id
|
1332
1299
|
#
|
1333
1300
|
# @return [String]
|
@@ -1372,7 +1339,7 @@ module Orb
|
|
1372
1339
|
|
1373
1340
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
1374
1341
|
# Some parameter documentations has been truncated, see
|
1375
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1342
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount}
|
1376
1343
|
# for more details.
|
1377
1344
|
#
|
1378
1345
|
# @param id [String]
|
@@ -1382,17 +1349,15 @@ module Orb
|
|
1382
1349
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1383
1350
|
#
|
1384
1351
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1385
|
-
# ...
|
1386
1352
|
#
|
1387
1353
|
# @param reason [String, nil] The reason for the adjustment.
|
1388
1354
|
#
|
1389
1355
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
1390
|
-
# ...
|
1391
1356
|
#
|
1392
1357
|
# @param adjustment_type [Symbol, :usage_discount]
|
1393
1358
|
end
|
1394
1359
|
|
1395
|
-
class
|
1360
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
1396
1361
|
# @!attribute id
|
1397
1362
|
#
|
1398
1363
|
# @return [String]
|
@@ -1437,7 +1402,7 @@ module Orb
|
|
1437
1402
|
|
1438
1403
|
# @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
|
1439
1404
|
# Some parameter documentations has been truncated, see
|
1440
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1405
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount}
|
1441
1406
|
# for more details.
|
1442
1407
|
#
|
1443
1408
|
# @param id [String]
|
@@ -1445,19 +1410,17 @@ module Orb
|
|
1445
1410
|
# @param amount [String] The value applied by an adjustment.
|
1446
1411
|
#
|
1447
1412
|
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
1448
|
-
# ...
|
1449
1413
|
#
|
1450
1414
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1451
1415
|
#
|
1452
1416
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1453
|
-
# ...
|
1454
1417
|
#
|
1455
1418
|
# @param reason [String, nil] The reason for the adjustment.
|
1456
1419
|
#
|
1457
1420
|
# @param adjustment_type [Symbol, :amount_discount]
|
1458
1421
|
end
|
1459
1422
|
|
1460
|
-
class
|
1423
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
1461
1424
|
# @!attribute id
|
1462
1425
|
#
|
1463
1426
|
# @return [String]
|
@@ -1502,7 +1465,7 @@ module Orb
|
|
1502
1465
|
|
1503
1466
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
|
1504
1467
|
# Some parameter documentations has been truncated, see
|
1505
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1468
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount}
|
1506
1469
|
# for more details.
|
1507
1470
|
#
|
1508
1471
|
# @param id [String]
|
@@ -1512,17 +1475,15 @@ module Orb
|
|
1512
1475
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1513
1476
|
#
|
1514
1477
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1515
|
-
# ...
|
1516
1478
|
#
|
1517
1479
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
1518
|
-
# ...
|
1519
1480
|
#
|
1520
1481
|
# @param reason [String, nil] The reason for the adjustment.
|
1521
1482
|
#
|
1522
1483
|
# @param adjustment_type [Symbol, :percentage_discount]
|
1523
1484
|
end
|
1524
1485
|
|
1525
|
-
class
|
1486
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
1526
1487
|
# @!attribute id
|
1527
1488
|
#
|
1528
1489
|
# @return [String]
|
@@ -1573,8 +1534,8 @@ module Orb
|
|
1573
1534
|
|
1574
1535
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
|
1575
1536
|
# Some parameter documentations has been truncated, see
|
1576
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1577
|
-
#
|
1537
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum} for
|
1538
|
+
# more details.
|
1578
1539
|
#
|
1579
1540
|
# @param id [String]
|
1580
1541
|
#
|
@@ -1583,19 +1544,17 @@ module Orb
|
|
1583
1544
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1584
1545
|
#
|
1585
1546
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1586
|
-
# ...
|
1587
1547
|
#
|
1588
1548
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
1589
1549
|
#
|
1590
1550
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
1591
|
-
# ...
|
1592
1551
|
#
|
1593
1552
|
# @param reason [String, nil] The reason for the adjustment.
|
1594
1553
|
#
|
1595
1554
|
# @param adjustment_type [Symbol, :minimum]
|
1596
1555
|
end
|
1597
1556
|
|
1598
|
-
class
|
1557
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
1599
1558
|
# @!attribute id
|
1600
1559
|
#
|
1601
1560
|
# @return [String]
|
@@ -1640,8 +1599,8 @@ module Orb
|
|
1640
1599
|
|
1641
1600
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
|
1642
1601
|
# Some parameter documentations has been truncated, see
|
1643
|
-
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1644
|
-
#
|
1602
|
+
# {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum} for
|
1603
|
+
# more details.
|
1645
1604
|
#
|
1646
1605
|
# @param id [String]
|
1647
1606
|
#
|
@@ -1650,10 +1609,8 @@ module Orb
|
|
1650
1609
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1651
1610
|
#
|
1652
1611
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1653
|
-
# ...
|
1654
1612
|
#
|
1655
1613
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
1656
|
-
# ...
|
1657
1614
|
#
|
1658
1615
|
# @param reason [String, nil] The reason for the adjustment.
|
1659
1616
|
#
|
@@ -1661,7 +1618,7 @@ module Orb
|
|
1661
1618
|
end
|
1662
1619
|
|
1663
1620
|
# @!method self.variants
|
1664
|
-
# @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::
|
1621
|
+
# @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum)]
|
1665
1622
|
end
|
1666
1623
|
|
1667
1624
|
# @deprecated
|
@@ -1688,7 +1645,6 @@ module Orb
|
|
1688
1645
|
# This field is deprecated in favor of `adjustments`.
|
1689
1646
|
#
|
1690
1647
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
1691
|
-
# ...
|
1692
1648
|
#
|
1693
1649
|
# @param maximum_amount [String] Maximum amount applied
|
1694
1650
|
end
|
@@ -1717,7 +1673,6 @@ module Orb
|
|
1717
1673
|
# This field is deprecated in favor of `adjustments`.
|
1718
1674
|
#
|
1719
1675
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
1720
|
-
# ...
|
1721
1676
|
#
|
1722
1677
|
# @param minimum_amount [String] Minimum amount applied
|
1723
1678
|
end
|
@@ -1727,15 +1682,13 @@ module Orb
|
|
1727
1682
|
|
1728
1683
|
discriminator :type
|
1729
1684
|
|
1730
|
-
variant :matrix,
|
1731
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem }
|
1685
|
+
variant :matrix, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix }
|
1732
1686
|
|
1733
|
-
variant :tier, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1687
|
+
variant :tier, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier }
|
1734
1688
|
|
1735
|
-
variant :"'null'",
|
1736
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem }
|
1689
|
+
variant :"'null'", -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null }
|
1737
1690
|
|
1738
|
-
class
|
1691
|
+
class Matrix < Orb::Internal::Type::BaseModel
|
1739
1692
|
# @!attribute amount
|
1740
1693
|
# The total amount for this sub line item.
|
1741
1694
|
#
|
@@ -1744,16 +1697,16 @@ module Orb
|
|
1744
1697
|
|
1745
1698
|
# @!attribute grouping
|
1746
1699
|
#
|
1747
|
-
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1700
|
+
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping, nil]
|
1748
1701
|
required :grouping,
|
1749
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1702
|
+
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping },
|
1750
1703
|
nil?: true
|
1751
1704
|
|
1752
1705
|
# @!attribute matrix_config
|
1753
1706
|
#
|
1754
|
-
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1707
|
+
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig]
|
1755
1708
|
required :matrix_config,
|
1756
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1709
|
+
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig }
|
1757
1710
|
|
1758
1711
|
# @!attribute name
|
1759
1712
|
#
|
@@ -1773,9 +1726,9 @@ module Orb
|
|
1773
1726
|
# @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
1774
1727
|
# @param amount [String] The total amount for this sub line item.
|
1775
1728
|
#
|
1776
|
-
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1729
|
+
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping, nil]
|
1777
1730
|
#
|
1778
|
-
# @param matrix_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1731
|
+
# @param matrix_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig]
|
1779
1732
|
#
|
1780
1733
|
# @param name [String]
|
1781
1734
|
#
|
@@ -1783,7 +1736,7 @@ module Orb
|
|
1783
1736
|
#
|
1784
1737
|
# @param type [Symbol, :matrix]
|
1785
1738
|
|
1786
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1739
|
+
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix#grouping
|
1787
1740
|
class Grouping < Orb::Internal::Type::BaseModel
|
1788
1741
|
# @!attribute key
|
1789
1742
|
#
|
@@ -1802,7 +1755,7 @@ module Orb
|
|
1802
1755
|
# @param value [String, nil] No value indicates the default group
|
1803
1756
|
end
|
1804
1757
|
|
1805
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1758
|
+
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix#matrix_config
|
1806
1759
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
1807
1760
|
# @!attribute dimension_values
|
1808
1761
|
# The ordered dimension values for this line item.
|
@@ -1815,7 +1768,7 @@ module Orb
|
|
1815
1768
|
end
|
1816
1769
|
end
|
1817
1770
|
|
1818
|
-
class
|
1771
|
+
class Tier < Orb::Internal::Type::BaseModel
|
1819
1772
|
# @!attribute amount
|
1820
1773
|
# The total amount for this sub line item.
|
1821
1774
|
#
|
@@ -1824,9 +1777,9 @@ module Orb
|
|
1824
1777
|
|
1825
1778
|
# @!attribute grouping
|
1826
1779
|
#
|
1827
|
-
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1780
|
+
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping, nil]
|
1828
1781
|
required :grouping,
|
1829
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1782
|
+
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping },
|
1830
1783
|
nil?: true
|
1831
1784
|
|
1832
1785
|
# @!attribute name
|
@@ -1841,9 +1794,9 @@ module Orb
|
|
1841
1794
|
|
1842
1795
|
# @!attribute tier_config
|
1843
1796
|
#
|
1844
|
-
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1797
|
+
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig]
|
1845
1798
|
required :tier_config,
|
1846
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1799
|
+
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig }
|
1847
1800
|
|
1848
1801
|
# @!attribute type
|
1849
1802
|
#
|
@@ -1853,17 +1806,17 @@ module Orb
|
|
1853
1806
|
# @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
1854
1807
|
# @param amount [String] The total amount for this sub line item.
|
1855
1808
|
#
|
1856
|
-
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1809
|
+
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping, nil]
|
1857
1810
|
#
|
1858
1811
|
# @param name [String]
|
1859
1812
|
#
|
1860
1813
|
# @param quantity [Float]
|
1861
1814
|
#
|
1862
|
-
# @param tier_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1815
|
+
# @param tier_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig]
|
1863
1816
|
#
|
1864
1817
|
# @param type [Symbol, :tier]
|
1865
1818
|
|
1866
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1819
|
+
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier#grouping
|
1867
1820
|
class Grouping < Orb::Internal::Type::BaseModel
|
1868
1821
|
# @!attribute key
|
1869
1822
|
#
|
@@ -1882,7 +1835,7 @@ module Orb
|
|
1882
1835
|
# @param value [String, nil] No value indicates the default group
|
1883
1836
|
end
|
1884
1837
|
|
1885
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1838
|
+
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier#tier_config
|
1886
1839
|
class TierConfig < Orb::Internal::Type::BaseModel
|
1887
1840
|
# @!attribute first_unit
|
1888
1841
|
#
|
@@ -1906,7 +1859,7 @@ module Orb
|
|
1906
1859
|
end
|
1907
1860
|
end
|
1908
1861
|
|
1909
|
-
class
|
1862
|
+
class Null < Orb::Internal::Type::BaseModel
|
1910
1863
|
# @!attribute amount
|
1911
1864
|
# The total amount for this sub line item.
|
1912
1865
|
#
|
@@ -1915,9 +1868,9 @@ module Orb
|
|
1915
1868
|
|
1916
1869
|
# @!attribute grouping
|
1917
1870
|
#
|
1918
|
-
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1871
|
+
# @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping, nil]
|
1919
1872
|
required :grouping,
|
1920
|
-
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1873
|
+
-> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping },
|
1921
1874
|
nil?: true
|
1922
1875
|
|
1923
1876
|
# @!attribute name
|
@@ -1938,7 +1891,7 @@ module Orb
|
|
1938
1891
|
# @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
|
1939
1892
|
# @param amount [String] The total amount for this sub line item.
|
1940
1893
|
#
|
1941
|
-
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1894
|
+
# @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping, nil]
|
1942
1895
|
#
|
1943
1896
|
# @param name [String]
|
1944
1897
|
#
|
@@ -1946,7 +1899,7 @@ module Orb
|
|
1946
1899
|
#
|
1947
1900
|
# @param type [Symbol, :"'null'"]
|
1948
1901
|
|
1949
|
-
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1902
|
+
# @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null#grouping
|
1950
1903
|
class Grouping < Orb::Internal::Type::BaseModel
|
1951
1904
|
# @!attribute key
|
1952
1905
|
#
|
@@ -1967,7 +1920,7 @@ module Orb
|
|
1967
1920
|
end
|
1968
1921
|
|
1969
1922
|
# @!method self.variants
|
1970
|
-
# @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::
|
1923
|
+
# @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null)]
|
1971
1924
|
end
|
1972
1925
|
|
1973
1926
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
@@ -2018,7 +1971,6 @@ module Orb
|
|
2018
1971
|
# {Orb::Models::InvoiceFetchUpcomingResponse::Maximum} for more details.
|
2019
1972
|
#
|
2020
1973
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
2021
|
-
# ...
|
2022
1974
|
#
|
2023
1975
|
# @param maximum_amount [String] Maximum amount applied
|
2024
1976
|
end
|
@@ -2043,7 +1995,6 @@ module Orb
|
|
2043
1995
|
# {Orb::Models::InvoiceFetchUpcomingResponse::Minimum} for more details.
|
2044
1996
|
#
|
2045
1997
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
2046
|
-
# ...
|
2047
1998
|
#
|
2048
1999
|
# @param minimum_amount [String] Minimum amount applied
|
2049
2000
|
end
|
@@ -22,7 +22,6 @@ module Orb
|
|
22
22
|
# {Orb::Models::InvoiceIssueParams} for more details.
|
23
23
|
#
|
24
24
|
# @param synchronous [Boolean] If true, the invoice will be issued synchronously. If false, the invoice will be
|
25
|
-
# ...
|
26
25
|
#
|
27
26
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
28
27
|
end
|
@@ -7,14 +7,14 @@ module Orb
|
|
7
7
|
|
8
8
|
discriminator :discount_type
|
9
9
|
|
10
|
-
variant :percentage, -> { Orb::
|
10
|
+
variant :percentage, -> { Orb::PercentageDiscount }
|
11
11
|
|
12
|
-
variant :amount, -> { Orb::
|
12
|
+
variant :amount, -> { Orb::AmountDiscount }
|
13
13
|
|
14
|
-
variant :trial, -> { Orb::
|
14
|
+
variant :trial, -> { Orb::TrialDiscount }
|
15
15
|
|
16
16
|
# @!method self.variants
|
17
|
-
# @return [Array(Orb::
|
17
|
+
# @return [Array(Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount)]
|
18
18
|
end
|
19
19
|
end
|
20
20
|
end
|
@@ -55,7 +55,6 @@ module Orb
|
|
55
55
|
# @param invoice_id [String] The id of the Invoice to add this line item.
|
56
56
|
#
|
57
57
|
# @param name [String] The item name associated with this line item. If an item with the same name exis
|
58
|
-
# ...
|
59
58
|
#
|
60
59
|
# @param quantity [Float] The number of units on the line item
|
61
60
|
#
|