orb-billing 1.45.0 → 1.46.0

data/sig/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbs

@@ -0,0 +1,396 @@
+module Orb
+  module Models
+    module Webhooks
+      type customer_credit_balance_recovered_standard_webhook_event =
+        {
+          id: String,
+          created_at: Time,
+          customer: Orb::Customer,
+          payload_style: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::payload_style,
+          properties: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties,
+          type: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::type_
+        }
+
+      class CustomerCreditBalanceRecoveredStandardWebhookEvent < Orb::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Time
+
+        attr_accessor customer: Orb::Customer
+
+        attr_accessor payload_style: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::payload_style
+
+        attr_accessor properties: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties
+
+        attr_accessor type: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::type_
+
+        def initialize: (
+          id: String,
+          created_at: Time,
+          customer: Orb::Customer,
+          payload_style: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::payload_style,
+          properties: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties,
+          type: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::type_
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Time,
+          customer: Orb::Customer,
+          payload_style: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::payload_style,
+          properties: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties,
+          type: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::type_
+        }
+
+        type payload_style = :expanded | :standard
+
+        module PayloadStyle
+          extend Orb::Internal::Type::Enum
+
+          EXPANDED: :expanded
+          STANDARD: :standard
+
+          def self?.values: -> ::Array[Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::payload_style]
+        end
+
+        type properties =
+          {
+            alert_configuration: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration,
+            pricing_unit: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit?
+          }
+
+        class Properties < Orb::Internal::Type::BaseModel
+          attr_accessor alert_configuration: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration
+
+          attr_accessor pricing_unit: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit?
+
+          def initialize: (
+            alert_configuration: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration,
+            pricing_unit: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit?
+          ) -> void
+
+          def to_hash: -> {
+            alert_configuration: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration,
+            pricing_unit: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit?
+          }
+
+          type alert_configuration =
+            {
+              id: String,
+              created_at: Time,
+              currency: String?,
+              customer: Orb::CustomerMinified?,
+              enabled: bool,
+              metric: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric?,
+              plan: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan?,
+              subscription: Orb::SubscriptionMinified?,
+              thresholds: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold]?,
+              type: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::type_,
+              balance_alert_status: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus]?,
+              grouping_keys: ::Array[String]?,
+              license_type: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType?,
+              price_filters: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter]?,
+              threshold_overrides: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride]?
+            }
+
+          class AlertConfiguration < Orb::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            attr_accessor created_at: Time
+
+            attr_accessor currency: String?
+
+            attr_accessor customer: Orb::CustomerMinified?
+
+            attr_accessor enabled: bool
+
+            attr_accessor metric: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric?
+
+            attr_accessor plan: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan?
+
+            attr_accessor subscription: Orb::SubscriptionMinified?
+
+            attr_accessor thresholds: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold]?
+
+            attr_accessor type: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::type_
+
+            attr_accessor balance_alert_status: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus]?
+
+            attr_accessor grouping_keys: ::Array[String]?
+
+            attr_accessor license_type: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType?
+
+            attr_accessor price_filters: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter]?
+
+            attr_accessor threshold_overrides: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride]?
+
+            def initialize: (
+              id: String,
+              created_at: Time,
+              currency: String?,
+              customer: Orb::CustomerMinified?,
+              enabled: bool,
+              metric: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric?,
+              plan: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan?,
+              subscription: Orb::SubscriptionMinified?,
+              thresholds: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold]?,
+              type: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::type_,
+              ?balance_alert_status: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus]?,
+              ?grouping_keys: ::Array[String]?,
+              ?license_type: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType?,
+              ?price_filters: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter]?,
+              ?threshold_overrides: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride]?
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              created_at: Time,
+              currency: String?,
+              customer: Orb::CustomerMinified?,
+              enabled: bool,
+              metric: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric?,
+              plan: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan?,
+              subscription: Orb::SubscriptionMinified?,
+              thresholds: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold]?,
+              type: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::type_,
+              balance_alert_status: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus]?,
+              grouping_keys: ::Array[String]?,
+              license_type: Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType?,
+              price_filters: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter]?,
+              threshold_overrides: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride]?
+            }
+
+            type metric = { id: String }
+
+            class Metric < Orb::Internal::Type::BaseModel
+              attr_accessor id: String
+
+              def initialize: (id: String) -> void
+
+              def to_hash: -> { id: String }
+            end
+
+            type plan =
+              {
+                id: String?,
+                external_plan_id: String?,
+                name: String?,
+                plan_version: String
+              }
+
+            class Plan < Orb::Internal::Type::BaseModel
+              attr_accessor id: String?
+
+              attr_accessor external_plan_id: String?
+
+              attr_accessor name: String?
+
+              attr_accessor plan_version: String
+
+              def initialize: (
+                id: String?,
+                external_plan_id: String?,
+                name: String?,
+                plan_version: String
+              ) -> void
+
+              def to_hash: -> {
+                id: String?,
+                external_plan_id: String?,
+                name: String?,
+                plan_version: String
+              }
+            end
+
+            type threshold = { value: String }
+
+            class Threshold < Orb::Internal::Type::BaseModel
+              attr_accessor value: String
+
+              def initialize: (value: String) -> void
+
+              def to_hash: -> { value: String }
+            end
+
+            type type_ =
+              :credit_balance_depleted
+              | :credit_balance_dropped
+              | :credit_balance_recovered
+              | :usage_exceeded
+              | :cost_exceeded
+              | :spend_exceeded
+              | :license_balance_threshold_reached
+
+            module Type
+              extend Orb::Internal::Type::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
+              SPEND_EXCEEDED: :spend_exceeded
+              LICENSE_BALANCE_THRESHOLD_REACHED: :license_balance_threshold_reached
+
+              def self?.values: -> ::Array[Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::type_]
+            end
+
+            type balance_alert_status =
+              { in_alert: bool, threshold_value: String }
+
+            class BalanceAlertStatus < Orb::Internal::Type::BaseModel
+              attr_accessor in_alert: bool
+
+              attr_accessor threshold_value: String
+
+              def initialize: (in_alert: bool, threshold_value: String) -> void
+
+              def to_hash: -> { in_alert: bool, threshold_value: String }
+            end
+
+            type license_type = { id: String }
+
+            class LicenseType < Orb::Internal::Type::BaseModel
+              attr_accessor id: String
+
+              def initialize: (id: String) -> void
+
+              def to_hash: -> { id: String }
+            end
+
+            type price_filter =
+              {
+                field: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::field,
+                operator: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::operator,
+                values: ::Array[String]
+              }
+
+            class PriceFilter < Orb::Internal::Type::BaseModel
+              attr_accessor field: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::field
+
+              attr_accessor operator: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::operator
+
+              attr_accessor values: ::Array[String]
+
+              def initialize: (
+                field: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::field,
+                operator: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::operator,
+                values: ::Array[String]
+              ) -> void
+
+              def to_hash: -> {
+                field: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::field,
+                operator: Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::operator,
+                values: ::Array[String]
+              }
+
+              type field =
+                :price_id
+                | :item_id
+                | :price_type
+                | :currency
+                | :pricing_unit_id
+
+              module Field
+                extend Orb::Internal::Type::Enum
+
+                PRICE_ID: :price_id
+                ITEM_ID: :item_id
+                PRICE_TYPE: :price_type
+                CURRENCY: :currency
+                PRICING_UNIT_ID: :pricing_unit_id
+
+                def self?.values: -> ::Array[Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::field]
+              end
+
+              type operator = :includes | :excludes
+
+              module Operator
+                extend Orb::Internal::Type::Enum
+
+                INCLUDES: :includes
+                EXCLUDES: :excludes
+
+                def self?.values: -> ::Array[Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::operator]
+              end
+            end
+
+            type threshold_override =
+              {
+                group_values: ::Array[String],
+                thresholds: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold],
+                group_keys: ::Array[String]?
+              }
+
+            class ThresholdOverride < Orb::Internal::Type::BaseModel
+              attr_accessor group_values: ::Array[String]
+
+              attr_accessor thresholds: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold]
+
+              attr_accessor group_keys: ::Array[String]?
+
+              def initialize: (
+                group_values: ::Array[String],
+                thresholds: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold],
+                ?group_keys: ::Array[String]?
+              ) -> void
+
+              def to_hash: -> {
+                group_values: ::Array[String],
+                thresholds: ::Array[Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold],
+                group_keys: ::Array[String]?
+              }
+
+              type threshold = { value: String }
+
+              class Threshold < Orb::Internal::Type::BaseModel
+                attr_accessor value: String
+
+                def initialize: (value: String) -> void
+
+                def to_hash: -> { value: String }
+              end
+            end
+          end
+
+          type pricing_unit =
+            { id: String, display_name: String?, name: String, symbol: String? }
+
+          class PricingUnit < Orb::Internal::Type::BaseModel
+            attr_accessor id: String
+
+            attr_accessor display_name: String?
+
+            attr_accessor name: String
+
+            attr_accessor symbol: String?
+
+            def initialize: (
+              id: String,
+              display_name: String?,
+              name: String,
+              symbol: String?
+            ) -> void
+
+            def to_hash: -> {
+              id: String,
+              display_name: String?,
+              name: String,
+              symbol: String?
+            }
+          end
+        end
+
+        type type_ = :"customer.credit_balance_recovered"
+
+        module Type
+          extend Orb::Internal::Type::Enum
+
+          CUSTOMER_CREDIT_BALANCE_RECOVERED: :"customer.credit_balance_recovered"
+
+          def self?.values: -> ::Array[Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::type_]
+        end
+      end
+    end
+  end
+end