orb-billing 0.3.1 → 0.4.0
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 +35 -0
- data/README.md +3 -3
- data/lib/orb/errors.rb +1 -1
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/transport/base_client.rb +74 -5
- data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/orb/internal/type/array_of.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +62 -30
- data/lib/orb/internal/type/converter.rb +18 -0
- data/lib/orb/internal/type/enum.rb +4 -3
- data/lib/orb/internal/type/hash_of.rb +1 -1
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +5 -4
- data/lib/orb/internal/util.rb +57 -1
- data/lib/orb/internal.rb +6 -0
- 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 +13 -12
- data/lib/orb/models/coupon_create_params.rb +12 -8
- 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 +50 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
- data/lib/orb/models/customer_update_params.rb +50 -51
- 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 +14 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +14 -7
- 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 +14 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -7
- 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 +11 -5
- data/lib/orb/models/evaluate_price_group.rb +5 -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 +179 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +8 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +28 -26
- 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 +90 -103
- data/lib/orb/models/plan_create_params.rb +759 -800
- 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 +1706 -1724
- 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 +108 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +43 -57
- data/lib/orb/models/subscription_change_apply_response.rb +43 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
- data/lib/orb/models/subscription_create_params.rb +1953 -1815
- data/lib/orb/models/subscription_create_response.rb +43 -57
- 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 +1194 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +43 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +8 -6
- data/lib/orb/models/subscription_update_trial_response.rb +43 -57
- data/lib/orb/models/subscription_usage.rb +55 -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 +24 -0
- data/lib/orb/request_options.rb +4 -0
- 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 +14 -33
- 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 +3 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +20 -6
- data/rbi/orb/internal/transport/base_client.rbi +159 -78
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +144 -69
- data/rbi/orb/internal/type/base_page.rbi +12 -8
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +68 -31
- data/rbi/orb/internal/type/enum.rbi +28 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +61 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +232 -90
- data/rbi/orb/internal.rbi +2 -0
- data/rbi/orb/models/alert.rbi +114 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
- data/rbi/orb/models/alert_disable_params.rbi +18 -6
- data/rbi/orb/models/alert_enable_params.rbi +18 -6
- data/rbi/orb/models/alert_list_params.rbi +24 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
- data/rbi/orb/models/alert_update_params.rbi +29 -14
- data/rbi/orb/models/amount_discount.rbi +29 -19
- data/rbi/orb/models/billable_metric.rbi +34 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +11 -4
- data/rbi/orb/models/coupon_create_params.rbi +85 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
- data/rbi/orb/models/coupon_list_params.rbi +19 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
- data/rbi/orb/models/credit_note.rbi +329 -158
- data/rbi/orb/models/credit_note_create_params.rbi +64 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
- data/rbi/orb/models/credit_note_list_params.rbi +23 -17
- data/rbi/orb/models/customer.rbi +461 -329
- data/rbi/orb/models/customer_create_params.rbi +713 -325
- data/rbi/orb/models/customer_delete_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_params.rbi +11 -4
- data/rbi/orb/models/customer_list_params.rbi +21 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
- data/rbi/orb/models/customer_update_params.rbi +712 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
- data/rbi/orb/models/dimensional_price_group.rbi +21 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
- data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +29 -12
- data/rbi/orb/models/event_deprecate_params.rbi +13 -4
- data/rbi/orb/models/event_deprecate_response.rbi +11 -3
- data/rbi/orb/models/event_ingest_params.rbi +41 -31
- data/rbi/orb/models/event_ingest_response.rbi +78 -23
- data/rbi/orb/models/event_search_params.rbi +18 -14
- data/rbi/orb/models/event_search_response.rbi +42 -21
- data/rbi/orb/models/event_update_params.rbi +20 -16
- data/rbi/orb/models/event_update_response.rbi +11 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
- data/rbi/orb/models/events/event_volumes.rbi +38 -10
- data/rbi/orb/models/events/volume_list_params.rbi +21 -15
- data/rbi/orb/models/invoice.rbi +1411 -805
- data/rbi/orb/models/invoice_create_params.rbi +107 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
- data/rbi/orb/models/invoice_issue_params.rbi +17 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
- data/rbi/orb/models/invoice_list_params.rbi +68 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
- data/rbi/orb/models/invoice_pay_params.rbi +11 -4
- data/rbi/orb/models/invoice_update_params.rbi +16 -10
- data/rbi/orb/models/invoice_void_params.rbi +11 -4
- data/rbi/orb/models/item.rbi +90 -39
- data/rbi/orb/models/item_create_params.rbi +15 -5
- data/rbi/orb/models/item_fetch_params.rbi +11 -4
- data/rbi/orb/models/item_list_params.rbi +17 -6
- data/rbi/orb/models/item_update_params.rbi +86 -39
- data/rbi/orb/models/metric_create_params.rbi +20 -16
- data/rbi/orb/models/metric_fetch_params.rbi +11 -4
- data/rbi/orb/models/metric_list_params.rbi +21 -17
- data/rbi/orb/models/metric_update_params.rbi +16 -10
- data/rbi/orb/models/pagination_metadata.rbi +17 -4
- data/rbi/orb/models/percentage_discount.rbi +33 -19
- data/rbi/orb/models/plan.rbi +532 -365
- data/rbi/orb/models/plan_create_params.rbi +5295 -2870
- data/rbi/orb/models/plan_fetch_params.rbi +11 -4
- data/rbi/orb/models/plan_list_params.rbi +35 -27
- data/rbi/orb/models/plan_update_params.rbi +17 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
- data/rbi/orb/models/price.rbi +11332 -5033
- data/rbi/orb/models/price_create_params.rbi +583 -245
- data/rbi/orb/models/price_evaluate_params.rbi +21 -17
- data/rbi/orb/models/price_evaluate_response.rbi +14 -6
- data/rbi/orb/models/price_fetch_params.rbi +11 -4
- data/rbi/orb/models/price_list_params.rbi +17 -6
- data/rbi/orb/models/price_update_params.rbi +16 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
- data/rbi/orb/models/subscription.rbi +668 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
- data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
- data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
- data/rbi/orb/models/subscription_create_response.rbi +817 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
- data/rbi/orb/models/subscription_list_params.rbi +42 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
- data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
- data/rbi/orb/models/subscription_update_params.rbi +22 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
- data/rbi/orb/models/subscription_usage.rbi +325 -121
- data/rbi/orb/models/subscriptions.rbi +19 -11
- data/rbi/orb/models/top_level_ping_params.rbi +11 -4
- data/rbi/orb/models/top_level_ping_response.rbi +10 -3
- data/rbi/orb/models/trial_discount.rbi +30 -20
- data/rbi/orb/models/usage_discount.rbi +29 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/transport/base_client.rbs +16 -1
- data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +11 -5
- data/sig/orb/internal/type/base_page.rbs +1 -1
- data/sig/orb/internal/type/converter.rbs +2 -0
- data/sig/orb/internal/type/enum.rbs +1 -0
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/type/union.rbs +1 -0
- data/sig/orb/internal/util.rbs +13 -0
- data/sig/orb/internal.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 +3 -9
- 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 +32 -52
- 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 +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- 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 +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- 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 +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- 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 +110 -172
- 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 +2 -64
- 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 +2 -36
- 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 +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- 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 +1194 -1730
- 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 +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- 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 +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- 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 +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- 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 +20 -60
- 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/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 +2 -2
data/rbi/orb/models/alert.rbi
CHANGED
@@ -3,6 +3,8 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class Alert < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash = T.type_alias { T.any(Orb::Alert, Orb::Internal::AnyHash) }
|
7
|
+
|
6
8
|
# Also referred to as alert_id in this documentation.
|
7
9
|
sig { returns(String) }
|
8
10
|
attr_accessor :id
|
@@ -16,10 +18,10 @@ module Orb
|
|
16
18
|
attr_accessor :currency
|
17
19
|
|
18
20
|
# The customer the alert applies to.
|
19
|
-
sig { returns(T.nilable(Orb::
|
21
|
+
sig { returns(T.nilable(Orb::Alert::Customer)) }
|
20
22
|
attr_reader :customer
|
21
23
|
|
22
|
-
sig { params(customer: T.nilable(
|
24
|
+
sig { params(customer: T.nilable(Orb::Alert::Customer::OrHash)).void }
|
23
25
|
attr_writer :customer
|
24
26
|
|
25
27
|
# Whether the alert is enabled or disabled.
|
@@ -27,33 +29,35 @@ module Orb
|
|
27
29
|
attr_accessor :enabled
|
28
30
|
|
29
31
|
# The metric the alert applies to.
|
30
|
-
sig { returns(T.nilable(Orb::
|
32
|
+
sig { returns(T.nilable(Orb::Alert::Metric)) }
|
31
33
|
attr_reader :metric
|
32
34
|
|
33
|
-
sig { params(metric: T.nilable(
|
35
|
+
sig { params(metric: T.nilable(Orb::Alert::Metric::OrHash)).void }
|
34
36
|
attr_writer :metric
|
35
37
|
|
36
38
|
# The plan the alert applies to.
|
37
|
-
sig { returns(T.nilable(Orb::
|
39
|
+
sig { returns(T.nilable(Orb::Alert::Plan)) }
|
38
40
|
attr_reader :plan
|
39
41
|
|
40
|
-
sig { params(plan: T.nilable(
|
42
|
+
sig { params(plan: T.nilable(Orb::Alert::Plan::OrHash)).void }
|
41
43
|
attr_writer :plan
|
42
44
|
|
43
45
|
# The subscription the alert applies to.
|
44
|
-
sig { returns(T.nilable(Orb::
|
46
|
+
sig { returns(T.nilable(Orb::Alert::Subscription)) }
|
45
47
|
attr_reader :subscription
|
46
48
|
|
47
|
-
sig
|
49
|
+
sig do
|
50
|
+
params(subscription: T.nilable(Orb::Alert::Subscription::OrHash)).void
|
51
|
+
end
|
48
52
|
attr_writer :subscription
|
49
53
|
|
50
54
|
# The thresholds that define the conditions under which the alert will be
|
51
55
|
# triggered.
|
52
|
-
sig { returns(T.nilable(T::Array[Orb::
|
56
|
+
sig { returns(T.nilable(T::Array[Orb::Alert::Threshold])) }
|
53
57
|
attr_accessor :thresholds
|
54
58
|
|
55
59
|
# The type of alert. This must be a valid alert type.
|
56
|
-
sig { returns(Orb::
|
60
|
+
sig { returns(Orb::Alert::Type::TaggedSymbol) }
|
57
61
|
attr_accessor :type
|
58
62
|
|
59
63
|
# [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
|
@@ -66,15 +70,14 @@ module Orb
|
|
66
70
|
id: String,
|
67
71
|
created_at: Time,
|
68
72
|
currency: T.nilable(String),
|
69
|
-
customer: T.nilable(
|
73
|
+
customer: T.nilable(Orb::Alert::Customer::OrHash),
|
70
74
|
enabled: T::Boolean,
|
71
|
-
metric: T.nilable(
|
72
|
-
plan: T.nilable(
|
73
|
-
subscription: T.nilable(
|
74
|
-
thresholds: T.nilable(T::Array[
|
75
|
-
type: Orb::
|
76
|
-
)
|
77
|
-
.returns(T.attached_class)
|
75
|
+
metric: T.nilable(Orb::Alert::Metric::OrHash),
|
76
|
+
plan: T.nilable(Orb::Alert::Plan::OrHash),
|
77
|
+
subscription: T.nilable(Orb::Alert::Subscription::OrHash),
|
78
|
+
thresholds: T.nilable(T::Array[Orb::Alert::Threshold::OrHash]),
|
79
|
+
type: Orb::Alert::Type::OrSymbol
|
80
|
+
).returns(T.attached_class)
|
78
81
|
end
|
79
82
|
def self.new(
|
80
83
|
# Also referred to as alert_id in this documentation.
|
@@ -98,27 +101,32 @@ module Orb
|
|
98
101
|
thresholds:,
|
99
102
|
# The type of alert. This must be a valid alert type.
|
100
103
|
type:
|
101
|
-
)
|
104
|
+
)
|
105
|
+
end
|
106
|
+
|
102
107
|
sig do
|
103
|
-
override
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
108
|
+
override.returns(
|
109
|
+
{
|
110
|
+
id: String,
|
111
|
+
created_at: Time,
|
112
|
+
currency: T.nilable(String),
|
113
|
+
customer: T.nilable(Orb::Alert::Customer),
|
114
|
+
enabled: T::Boolean,
|
115
|
+
metric: T.nilable(Orb::Alert::Metric),
|
116
|
+
plan: T.nilable(Orb::Alert::Plan),
|
117
|
+
subscription: T.nilable(Orb::Alert::Subscription),
|
118
|
+
thresholds: T.nilable(T::Array[Orb::Alert::Threshold]),
|
119
|
+
type: Orb::Alert::Type::TaggedSymbol
|
120
|
+
}
|
121
|
+
)
|
122
|
+
end
|
123
|
+
def to_hash
|
118
124
|
end
|
119
|
-
def to_hash; end
|
120
125
|
|
121
126
|
class Customer < Orb::Internal::Type::BaseModel
|
127
|
+
OrHash =
|
128
|
+
T.type_alias { T.any(Orb::Alert::Customer, Orb::Internal::AnyHash) }
|
129
|
+
|
122
130
|
sig { returns(String) }
|
123
131
|
attr_accessor :id
|
124
132
|
|
@@ -126,26 +134,44 @@ module Orb
|
|
126
134
|
attr_accessor :external_customer_id
|
127
135
|
|
128
136
|
# The customer the alert applies to.
|
129
|
-
sig
|
130
|
-
|
137
|
+
sig do
|
138
|
+
params(id: String, external_customer_id: T.nilable(String)).returns(
|
139
|
+
T.attached_class
|
140
|
+
)
|
141
|
+
end
|
142
|
+
def self.new(id:, external_customer_id:)
|
143
|
+
end
|
131
144
|
|
132
|
-
sig
|
133
|
-
|
145
|
+
sig do
|
146
|
+
override.returns(
|
147
|
+
{ id: String, external_customer_id: T.nilable(String) }
|
148
|
+
)
|
149
|
+
end
|
150
|
+
def to_hash
|
151
|
+
end
|
134
152
|
end
|
135
153
|
|
136
154
|
class Metric < Orb::Internal::Type::BaseModel
|
155
|
+
OrHash =
|
156
|
+
T.type_alias { T.any(Orb::Alert::Metric, Orb::Internal::AnyHash) }
|
157
|
+
|
137
158
|
sig { returns(String) }
|
138
159
|
attr_accessor :id
|
139
160
|
|
140
161
|
# The metric the alert applies to.
|
141
162
|
sig { params(id: String).returns(T.attached_class) }
|
142
|
-
def self.new(id:)
|
163
|
+
def self.new(id:)
|
164
|
+
end
|
143
165
|
|
144
|
-
sig { override.returns({id: String}) }
|
145
|
-
def to_hash
|
166
|
+
sig { override.returns({ id: String }) }
|
167
|
+
def to_hash
|
168
|
+
end
|
146
169
|
end
|
147
170
|
|
148
171
|
class Plan < Orb::Internal::Type::BaseModel
|
172
|
+
OrHash =
|
173
|
+
T.type_alias { T.any(Orb::Alert::Plan, Orb::Internal::AnyHash) }
|
174
|
+
|
149
175
|
sig { returns(T.nilable(String)) }
|
150
176
|
attr_accessor :id
|
151
177
|
|
@@ -168,8 +194,7 @@ module Orb
|
|
168
194
|
external_plan_id: T.nilable(String),
|
169
195
|
name: T.nilable(String),
|
170
196
|
plan_version: String
|
171
|
-
)
|
172
|
-
.returns(T.attached_class)
|
197
|
+
).returns(T.attached_class)
|
173
198
|
end
|
174
199
|
def self.new(
|
175
200
|
id:,
|
@@ -179,34 +204,46 @@ module Orb
|
|
179
204
|
external_plan_id:,
|
180
205
|
name:,
|
181
206
|
plan_version:
|
182
|
-
)
|
207
|
+
)
|
208
|
+
end
|
209
|
+
|
183
210
|
sig do
|
184
|
-
override
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
211
|
+
override.returns(
|
212
|
+
{
|
213
|
+
id: T.nilable(String),
|
214
|
+
external_plan_id: T.nilable(String),
|
215
|
+
name: T.nilable(String),
|
216
|
+
plan_version: String
|
217
|
+
}
|
218
|
+
)
|
219
|
+
end
|
220
|
+
def to_hash
|
193
221
|
end
|
194
|
-
def to_hash; end
|
195
222
|
end
|
196
223
|
|
197
224
|
class Subscription < Orb::Internal::Type::BaseModel
|
225
|
+
OrHash =
|
226
|
+
T.type_alias do
|
227
|
+
T.any(Orb::Alert::Subscription, Orb::Internal::AnyHash)
|
228
|
+
end
|
229
|
+
|
198
230
|
sig { returns(String) }
|
199
231
|
attr_accessor :id
|
200
232
|
|
201
233
|
# The subscription the alert applies to.
|
202
234
|
sig { params(id: String).returns(T.attached_class) }
|
203
|
-
def self.new(id:)
|
235
|
+
def self.new(id:)
|
236
|
+
end
|
204
237
|
|
205
|
-
sig { override.returns({id: String}) }
|
206
|
-
def to_hash
|
238
|
+
sig { override.returns({ id: String }) }
|
239
|
+
def to_hash
|
240
|
+
end
|
207
241
|
end
|
208
242
|
|
209
243
|
class Threshold < Orb::Internal::Type::BaseModel
|
244
|
+
OrHash =
|
245
|
+
T.type_alias { T.any(Orb::Alert::Threshold, Orb::Internal::AnyHash) }
|
246
|
+
|
210
247
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
211
248
|
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
212
249
|
# or above this value.
|
@@ -221,26 +258,33 @@ module Orb
|
|
221
258
|
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
222
259
|
# or above this value.
|
223
260
|
value:
|
224
|
-
)
|
225
|
-
|
226
|
-
|
261
|
+
)
|
262
|
+
end
|
263
|
+
|
264
|
+
sig { override.returns({ value: Float }) }
|
265
|
+
def to_hash
|
266
|
+
end
|
227
267
|
end
|
228
268
|
|
229
269
|
# The type of alert. This must be a valid alert type.
|
230
270
|
module Type
|
231
271
|
extend Orb::Internal::Type::Enum
|
232
272
|
|
233
|
-
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::
|
273
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Alert::Type) }
|
234
274
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
235
275
|
|
236
|
-
CREDIT_BALANCE_DEPLETED =
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
|
276
|
+
CREDIT_BALANCE_DEPLETED =
|
277
|
+
T.let(:credit_balance_depleted, Orb::Alert::Type::TaggedSymbol)
|
278
|
+
CREDIT_BALANCE_DROPPED =
|
279
|
+
T.let(:credit_balance_dropped, Orb::Alert::Type::TaggedSymbol)
|
280
|
+
CREDIT_BALANCE_RECOVERED =
|
281
|
+
T.let(:credit_balance_recovered, Orb::Alert::Type::TaggedSymbol)
|
282
|
+
USAGE_EXCEEDED = T.let(:usage_exceeded, Orb::Alert::Type::TaggedSymbol)
|
283
|
+
COST_EXCEEDED = T.let(:cost_exceeded, Orb::Alert::Type::TaggedSymbol)
|
284
|
+
|
285
|
+
sig { override.returns(T::Array[Orb::Alert::Type::TaggedSymbol]) }
|
286
|
+
def self.values
|
287
|
+
end
|
244
288
|
end
|
245
289
|
end
|
246
290
|
end
|
@@ -6,26 +6,37 @@ module Orb
|
|
6
6
|
extend Orb::Internal::Type::RequestParameters::Converter
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
|
+
OrHash =
|
10
|
+
T.type_alias do
|
11
|
+
T.any(Orb::AlertCreateForCustomerParams, Orb::Internal::AnyHash)
|
12
|
+
end
|
13
|
+
|
9
14
|
# The case sensitive currency or custom pricing unit to use for this alert.
|
10
15
|
sig { returns(String) }
|
11
16
|
attr_accessor :currency
|
12
17
|
|
13
18
|
# The type of alert to create. This must be a valid alert type.
|
14
|
-
sig { returns(Orb::
|
19
|
+
sig { returns(Orb::AlertCreateForCustomerParams::Type::OrSymbol) }
|
15
20
|
attr_accessor :type
|
16
21
|
|
17
22
|
# The thresholds that define the values at which the alert will be triggered.
|
18
|
-
sig
|
23
|
+
sig do
|
24
|
+
returns(
|
25
|
+
T.nilable(T::Array[Orb::AlertCreateForCustomerParams::Threshold])
|
26
|
+
)
|
27
|
+
end
|
19
28
|
attr_accessor :thresholds
|
20
29
|
|
21
30
|
sig do
|
22
31
|
params(
|
23
32
|
currency: String,
|
24
|
-
type: Orb::
|
25
|
-
thresholds:
|
26
|
-
|
27
|
-
|
28
|
-
|
33
|
+
type: Orb::AlertCreateForCustomerParams::Type::OrSymbol,
|
34
|
+
thresholds:
|
35
|
+
T.nilable(
|
36
|
+
T::Array[Orb::AlertCreateForCustomerParams::Threshold::OrHash]
|
37
|
+
),
|
38
|
+
request_options: Orb::RequestOptions::OrHash
|
39
|
+
).returns(T.attached_class)
|
29
40
|
end
|
30
41
|
def self.new(
|
31
42
|
# The case sensitive currency or custom pricing unit to use for this alert.
|
@@ -35,39 +46,67 @@ module Orb
|
|
35
46
|
# The thresholds that define the values at which the alert will be triggered.
|
36
47
|
thresholds: nil,
|
37
48
|
request_options: {}
|
38
|
-
)
|
49
|
+
)
|
50
|
+
end
|
51
|
+
|
39
52
|
sig do
|
40
|
-
override
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
53
|
+
override.returns(
|
54
|
+
{
|
55
|
+
currency: String,
|
56
|
+
type: Orb::AlertCreateForCustomerParams::Type::OrSymbol,
|
57
|
+
thresholds:
|
58
|
+
T.nilable(T::Array[Orb::AlertCreateForCustomerParams::Threshold]),
|
59
|
+
request_options: Orb::RequestOptions
|
60
|
+
}
|
61
|
+
)
|
62
|
+
end
|
63
|
+
def to_hash
|
49
64
|
end
|
50
|
-
def to_hash; end
|
51
65
|
|
52
66
|
# The type of alert to create. This must be a valid alert type.
|
53
67
|
module Type
|
54
68
|
extend Orb::Internal::Type::Enum
|
55
69
|
|
56
|
-
TaggedSymbol =
|
70
|
+
TaggedSymbol =
|
71
|
+
T.type_alias do
|
72
|
+
T.all(Symbol, Orb::AlertCreateForCustomerParams::Type)
|
73
|
+
end
|
57
74
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
58
75
|
|
59
76
|
CREDIT_BALANCE_DEPLETED =
|
60
|
-
T.let(
|
77
|
+
T.let(
|
78
|
+
:credit_balance_depleted,
|
79
|
+
Orb::AlertCreateForCustomerParams::Type::TaggedSymbol
|
80
|
+
)
|
61
81
|
CREDIT_BALANCE_DROPPED =
|
62
|
-
T.let(
|
82
|
+
T.let(
|
83
|
+
:credit_balance_dropped,
|
84
|
+
Orb::AlertCreateForCustomerParams::Type::TaggedSymbol
|
85
|
+
)
|
63
86
|
CREDIT_BALANCE_RECOVERED =
|
64
|
-
T.let(
|
87
|
+
T.let(
|
88
|
+
:credit_balance_recovered,
|
89
|
+
Orb::AlertCreateForCustomerParams::Type::TaggedSymbol
|
90
|
+
)
|
65
91
|
|
66
|
-
sig
|
67
|
-
|
92
|
+
sig do
|
93
|
+
override.returns(
|
94
|
+
T::Array[Orb::AlertCreateForCustomerParams::Type::TaggedSymbol]
|
95
|
+
)
|
96
|
+
end
|
97
|
+
def self.values
|
98
|
+
end
|
68
99
|
end
|
69
100
|
|
70
101
|
class Threshold < Orb::Internal::Type::BaseModel
|
102
|
+
OrHash =
|
103
|
+
T.type_alias do
|
104
|
+
T.any(
|
105
|
+
Orb::AlertCreateForCustomerParams::Threshold,
|
106
|
+
Orb::Internal::AnyHash
|
107
|
+
)
|
108
|
+
end
|
109
|
+
|
71
110
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
72
111
|
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
73
112
|
# or above this value.
|
@@ -82,9 +121,12 @@ module Orb
|
|
82
121
|
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
83
122
|
# or above this value.
|
84
123
|
value:
|
85
|
-
)
|
86
|
-
|
87
|
-
|
124
|
+
)
|
125
|
+
end
|
126
|
+
|
127
|
+
sig { override.returns({ value: Float }) }
|
128
|
+
def to_hash
|
129
|
+
end
|
88
130
|
end
|
89
131
|
end
|
90
132
|
end
|
@@ -6,28 +6,44 @@ module Orb
|
|
6
6
|
extend Orb::Internal::Type::RequestParameters::Converter
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
|
+
OrHash =
|
10
|
+
T.type_alias do
|
11
|
+
T.any(
|
12
|
+
Orb::AlertCreateForExternalCustomerParams,
|
13
|
+
Orb::Internal::AnyHash
|
14
|
+
)
|
15
|
+
end
|
16
|
+
|
9
17
|
# The case sensitive currency or custom pricing unit to use for this alert.
|
10
18
|
sig { returns(String) }
|
11
19
|
attr_accessor :currency
|
12
20
|
|
13
21
|
# The type of alert to create. This must be a valid alert type.
|
14
|
-
sig { returns(Orb::
|
22
|
+
sig { returns(Orb::AlertCreateForExternalCustomerParams::Type::OrSymbol) }
|
15
23
|
attr_accessor :type
|
16
24
|
|
17
25
|
# The thresholds that define the values at which the alert will be triggered.
|
18
|
-
sig
|
26
|
+
sig do
|
27
|
+
returns(
|
28
|
+
T.nilable(
|
29
|
+
T::Array[Orb::AlertCreateForExternalCustomerParams::Threshold]
|
30
|
+
)
|
31
|
+
)
|
32
|
+
end
|
19
33
|
attr_accessor :thresholds
|
20
34
|
|
21
35
|
sig do
|
22
36
|
params(
|
23
37
|
currency: String,
|
24
|
-
type: Orb::
|
25
|
-
thresholds:
|
26
|
-
T
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
38
|
+
type: Orb::AlertCreateForExternalCustomerParams::Type::OrSymbol,
|
39
|
+
thresholds:
|
40
|
+
T.nilable(
|
41
|
+
T::Array[
|
42
|
+
Orb::AlertCreateForExternalCustomerParams::Threshold::OrHash
|
43
|
+
]
|
44
|
+
),
|
45
|
+
request_options: Orb::RequestOptions::OrHash
|
46
|
+
).returns(T.attached_class)
|
31
47
|
end
|
32
48
|
def self.new(
|
33
49
|
# The case sensitive currency or custom pricing unit to use for this alert.
|
@@ -37,39 +53,71 @@ module Orb
|
|
37
53
|
# The thresholds that define the values at which the alert will be triggered.
|
38
54
|
thresholds: nil,
|
39
55
|
request_options: {}
|
40
|
-
)
|
56
|
+
)
|
57
|
+
end
|
58
|
+
|
41
59
|
sig do
|
42
|
-
override
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
60
|
+
override.returns(
|
61
|
+
{
|
62
|
+
currency: String,
|
63
|
+
type: Orb::AlertCreateForExternalCustomerParams::Type::OrSymbol,
|
64
|
+
thresholds:
|
65
|
+
T.nilable(
|
66
|
+
T::Array[Orb::AlertCreateForExternalCustomerParams::Threshold]
|
67
|
+
),
|
68
|
+
request_options: Orb::RequestOptions
|
69
|
+
}
|
70
|
+
)
|
71
|
+
end
|
72
|
+
def to_hash
|
51
73
|
end
|
52
|
-
def to_hash; end
|
53
74
|
|
54
75
|
# The type of alert to create. This must be a valid alert type.
|
55
76
|
module Type
|
56
77
|
extend Orb::Internal::Type::Enum
|
57
78
|
|
58
|
-
TaggedSymbol =
|
79
|
+
TaggedSymbol =
|
80
|
+
T.type_alias do
|
81
|
+
T.all(Symbol, Orb::AlertCreateForExternalCustomerParams::Type)
|
82
|
+
end
|
59
83
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
60
84
|
|
61
85
|
CREDIT_BALANCE_DEPLETED =
|
62
|
-
T.let(
|
86
|
+
T.let(
|
87
|
+
:credit_balance_depleted,
|
88
|
+
Orb::AlertCreateForExternalCustomerParams::Type::TaggedSymbol
|
89
|
+
)
|
63
90
|
CREDIT_BALANCE_DROPPED =
|
64
|
-
T.let(
|
91
|
+
T.let(
|
92
|
+
:credit_balance_dropped,
|
93
|
+
Orb::AlertCreateForExternalCustomerParams::Type::TaggedSymbol
|
94
|
+
)
|
65
95
|
CREDIT_BALANCE_RECOVERED =
|
66
|
-
T.let(
|
96
|
+
T.let(
|
97
|
+
:credit_balance_recovered,
|
98
|
+
Orb::AlertCreateForExternalCustomerParams::Type::TaggedSymbol
|
99
|
+
)
|
67
100
|
|
68
|
-
sig
|
69
|
-
|
101
|
+
sig do
|
102
|
+
override.returns(
|
103
|
+
T::Array[
|
104
|
+
Orb::AlertCreateForExternalCustomerParams::Type::TaggedSymbol
|
105
|
+
]
|
106
|
+
)
|
107
|
+
end
|
108
|
+
def self.values
|
109
|
+
end
|
70
110
|
end
|
71
111
|
|
72
112
|
class Threshold < Orb::Internal::Type::BaseModel
|
113
|
+
OrHash =
|
114
|
+
T.type_alias do
|
115
|
+
T.any(
|
116
|
+
Orb::AlertCreateForExternalCustomerParams::Threshold,
|
117
|
+
Orb::Internal::AnyHash
|
118
|
+
)
|
119
|
+
end
|
120
|
+
|
73
121
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
74
122
|
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
75
123
|
# or above this value.
|
@@ -84,9 +132,12 @@ module Orb
|
|
84
132
|
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
85
133
|
# or above this value.
|
86
134
|
value:
|
87
|
-
)
|
88
|
-
|
89
|
-
|
135
|
+
)
|
136
|
+
end
|
137
|
+
|
138
|
+
sig { override.returns({ value: Float }) }
|
139
|
+
def to_hash
|
140
|
+
end
|
90
141
|
end
|
91
142
|
end
|
92
143
|
end
|