orb-billing 0.2.0 → 0.3.1

data/lib/orb/models/alert.rb

@@ -65,27 +65,36 @@ module Orb
       #   @return [Symbol, Orb::Models::Alert::Type]
       required :type, enum: -> { Orb::Models::Alert::Type }
 
-      # @!parse
-      #   # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
-      #   # usage, or credit balance and trigger webhooks when a threshold is exceeded.
-      #   #
-      #   # Alerts created through the API can be scoped to either customers or
-      #   # subscriptions.
-      #   #
-      #   # @param id [String]
-      #   # @param created_at [Time]
-      #   # @param currency [String, nil]
-      #   # @param customer [Orb::Models::Alert::Customer, nil]
-      #   # @param enabled [Boolean]
-      #   # @param metric [Orb::Models::Alert::Metric, nil]
-      #   # @param plan [Orb::Models::Alert::Plan, nil]
-      #   # @param subscription [Orb::Models::Alert::Subscription, nil]
-      #   # @param thresholds [Array<Orb::Models::Alert::Threshold>, nil]
-      #   # @param type [Symbol, Orb::Models::Alert::Type]
-      #   #
-      #   def initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:)
+      #   Some parameter documentations has been truncated, see {Orb::Models::Alert} for
+      #   more details.
+      #
+      #   [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
+      #   usage, or credit balance and trigger webhooks when a threshold is exceeded.
+      #
+      #   Alerts created through the API can be scoped to either customers or
+      #   subscriptions.
+      #
+      #   @param id [String] Also referred to as alert_id in this documentation.
+      #
+      #   @param created_at [Time] The creation time of the resource in Orb.
+      #
+      #   @param currency [String, nil] The name of the currency the credit balance or invoice cost is denominated in.
+      #
+      #   @param customer [Orb::Models::Alert::Customer, nil] The customer the alert applies to.
+      #
+      #   @param enabled [Boolean] Whether the alert is enabled or disabled.
+      #
+      #   @param metric [Orb::Models::Alert::Metric, nil] The metric the alert applies to.
+      #
+      #   @param plan [Orb::Models::Alert::Plan, nil] The plan the alert applies to.
+      #
+      #   @param subscription [Orb::Models::Alert::Subscription, nil] The subscription the alert applies to.
+      #
+      #   @param thresholds [Array<Orb::Models::Alert::Threshold>, nil] The thresholds that define the conditions under which the alert will be triggere
+      #   ...
+      #
+      #   @param type [Symbol, Orb::Models::Alert::Type] The type of alert. This must be a valid alert type.
 
       # @see Orb::Models::Alert#customer
       class Customer < Orb::Internal::Type::BaseModel
@@ -99,15 +108,11 @@ module Orb
         #   @return [String, nil]
         required :external_customer_id, String, nil?: true
 
-        # @!parse
-        #   # The customer the alert applies to.
-        #   #
-        #   # @param id [String]
-        #   # @param external_customer_id [String, nil]
-        #   #
-        #   def initialize(id:, external_customer_id:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, external_customer_id:)
+        #   The customer the alert applies to.
+        #
+        #   @param id [String]
+        #   @param external_customer_id [String, nil]
       end
 
       # @see Orb::Models::Alert#metric
@@ -117,14 +122,10 @@ module Orb
         #   @return [String]
         required :id, String
 
-        # @!parse
-        #   # The metric the alert applies to.
-        #   #
-        #   # @param id [String]
-        #   #
-        #   def initialize(id:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:)
+        #   The metric the alert applies to.
+        #
+        #   @param id [String]
       end
 
       # @see Orb::Models::Alert#plan
@@ -152,17 +153,20 @@ module Orb
         #   @return [String]
         required :plan_version, String
 
-        # @!parse
-        #   # The plan the alert applies to.
-        #   #
-        #   # @param id [String, nil]
-        #   # @param external_plan_id [String, nil]
-        #   # @param name [String, nil]
-        #   # @param plan_version [String]
-        #   #
-        #   def initialize(id:, external_plan_id:, name:, plan_version:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, external_plan_id:, name:, plan_version:)
+        #   Some parameter documentations has been truncated, see {Orb::Models::Alert::Plan}
+        #   for more details.
+        #
+        #   The plan the alert applies to.
+        #
+        #   @param id [String, nil]
+        #
+        #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+        #   ...
+        #
+        #   @param name [String, nil]
+        #
+        #   @param plan_version [String]
       end
 
       # @see Orb::Models::Alert#subscription
@@ -172,14 +176,10 @@ module Orb
         #   @return [String]
         required :id, String
 
-        # @!parse
-        #   # The subscription the alert applies to.
-        #   #
-        #   # @param id [String]
-        #   #
-        #   def initialize(id:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:)
+        #   The subscription the alert applies to.
+        #
+        #   @param id [String]
       end
 
       class Threshold < Orb::Internal::Type::BaseModel
@@ -191,15 +191,15 @@ module Orb
         #   @return [Float]
         required :value, Float
 
-        # @!parse
-        #   # Thresholds are used to define the conditions under which an alert will be
-        #   # triggered.
-        #   #
-        #   # @param value [Float]
-        #   #
-        #   def initialize(value:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Alert::Threshold} for more details.
+        #
+        #   Thresholds are used to define the conditions under which an alert will be
+        #   triggered.
+        #
+        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+        #   ...
       end
 
       # The type of alert. This must be a valid alert type.
@@ -214,11 +214,8 @@ module Orb
         USAGE_EXCEEDED = :usage_exceeded
         COST_EXCEEDED = :cost_exceeded
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/orb/models/alert_create_for_customer_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Alerts#create_for_customer
     class AlertCreateForCustomerParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute currency
@@ -28,15 +27,14 @@ module Orb
                -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertCreateForCustomerParams::Threshold] },
                nil?: true
 
-      # @!parse
-      #   # @param currency [String]
-      #   # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type]
-      #   # @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(currency:, type:, thresholds: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
+      #   @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
+      #
+      #   @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
+      #
+      #   @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       # The type of alert to create. This must be a valid alert type.
       module Type
@@ -46,11 +44,8 @@ module Orb
         CREDIT_BALANCE_DROPPED = :credit_balance_dropped
         CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       class Threshold < Orb::Internal::Type::BaseModel
@@ -62,15 +57,15 @@ module Orb
         #   @return [Float]
         required :value, Float
 
-        # @!parse
-        #   # Thresholds are used to define the conditions under which an alert will be
-        #   # triggered.
-        #   #
-        #   # @param value [Float]
-        #   #
-        #   def initialize(value:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::AlertCreateForCustomerParams::Threshold} for more details.
+        #
+        #   Thresholds are used to define the conditions under which an alert will be
+        #   triggered.
+        #
+        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+        #   ...
       end
     end
   end

data/lib/orb/models/alert_create_for_external_customer_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Alerts#create_for_external_customer
     class AlertCreateForExternalCustomerParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute currency
@@ -28,15 +27,14 @@ module Orb
                -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertCreateForExternalCustomerParams::Threshold] },
                nil?: true
 
-      # @!parse
-      #   # @param currency [String]
-      #   # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type]
-      #   # @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(currency:, type:, thresholds: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
+      #   @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
+      #
+      #   @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
+      #
+      #   @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       # The type of alert to create. This must be a valid alert type.
       module Type
@@ -46,11 +44,8 @@ module Orb
         CREDIT_BALANCE_DROPPED = :credit_balance_dropped
         CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       class Threshold < Orb::Internal::Type::BaseModel
@@ -62,15 +57,15 @@ module Orb
         #   @return [Float]
         required :value, Float
 
-        # @!parse
-        #   # Thresholds are used to define the conditions under which an alert will be
-        #   # triggered.
-        #   #
-        #   # @param value [Float]
-        #   #
-        #   def initialize(value:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::AlertCreateForExternalCustomerParams::Threshold} for more details.
+        #
+        #   Thresholds are used to define the conditions under which an alert will be
+        #   triggered.
+        #
+        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+        #   ...
       end
     end
   end

data/lib/orb/models/alert_create_for_subscription_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Alerts#create_for_subscription
     class AlertCreateForSubscriptionParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute thresholds
@@ -27,15 +26,14 @@ module Orb
       #   @return [String, nil]
       optional :metric_id, String, nil?: true
 
-      # @!parse
-      #   # @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>]
-      #   # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type]
-      #   # @param metric_id [String, nil]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(thresholds:, type:, metric_id: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(thresholds:, type:, metric_id: nil, request_options: {})
+      #   @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
+      #
+      #   @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
+      #
+      #   @param metric_id [String, nil] The metric to track usage for.
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       class Threshold < Orb::Internal::Type::BaseModel
         # @!attribute value
@@ -46,15 +44,15 @@ module Orb
         #   @return [Float]
         required :value, Float
 
-        # @!parse
-        #   # Thresholds are used to define the conditions under which an alert will be
-        #   # triggered.
-        #   #
-        #   # @param value [Float]
-        #   #
-        #   def initialize(value:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::AlertCreateForSubscriptionParams::Threshold} for more details.
+        #
+        #   Thresholds are used to define the conditions under which an alert will be
+        #   triggered.
+        #
+        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+        #   ...
       end
 
       # The type of alert to create. This must be a valid alert type.
@@ -64,11 +62,8 @@ module Orb
         USAGE_EXCEEDED = :usage_exceeded
         COST_EXCEEDED = :cost_exceeded
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/orb/models/alert_disable_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Alerts#disable
     class AlertDisableParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute subscription_id
@@ -14,13 +13,10 @@ module Orb
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!parse
-      #   # @param subscription_id [String, nil]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(subscription_id: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(subscription_id: nil, request_options: {})
+      #   @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/orb/models/alert_enable_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Alerts#enable
     class AlertEnableParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute subscription_id
@@ -14,13 +13,10 @@ module Orb
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!parse
-      #   # @param subscription_id [String, nil]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(subscription_id: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(subscription_id: nil, request_options: {})
+      #   @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/orb/models/alert_list_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Alerts#list
     class AlertListParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute created_at_gt
@@ -47,51 +46,42 @@ module Orb
       #   @return [String, nil]
       optional :external_customer_id, String, nil?: true
 
-      # @!attribute [r] limit
+      # @!attribute limit
       #   The number of items to fetch. Defaults to 20.
       #
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :limit
-
       # @!attribute subscription_id
       #   Fetch alerts scoped to this subscription_id
       #
       #   @return [String, nil]
       optional :subscription_id, String, nil?: true
 
-      # @!parse
-      #   # @param created_at_gt [Time, nil]
-      #   # @param created_at_gte [Time, nil]
-      #   # @param created_at_lt [Time, nil]
-      #   # @param created_at_lte [Time, nil]
-      #   # @param cursor [String, nil]
-      #   # @param customer_id [String, nil]
-      #   # @param external_customer_id [String, nil]
-      #   # @param limit [Integer]
-      #   # @param subscription_id [String, nil]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     created_at_gt: nil,
-      #     created_at_gte: nil,
-      #     created_at_lt: nil,
-      #     created_at_lte: nil,
-      #     cursor: nil,
-      #     customer_id: nil,
-      #     external_customer_id: nil,
-      #     limit: nil,
-      #     subscription_id: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::AlertListParams} for more details.
+      #
+      #   @param created_at_gt [Time, nil]
+      #
+      #   @param created_at_gte [Time, nil]
+      #
+      #   @param created_at_lt [Time, nil]
+      #
+      #   @param created_at_lte [Time, nil]
+      #
+      #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #   ...
+      #
+      #   @param customer_id [String, nil] Fetch alerts scoped to this customer_id
+      #
+      #   @param external_customer_id [String, nil] Fetch alerts scoped to this external_customer_id
+      #
+      #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      #   @param subscription_id [String, nil] Fetch alerts scoped to this subscription_id
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/orb/models/alert_retrieve_params.rb

@@ -4,16 +4,11 @@ module Orb
   module Models
     # @see Orb::Resources::Alerts#retrieve
     class AlertRetrieveParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/orb/models/alert_update_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Alerts#update
     class AlertUpdateParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute thresholds
@@ -14,13 +13,10 @@ module Orb
       #   @return [Array<Orb::Models::AlertUpdateParams::Threshold>]
       required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertUpdateParams::Threshold] }
 
-      # @!parse
-      #   # @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(thresholds:, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(thresholds:, request_options: {})
+      #   @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       class Threshold < Orb::Internal::Type::BaseModel
         # @!attribute value
@@ -31,15 +27,15 @@ module Orb
         #   @return [Float]
         required :value, Float
 
-        # @!parse
-        #   # Thresholds are used to define the conditions under which an alert will be
-        #   # triggered.
-        #   #
-        #   # @param value [Float]
-        #   #
-        #   def initialize(value:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::AlertUpdateParams::Threshold} for more details.
+        #
+        #   Thresholds are used to define the conditions under which an alert will be
+        #   triggered.
+        #
+        #   @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
+        #   ...
       end
     end
   end