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
@@ -88,8 +88,8 @@ module Orb
|
|
88
88
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
89
89
|
# information on what this timezone parameter influences within Orb.
|
90
90
|
#
|
91
|
-
# @return [Orb::
|
92
|
-
required :customer, -> { Orb::
|
91
|
+
# @return [Orb::Customer]
|
92
|
+
required :customer, -> { Orb::Customer }
|
93
93
|
|
94
94
|
# @!attribute default_invoice_memo
|
95
95
|
# Determines the default memo on this subscriptions' invoices. Note that if this
|
@@ -101,7 +101,7 @@ module Orb
|
|
101
101
|
# @!attribute discount_intervals
|
102
102
|
# The discount intervals for this subscription sorted by the start_date.
|
103
103
|
#
|
104
|
-
# @return [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
104
|
+
# @return [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage>]
|
105
105
|
required :discount_intervals,
|
106
106
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval] }
|
107
107
|
|
@@ -168,8 +168,8 @@ module Orb
|
|
168
168
|
# subscription. You can see more about how to configure prices in the
|
169
169
|
# [Price resource](/reference/price).
|
170
170
|
#
|
171
|
-
# @return [Orb::
|
172
|
-
required :plan, -> { Orb::
|
171
|
+
# @return [Orb::Plan]
|
172
|
+
required :plan, -> { Orb::Plan }
|
173
173
|
|
174
174
|
# @!attribute price_intervals
|
175
175
|
# The price intervals for this subscription.
|
@@ -216,34 +216,26 @@ module Orb
|
|
216
216
|
# @param id [String]
|
217
217
|
#
|
218
218
|
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
219
|
-
# ...
|
220
219
|
#
|
221
220
|
# @param adjustment_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
222
|
-
# ...
|
223
221
|
#
|
224
222
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
225
|
-
# ...
|
226
223
|
#
|
227
224
|
# @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUpdateTrialResponse::BillingCycleAnchorConfiguration]
|
228
225
|
#
|
229
226
|
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
230
|
-
# ...
|
231
227
|
#
|
232
228
|
# @param created_at [Time]
|
233
229
|
#
|
234
230
|
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
235
|
-
# ...
|
236
231
|
#
|
237
232
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
238
|
-
# ...
|
239
233
|
#
|
240
|
-
# @param customer [Orb::
|
241
|
-
# ...
|
234
|
+
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
242
235
|
#
|
243
236
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
244
|
-
# ...
|
245
237
|
#
|
246
|
-
# @param discount_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
238
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
247
239
|
#
|
248
240
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
249
241
|
#
|
@@ -254,17 +246,14 @@ module Orb
|
|
254
246
|
# @param maximum_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
255
247
|
#
|
256
248
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
257
|
-
# ...
|
258
249
|
#
|
259
250
|
# @param minimum_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
260
251
|
#
|
261
252
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
262
|
-
# ...
|
263
253
|
#
|
264
254
|
# @param pending_subscription_change [Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
265
255
|
#
|
266
|
-
# @param plan [Orb::
|
267
|
-
# ...
|
256
|
+
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
268
257
|
#
|
269
258
|
# @param price_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval>] The price intervals for this subscription.
|
270
259
|
#
|
@@ -277,7 +266,6 @@ module Orb
|
|
277
266
|
# @param trial_info [Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo]
|
278
267
|
#
|
279
268
|
# @param changed_resources [Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
|
280
|
-
# ...
|
281
269
|
|
282
270
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
283
271
|
# @!attribute id
|
@@ -287,7 +275,7 @@ module Orb
|
|
287
275
|
|
288
276
|
# @!attribute adjustment
|
289
277
|
#
|
290
|
-
# @return [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
278
|
+
# @return [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum]
|
291
279
|
required :adjustment,
|
292
280
|
union: -> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment }
|
293
281
|
|
@@ -312,7 +300,7 @@ module Orb
|
|
312
300
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
313
301
|
# @param id [String]
|
314
302
|
#
|
315
|
-
# @param adjustment [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
303
|
+
# @param adjustment [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum]
|
316
304
|
#
|
317
305
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
318
306
|
#
|
@@ -327,21 +315,21 @@ module Orb
|
|
327
315
|
discriminator :adjustment_type
|
328
316
|
|
329
317
|
variant :usage_discount,
|
330
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
318
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount }
|
331
319
|
|
332
320
|
variant :amount_discount,
|
333
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
321
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount }
|
334
322
|
|
335
323
|
variant :percentage_discount,
|
336
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
324
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
|
337
325
|
|
338
326
|
variant :minimum,
|
339
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
327
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum }
|
340
328
|
|
341
329
|
variant :maximum,
|
342
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
330
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum }
|
343
331
|
|
344
|
-
class
|
332
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
345
333
|
# @!attribute id
|
346
334
|
#
|
347
335
|
# @return [String]
|
@@ -386,7 +374,7 @@ module Orb
|
|
386
374
|
|
387
375
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
388
376
|
# Some parameter documentations has been truncated, see
|
389
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
377
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
390
378
|
# for more details.
|
391
379
|
#
|
392
380
|
# @param id [String]
|
@@ -394,19 +382,17 @@ module Orb
|
|
394
382
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
395
383
|
#
|
396
384
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
397
|
-
# ...
|
398
385
|
#
|
399
386
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
400
387
|
#
|
401
388
|
# @param reason [String, nil] The reason for the adjustment.
|
402
389
|
#
|
403
390
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
404
|
-
# ...
|
405
391
|
#
|
406
392
|
# @param adjustment_type [Symbol, :usage_discount]
|
407
393
|
end
|
408
394
|
|
409
|
-
class
|
395
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
410
396
|
# @!attribute id
|
411
397
|
#
|
412
398
|
# @return [String]
|
@@ -451,18 +437,16 @@ module Orb
|
|
451
437
|
|
452
438
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
453
439
|
# Some parameter documentations has been truncated, see
|
454
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
440
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
455
441
|
# for more details.
|
456
442
|
#
|
457
443
|
# @param id [String]
|
458
444
|
#
|
459
445
|
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
460
|
-
# ...
|
461
446
|
#
|
462
447
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
463
448
|
#
|
464
449
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
465
|
-
# ...
|
466
450
|
#
|
467
451
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
468
452
|
#
|
@@ -471,7 +455,7 @@ module Orb
|
|
471
455
|
# @param adjustment_type [Symbol, :amount_discount]
|
472
456
|
end
|
473
457
|
|
474
|
-
class
|
458
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
475
459
|
# @!attribute id
|
476
460
|
#
|
477
461
|
# @return [String]
|
@@ -516,7 +500,7 @@ module Orb
|
|
516
500
|
|
517
501
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
518
502
|
# Some parameter documentations has been truncated, see
|
519
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
503
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
520
504
|
# for more details.
|
521
505
|
#
|
522
506
|
# @param id [String]
|
@@ -524,10 +508,8 @@ module Orb
|
|
524
508
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
525
509
|
#
|
526
510
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
527
|
-
# ...
|
528
511
|
#
|
529
512
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
530
|
-
# ...
|
531
513
|
#
|
532
514
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
533
515
|
#
|
@@ -536,7 +518,7 @@ module Orb
|
|
536
518
|
# @param adjustment_type [Symbol, :percentage_discount]
|
537
519
|
end
|
538
520
|
|
539
|
-
class
|
521
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
540
522
|
# @!attribute id
|
541
523
|
#
|
542
524
|
# @return [String]
|
@@ -587,7 +569,7 @@ module Orb
|
|
587
569
|
|
588
570
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
589
571
|
# Some parameter documentations has been truncated, see
|
590
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
572
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum}
|
591
573
|
# for more details.
|
592
574
|
#
|
593
575
|
# @param id [String]
|
@@ -595,12 +577,10 @@ module Orb
|
|
595
577
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
596
578
|
#
|
597
579
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
598
|
-
# ...
|
599
580
|
#
|
600
581
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
601
582
|
#
|
602
583
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
603
|
-
# ...
|
604
584
|
#
|
605
585
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
606
586
|
#
|
@@ -609,7 +589,7 @@ module Orb
|
|
609
589
|
# @param adjustment_type [Symbol, :minimum]
|
610
590
|
end
|
611
591
|
|
612
|
-
class
|
592
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
613
593
|
# @!attribute id
|
614
594
|
#
|
615
595
|
# @return [String]
|
@@ -654,7 +634,7 @@ module Orb
|
|
654
634
|
|
655
635
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
656
636
|
# Some parameter documentations has been truncated, see
|
657
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
637
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum}
|
658
638
|
# for more details.
|
659
639
|
#
|
660
640
|
# @param id [String]
|
@@ -662,10 +642,8 @@ module Orb
|
|
662
642
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
663
643
|
#
|
664
644
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
665
|
-
# ...
|
666
645
|
#
|
667
646
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
668
|
-
# ...
|
669
647
|
#
|
670
648
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
671
649
|
#
|
@@ -675,7 +653,7 @@ module Orb
|
|
675
653
|
end
|
676
654
|
|
677
655
|
# @!method self.variants
|
678
|
-
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
656
|
+
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum)]
|
679
657
|
end
|
680
658
|
end
|
681
659
|
|
@@ -711,13 +689,10 @@ module Orb
|
|
711
689
|
# for more details.
|
712
690
|
#
|
713
691
|
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
714
|
-
# ...
|
715
692
|
#
|
716
693
|
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
717
|
-
# ...
|
718
694
|
#
|
719
695
|
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
720
|
-
# ...
|
721
696
|
end
|
722
697
|
|
723
698
|
module DiscountInterval
|
@@ -725,16 +700,13 @@ module Orb
|
|
725
700
|
|
726
701
|
discriminator :discount_type
|
727
702
|
|
728
|
-
variant :amount,
|
729
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval }
|
703
|
+
variant :amount, -> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount }
|
730
704
|
|
731
|
-
variant :percentage,
|
732
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval }
|
705
|
+
variant :percentage, -> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage }
|
733
706
|
|
734
|
-
variant :usage,
|
735
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval }
|
707
|
+
variant :usage, -> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage }
|
736
708
|
|
737
|
-
class
|
709
|
+
class Amount < Orb::Internal::Type::BaseModel
|
738
710
|
# @!attribute amount_discount
|
739
711
|
# Only available if discount_type is `amount`.
|
740
712
|
#
|
@@ -784,7 +756,7 @@ module Orb
|
|
784
756
|
# @param discount_type [Symbol, :amount]
|
785
757
|
end
|
786
758
|
|
787
|
-
class
|
759
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
788
760
|
# @!attribute applies_to_price_ids
|
789
761
|
# The price ids that this discount interval applies to.
|
790
762
|
#
|
@@ -823,8 +795,8 @@ module Orb
|
|
823
795
|
|
824
796
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
825
797
|
# Some parameter documentations has been truncated, see
|
826
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
827
|
-
#
|
798
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage} for
|
799
|
+
# more details.
|
828
800
|
#
|
829
801
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
830
802
|
#
|
@@ -833,14 +805,13 @@ module Orb
|
|
833
805
|
# @param end_date [Time, nil] The end date of the discount interval.
|
834
806
|
#
|
835
807
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
836
|
-
# ...
|
837
808
|
#
|
838
809
|
# @param start_date [Time] The start date of the discount interval.
|
839
810
|
#
|
840
811
|
# @param discount_type [Symbol, :percentage]
|
841
812
|
end
|
842
813
|
|
843
|
-
class
|
814
|
+
class Usage < Orb::Internal::Type::BaseModel
|
844
815
|
# @!attribute applies_to_price_ids
|
845
816
|
# The price ids that this discount interval applies to.
|
846
817
|
#
|
@@ -879,8 +850,8 @@ module Orb
|
|
879
850
|
|
880
851
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
881
852
|
# Some parameter documentations has been truncated, see
|
882
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
883
|
-
#
|
853
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage} for more
|
854
|
+
# details.
|
884
855
|
#
|
885
856
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
886
857
|
#
|
@@ -891,13 +862,12 @@ module Orb
|
|
891
862
|
# @param start_date [Time] The start date of the discount interval.
|
892
863
|
#
|
893
864
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
894
|
-
# ...
|
895
865
|
#
|
896
866
|
# @param discount_type [Symbol, :usage]
|
897
867
|
end
|
898
868
|
|
899
869
|
# @!method self.variants
|
900
|
-
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
870
|
+
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage)]
|
901
871
|
end
|
902
872
|
|
903
873
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -972,7 +942,6 @@ module Orb
|
|
972
942
|
# @param end_date [Time, nil] The end date of the maximum interval.
|
973
943
|
#
|
974
944
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
975
|
-
# ...
|
976
945
|
#
|
977
946
|
# @param start_date [Time] The start date of the maximum interval.
|
978
947
|
end
|
@@ -1021,7 +990,6 @@ module Orb
|
|
1021
990
|
# @param end_date [Time, nil] The end date of the minimum interval.
|
1022
991
|
#
|
1023
992
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1024
|
-
# ...
|
1025
993
|
#
|
1026
994
|
# @param start_date [Time] The start date of the minimum interval.
|
1027
995
|
end
|
@@ -1101,8 +1069,8 @@ module Orb
|
|
1101
1069
|
# For more on the types of prices, see
|
1102
1070
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1103
1071
|
#
|
1104
|
-
# @return [Orb::
|
1105
|
-
required :price, union: -> { Orb::
|
1072
|
+
# @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]
|
1073
|
+
required :price, union: -> { Orb::Price }
|
1106
1074
|
|
1107
1075
|
# @!attribute start_date
|
1108
1076
|
# The start date of the price interval. This is the date that Orb starts billing
|
@@ -1131,27 +1099,20 @@ module Orb
|
|
1131
1099
|
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1132
1100
|
#
|
1133
1101
|
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1134
|
-
# ...
|
1135
1102
|
#
|
1136
1103
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1137
|
-
# ...
|
1138
1104
|
#
|
1139
1105
|
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1140
|
-
# ...
|
1141
1106
|
#
|
1142
1107
|
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1143
1108
|
#
|
1144
1109
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1145
|
-
# ...
|
1146
1110
|
#
|
1147
|
-
# @param price [Orb::
|
1148
|
-
# ...
|
1111
|
+
# @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] The Price resource represents a price that can be billed on a subscription, resu
|
1149
1112
|
#
|
1150
1113
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1151
|
-
# ...
|
1152
1114
|
#
|
1153
1115
|
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1154
|
-
# ...
|
1155
1116
|
|
1156
1117
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1157
1118
|
# @!attribute effective_date
|
@@ -1227,39 +1188,39 @@ module Orb
|
|
1227
1188
|
# @!attribute created_credit_notes
|
1228
1189
|
# The credit notes that were created as part of this operation.
|
1229
1190
|
#
|
1230
|
-
# @return [Array<Orb::
|
1231
|
-
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1191
|
+
# @return [Array<Orb::CreditNote>]
|
1192
|
+
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1232
1193
|
|
1233
1194
|
# @!attribute created_invoices
|
1234
1195
|
# The invoices that were created as part of this operation.
|
1235
1196
|
#
|
1236
|
-
# @return [Array<Orb::
|
1237
|
-
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1197
|
+
# @return [Array<Orb::Invoice>]
|
1198
|
+
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1238
1199
|
|
1239
1200
|
# @!attribute voided_credit_notes
|
1240
1201
|
# The credit notes that were voided as part of this operation.
|
1241
1202
|
#
|
1242
|
-
# @return [Array<Orb::
|
1243
|
-
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1203
|
+
# @return [Array<Orb::CreditNote>]
|
1204
|
+
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1244
1205
|
|
1245
1206
|
# @!attribute voided_invoices
|
1246
1207
|
# The invoices that were voided as part of this operation.
|
1247
1208
|
#
|
1248
|
-
# @return [Array<Orb::
|
1249
|
-
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1209
|
+
# @return [Array<Orb::Invoice>]
|
1210
|
+
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1250
1211
|
|
1251
1212
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
1252
1213
|
# The resources that were changed as part of this operation. Only present when
|
1253
1214
|
# fetched through the subscription changes API or if the
|
1254
1215
|
# `include_changed_resources` parameter was passed in the request.
|
1255
1216
|
#
|
1256
|
-
# @param created_credit_notes [Array<Orb::
|
1217
|
+
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1257
1218
|
#
|
1258
|
-
# @param created_invoices [Array<Orb::
|
1219
|
+
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1259
1220
|
#
|
1260
|
-
# @param voided_credit_notes [Array<Orb::
|
1221
|
+
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1261
1222
|
#
|
1262
|
-
# @param voided_invoices [Array<Orb::
|
1223
|
+
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1263
1224
|
end
|
1264
1225
|
end
|
1265
1226
|
end
|