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::SubscriptionCreateResponse::DiscountInterval::
|
104
|
+
# @return [Array<Orb::Models::SubscriptionCreateResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCreateResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCreateResponse::DiscountInterval::Usage>]
|
105
105
|
required :discount_intervals,
|
106
106
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionCreateResponse::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.
|
@@ -214,34 +214,26 @@ module Orb
|
|
214
214
|
# @param id [String]
|
215
215
|
#
|
216
216
|
# @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
|
217
|
-
# ...
|
218
217
|
#
|
219
218
|
# @param adjustment_intervals [Array<Orb::Models::SubscriptionCreateResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
|
220
|
-
# ...
|
221
219
|
#
|
222
220
|
# @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
|
223
|
-
# ...
|
224
221
|
#
|
225
222
|
# @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCreateResponse::BillingCycleAnchorConfiguration]
|
226
223
|
#
|
227
224
|
# @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
228
|
-
# ...
|
229
225
|
#
|
230
226
|
# @param created_at [Time]
|
231
227
|
#
|
232
228
|
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
233
|
-
# ...
|
234
229
|
#
|
235
230
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
236
|
-
# ...
|
237
231
|
#
|
238
|
-
# @param customer [Orb::
|
239
|
-
# ...
|
232
|
+
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
240
233
|
#
|
241
234
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
242
|
-
# ...
|
243
235
|
#
|
244
|
-
# @param discount_intervals [Array<Orb::Models::SubscriptionCreateResponse::DiscountInterval::
|
236
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionCreateResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCreateResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCreateResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
245
237
|
#
|
246
238
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
247
239
|
#
|
@@ -252,17 +244,14 @@ module Orb
|
|
252
244
|
# @param maximum_intervals [Array<Orb::Models::SubscriptionCreateResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
|
253
245
|
#
|
254
246
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
255
|
-
# ...
|
256
247
|
#
|
257
248
|
# @param minimum_intervals [Array<Orb::Models::SubscriptionCreateResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
258
249
|
#
|
259
250
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
260
|
-
# ...
|
261
251
|
#
|
262
252
|
# @param pending_subscription_change [Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
263
253
|
#
|
264
|
-
# @param plan [Orb::
|
265
|
-
# ...
|
254
|
+
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
266
255
|
#
|
267
256
|
# @param price_intervals [Array<Orb::Models::SubscriptionCreateResponse::PriceInterval>] The price intervals for this subscription.
|
268
257
|
#
|
@@ -275,7 +264,6 @@ module Orb
|
|
275
264
|
# @param trial_info [Orb::Models::SubscriptionCreateResponse::TrialInfo]
|
276
265
|
#
|
277
266
|
# @param changed_resources [Orb::Models::SubscriptionCreateResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
|
278
|
-
# ...
|
279
267
|
|
280
268
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
281
269
|
# @!attribute id
|
@@ -285,7 +273,7 @@ module Orb
|
|
285
273
|
|
286
274
|
# @!attribute adjustment
|
287
275
|
#
|
288
|
-
# @return [Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
276
|
+
# @return [Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Maximum]
|
289
277
|
required :adjustment,
|
290
278
|
union: -> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment }
|
291
279
|
|
@@ -310,7 +298,7 @@ module Orb
|
|
310
298
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
311
299
|
# @param id [String]
|
312
300
|
#
|
313
|
-
# @param adjustment [Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
301
|
+
# @param adjustment [Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Maximum]
|
314
302
|
#
|
315
303
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
316
304
|
#
|
@@ -325,21 +313,19 @@ module Orb
|
|
325
313
|
discriminator :adjustment_type
|
326
314
|
|
327
315
|
variant :usage_discount,
|
328
|
-
-> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
316
|
+
-> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::UsageDiscount }
|
329
317
|
|
330
318
|
variant :amount_discount,
|
331
|
-
-> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
319
|
+
-> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::AmountDiscount }
|
332
320
|
|
333
321
|
variant :percentage_discount,
|
334
|
-
-> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
322
|
+
-> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
|
335
323
|
|
336
|
-
variant :minimum,
|
337
|
-
-> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment }
|
324
|
+
variant :minimum, -> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Minimum }
|
338
325
|
|
339
|
-
variant :maximum,
|
340
|
-
-> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment }
|
326
|
+
variant :maximum, -> { Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Maximum }
|
341
327
|
|
342
|
-
class
|
328
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
343
329
|
# @!attribute id
|
344
330
|
#
|
345
331
|
# @return [String]
|
@@ -384,7 +370,7 @@ module Orb
|
|
384
370
|
|
385
371
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
386
372
|
# Some parameter documentations has been truncated, see
|
387
|
-
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
373
|
+
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
388
374
|
# for more details.
|
389
375
|
#
|
390
376
|
# @param id [String]
|
@@ -392,19 +378,17 @@ module Orb
|
|
392
378
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
393
379
|
#
|
394
380
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
395
|
-
# ...
|
396
381
|
#
|
397
382
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
398
383
|
#
|
399
384
|
# @param reason [String, nil] The reason for the adjustment.
|
400
385
|
#
|
401
386
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
402
|
-
# ...
|
403
387
|
#
|
404
388
|
# @param adjustment_type [Symbol, :usage_discount]
|
405
389
|
end
|
406
390
|
|
407
|
-
class
|
391
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
408
392
|
# @!attribute id
|
409
393
|
#
|
410
394
|
# @return [String]
|
@@ -449,18 +433,16 @@ module Orb
|
|
449
433
|
|
450
434
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
451
435
|
# Some parameter documentations has been truncated, see
|
452
|
-
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
436
|
+
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
453
437
|
# for more details.
|
454
438
|
#
|
455
439
|
# @param id [String]
|
456
440
|
#
|
457
441
|
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
458
|
-
# ...
|
459
442
|
#
|
460
443
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
461
444
|
#
|
462
445
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
463
|
-
# ...
|
464
446
|
#
|
465
447
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
466
448
|
#
|
@@ -469,7 +451,7 @@ module Orb
|
|
469
451
|
# @param adjustment_type [Symbol, :amount_discount]
|
470
452
|
end
|
471
453
|
|
472
|
-
class
|
454
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
473
455
|
# @!attribute id
|
474
456
|
#
|
475
457
|
# @return [String]
|
@@ -514,7 +496,7 @@ module Orb
|
|
514
496
|
|
515
497
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
516
498
|
# Some parameter documentations has been truncated, see
|
517
|
-
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
499
|
+
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
518
500
|
# for more details.
|
519
501
|
#
|
520
502
|
# @param id [String]
|
@@ -522,10 +504,8 @@ module Orb
|
|
522
504
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
523
505
|
#
|
524
506
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
525
|
-
# ...
|
526
507
|
#
|
527
508
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
528
|
-
# ...
|
529
509
|
#
|
530
510
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
531
511
|
#
|
@@ -534,7 +514,7 @@ module Orb
|
|
534
514
|
# @param adjustment_type [Symbol, :percentage_discount]
|
535
515
|
end
|
536
516
|
|
537
|
-
class
|
517
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
538
518
|
# @!attribute id
|
539
519
|
#
|
540
520
|
# @return [String]
|
@@ -585,7 +565,7 @@ module Orb
|
|
585
565
|
|
586
566
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
587
567
|
# Some parameter documentations has been truncated, see
|
588
|
-
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
568
|
+
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Minimum}
|
589
569
|
# for more details.
|
590
570
|
#
|
591
571
|
# @param id [String]
|
@@ -593,12 +573,10 @@ module Orb
|
|
593
573
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
594
574
|
#
|
595
575
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
596
|
-
# ...
|
597
576
|
#
|
598
577
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
599
578
|
#
|
600
579
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
601
|
-
# ...
|
602
580
|
#
|
603
581
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
604
582
|
#
|
@@ -607,7 +585,7 @@ module Orb
|
|
607
585
|
# @param adjustment_type [Symbol, :minimum]
|
608
586
|
end
|
609
587
|
|
610
|
-
class
|
588
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
611
589
|
# @!attribute id
|
612
590
|
#
|
613
591
|
# @return [String]
|
@@ -652,7 +630,7 @@ module Orb
|
|
652
630
|
|
653
631
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
654
632
|
# Some parameter documentations has been truncated, see
|
655
|
-
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
633
|
+
# {Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Maximum}
|
656
634
|
# for more details.
|
657
635
|
#
|
658
636
|
# @param id [String]
|
@@ -660,10 +638,8 @@ module Orb
|
|
660
638
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
661
639
|
#
|
662
640
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
663
|
-
# ...
|
664
641
|
#
|
665
642
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
666
|
-
# ...
|
667
643
|
#
|
668
644
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
669
645
|
#
|
@@ -673,7 +649,7 @@ module Orb
|
|
673
649
|
end
|
674
650
|
|
675
651
|
# @!method self.variants
|
676
|
-
# @return [Array(Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::
|
652
|
+
# @return [Array(Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Maximum)]
|
677
653
|
end
|
678
654
|
end
|
679
655
|
|
@@ -709,13 +685,10 @@ module Orb
|
|
709
685
|
# more details.
|
710
686
|
#
|
711
687
|
# @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
|
712
|
-
# ...
|
713
688
|
#
|
714
689
|
# @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
|
715
|
-
# ...
|
716
690
|
#
|
717
691
|
# @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
|
718
|
-
# ...
|
719
692
|
end
|
720
693
|
|
721
694
|
module DiscountInterval
|
@@ -723,14 +696,13 @@ module Orb
|
|
723
696
|
|
724
697
|
discriminator :discount_type
|
725
698
|
|
726
|
-
variant :amount, -> { Orb::Models::SubscriptionCreateResponse::DiscountInterval::
|
699
|
+
variant :amount, -> { Orb::Models::SubscriptionCreateResponse::DiscountInterval::Amount }
|
727
700
|
|
728
|
-
variant :percentage,
|
729
|
-
-> { Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval }
|
701
|
+
variant :percentage, -> { Orb::Models::SubscriptionCreateResponse::DiscountInterval::Percentage }
|
730
702
|
|
731
|
-
variant :usage, -> { Orb::Models::SubscriptionCreateResponse::DiscountInterval::
|
703
|
+
variant :usage, -> { Orb::Models::SubscriptionCreateResponse::DiscountInterval::Usage }
|
732
704
|
|
733
|
-
class
|
705
|
+
class Amount < Orb::Internal::Type::BaseModel
|
734
706
|
# @!attribute amount_discount
|
735
707
|
# Only available if discount_type is `amount`.
|
736
708
|
#
|
@@ -780,7 +752,7 @@ module Orb
|
|
780
752
|
# @param discount_type [Symbol, :amount]
|
781
753
|
end
|
782
754
|
|
783
|
-
class
|
755
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
784
756
|
# @!attribute applies_to_price_ids
|
785
757
|
# The price ids that this discount interval applies to.
|
786
758
|
#
|
@@ -819,8 +791,8 @@ module Orb
|
|
819
791
|
|
820
792
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
821
793
|
# Some parameter documentations has been truncated, see
|
822
|
-
# {Orb::Models::SubscriptionCreateResponse::DiscountInterval::
|
823
|
-
#
|
794
|
+
# {Orb::Models::SubscriptionCreateResponse::DiscountInterval::Percentage} for more
|
795
|
+
# details.
|
824
796
|
#
|
825
797
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
826
798
|
#
|
@@ -829,14 +801,13 @@ module Orb
|
|
829
801
|
# @param end_date [Time, nil] The end date of the discount interval.
|
830
802
|
#
|
831
803
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
832
|
-
# ...
|
833
804
|
#
|
834
805
|
# @param start_date [Time] The start date of the discount interval.
|
835
806
|
#
|
836
807
|
# @param discount_type [Symbol, :percentage]
|
837
808
|
end
|
838
809
|
|
839
|
-
class
|
810
|
+
class Usage < Orb::Internal::Type::BaseModel
|
840
811
|
# @!attribute applies_to_price_ids
|
841
812
|
# The price ids that this discount interval applies to.
|
842
813
|
#
|
@@ -875,8 +846,8 @@ module Orb
|
|
875
846
|
|
876
847
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
877
848
|
# Some parameter documentations has been truncated, see
|
878
|
-
# {Orb::Models::SubscriptionCreateResponse::DiscountInterval::
|
879
|
-
#
|
849
|
+
# {Orb::Models::SubscriptionCreateResponse::DiscountInterval::Usage} for more
|
850
|
+
# details.
|
880
851
|
#
|
881
852
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
882
853
|
#
|
@@ -887,13 +858,12 @@ module Orb
|
|
887
858
|
# @param start_date [Time] The start date of the discount interval.
|
888
859
|
#
|
889
860
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
890
|
-
# ...
|
891
861
|
#
|
892
862
|
# @param discount_type [Symbol, :usage]
|
893
863
|
end
|
894
864
|
|
895
865
|
# @!method self.variants
|
896
|
-
# @return [Array(Orb::Models::SubscriptionCreateResponse::DiscountInterval::
|
866
|
+
# @return [Array(Orb::Models::SubscriptionCreateResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCreateResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCreateResponse::DiscountInterval::Usage)]
|
897
867
|
end
|
898
868
|
|
899
869
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -967,7 +937,6 @@ module Orb
|
|
967
937
|
# @param end_date [Time, nil] The end date of the maximum interval.
|
968
938
|
#
|
969
939
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
970
|
-
# ...
|
971
940
|
#
|
972
941
|
# @param start_date [Time] The start date of the maximum interval.
|
973
942
|
end
|
@@ -1015,7 +984,6 @@ module Orb
|
|
1015
984
|
# @param end_date [Time, nil] The end date of the minimum interval.
|
1016
985
|
#
|
1017
986
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
1018
|
-
# ...
|
1019
987
|
#
|
1020
988
|
# @param start_date [Time] The start date of the minimum interval.
|
1021
989
|
end
|
@@ -1095,8 +1063,8 @@ module Orb
|
|
1095
1063
|
# For more on the types of prices, see
|
1096
1064
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1097
1065
|
#
|
1098
|
-
# @return [Orb::
|
1099
|
-
required :price, union: -> { Orb::
|
1066
|
+
# @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]
|
1067
|
+
required :price, union: -> { Orb::Price }
|
1100
1068
|
|
1101
1069
|
# @!attribute start_date
|
1102
1070
|
# The start date of the price interval. This is the date that Orb starts billing
|
@@ -1125,27 +1093,20 @@ module Orb
|
|
1125
1093
|
# @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
|
1126
1094
|
#
|
1127
1095
|
# @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
|
1128
|
-
# ...
|
1129
1096
|
#
|
1130
1097
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
1131
|
-
# ...
|
1132
1098
|
#
|
1133
1099
|
# @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
|
1134
|
-
# ...
|
1135
1100
|
#
|
1136
1101
|
# @param filter [String, nil] An additional filter to apply to usage queries.
|
1137
1102
|
#
|
1138
1103
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionCreateResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1139
|
-
# ...
|
1140
1104
|
#
|
1141
|
-
# @param price [Orb::
|
1142
|
-
# ...
|
1105
|
+
# @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
|
1143
1106
|
#
|
1144
1107
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1145
|
-
# ...
|
1146
1108
|
#
|
1147
1109
|
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
1148
|
-
# ...
|
1149
1110
|
|
1150
1111
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1151
1112
|
# @!attribute effective_date
|
@@ -1221,39 +1182,39 @@ module Orb
|
|
1221
1182
|
# @!attribute created_credit_notes
|
1222
1183
|
# The credit notes that were created as part of this operation.
|
1223
1184
|
#
|
1224
|
-
# @return [Array<Orb::
|
1225
|
-
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1185
|
+
# @return [Array<Orb::CreditNote>]
|
1186
|
+
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1226
1187
|
|
1227
1188
|
# @!attribute created_invoices
|
1228
1189
|
# The invoices that were created as part of this operation.
|
1229
1190
|
#
|
1230
|
-
# @return [Array<Orb::
|
1231
|
-
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1191
|
+
# @return [Array<Orb::Invoice>]
|
1192
|
+
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1232
1193
|
|
1233
1194
|
# @!attribute voided_credit_notes
|
1234
1195
|
# The credit notes that were voided as part of this operation.
|
1235
1196
|
#
|
1236
|
-
# @return [Array<Orb::
|
1237
|
-
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1197
|
+
# @return [Array<Orb::CreditNote>]
|
1198
|
+
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1238
1199
|
|
1239
1200
|
# @!attribute voided_invoices
|
1240
1201
|
# The invoices that were voided as part of this operation.
|
1241
1202
|
#
|
1242
|
-
# @return [Array<Orb::
|
1243
|
-
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1203
|
+
# @return [Array<Orb::Invoice>]
|
1204
|
+
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1244
1205
|
|
1245
1206
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
1246
1207
|
# The resources that were changed as part of this operation. Only present when
|
1247
1208
|
# fetched through the subscription changes API or if the
|
1248
1209
|
# `include_changed_resources` parameter was passed in the request.
|
1249
1210
|
#
|
1250
|
-
# @param created_credit_notes [Array<Orb::
|
1211
|
+
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1251
1212
|
#
|
1252
|
-
# @param created_invoices [Array<Orb::
|
1213
|
+
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1253
1214
|
#
|
1254
|
-
# @param voided_credit_notes [Array<Orb::
|
1215
|
+
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1255
1216
|
#
|
1256
|
-
# @param voided_invoices [Array<Orb::
|
1217
|
+
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1257
1218
|
end
|
1258
1219
|
end
|
1259
1220
|
end
|
@@ -31,8 +31,8 @@ module Orb
|
|
31
31
|
# discounts, it's strongly recommended that you use the default cumulative
|
32
32
|
# behavior.
|
33
33
|
#
|
34
|
-
# @return [Symbol, Orb::
|
35
|
-
optional :view_mode, enum: -> { Orb::
|
34
|
+
# @return [Symbol, Orb::SubscriptionFetchCostsParams::ViewMode, nil]
|
35
|
+
optional :view_mode, enum: -> { Orb::SubscriptionFetchCostsParams::ViewMode }, nil?: true
|
36
36
|
|
37
37
|
# @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
|
38
38
|
# Some parameter documentations has been truncated, see
|
@@ -44,8 +44,7 @@ module Orb
|
|
44
44
|
#
|
45
45
|
# @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
|
46
46
|
#
|
47
|
-
# @param view_mode [Symbol, Orb::
|
48
|
-
# ...
|
47
|
+
# @param view_mode [Symbol, Orb::SubscriptionFetchCostsParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
|
49
48
|
#
|
50
49
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
51
50
|
|
@@ -56,8 +56,8 @@ module Orb
|
|
56
56
|
# @!attribute price
|
57
57
|
# The price object
|
58
58
|
#
|
59
|
-
# @return [Orb::
|
60
|
-
required :price, union: -> { Orb::
|
59
|
+
# @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]
|
60
|
+
required :price, union: -> { Orb::Price }
|
61
61
|
|
62
62
|
# @!attribute price_id
|
63
63
|
# The price the cost is associated with
|
@@ -84,7 +84,7 @@ module Orb
|
|
84
84
|
optional :quantity, Float, nil?: true
|
85
85
|
|
86
86
|
# @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil)
|
87
|
-
# @param price [Orb::
|
87
|
+
# @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 object
|
88
88
|
#
|
89
89
|
# @param price_id [String] The price the cost is associated with
|
90
90
|
#
|
@@ -45,7 +45,6 @@ module Orb
|
|
45
45
|
# {Orb::Models::SubscriptionFetchScheduleParams} for more details.
|
46
46
|
#
|
47
47
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
48
|
-
# ...
|
49
48
|
#
|
50
49
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
51
50
|
#
|
@@ -28,8 +28,8 @@ module Orb
|
|
28
28
|
# @!attribute granularity
|
29
29
|
# This determines the windowing of usage reporting.
|
30
30
|
#
|
31
|
-
# @return [Symbol, Orb::
|
32
|
-
optional :granularity, enum: -> { Orb::
|
31
|
+
# @return [Symbol, Orb::SubscriptionFetchUsageParams::Granularity, nil]
|
32
|
+
optional :granularity, enum: -> { Orb::SubscriptionFetchUsageParams::Granularity }, nil?: true
|
33
33
|
|
34
34
|
# @!attribute group_by
|
35
35
|
# Groups per-price usage by the key provided.
|
@@ -65,21 +65,20 @@ module Orb
|
|
65
65
|
# discounts, it's strongly recommended that you use the default cumulative
|
66
66
|
# behavior.
|
67
67
|
#
|
68
|
-
# @return [Symbol, Orb::
|
69
|
-
optional :view_mode, enum: -> { Orb::
|
68
|
+
# @return [Symbol, Orb::SubscriptionFetchUsageParams::ViewMode, nil]
|
69
|
+
optional :view_mode, enum: -> { Orb::SubscriptionFetchUsageParams::ViewMode }, nil?: true
|
70
70
|
|
71
71
|
# @!method initialize(billable_metric_id: nil, first_dimension_key: nil, first_dimension_value: nil, granularity: nil, group_by: nil, second_dimension_key: nil, second_dimension_value: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
|
72
72
|
# Some parameter documentations has been truncated, see
|
73
73
|
# {Orb::Models::SubscriptionFetchUsageParams} for more details.
|
74
74
|
#
|
75
75
|
# @param billable_metric_id [String, nil] When specified in conjunction with `group_by`, this parameter filters usage to a
|
76
|
-
# ...
|
77
76
|
#
|
78
77
|
# @param first_dimension_key [String, nil]
|
79
78
|
#
|
80
79
|
# @param first_dimension_value [String, nil]
|
81
80
|
#
|
82
|
-
# @param granularity [Symbol, Orb::
|
81
|
+
# @param granularity [Symbol, Orb::SubscriptionFetchUsageParams::Granularity, nil] This determines the windowing of usage reporting.
|
83
82
|
#
|
84
83
|
# @param group_by [String, nil] Groups per-price usage by the key provided.
|
85
84
|
#
|
@@ -91,8 +90,7 @@ module Orb
|
|
91
90
|
#
|
92
91
|
# @param timeframe_start [Time, nil] Usage returned is inclusive of `timeframe_start`.
|
93
92
|
#
|
94
|
-
# @param view_mode [Symbol, Orb::
|
95
|
-
# ...
|
93
|
+
# @param view_mode [Symbol, Orb::SubscriptionFetchUsageParams::ViewMode, nil] Controls whether Orb returns cumulative usage since the start of the billing per
|
96
94
|
#
|
97
95
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
98
96
|
|
@@ -52,8 +52,8 @@ module Orb
|
|
52
52
|
|
53
53
|
# @!attribute status
|
54
54
|
#
|
55
|
-
# @return [Symbol, Orb::
|
56
|
-
optional :status, enum: -> { Orb::
|
55
|
+
# @return [Symbol, Orb::SubscriptionListParams::Status, nil]
|
56
|
+
optional :status, enum: -> { Orb::SubscriptionListParams::Status }, nil?: true
|
57
57
|
|
58
58
|
# @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, status: nil, request_options: {})
|
59
59
|
# Some parameter documentations has been truncated, see
|
@@ -68,7 +68,6 @@ module Orb
|
|
68
68
|
# @param created_at_lte [Time, nil]
|
69
69
|
#
|
70
70
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
71
|
-
# ...
|
72
71
|
#
|
73
72
|
# @param customer_id [Array<String>, nil]
|
74
73
|
#
|
@@ -76,7 +75,7 @@ module Orb
|
|
76
75
|
#
|
77
76
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
78
77
|
#
|
79
|
-
# @param status [Symbol, Orb::
|
78
|
+
# @param status [Symbol, Orb::SubscriptionListParams::Status, nil]
|
80
79
|
#
|
81
80
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
82
81
|
|