orb-billing 0.1.0.pre.alpha.38 → 0.1.1
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/README.md +10 -2
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/transport/base_client.rb +2 -2
- data/lib/orb/internal/transport/pooled_net_requester.rb +15 -6
- data/lib/orb/internal/type/array_of.rb +12 -2
- data/lib/orb/internal/type/base_model.rb +23 -22
- data/lib/orb/internal/type/boolean.rb +5 -1
- data/lib/orb/internal/type/converter.rb +62 -39
- data/lib/orb/internal/type/enum.rb +13 -9
- data/lib/orb/internal/type/hash_of.rb +6 -2
- data/lib/orb/internal/type/io_like.rb +75 -0
- data/lib/orb/internal/type/request_parameters.rb +11 -2
- data/lib/orb/internal/type/union.rb +7 -3
- data/lib/orb/internal/type/unknown.rb +5 -1
- data/lib/orb/internal/util.rb +81 -26
- data/lib/orb/models/alert.rb +9 -9
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
- data/lib/orb/models/alert_list_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +1 -1
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +7 -7
- data/lib/orb/models/coupon_create_params.rb +2 -2
- data/lib/orb/models/coupon_list_params.rb +2 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
- data/lib/orb/models/credit_note.rb +1 -1
- data/lib/orb/models/credit_note_list_params.rb +5 -5
- data/lib/orb/models/customer.rb +232 -232
- data/lib/orb/models/customer_create_params.rb +223 -223
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
- data/lib/orb/models/customer_update_params.rb +224 -224
- data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
- data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/cost_list_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credit_list_params.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
- data/lib/orb/models/dimensional_price_group.rb +7 -7
- data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
- data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +7 -7
- data/lib/orb/models/event_ingest_response.rb +4 -4
- data/lib/orb/models/event_search_params.rb +5 -5
- data/lib/orb/models/event_search_response.rb +8 -8
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +7 -7
- data/lib/orb/models/events/backfill_create_params.rb +11 -11
- data/lib/orb/models/events/backfill_create_response.rb +7 -7
- data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +7 -7
- data/lib/orb/models/events/backfill_revert_response.rb +7 -7
- data/lib/orb/models/events/event_volumes.rb +1 -1
- data/lib/orb/models/events/volume_list_params.rb +7 -7
- data/lib/orb/models/invoice.rb +270 -270
- data/lib/orb/models/invoice_create_params.rb +12 -11
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
- data/lib/orb/models/invoice_issue_params.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
- data/lib/orb/models/invoice_list_params.rb +12 -12
- data/lib/orb/models/invoice_update_params.rb +2 -2
- data/lib/orb/models/item.rb +2 -2
- data/lib/orb/models/item_list_params.rb +1 -1
- data/lib/orb/models/metric_create_params.rb +2 -2
- data/lib/orb/models/metric_list_params.rb +5 -5
- data/lib/orb/models/metric_update_params.rb +2 -2
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +35 -35
- data/lib/orb/models/plan_create_params.rb +267 -267
- data/lib/orb/models/plan_list_params.rb +5 -5
- data/lib/orb/models/plan_update_params.rb +4 -4
- data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
- data/lib/orb/models/price.rb +158 -158
- data/lib/orb/models/price_create_params.rb +20 -20
- data/lib/orb/models/price_evaluate_params.rb +4 -4
- data/lib/orb/models/price_list_params.rb +1 -1
- data/lib/orb/models/price_update_params.rb +2 -2
- data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
- data/lib/orb/models/subscription.rb +114 -87
- data/lib/orb/models/subscription_cancel_params.rb +3 -3
- data/lib/orb/models/subscription_cancel_response.rb +150 -72
- data/lib/orb/models/subscription_change_apply_params.rb +33 -0
- data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
- data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
- data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
- data/lib/orb/models/subscription_create_params.rb +641 -641
- data/lib/orb/models/subscription_create_response.rb +150 -72
- data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
- data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
- data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
- data/lib/orb/models/subscription_list_params.rb +5 -5
- data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
- data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
- data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
- data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
- data/lib/orb/models/subscription_update_params.rb +10 -10
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +152 -72
- data/lib/orb/models/trial_discount.rb +1 -1
- data/lib/orb/models/usage_discount.rb +2 -2
- data/lib/orb/request_options.rb +7 -7
- data/lib/orb/resources/alerts.rb +38 -38
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +8 -8
- data/lib/orb/resources/customers/balance_transactions.rb +26 -26
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +344 -344
- data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
- data/lib/orb/resources/customers/credits.rb +8 -8
- data/lib/orb/resources/customers.rb +59 -59
- data/lib/orb/resources/dimensional_price_groups.rb +6 -6
- data/lib/orb/resources/events/backfills.rb +49 -49
- data/lib/orb/resources/events/volume.rb +10 -10
- data/lib/orb/resources/events.rb +295 -295
- data/lib/orb/resources/invoice_line_items.rb +1 -1
- data/lib/orb/resources/invoices.rb +38 -38
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +11 -11
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +22 -22
- data/lib/orb/resources/prices/external_price_id.rb +4 -4
- data/lib/orb/resources/prices.rb +30 -30
- data/lib/orb/resources/subscription_changes.rb +87 -0
- data/lib/orb/resources/subscriptions.rb +813 -813
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +8 -0
- data/rbi/lib/orb/client.rbi +5 -4
- data/rbi/lib/orb/errors.rbi +3 -6
- data/rbi/lib/orb/internal/page.rbi +3 -6
- data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +8 -14
- data/rbi/lib/orb/internal/type/array_of.rbi +14 -18
- data/rbi/lib/orb/internal/type/base_model.rbi +51 -66
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/boolean.rbi +12 -10
- data/rbi/lib/orb/internal/type/converter.rbi +44 -37
- data/rbi/lib/orb/internal/type/enum.rbi +24 -21
- data/rbi/lib/orb/internal/type/hash_of.rbi +13 -18
- data/rbi/lib/orb/internal/type/io_like.rbi +49 -0
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +19 -21
- data/rbi/lib/orb/internal/type/unknown.rbi +10 -9
- data/rbi/lib/orb/internal/util.rbi +67 -70
- data/rbi/lib/orb/internal.rbi +1 -1
- data/rbi/lib/orb/models/alert.rbi +21 -33
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
- data/rbi/lib/orb/models/amount_discount.rbi +4 -7
- data/rbi/lib/orb/models/billable_metric.rbi +10 -13
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
- data/rbi/lib/orb/models/coupon.rbi +9 -11
- data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
- data/rbi/lib/orb/models/credit_note.rbi +22 -45
- data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer.rbi +256 -281
- data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
- data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
- data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
- data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
- data/rbi/lib/orb/models/discount.rbi +1 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
- data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
- data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
- data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
- data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
- data/rbi/lib/orb/models/event_search_params.rbi +7 -9
- data/rbi/lib/orb/models/event_search_response.rbi +11 -14
- data/rbi/lib/orb/models/event_update_params.rbi +5 -6
- data/rbi/lib/orb/models/event_update_response.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
- data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
- data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
- data/rbi/lib/orb/models/invoice.rbi +388 -465
- data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
- data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
- data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
- data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
- data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
- data/rbi/lib/orb/models/item.rbi +7 -12
- data/rbi/lib/orb/models/item_create_params.rbi +2 -4
- data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/item_list_params.rbi +3 -5
- data/rbi/lib/orb/models/item_update_params.rbi +5 -10
- data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
- data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
- data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
- data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
- data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
- data/rbi/lib/orb/models/plan.rbi +180 -219
- data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
- data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
- data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
- data/rbi/lib/orb/models/price.rbi +827 -1494
- data/rbi/lib/orb/models/price_create_params.rbi +60 -101
- data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
- data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
- data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/price_list_params.rbi +3 -5
- data/rbi/lib/orb/models/price_update_params.rbi +4 -6
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
- data/rbi/lib/orb/models/subscription.rbi +167 -187
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
- data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
- data/rbi/lib/orb/models/subscriptions.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
- data/rbi/lib/orb/models/trial_discount.rbi +4 -8
- data/rbi/lib/orb/models/usage_discount.rbi +5 -8
- data/rbi/lib/orb/request_options.rbi +9 -11
- data/rbi/lib/orb/resources/alerts.rbi +44 -60
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
- data/rbi/lib/orb/resources/coupons.rbi +18 -25
- data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
- data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
- data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
- data/rbi/lib/orb/resources/customers.rbi +407 -417
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
- data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
- data/rbi/lib/orb/resources/events/volume.rbi +19 -22
- data/rbi/lib/orb/resources/events.rbi +311 -319
- data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
- data/rbi/lib/orb/resources/invoices.rbi +62 -76
- data/rbi/lib/orb/resources/items.rbi +7 -14
- data/rbi/lib/orb/resources/metrics.rbi +17 -25
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
- data/rbi/lib/orb/resources/plans.rbi +63 -71
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
- data/rbi/lib/orb/resources/prices.rbi +77 -87
- data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
- data/rbi/lib/orb/resources/top_level.rbi +6 -8
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/internal/transport/pooled_net_requester.rbs +1 -1
- data/sig/orb/internal/type/array_of.rbs +5 -2
- data/sig/orb/internal/type/base_model.rbs +5 -2
- data/sig/orb/internal/type/boolean.rbs +5 -2
- data/sig/orb/internal/type/converter.rbs +11 -5
- data/sig/orb/internal/type/enum.rbs +5 -2
- data/sig/orb/internal/type/hash_of.rbs +5 -2
- data/sig/orb/internal/type/io_like.rbs +23 -0
- data/sig/orb/internal/type/union.rbs +5 -2
- data/sig/orb/internal/type/unknown.rbs +5 -2
- data/sig/orb/internal/util.rbs +17 -2
- data/sig/orb/models/subscription.rbs +14 -0
- data/sig/orb/models/subscription_cancel_response.rbs +47 -2
- data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
- data/sig/orb/models/subscription_create_response.rbs +47 -2
- data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
- data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
- data/sig/orb/resources/customers.rbs +2 -2
- data/sig/orb/resources/subscription_changes.rbs +24 -0
- metadata +28 -4
@@ -15,12 +15,10 @@ module Orb
|
|
15
15
|
)
|
16
16
|
.returns(T.attached_class)
|
17
17
|
end
|
18
|
-
def self.new(data:)
|
19
|
-
end
|
18
|
+
def self.new(data:); end
|
20
19
|
|
21
20
|
sig { override.returns({data: T::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data]}) }
|
22
|
-
def to_hash
|
23
|
-
end
|
21
|
+
def to_hash; end
|
24
22
|
|
25
23
|
class Data < Orb::Internal::Type::BaseModel
|
26
24
|
sig { returns(Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric) }
|
@@ -54,8 +52,7 @@ module Orb
|
|
54
52
|
)
|
55
53
|
.returns(T.attached_class)
|
56
54
|
end
|
57
|
-
def self.new(billable_metric:, usage:, view_mode:)
|
58
|
-
end
|
55
|
+
def self.new(billable_metric:, usage:, view_mode:); end
|
59
56
|
|
60
57
|
sig do
|
61
58
|
override
|
@@ -67,8 +64,7 @@ module Orb
|
|
67
64
|
}
|
68
65
|
)
|
69
66
|
end
|
70
|
-
def to_hash
|
71
|
-
end
|
67
|
+
def to_hash; end
|
72
68
|
|
73
69
|
class BillableMetric < Orb::Internal::Type::BaseModel
|
74
70
|
sig { returns(String) }
|
@@ -78,12 +74,10 @@ module Orb
|
|
78
74
|
attr_accessor :name
|
79
75
|
|
80
76
|
sig { params(id: String, name: String).returns(T.attached_class) }
|
81
|
-
def self.new(id:, name:)
|
82
|
-
end
|
77
|
+
def self.new(id:, name:); end
|
83
78
|
|
84
79
|
sig { override.returns({id: String, name: String}) }
|
85
|
-
def to_hash
|
86
|
-
end
|
80
|
+
def to_hash; end
|
87
81
|
end
|
88
82
|
|
89
83
|
class Usage < Orb::Internal::Type::BaseModel
|
@@ -99,12 +93,10 @@ module Orb
|
|
99
93
|
sig do
|
100
94
|
params(quantity: Float, timeframe_end: Time, timeframe_start: Time).returns(T.attached_class)
|
101
95
|
end
|
102
|
-
def self.new(quantity:, timeframe_end:, timeframe_start:)
|
103
|
-
end
|
96
|
+
def self.new(quantity:, timeframe_end:, timeframe_start:); end
|
104
97
|
|
105
98
|
sig { override.returns({quantity: Float, timeframe_end: Time, timeframe_start: Time}) }
|
106
|
-
def to_hash
|
107
|
-
end
|
99
|
+
def to_hash; end
|
108
100
|
end
|
109
101
|
|
110
102
|
module ViewMode
|
@@ -135,8 +127,7 @@ module Orb
|
|
135
127
|
T::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol]
|
136
128
|
)
|
137
129
|
end
|
138
|
-
def self.values
|
139
|
-
end
|
130
|
+
def self.values; end
|
140
131
|
end
|
141
132
|
end
|
142
133
|
end
|
@@ -148,7 +139,9 @@ module Orb
|
|
148
139
|
sig { returns(T.nilable(Orb::Models::PaginationMetadata)) }
|
149
140
|
attr_reader :pagination_metadata
|
150
141
|
|
151
|
-
sig
|
142
|
+
sig do
|
143
|
+
params(pagination_metadata: T.nilable(T.any(Orb::Models::PaginationMetadata, Orb::Internal::AnyHash))).void
|
144
|
+
end
|
152
145
|
attr_writer :pagination_metadata
|
153
146
|
|
154
147
|
sig do
|
@@ -158,8 +151,7 @@ module Orb
|
|
158
151
|
)
|
159
152
|
.returns(T.attached_class)
|
160
153
|
end
|
161
|
-
def self.new(data:, pagination_metadata: nil)
|
162
|
-
end
|
154
|
+
def self.new(data:, pagination_metadata: nil); end
|
163
155
|
|
164
156
|
sig do
|
165
157
|
override
|
@@ -170,8 +162,7 @@ module Orb
|
|
170
162
|
}
|
171
163
|
)
|
172
164
|
end
|
173
|
-
def to_hash
|
174
|
-
end
|
165
|
+
def to_hash; end
|
175
166
|
|
176
167
|
class Data < Orb::Internal::Type::BaseModel
|
177
168
|
sig { returns(Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric) }
|
@@ -217,8 +208,7 @@ module Orb
|
|
217
208
|
)
|
218
209
|
.returns(T.attached_class)
|
219
210
|
end
|
220
|
-
def self.new(billable_metric:, metric_group:, usage:, view_mode:)
|
221
|
-
end
|
211
|
+
def self.new(billable_metric:, metric_group:, usage:, view_mode:); end
|
222
212
|
|
223
213
|
sig do
|
224
214
|
override
|
@@ -231,8 +221,7 @@ module Orb
|
|
231
221
|
}
|
232
222
|
)
|
233
223
|
end
|
234
|
-
def to_hash
|
235
|
-
end
|
224
|
+
def to_hash; end
|
236
225
|
|
237
226
|
class BillableMetric < Orb::Internal::Type::BaseModel
|
238
227
|
sig { returns(String) }
|
@@ -242,12 +231,10 @@ module Orb
|
|
242
231
|
attr_accessor :name
|
243
232
|
|
244
233
|
sig { params(id: String, name: String).returns(T.attached_class) }
|
245
|
-
def self.new(id:, name:)
|
246
|
-
end
|
234
|
+
def self.new(id:, name:); end
|
247
235
|
|
248
236
|
sig { override.returns({id: String, name: String}) }
|
249
|
-
def to_hash
|
250
|
-
end
|
237
|
+
def to_hash; end
|
251
238
|
end
|
252
239
|
|
253
240
|
class MetricGroup < Orb::Internal::Type::BaseModel
|
@@ -258,12 +245,10 @@ module Orb
|
|
258
245
|
attr_accessor :property_value
|
259
246
|
|
260
247
|
sig { params(property_key: String, property_value: String).returns(T.attached_class) }
|
261
|
-
def self.new(property_key:, property_value:)
|
262
|
-
end
|
248
|
+
def self.new(property_key:, property_value:); end
|
263
249
|
|
264
250
|
sig { override.returns({property_key: String, property_value: String}) }
|
265
|
-
def to_hash
|
266
|
-
end
|
251
|
+
def to_hash; end
|
267
252
|
end
|
268
253
|
|
269
254
|
class Usage < Orb::Internal::Type::BaseModel
|
@@ -279,12 +264,10 @@ module Orb
|
|
279
264
|
sig do
|
280
265
|
params(quantity: Float, timeframe_end: Time, timeframe_start: Time).returns(T.attached_class)
|
281
266
|
end
|
282
|
-
def self.new(quantity:, timeframe_end:, timeframe_start:)
|
283
|
-
end
|
267
|
+
def self.new(quantity:, timeframe_end:, timeframe_start:); end
|
284
268
|
|
285
269
|
sig { override.returns({quantity: Float, timeframe_end: Time, timeframe_start: Time}) }
|
286
|
-
def to_hash
|
287
|
-
end
|
270
|
+
def to_hash; end
|
288
271
|
end
|
289
272
|
|
290
273
|
module ViewMode
|
@@ -310,8 +293,7 @@ module Orb
|
|
310
293
|
override
|
311
294
|
.returns(T::Array[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol])
|
312
295
|
end
|
313
|
-
def self.values
|
314
|
-
end
|
296
|
+
def self.values; end
|
315
297
|
end
|
316
298
|
end
|
317
299
|
end
|
@@ -322,8 +304,7 @@ module Orb
|
|
322
304
|
[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage]
|
323
305
|
)
|
324
306
|
end
|
325
|
-
def self.variants
|
326
|
-
end
|
307
|
+
def self.variants; end
|
327
308
|
end
|
328
309
|
end
|
329
310
|
end
|
@@ -19,15 +19,13 @@ module Orb
|
|
19
19
|
)
|
20
20
|
.returns(T.attached_class)
|
21
21
|
end
|
22
|
-
def self.new(data:, pagination_metadata:)
|
23
|
-
end
|
22
|
+
def self.new(data:, pagination_metadata:); end
|
24
23
|
|
25
24
|
sig do
|
26
25
|
override
|
27
26
|
.returns({data: T::Array[Orb::Models::Subscription], pagination_metadata: Orb::Models::PaginationMetadata})
|
28
27
|
end
|
29
|
-
def to_hash
|
30
|
-
end
|
28
|
+
def to_hash; end
|
31
29
|
end
|
32
30
|
end
|
33
31
|
end
|
@@ -9,12 +9,10 @@ module Orb
|
|
9
9
|
sig do
|
10
10
|
params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class)
|
11
11
|
end
|
12
|
-
def self.new(request_options: {})
|
13
|
-
end
|
12
|
+
def self.new(request_options: {}); end
|
14
13
|
|
15
14
|
sig { override.returns({request_options: Orb::RequestOptions}) }
|
16
|
-
def to_hash
|
17
|
-
end
|
15
|
+
def to_hash; end
|
18
16
|
end
|
19
17
|
end
|
20
18
|
end
|
@@ -7,12 +7,10 @@ module Orb
|
|
7
7
|
attr_accessor :response
|
8
8
|
|
9
9
|
sig { params(response: String).returns(T.attached_class) }
|
10
|
-
def self.new(response:)
|
11
|
-
end
|
10
|
+
def self.new(response:); end
|
12
11
|
|
13
12
|
sig { override.returns({response: String}) }
|
14
|
-
def to_hash
|
15
|
-
end
|
13
|
+
def to_hash; end
|
16
14
|
end
|
17
15
|
end
|
18
16
|
end
|
@@ -4,7 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
class TrialDiscount < Orb::Internal::Type::BaseModel
|
6
6
|
# List of price_ids that this discount applies to. For plan/plan phase discounts,
|
7
|
-
#
|
7
|
+
# this can be a subset of prices.
|
8
8
|
sig { returns(T::Array[String]) }
|
9
9
|
attr_accessor :applies_to_price_ids
|
10
10
|
|
@@ -38,9 +38,7 @@ module Orb
|
|
38
38
|
reason: nil,
|
39
39
|
trial_amount_discount: nil,
|
40
40
|
trial_percentage_discount: nil
|
41
|
-
)
|
42
|
-
end
|
43
|
-
|
41
|
+
); end
|
44
42
|
sig do
|
45
43
|
override
|
46
44
|
.returns(
|
@@ -53,8 +51,7 @@ module Orb
|
|
53
51
|
}
|
54
52
|
)
|
55
53
|
end
|
56
|
-
def to_hash
|
57
|
-
end
|
54
|
+
def to_hash; end
|
58
55
|
|
59
56
|
module DiscountType
|
60
57
|
extend Orb::Internal::Type::Enum
|
@@ -65,8 +62,7 @@ module Orb
|
|
65
62
|
TRIAL = T.let(:trial, Orb::Models::TrialDiscount::DiscountType::TaggedSymbol)
|
66
63
|
|
67
64
|
sig { override.returns(T::Array[Orb::Models::TrialDiscount::DiscountType::TaggedSymbol]) }
|
68
|
-
def self.values
|
69
|
-
end
|
65
|
+
def self.values; end
|
70
66
|
end
|
71
67
|
end
|
72
68
|
end
|
@@ -4,7 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
6
6
|
# List of price_ids that this discount applies to. For plan/plan phase discounts,
|
7
|
-
#
|
7
|
+
# this can be a subset of prices.
|
8
8
|
sig { returns(T::Array[String]) }
|
9
9
|
attr_accessor :applies_to_price_ids
|
10
10
|
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
attr_accessor :discount_type
|
13
13
|
|
14
14
|
# Only available if discount_type is `usage`. Number of usage units that this
|
15
|
-
#
|
15
|
+
# discount is for
|
16
16
|
sig { returns(Float) }
|
17
17
|
attr_accessor :usage_discount
|
18
18
|
|
@@ -28,8 +28,7 @@ module Orb
|
|
28
28
|
)
|
29
29
|
.returns(T.attached_class)
|
30
30
|
end
|
31
|
-
def self.new(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil)
|
32
|
-
end
|
31
|
+
def self.new(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil); end
|
33
32
|
|
34
33
|
sig do
|
35
34
|
override
|
@@ -42,8 +41,7 @@ module Orb
|
|
42
41
|
}
|
43
42
|
)
|
44
43
|
end
|
45
|
-
def to_hash
|
46
|
-
end
|
44
|
+
def to_hash; end
|
47
45
|
|
48
46
|
module DiscountType
|
49
47
|
extend Orb::Internal::Type::Enum
|
@@ -54,8 +52,7 @@ module Orb
|
|
54
52
|
USAGE = T.let(:usage, Orb::Models::UsageDiscount::DiscountType::TaggedSymbol)
|
55
53
|
|
56
54
|
sig { override.returns(T::Array[Orb::Models::UsageDiscount::DiscountType::TaggedSymbol]) }
|
57
|
-
def self.values
|
58
|
-
end
|
55
|
+
def self.values; end
|
59
56
|
end
|
60
57
|
end
|
61
58
|
end
|
@@ -2,33 +2,32 @@
|
|
2
2
|
|
3
3
|
module Orb
|
4
4
|
# Specify HTTP behaviour to use for a specific request. These options supplement
|
5
|
-
#
|
5
|
+
# or override those provided at the client level.
|
6
6
|
#
|
7
|
-
#
|
8
|
-
#
|
7
|
+
# When making a request, you can pass an actual {RequestOptions} instance, or
|
8
|
+
# simply pass a Hash with symbol keys matching the attributes on this class.
|
9
9
|
class RequestOptions < Orb::Internal::Type::BaseModel
|
10
10
|
# @api private
|
11
11
|
sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void }
|
12
|
-
def self.validate!(opts)
|
13
|
-
end
|
12
|
+
def self.validate!(opts); end
|
14
13
|
|
15
14
|
# Idempotency key to send with request and all associated retries. Will only be
|
16
|
-
#
|
15
|
+
# sent for write requests.
|
17
16
|
sig { returns(T.nilable(String)) }
|
18
17
|
attr_accessor :idempotency_key
|
19
18
|
|
20
19
|
# Extra query params to send with the request. These are `.merge`’d into any
|
21
|
-
#
|
20
|
+
# `query` given at the client level.
|
22
21
|
sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) }
|
23
22
|
attr_accessor :extra_query
|
24
23
|
|
25
24
|
# Extra headers to send with the request. These are `.merged`’d into any
|
26
|
-
#
|
25
|
+
# `extra_headers` given at the client level.
|
27
26
|
sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
|
28
27
|
attr_accessor :extra_headers
|
29
28
|
|
30
29
|
# Extra data to send with the request. These are deep merged into any data
|
31
|
-
#
|
30
|
+
# generated as part of the normal request.
|
32
31
|
sig { returns(T.nilable(T.anything)) }
|
33
32
|
attr_accessor :extra_body
|
34
33
|
|
@@ -42,7 +41,6 @@ module Orb
|
|
42
41
|
|
43
42
|
# Returns a new instance of RequestOptions.
|
44
43
|
sig { params(values: Orb::Internal::AnyHash).returns(T.attached_class) }
|
45
|
-
def self.new(values = {})
|
46
|
-
end
|
44
|
+
def self.new(values = {}); end
|
47
45
|
end
|
48
46
|
end
|
@@ -11,8 +11,7 @@ module Orb
|
|
11
11
|
)
|
12
12
|
.returns(Orb::Models::Alert)
|
13
13
|
end
|
14
|
-
def retrieve(alert_id, request_options: {})
|
15
|
-
end
|
14
|
+
def retrieve(alert_id, request_options: {}); end
|
16
15
|
|
17
16
|
# This endpoint updates the thresholds of an alert.
|
18
17
|
sig do
|
@@ -28,20 +27,18 @@ module Orb
|
|
28
27
|
# The thresholds that define the values at which the alert will be triggered.
|
29
28
|
thresholds:,
|
30
29
|
request_options: {}
|
31
|
-
)
|
32
|
-
end
|
33
|
-
|
30
|
+
); end
|
34
31
|
# This endpoint returns a list of alerts within Orb.
|
35
32
|
#
|
36
|
-
#
|
37
|
-
#
|
33
|
+
# The request must specify one of `customer_id`, `external_customer_id`, or
|
34
|
+
# `subscription_id`.
|
38
35
|
#
|
39
|
-
#
|
40
|
-
#
|
36
|
+
# If querying by subscripion_id, the endpoint will return the subscription level
|
37
|
+
# alerts as well as the plan level alerts associated with the subscription.
|
41
38
|
#
|
42
|
-
#
|
43
|
-
#
|
44
|
-
#
|
39
|
+
# The list of alerts is ordered starting from the most recently created alert.
|
40
|
+
# This endpoint follows Orb's
|
41
|
+
# [standardized pagination format](/api-reference/pagination).
|
45
42
|
sig do
|
46
43
|
params(
|
47
44
|
created_at_gt: T.nilable(Time),
|
@@ -63,7 +60,7 @@ module Orb
|
|
63
60
|
created_at_lt: nil,
|
64
61
|
created_at_lte: nil,
|
65
62
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
66
|
-
#
|
63
|
+
# from the initial request.
|
67
64
|
cursor: nil,
|
68
65
|
# Fetch alerts scoped to this customer_id
|
69
66
|
customer_id: nil,
|
@@ -74,17 +71,15 @@ module Orb
|
|
74
71
|
# Fetch alerts scoped to this subscription_id
|
75
72
|
subscription_id: nil,
|
76
73
|
request_options: {}
|
77
|
-
)
|
78
|
-
end
|
79
|
-
|
74
|
+
); end
|
80
75
|
# This endpoint creates a new alert to monitor a customer's credit balance. There
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
76
|
+
# are three types of alerts that can be scoped to customers:
|
77
|
+
# `credit_balance_depleted`, `credit_balance_dropped`, and
|
78
|
+
# `credit_balance_recovered`. Customers can have a maximum of one of each type of
|
79
|
+
# alert per [credit balance currency](/product-catalog/prepurchase).
|
80
|
+
# `credit_balance_dropped` alerts require a list of thresholds to be provided
|
81
|
+
# while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
|
82
|
+
# require thresholds.
|
88
83
|
sig do
|
89
84
|
params(
|
90
85
|
customer_id: String,
|
@@ -104,17 +99,15 @@ module Orb
|
|
104
99
|
# The thresholds that define the values at which the alert will be triggered.
|
105
100
|
thresholds: nil,
|
106
101
|
request_options: {}
|
107
|
-
)
|
108
|
-
end
|
109
|
-
|
102
|
+
); end
|
110
103
|
# This endpoint creates a new alert to monitor a customer's credit balance. There
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
#
|
104
|
+
# are three types of alerts that can be scoped to customers:
|
105
|
+
# `credit_balance_depleted`, `credit_balance_dropped`, and
|
106
|
+
# `credit_balance_recovered`. Customers can have a maximum of one of each type of
|
107
|
+
# alert per [credit balance currency](/product-catalog/prepurchase).
|
108
|
+
# `credit_balance_dropped` alerts require a list of thresholds to be provided
|
109
|
+
# while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
|
110
|
+
# require thresholds.
|
118
111
|
sig do
|
119
112
|
params(
|
120
113
|
external_customer_id: String,
|
@@ -136,20 +129,18 @@ module Orb
|
|
136
129
|
# The thresholds that define the values at which the alert will be triggered.
|
137
130
|
thresholds: nil,
|
138
131
|
request_options: {}
|
139
|
-
)
|
140
|
-
end
|
141
|
-
|
132
|
+
); end
|
142
133
|
# This endpoint is used to create alerts at the subscription level.
|
143
134
|
#
|
144
|
-
#
|
145
|
-
#
|
146
|
-
#
|
147
|
-
#
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
135
|
+
# Subscription level alerts can be one of two types: `usage_exceeded` or
|
136
|
+
# `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and
|
137
|
+
# is triggered when the usage of that metric exceeds predefined thresholds during
|
138
|
+
# the current billing cycle. A `cost_exceeded` alert is triggered when the total
|
139
|
+
# amount due during the current billing cycle surpasses predefined thresholds.
|
140
|
+
# `cost_exceeded` alerts do not include burndown of pre-purchase credits. Each
|
141
|
+
# subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
|
142
|
+
# per metric that is a part of the subscription. Alerts are triggered based on
|
143
|
+
# usage or cost conditions met during the current billing cycle.
|
153
144
|
sig do
|
154
145
|
params(
|
155
146
|
subscription_id: String,
|
@@ -169,12 +160,10 @@ module Orb
|
|
169
160
|
# The metric to track usage for.
|
170
161
|
metric_id: nil,
|
171
162
|
request_options: {}
|
172
|
-
)
|
173
|
-
end
|
174
|
-
|
163
|
+
); end
|
175
164
|
# This endpoint allows you to disable an alert. To disable a plan-level alert for
|
176
|
-
#
|
177
|
-
#
|
165
|
+
# a specific subscription, you must include the `subscription_id`. The
|
166
|
+
# `subscription_id` is not required for customer or subscription level alerts.
|
178
167
|
sig do
|
179
168
|
params(
|
180
169
|
alert_configuration_id: String,
|
@@ -188,12 +177,10 @@ module Orb
|
|
188
177
|
# Used to update the status of a plan alert scoped to this subscription_id
|
189
178
|
subscription_id: nil,
|
190
179
|
request_options: {}
|
191
|
-
)
|
192
|
-
end
|
193
|
-
|
180
|
+
); end
|
194
181
|
# This endpoint allows you to enable an alert. To enable a plan-level alert for a
|
195
|
-
#
|
196
|
-
#
|
182
|
+
# specific subscription, you must include the `subscription_id`. The
|
183
|
+
# `subscription_id` is not required for customer or subscription level alerts.
|
197
184
|
sig do
|
198
185
|
params(
|
199
186
|
alert_configuration_id: String,
|
@@ -207,13 +194,10 @@ module Orb
|
|
207
194
|
# Used to update the status of a plan alert scoped to this subscription_id
|
208
195
|
subscription_id: nil,
|
209
196
|
request_options: {}
|
210
|
-
)
|
211
|
-
end
|
212
|
-
|
197
|
+
); end
|
213
198
|
# @api private
|
214
199
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
215
|
-
def self.new(client:)
|
216
|
-
end
|
200
|
+
def self.new(client:); end
|
217
201
|
end
|
218
202
|
end
|
219
203
|
end
|
@@ -5,9 +5,9 @@ module Orb
|
|
5
5
|
class Coupons
|
6
6
|
class Subscriptions
|
7
7
|
# This endpoint returns a list of all subscriptions that have redeemed a given
|
8
|
-
#
|
9
|
-
#
|
10
|
-
#
|
8
|
+
# coupon as a [paginated](/api-reference/pagination) list, ordered starting from
|
9
|
+
# the most recently created subscription. For a full discussion of the
|
10
|
+
# subscription resource, see [Subscription](/core-concepts#subscription).
|
11
11
|
sig do
|
12
12
|
params(
|
13
13
|
coupon_id: String,
|
@@ -20,18 +20,15 @@ module Orb
|
|
20
20
|
def list(
|
21
21
|
coupon_id,
|
22
22
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
23
|
-
#
|
23
|
+
# from the initial request.
|
24
24
|
cursor: nil,
|
25
25
|
# The number of items to fetch. Defaults to 20.
|
26
26
|
limit: nil,
|
27
27
|
request_options: {}
|
28
|
-
)
|
29
|
-
end
|
30
|
-
|
28
|
+
); end
|
31
29
|
# @api private
|
32
30
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
33
|
-
def self.new(client:)
|
34
|
-
end
|
31
|
+
def self.new(client:); end
|
35
32
|
end
|
36
33
|
end
|
37
34
|
end
|