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
@@ -20,9 +20,11 @@ module Orb
|
|
20
20
|
# The adjustment intervals for this subscription sorted by the start_date of the
|
21
21
|
# adjustment interval.
|
22
22
|
#
|
23
|
-
# @return [Array<Orb::
|
23
|
+
# @return [Array<Orb::Subscription::AdjustmentInterval>]
|
24
24
|
required :adjustment_intervals,
|
25
|
-
-> {
|
25
|
+
-> {
|
26
|
+
Orb::Internal::Type::ArrayOf[Orb::Subscription::AdjustmentInterval]
|
27
|
+
}
|
26
28
|
|
27
29
|
# @!attribute auto_collection
|
28
30
|
# Determines whether issued invoices for this subscription will automatically be
|
@@ -34,9 +36,8 @@ module Orb
|
|
34
36
|
|
35
37
|
# @!attribute billing_cycle_anchor_configuration
|
36
38
|
#
|
37
|
-
# @return [Orb::
|
38
|
-
required :billing_cycle_anchor_configuration,
|
39
|
-
-> { Orb::Models::Subscription::BillingCycleAnchorConfiguration }
|
39
|
+
# @return [Orb::Subscription::BillingCycleAnchorConfiguration]
|
40
|
+
required :billing_cycle_anchor_configuration, -> { Orb::Subscription::BillingCycleAnchorConfiguration }
|
40
41
|
|
41
42
|
# @!attribute billing_cycle_day
|
42
43
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
@@ -88,8 +89,8 @@ module Orb
|
|
88
89
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
89
90
|
# information on what this timezone parameter influences within Orb.
|
90
91
|
#
|
91
|
-
# @return [Orb::
|
92
|
-
required :customer, -> { Orb::
|
92
|
+
# @return [Orb::Customer]
|
93
|
+
required :customer, -> { Orb::Customer }
|
93
94
|
|
94
95
|
# @!attribute default_invoice_memo
|
95
96
|
# Determines the default memo on this subscriptions' invoices. Note that if this
|
@@ -101,9 +102,9 @@ module Orb
|
|
101
102
|
# @!attribute discount_intervals
|
102
103
|
# The discount intervals for this subscription sorted by the start_date.
|
103
104
|
#
|
104
|
-
# @return [Array<Orb::
|
105
|
+
# @return [Array<Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage>]
|
105
106
|
required :discount_intervals,
|
106
|
-
-> { Orb::Internal::Type::ArrayOf[union: Orb::
|
107
|
+
-> { Orb::Internal::Type::ArrayOf[union: Orb::Subscription::DiscountInterval] }
|
107
108
|
|
108
109
|
# @!attribute end_date
|
109
110
|
# The date Orb stops billing for this subscription.
|
@@ -113,9 +114,9 @@ module Orb
|
|
113
114
|
|
114
115
|
# @!attribute fixed_fee_quantity_schedule
|
115
116
|
#
|
116
|
-
# @return [Array<Orb::
|
117
|
+
# @return [Array<Orb::Subscription::FixedFeeQuantitySchedule>]
|
117
118
|
required :fixed_fee_quantity_schedule,
|
118
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::
|
119
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Subscription::FixedFeeQuantitySchedule] }
|
119
120
|
|
120
121
|
# @!attribute invoicing_threshold
|
121
122
|
#
|
@@ -125,9 +126,8 @@ module Orb
|
|
125
126
|
# @!attribute maximum_intervals
|
126
127
|
# The maximum intervals for this subscription sorted by the start_date.
|
127
128
|
#
|
128
|
-
# @return [Array<Orb::
|
129
|
-
required :maximum_intervals,
|
130
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::MaximumInterval] }
|
129
|
+
# @return [Array<Orb::Subscription::MaximumInterval>]
|
130
|
+
required :maximum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MaximumInterval] }
|
131
131
|
|
132
132
|
# @!attribute metadata
|
133
133
|
# User specified key-value pairs for the resource. If not present, this defaults
|
@@ -141,9 +141,8 @@ module Orb
|
|
141
141
|
# @!attribute minimum_intervals
|
142
142
|
# The minimum intervals for this subscription sorted by the start_date.
|
143
143
|
#
|
144
|
-
# @return [Array<Orb::
|
145
|
-
required :minimum_intervals,
|
146
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::MinimumInterval] }
|
144
|
+
# @return [Array<Orb::Subscription::MinimumInterval>]
|
145
|
+
required :minimum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MinimumInterval] }
|
147
146
|
|
148
147
|
# @!attribute net_terms
|
149
148
|
# Determines the difference between the invoice issue date for subscription
|
@@ -157,10 +156,8 @@ module Orb
|
|
157
156
|
# @!attribute pending_subscription_change
|
158
157
|
# A pending subscription change if one exists on this subscription.
|
159
158
|
#
|
160
|
-
# @return [Orb::
|
161
|
-
required :pending_subscription_change,
|
162
|
-
-> { Orb::Models::Subscription::PendingSubscriptionChange },
|
163
|
-
nil?: true
|
159
|
+
# @return [Orb::Subscription::PendingSubscriptionChange, nil]
|
160
|
+
required :pending_subscription_change, -> { Orb::Subscription::PendingSubscriptionChange }, nil?: true
|
164
161
|
|
165
162
|
# @!attribute plan
|
166
163
|
# The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
@@ -168,19 +165,19 @@ module Orb
|
|
168
165
|
# subscription. You can see more about how to configure prices in the
|
169
166
|
# [Price resource](/reference/price).
|
170
167
|
#
|
171
|
-
# @return [Orb::
|
172
|
-
required :plan, -> { Orb::
|
168
|
+
# @return [Orb::Plan]
|
169
|
+
required :plan, -> { Orb::Plan }
|
173
170
|
|
174
171
|
# @!attribute price_intervals
|
175
172
|
# The price intervals for this subscription.
|
176
173
|
#
|
177
|
-
# @return [Array<Orb::
|
178
|
-
required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::
|
174
|
+
# @return [Array<Orb::Subscription::PriceInterval>]
|
175
|
+
required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::PriceInterval] }
|
179
176
|
|
180
177
|
# @!attribute redeemed_coupon
|
181
178
|
#
|
182
|
-
# @return [Orb::
|
183
|
-
required :redeemed_coupon, -> { Orb::
|
179
|
+
# @return [Orb::Subscription::RedeemedCoupon, nil]
|
180
|
+
required :redeemed_coupon, -> { Orb::Subscription::RedeemedCoupon }, nil?: true
|
184
181
|
|
185
182
|
# @!attribute start_date
|
186
183
|
# The date Orb starts billing for this subscription.
|
@@ -190,17 +187,17 @@ module Orb
|
|
190
187
|
|
191
188
|
# @!attribute status
|
192
189
|
#
|
193
|
-
# @return [Symbol, Orb::
|
194
|
-
required :status, enum: -> { Orb::
|
190
|
+
# @return [Symbol, Orb::Subscription::Status]
|
191
|
+
required :status, enum: -> { Orb::Subscription::Status }
|
195
192
|
|
196
193
|
# @!attribute trial_info
|
197
194
|
#
|
198
|
-
# @return [Orb::
|
199
|
-
required :trial_info, -> { Orb::
|
195
|
+
# @return [Orb::Subscription::TrialInfo]
|
196
|
+
required :trial_info, -> { Orb::Subscription::TrialInfo }
|
200
197
|
|
201
198
|
# @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:)
|
202
|
-
# Some parameter documentations has been truncated, see
|
203
|
-
#
|
199
|
+
# Some parameter documentations has been truncated, see {Orb::Subscription} for
|
200
|
+
# more details.
|
204
201
|
#
|
205
202
|
# A [subscription](/core-concepts#subscription) represents the purchase of a plan
|
206
203
|
# by a customer.
|
@@ -225,65 +222,54 @@ module Orb
|
|
225
222
|
# @param id [String]
|
226
223
|
#
|
227
224
|
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
228
|
-
# ...
|
229
225
|
#
|
230
|
-
# @param adjustment_intervals [Array<Orb::
|
231
|
-
# ...
|
226
|
+
# @param adjustment_intervals [Array<Orb::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
232
227
|
#
|
233
228
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
234
|
-
# ...
|
235
229
|
#
|
236
|
-
# @param billing_cycle_anchor_configuration [Orb::
|
230
|
+
# @param billing_cycle_anchor_configuration [Orb::Subscription::BillingCycleAnchorConfiguration]
|
237
231
|
#
|
238
232
|
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
239
|
-
# ...
|
240
233
|
#
|
241
234
|
# @param created_at [Time]
|
242
235
|
#
|
243
236
|
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
244
|
-
# ...
|
245
237
|
#
|
246
238
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
247
|
-
# ...
|
248
239
|
#
|
249
|
-
# @param customer [Orb::
|
250
|
-
# ...
|
240
|
+
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
251
241
|
#
|
252
242
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
253
|
-
# ...
|
254
243
|
#
|
255
|
-
# @param discount_intervals [Array<Orb::
|
244
|
+
# @param discount_intervals [Array<Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
256
245
|
#
|
257
246
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
258
247
|
#
|
259
|
-
# @param fixed_fee_quantity_schedule [Array<Orb::
|
248
|
+
# @param fixed_fee_quantity_schedule [Array<Orb::Subscription::FixedFeeQuantitySchedule>]
|
260
249
|
#
|
261
250
|
# @param invoicing_threshold [String, nil]
|
262
251
|
#
|
263
|
-
# @param maximum_intervals [Array<Orb::
|
252
|
+
# @param maximum_intervals [Array<Orb::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
264
253
|
#
|
265
254
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
266
|
-
# ...
|
267
255
|
#
|
268
|
-
# @param minimum_intervals [Array<Orb::
|
256
|
+
# @param minimum_intervals [Array<Orb::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
269
257
|
#
|
270
258
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
271
|
-
# ...
|
272
259
|
#
|
273
|
-
# @param pending_subscription_change [Orb::
|
260
|
+
# @param pending_subscription_change [Orb::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
274
261
|
#
|
275
|
-
# @param plan [Orb::
|
276
|
-
# ...
|
262
|
+
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
277
263
|
#
|
278
|
-
# @param price_intervals [Array<Orb::
|
264
|
+
# @param price_intervals [Array<Orb::Subscription::PriceInterval>] The price intervals for this subscription.
|
279
265
|
#
|
280
|
-
# @param redeemed_coupon [Orb::
|
266
|
+
# @param redeemed_coupon [Orb::Subscription::RedeemedCoupon, nil]
|
281
267
|
#
|
282
268
|
# @param start_date [Time] The date Orb starts billing for this subscription.
|
283
269
|
#
|
284
|
-
# @param status [Symbol, Orb::
|
270
|
+
# @param status [Symbol, Orb::Subscription::Status]
|
285
271
|
#
|
286
|
-
# @param trial_info [Orb::
|
272
|
+
# @param trial_info [Orb::Subscription::TrialInfo]
|
287
273
|
|
288
274
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
289
275
|
# @!attribute id
|
@@ -293,8 +279,8 @@ module Orb
|
|
293
279
|
|
294
280
|
# @!attribute adjustment
|
295
281
|
#
|
296
|
-
# @return [Orb::
|
297
|
-
required :adjustment, union: -> { Orb::
|
282
|
+
# @return [Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
283
|
+
required :adjustment, union: -> { Orb::Subscription::AdjustmentInterval::Adjustment }
|
298
284
|
|
299
285
|
# @!attribute applies_to_price_interval_ids
|
300
286
|
# The price interval IDs that this adjustment applies to.
|
@@ -317,7 +303,7 @@ module Orb
|
|
317
303
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
318
304
|
# @param id [String]
|
319
305
|
#
|
320
|
-
# @param adjustment [Orb::
|
306
|
+
# @param adjustment [Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum]
|
321
307
|
#
|
322
308
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
323
309
|
#
|
@@ -325,28 +311,26 @@ module Orb
|
|
325
311
|
#
|
326
312
|
# @param start_date [Time] The start date of the adjustment interval.
|
327
313
|
|
328
|
-
# @see Orb::
|
314
|
+
# @see Orb::Subscription::AdjustmentInterval#adjustment
|
329
315
|
module Adjustment
|
330
316
|
extend Orb::Internal::Type::Union
|
331
317
|
|
332
318
|
discriminator :adjustment_type
|
333
319
|
|
334
|
-
variant :usage_discount,
|
335
|
-
-> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment }
|
320
|
+
variant :usage_discount, -> { Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount }
|
336
321
|
|
337
|
-
variant :amount_discount,
|
338
|
-
-> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment }
|
322
|
+
variant :amount_discount, -> { Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount }
|
339
323
|
|
340
324
|
variant :percentage_discount,
|
341
|
-
-> {
|
325
|
+
-> {
|
326
|
+
Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount
|
327
|
+
}
|
342
328
|
|
343
|
-
variant :minimum,
|
344
|
-
-> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment }
|
329
|
+
variant :minimum, -> { Orb::Subscription::AdjustmentInterval::Adjustment::Minimum }
|
345
330
|
|
346
|
-
variant :maximum,
|
347
|
-
-> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment }
|
331
|
+
variant :maximum, -> { Orb::Subscription::AdjustmentInterval::Adjustment::Maximum }
|
348
332
|
|
349
|
-
class
|
333
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
350
334
|
# @!attribute id
|
351
335
|
#
|
352
336
|
# @return [String]
|
@@ -391,27 +375,25 @@ module Orb
|
|
391
375
|
|
392
376
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
393
377
|
# Some parameter documentations has been truncated, see
|
394
|
-
# {Orb::
|
395
|
-
#
|
378
|
+
# {Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount} for more
|
379
|
+
# details.
|
396
380
|
#
|
397
381
|
# @param id [String]
|
398
382
|
#
|
399
383
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
400
384
|
#
|
401
385
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
402
|
-
# ...
|
403
386
|
#
|
404
387
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
405
388
|
#
|
406
389
|
# @param reason [String, nil] The reason for the adjustment.
|
407
390
|
#
|
408
391
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
409
|
-
# ...
|
410
392
|
#
|
411
393
|
# @param adjustment_type [Symbol, :usage_discount]
|
412
394
|
end
|
413
395
|
|
414
|
-
class
|
396
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
415
397
|
# @!attribute id
|
416
398
|
#
|
417
399
|
# @return [String]
|
@@ -456,18 +438,16 @@ module Orb
|
|
456
438
|
|
457
439
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
458
440
|
# Some parameter documentations has been truncated, see
|
459
|
-
# {Orb::
|
460
|
-
#
|
441
|
+
# {Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount} for more
|
442
|
+
# details.
|
461
443
|
#
|
462
444
|
# @param id [String]
|
463
445
|
#
|
464
446
|
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
465
|
-
# ...
|
466
447
|
#
|
467
448
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
468
449
|
#
|
469
450
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
470
|
-
# ...
|
471
451
|
#
|
472
452
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
473
453
|
#
|
@@ -476,7 +456,7 @@ module Orb
|
|
476
456
|
# @param adjustment_type [Symbol, :amount_discount]
|
477
457
|
end
|
478
458
|
|
479
|
-
class
|
459
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
480
460
|
# @!attribute id
|
481
461
|
#
|
482
462
|
# @return [String]
|
@@ -521,18 +501,16 @@ module Orb
|
|
521
501
|
|
522
502
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
523
503
|
# Some parameter documentations has been truncated, see
|
524
|
-
# {Orb::
|
525
|
-
#
|
504
|
+
# {Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount} for more
|
505
|
+
# details.
|
526
506
|
#
|
527
507
|
# @param id [String]
|
528
508
|
#
|
529
509
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
530
510
|
#
|
531
511
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
532
|
-
# ...
|
533
512
|
#
|
534
513
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
535
|
-
# ...
|
536
514
|
#
|
537
515
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
538
516
|
#
|
@@ -541,7 +519,7 @@ module Orb
|
|
541
519
|
# @param adjustment_type [Symbol, :percentage_discount]
|
542
520
|
end
|
543
521
|
|
544
|
-
class
|
522
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
545
523
|
# @!attribute id
|
546
524
|
#
|
547
525
|
# @return [String]
|
@@ -592,20 +570,17 @@ module Orb
|
|
592
570
|
|
593
571
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
594
572
|
# Some parameter documentations has been truncated, see
|
595
|
-
# {Orb::
|
596
|
-
# for more details.
|
573
|
+
# {Orb::Subscription::AdjustmentInterval::Adjustment::Minimum} for more details.
|
597
574
|
#
|
598
575
|
# @param id [String]
|
599
576
|
#
|
600
577
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
601
578
|
#
|
602
579
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
603
|
-
# ...
|
604
580
|
#
|
605
581
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
606
582
|
#
|
607
583
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
608
|
-
# ...
|
609
584
|
#
|
610
585
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
611
586
|
#
|
@@ -614,7 +589,7 @@ module Orb
|
|
614
589
|
# @param adjustment_type [Symbol, :minimum]
|
615
590
|
end
|
616
591
|
|
617
|
-
class
|
592
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
618
593
|
# @!attribute id
|
619
594
|
#
|
620
595
|
# @return [String]
|
@@ -659,18 +634,15 @@ module Orb
|
|
659
634
|
|
660
635
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
661
636
|
# Some parameter documentations has been truncated, see
|
662
|
-
# {Orb::
|
663
|
-
# for more details.
|
637
|
+
# {Orb::Subscription::AdjustmentInterval::Adjustment::Maximum} for more details.
|
664
638
|
#
|
665
639
|
# @param id [String]
|
666
640
|
#
|
667
641
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
668
642
|
#
|
669
643
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
670
|
-
# ...
|
671
644
|
#
|
672
645
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
673
|
-
# ...
|
674
646
|
#
|
675
647
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
676
648
|
#
|
@@ -680,11 +652,11 @@ module Orb
|
|
680
652
|
end
|
681
653
|
|
682
654
|
# @!method self.variants
|
683
|
-
# @return [Array(Orb::
|
655
|
+
# @return [Array(Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum)]
|
684
656
|
end
|
685
657
|
end
|
686
658
|
|
687
|
-
# @see Orb::
|
659
|
+
# @see Orb::Subscription#billing_cycle_anchor_configuration
|
688
660
|
class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
|
689
661
|
# @!attribute day
|
690
662
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
@@ -712,16 +684,13 @@ module Orb
|
|
712
684
|
|
713
685
|
# @!method initialize(day:, month: nil, year: nil)
|
714
686
|
# Some parameter documentations has been truncated, see
|
715
|
-
# {Orb::
|
687
|
+
# {Orb::Subscription::BillingCycleAnchorConfiguration} for more details.
|
716
688
|
#
|
717
689
|
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
718
|
-
# ...
|
719
690
|
#
|
720
691
|
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
721
|
-
# ...
|
722
692
|
#
|
723
693
|
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
724
|
-
# ...
|
725
694
|
end
|
726
695
|
|
727
696
|
module DiscountInterval
|
@@ -729,13 +698,13 @@ module Orb
|
|
729
698
|
|
730
699
|
discriminator :discount_type
|
731
700
|
|
732
|
-
variant :amount, -> { Orb::
|
701
|
+
variant :amount, -> { Orb::Subscription::DiscountInterval::Amount }
|
733
702
|
|
734
|
-
variant :percentage, -> { Orb::
|
703
|
+
variant :percentage, -> { Orb::Subscription::DiscountInterval::Percentage }
|
735
704
|
|
736
|
-
variant :usage, -> { Orb::
|
705
|
+
variant :usage, -> { Orb::Subscription::DiscountInterval::Usage }
|
737
706
|
|
738
|
-
class
|
707
|
+
class Amount < Orb::Internal::Type::BaseModel
|
739
708
|
# @!attribute amount_discount
|
740
709
|
# Only available if discount_type is `amount`.
|
741
710
|
#
|
@@ -785,7 +754,7 @@ module Orb
|
|
785
754
|
# @param discount_type [Symbol, :amount]
|
786
755
|
end
|
787
756
|
|
788
|
-
class
|
757
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
789
758
|
# @!attribute applies_to_price_ids
|
790
759
|
# The price ids that this discount interval applies to.
|
791
760
|
#
|
@@ -824,8 +793,7 @@ module Orb
|
|
824
793
|
|
825
794
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
826
795
|
# Some parameter documentations has been truncated, see
|
827
|
-
# {Orb::
|
828
|
-
# more details.
|
796
|
+
# {Orb::Subscription::DiscountInterval::Percentage} for more details.
|
829
797
|
#
|
830
798
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
831
799
|
#
|
@@ -834,14 +802,13 @@ module Orb
|
|
834
802
|
# @param end_date [Time, nil] The end date of the discount interval.
|
835
803
|
#
|
836
804
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
837
|
-
# ...
|
838
805
|
#
|
839
806
|
# @param start_date [Time] The start date of the discount interval.
|
840
807
|
#
|
841
808
|
# @param discount_type [Symbol, :percentage]
|
842
809
|
end
|
843
810
|
|
844
|
-
class
|
811
|
+
class Usage < Orb::Internal::Type::BaseModel
|
845
812
|
# @!attribute applies_to_price_ids
|
846
813
|
# The price ids that this discount interval applies to.
|
847
814
|
#
|
@@ -880,8 +847,7 @@ module Orb
|
|
880
847
|
|
881
848
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
882
849
|
# Some parameter documentations has been truncated, see
|
883
|
-
# {Orb::
|
884
|
-
# details.
|
850
|
+
# {Orb::Subscription::DiscountInterval::Usage} for more details.
|
885
851
|
#
|
886
852
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
887
853
|
#
|
@@ -892,13 +858,12 @@ module Orb
|
|
892
858
|
# @param start_date [Time] The start date of the discount interval.
|
893
859
|
#
|
894
860
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
895
|
-
# ...
|
896
861
|
#
|
897
862
|
# @param discount_type [Symbol, :usage]
|
898
863
|
end
|
899
864
|
|
900
865
|
# @!method self.variants
|
901
|
-
# @return [Array(Orb::
|
866
|
+
# @return [Array(Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage)]
|
902
867
|
end
|
903
868
|
|
904
869
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -963,7 +928,7 @@ module Orb
|
|
963
928
|
|
964
929
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
|
965
930
|
# Some parameter documentations has been truncated, see
|
966
|
-
# {Orb::
|
931
|
+
# {Orb::Subscription::MaximumInterval} for more details.
|
967
932
|
#
|
968
933
|
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
969
934
|
#
|
@@ -972,7 +937,6 @@ module Orb
|
|
972
937
|
# @param end_date [Time, nil] The end date of the maximum interval.
|
973
938
|
#
|
974
939
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
975
|
-
# ...
|
976
940
|
#
|
977
941
|
# @param start_date [Time] The start date of the maximum interval.
|
978
942
|
end
|
@@ -1011,7 +975,7 @@ module Orb
|
|
1011
975
|
|
1012
976
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
|
1013
977
|
# Some parameter documentations has been truncated, see
|
1014
|
-
# {Orb::
|
978
|
+
# {Orb::Subscription::MinimumInterval} for more details.
|
1015
979
|
#
|
1016
980
|
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
1017
981
|
#
|
@@ -1020,12 +984,11 @@ module Orb
|
|
1020
984
|
# @param end_date [Time, nil] The end date of the minimum interval.
|
1021
985
|
#
|
1022
986
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1023
|
-
# ...
|
1024
987
|
#
|
1025
988
|
# @param start_date [Time] The start date of the minimum interval.
|
1026
989
|
end
|
1027
990
|
|
1028
|
-
# @see Orb::
|
991
|
+
# @see Orb::Subscription#pending_subscription_change
|
1029
992
|
class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
|
1030
993
|
# @!attribute id
|
1031
994
|
#
|
@@ -1083,9 +1046,11 @@ module Orb
|
|
1083
1046
|
# The fixed fee quantity transitions for this price interval. This is only
|
1084
1047
|
# relevant for fixed fees.
|
1085
1048
|
#
|
1086
|
-
# @return [Array<Orb::
|
1049
|
+
# @return [Array<Orb::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
|
1087
1050
|
required :fixed_fee_quantity_transitions,
|
1088
|
-
-> {
|
1051
|
+
-> {
|
1052
|
+
Orb::Internal::Type::ArrayOf[Orb::Subscription::PriceInterval::FixedFeeQuantityTransition]
|
1053
|
+
},
|
1089
1054
|
nil?: true
|
1090
1055
|
|
1091
1056
|
# @!attribute price
|
@@ -1100,8 +1065,8 @@ module Orb
|
|
1100
1065
|
# For more on the types of prices, see
|
1101
1066
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1102
1067
|
#
|
1103
|
-
# @return [Orb::
|
1104
|
-
required :price, union: -> { Orb::
|
1068
|
+
# @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]
|
1069
|
+
required :price, union: -> { Orb::Price }
|
1105
1070
|
|
1106
1071
|
# @!attribute start_date
|
1107
1072
|
# The start date of the price interval. This is the date that Orb starts billing
|
@@ -1119,7 +1084,7 @@ module Orb
|
|
1119
1084
|
|
1120
1085
|
# @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
|
1121
1086
|
# Some parameter documentations has been truncated, see
|
1122
|
-
# {Orb::
|
1087
|
+
# {Orb::Subscription::PriceInterval} for more details.
|
1123
1088
|
#
|
1124
1089
|
# The Price Interval resource represents a period of time for which a price will
|
1125
1090
|
# bill on a subscription. A subscription’s price intervals define its billing
|
@@ -1130,27 +1095,20 @@ module Orb
|
|
1130
1095
|
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1131
1096
|
#
|
1132
1097
|
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1133
|
-
# ...
|
1134
1098
|
#
|
1135
1099
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1136
|
-
# ...
|
1137
1100
|
#
|
1138
1101
|
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1139
|
-
# ...
|
1140
1102
|
#
|
1141
1103
|
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1142
1104
|
#
|
1143
|
-
# @param fixed_fee_quantity_transitions [Array<Orb::
|
1144
|
-
# ...
|
1105
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1145
1106
|
#
|
1146
|
-
# @param price [Orb::
|
1147
|
-
# ...
|
1107
|
+
# @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
|
1148
1108
|
#
|
1149
1109
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1150
|
-
# ...
|
1151
1110
|
#
|
1152
1111
|
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1153
|
-
# ...
|
1154
1112
|
|
1155
1113
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1156
1114
|
# @!attribute effective_date
|
@@ -1175,7 +1133,7 @@ module Orb
|
|
1175
1133
|
end
|
1176
1134
|
end
|
1177
1135
|
|
1178
|
-
# @see Orb::
|
1136
|
+
# @see Orb::Subscription#redeemed_coupon
|
1179
1137
|
class RedeemedCoupon < Orb::Internal::Type::BaseModel
|
1180
1138
|
# @!attribute coupon_id
|
1181
1139
|
#
|
@@ -1198,7 +1156,7 @@ module Orb
|
|
1198
1156
|
# @param start_date [Time]
|
1199
1157
|
end
|
1200
1158
|
|
1201
|
-
# @see Orb::
|
1159
|
+
# @see Orb::Subscription#status
|
1202
1160
|
module Status
|
1203
1161
|
extend Orb::Internal::Type::Enum
|
1204
1162
|
|
@@ -1210,7 +1168,7 @@ module Orb
|
|
1210
1168
|
# @return [Array<Symbol>]
|
1211
1169
|
end
|
1212
1170
|
|
1213
|
-
# @see Orb::
|
1171
|
+
# @see Orb::Subscription#trial_info
|
1214
1172
|
class TrialInfo < Orb::Internal::Type::BaseModel
|
1215
1173
|
# @!attribute end_date
|
1216
1174
|
#
|