orb-billing 0.1.0.pre.alpha.33

data/lib/orb/models/alert.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Alerts#retrieve
+    class Alert < Orb::BaseModel
+      # @!attribute id
+      #   Also referred to as alert_id in this documentation.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The creation time of the resource in Orb.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The name of the currency the credit balance or invoice cost is denominated in.
+      #
+      #   @return [String, nil]
+      required :currency, String, nil?: true
+
+      # @!attribute customer
+      #   The customer the alert applies to.
+      #
+      #   @return [Orb::Models::Alert::Customer, nil]
+      required :customer, -> { Orb::Models::Alert::Customer }, nil?: true
+
+      # @!attribute enabled
+      #   Whether the alert is enabled or disabled.
+      #
+      #   @return [Boolean]
+      required :enabled, Orb::BooleanModel
+
+      # @!attribute metric
+      #   The metric the alert applies to.
+      #
+      #   @return [Orb::Models::Alert::Metric, nil]
+      required :metric, -> { Orb::Models::Alert::Metric }, nil?: true
+
+      # @!attribute plan
+      #   The plan the alert applies to.
+      #
+      #   @return [Orb::Models::Alert::Plan, nil]
+      required :plan, -> { Orb::Models::Alert::Plan }, nil?: true
+
+      # @!attribute subscription
+      #   The subscription the alert applies to.
+      #
+      #   @return [Orb::Models::Alert::Subscription, nil]
+      required :subscription, -> { Orb::Models::Alert::Subscription }, nil?: true
+
+      # @!attribute thresholds
+      #   The thresholds that define the conditions under which the alert will be
+      #     triggered.
+      #
+      #   @return [Array<Orb::Models::Alert::Threshold>, nil]
+      required :thresholds, -> { Orb::ArrayOf[Orb::Models::Alert::Threshold] }, nil?: true
+
+      # @!attribute type
+      #   The type of alert. This must be a valid alert type.
+      #
+      #   @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::BaseModel) -> void
+
+      # @see Orb::Models::Alert#customer
+      class Customer < Orb::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute external_customer_id
+        #
+        #   @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::BaseModel) -> void
+      end
+
+      # @see Orb::Models::Alert#metric
+      class Metric < Orb::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!parse
+        #   # The metric the alert applies to.
+        #   #
+        #   # @param id [String]
+        #   #
+        #   def initialize(id:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+
+      # @see Orb::Models::Alert#plan
+      class Plan < Orb::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        required :id, String, nil?: true
+
+        # @!attribute external_plan_id
+        #   An optional user-defined ID for this plan resource, used throughout the system
+        #     as an alias for this Plan. Use this field to identify a plan by an existing
+        #     identifier in your system.
+        #
+        #   @return [String, nil]
+        required :external_plan_id, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute plan_version
+        #
+        #   @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::BaseModel) -> void
+      end
+
+      # @see Orb::Models::Alert#subscription
+      class Subscription < Orb::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!parse
+        #   # The subscription the alert applies to.
+        #   #
+        #   # @param id [String]
+        #   #
+        #   def initialize(id:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+
+      class Threshold < Orb::BaseModel
+        # @!attribute value
+        #   The value at which an alert will fire. For credit balance alerts, the alert will
+        #     fire at or below this value. For usage and cost alerts, the alert will fire at
+        #     or above this value.
+        #
+        #   @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::BaseModel) -> void
+      end
+
+      # The type of alert. This must be a valid alert type.
+      #
+      # @see Orb::Models::Alert#type
+      module Type
+        extend Orb::Enum
+
+        CREDIT_BALANCE_DEPLETED = :credit_balance_depleted
+        CREDIT_BALANCE_DROPPED = :credit_balance_dropped
+        CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
+        USAGE_EXCEEDED = :usage_exceeded
+        COST_EXCEEDED = :cost_exceeded
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/orb/models/alert_create_for_customer_params.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Alerts#create_for_customer
+    class AlertCreateForCustomerParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute currency
+      #   The case sensitive currency or custom pricing unit to use for this alert.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute type
+      #   The type of alert to create. This must be a valid alert type.
+      #
+      #   @return [Symbol, Orb::Models::AlertCreateForCustomerParams::Type]
+      required :type, enum: -> { Orb::Models::AlertCreateForCustomerParams::Type }
+
+      # @!attribute thresholds
+      #   The thresholds that define the values at which the alert will be triggered.
+      #
+      #   @return [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil]
+      optional :thresholds,
+               -> { Orb::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::BaseModel) -> void
+
+      # The type of alert to create. This must be a valid alert type.
+      module Type
+        extend Orb::Enum
+
+        CREDIT_BALANCE_DEPLETED = :credit_balance_depleted
+        CREDIT_BALANCE_DROPPED = :credit_balance_dropped
+        CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      class Threshold < Orb::BaseModel
+        # @!attribute value
+        #   The value at which an alert will fire. For credit balance alerts, the alert will
+        #     fire at or below this value. For usage and cost alerts, the alert will fire at
+        #     or above this value.
+        #
+        #   @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::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/orb/models/alert_create_for_external_customer_params.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Alerts#create_for_external_customer
+    class AlertCreateForExternalCustomerParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute currency
+      #   The case sensitive currency or custom pricing unit to use for this alert.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute type
+      #   The type of alert to create. This must be a valid alert type.
+      #
+      #   @return [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type]
+      required :type, enum: -> { Orb::Models::AlertCreateForExternalCustomerParams::Type }
+
+      # @!attribute thresholds
+      #   The thresholds that define the values at which the alert will be triggered.
+      #
+      #   @return [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil]
+      optional :thresholds,
+               -> { Orb::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::BaseModel) -> void
+
+      # The type of alert to create. This must be a valid alert type.
+      module Type
+        extend Orb::Enum
+
+        CREDIT_BALANCE_DEPLETED = :credit_balance_depleted
+        CREDIT_BALANCE_DROPPED = :credit_balance_dropped
+        CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      class Threshold < Orb::BaseModel
+        # @!attribute value
+        #   The value at which an alert will fire. For credit balance alerts, the alert will
+        #     fire at or below this value. For usage and cost alerts, the alert will fire at
+        #     or above this value.
+        #
+        #   @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::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/orb/models/alert_create_for_subscription_params.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Alerts#create_for_subscription
+    class AlertCreateForSubscriptionParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute thresholds
+      #   The thresholds that define the values at which the alert will be triggered.
+      #
+      #   @return [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>]
+      required :thresholds, -> { Orb::ArrayOf[Orb::Models::AlertCreateForSubscriptionParams::Threshold] }
+
+      # @!attribute type
+      #   The type of alert to create. This must be a valid alert type.
+      #
+      #   @return [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type]
+      required :type, enum: -> { Orb::Models::AlertCreateForSubscriptionParams::Type }
+
+      # @!attribute metric_id
+      #   The metric to track usage for.
+      #
+      #   @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::BaseModel) -> void
+
+      class Threshold < Orb::BaseModel
+        # @!attribute value
+        #   The value at which an alert will fire. For credit balance alerts, the alert will
+        #     fire at or below this value. For usage and cost alerts, the alert will fire at
+        #     or above this value.
+        #
+        #   @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::BaseModel) -> void
+      end
+
+      # The type of alert to create. This must be a valid alert type.
+      module Type
+        extend Orb::Enum
+
+        USAGE_EXCEEDED = :usage_exceeded
+        COST_EXCEEDED = :cost_exceeded
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/orb/models/alert_disable_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Alerts#disable
+    class AlertDisableParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute subscription_id
+      #   Used to update the status of a plan alert scoped to this subscription_id
+      #
+      #   @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::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/alert_enable_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Alerts#enable
+    class AlertEnableParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute subscription_id
+      #   Used to update the status of a plan alert scoped to this subscription_id
+      #
+      #   @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::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/alert_list_params.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Alerts#list
+    class AlertListParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute created_at_gt
+      #
+      #   @return [Time, nil]
+      optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true
+
+      # @!attribute created_at_gte
+      #
+      #   @return [Time, nil]
+      optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true
+
+      # @!attribute created_at_lt
+      #
+      #   @return [Time, nil]
+      optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true
+
+      # @!attribute created_at_lte
+      #
+      #   @return [Time, nil]
+      optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true
+
+      # @!attribute cursor
+      #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #     from the initial request.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute customer_id
+      #   Fetch alerts scoped to this customer_id
+      #
+      #   @return [String, nil]
+      optional :customer_id, String, nil?: true
+
+      # @!attribute external_customer_id
+      #   Fetch alerts scoped to this external_customer_id
+      #
+      #   @return [String, nil]
+      optional :external_customer_id, String, nil?: true
+
+      # @!attribute [r] 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::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/alert_retrieve_params.rb

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

data/lib/orb/models/alert_update_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Alerts#update
+    class AlertUpdateParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute thresholds
+      #   The thresholds that define the values at which the alert will be triggered.
+      #
+      #   @return [Array<Orb::Models::AlertUpdateParams::Threshold>]
+      required :thresholds, -> { Orb::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::BaseModel) -> void
+
+      class Threshold < Orb::BaseModel
+        # @!attribute value
+        #   The value at which an alert will fire. For credit balance alerts, the alert will
+        #     fire at or below this value. For usage and cost alerts, the alert will fire at
+        #     or above this value.
+        #
+        #   @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::BaseModel) -> void
+      end
+    end
+  end
+end