whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/payout_list_response.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payouts#list
+    class PayoutListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   Payout ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   The payout amount in whole currency units.
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute created_at
+      #   When the payout was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   Payout currency.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute estimated_arrival
+      #   Estimated time the funds become available in the destination account.
+      #
+      #   @return [Time, nil]
+      required :estimated_arrival, Time, nil?: true
+
+      # @!attribute fee_amount
+      #   The fee charged for the payout, in the payout currency.
+      #
+      #   @return [Float]
+      required :fee_amount, Float
+
+      # @!attribute object
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutListResponse::Object]
+      required :object, enum: -> { WhopSDK::Models::PayoutListResponse::Object }
+
+      # @!attribute payer_name
+      #   Name of the entity processing the payout.
+      #
+      #   @return [String, nil]
+      required :payer_name, String, nil?: true
+
+      # @!attribute payout_request_id
+      #   The ID returned by POST /payouts when this payout was requested. Match it to the
+      #   settled payout in GET /payouts. Null for payouts not created by POST /payouts.
+      #
+      #   @return [String, nil]
+      required :payout_request_id, String, nil?: true
+
+      # @!attribute payout_token
+      #   The saved payout method used. Requires payout:destination:read; null without it.
+      #
+      #   @return [WhopSDK::Models::PayoutListResponse::PayoutToken, nil]
+      required :payout_token, -> { WhopSDK::Models::PayoutListResponse::PayoutToken }, nil?: true
+
+      # @!attribute speed
+      #   Payout delivery speed.
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutListResponse::Speed]
+      required :speed, enum: -> { WhopSDK::Models::PayoutListResponse::Speed }
+
+      # @!attribute status
+      #   Current payout status.
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutListResponse::Status]
+      required :status, enum: -> { WhopSDK::Models::PayoutListResponse::Status }
+
+      # @!method initialize(id:, amount:, created_at:, currency:, estimated_arrival:, fee_amount:, object:, payer_name:, payout_request_id:, payout_token:, speed:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PayoutListResponse} for more details.
+      #
+      #   @param id [String] Payout ID.
+      #
+      #   @param amount [Float] The payout amount in whole currency units.
+      #
+      #   @param created_at [Time] When the payout was created.
+      #
+      #   @param currency [String] Payout currency.
+      #
+      #   @param estimated_arrival [Time, nil] Estimated time the funds become available in the destination account.
+      #
+      #   @param fee_amount [Float] The fee charged for the payout, in the payout currency.
+      #
+      #   @param object [Symbol, WhopSDK::Models::PayoutListResponse::Object]
+      #
+      #   @param payer_name [String, nil] Name of the entity processing the payout.
+      #
+      #   @param payout_request_id [String, nil] The ID returned by POST /payouts when this payout was requested. Match it to the
+      #
+      #   @param payout_token [WhopSDK::Models::PayoutListResponse::PayoutToken, nil] The saved payout method used. Requires payout:destination:read; null without it.
+      #
+      #   @param speed [Symbol, WhopSDK::Models::PayoutListResponse::Speed] Payout delivery speed.
+      #
+      #   @param status [Symbol, WhopSDK::Models::PayoutListResponse::Status] Current payout status.
+
+      # @see WhopSDK::Models::PayoutListResponse#object
+      module Object
+        extend WhopSDK::Internal::Type::Enum
+
+        PAYOUT = :payout
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see WhopSDK::Models::PayoutListResponse#payout_token
+      class PayoutToken < WhopSDK::Internal::Type::BaseModel
+        # @!attribute nickname
+        #   Saved payout method nickname.
+        #
+        #   @return [String, nil]
+        required :nickname, String, nil?: true
+
+        # @!attribute payout_destination
+        #   Payout destination display details.
+        #
+        #   @return [WhopSDK::Models::PayoutListResponse::PayoutToken::PayoutDestination, nil]
+        required :payout_destination,
+                 -> { WhopSDK::Models::PayoutListResponse::PayoutToken::PayoutDestination },
+                 nil?: true
+
+        # @!method initialize(nickname:, payout_destination:)
+        #   The saved payout method used. Requires payout:destination:read; null without it.
+        #
+        #   @param nickname [String, nil] Saved payout method nickname.
+        #
+        #   @param payout_destination [WhopSDK::Models::PayoutListResponse::PayoutToken::PayoutDestination, nil] Payout destination display details.
+
+        # @see WhopSDK::Models::PayoutListResponse::PayoutToken#payout_destination
+        class PayoutDestination < WhopSDK::Internal::Type::BaseModel
+          # @!attribute icon_url
+          #   Payout destination icon URL.
+          #
+          #   @return [String, nil]
+          required :icon_url, String, nil?: true
+
+          # @!attribute payer_name
+          #   Payout destination display name.
+          #
+          #   @return [String, nil]
+          required :payer_name, String, nil?: true
+
+          # @!method initialize(icon_url:, payer_name:)
+          #   Payout destination display details.
+          #
+          #   @param icon_url [String, nil] Payout destination icon URL.
+          #
+          #   @param payer_name [String, nil] Payout destination display name.
+        end
+      end
+
+      # Payout delivery speed.
+      #
+      # @see WhopSDK::Models::PayoutListResponse#speed
+      module Speed
+        extend WhopSDK::Internal::Type::Enum
+
+        STANDARD = :standard
+        INSTANT = :instant
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Current payout status.
+      #
+      # @see WhopSDK::Models::PayoutListResponse#status
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        REQUESTED = :requested
+        AWAITING_PAYMENT = :awaiting_payment
+        IN_TRANSIT = :in_transit
+        COMPLETED = :completed
+        FAILED = :failed
+        CANCELED = :canceled
+        DENIED = :denied
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/payout_method_created_webhook_event.rb

@@ -164,8 +164,8 @@ module WhopSDK
           # @!attribute category
           #   The category of the payout destination
           #
-          #   @return [Symbol, WhopSDK::Models::PayoutDestinationCategory]
-          required :category, enum: -> { WhopSDK::PayoutDestinationCategory }
+          #   @return [Symbol, WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data::Destination::Category]
+          required :category, enum: -> { WhopSDK::PayoutMethodCreatedWebhookEvent::Data::Destination::Category }
 
           # @!attribute country_code
           #   The country code of the payout destination
@@ -183,11 +183,28 @@ module WhopSDK
           #   The payout destination configuration linked to this token. Null if not yet
           #   configured.
           #
-          #   @param category [Symbol, WhopSDK::Models::PayoutDestinationCategory] The category of the payout destination
+          #   @param category [Symbol, WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data::Destination::Category] The category of the payout destination
           #
           #   @param country_code [String] The country code of the payout destination
           #
           #   @param name [String] The name of the payer associated with the payout destination
+
+          # The category of the payout destination
+          #
+          # @see WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data::Destination#category
+          module Category
+            extend WhopSDK::Internal::Type::Enum
+
+            CRYPTO = :crypto
+            RTP = :rtp
+            NEXT_DAY_BANK = :next_day_bank
+            BANK_WIRE = :bank_wire
+            DIGITAL_WALLET = :digital_wallet
+            UNKNOWN = :unknown
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end
     end

data/lib/whop_sdk/models/payouts/method_list_params.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    module Payouts
+      # @see WhopSDK::Resources::Payouts::Methods#list
+      class MethodListParams < WhopSDK::Internal::Type::BaseModel
+        extend WhopSDK::Internal::Type::RequestParameters::Converter
+        include WhopSDK::Internal::Type::RequestParameters
+
+        # @!attribute account_id
+        #   The owning account ID (a biz\_ identifier). Provide this or user_id.
+        #
+        #   @return [String, nil]
+        optional :account_id, String
+
+        # @!attribute after
+        #   Cursor to fetch the page after (from page_info.end_cursor).
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!attribute amount
+        #   Optional withdrawal amount in whole currency units, for example `250.00`. When
+        #   provided, each method includes a quote with the estimated fee, amount received,
+        #   and delivery date for that amount.
+        #
+        #   @return [Float, nil]
+        optional :amount, Float
+
+        # @!attribute before
+        #   Cursor to fetch the page before (from page_info.start_cursor).
+        #
+        #   @return [String, nil]
+        optional :before, String
+
+        # @!attribute currency
+        #   Currency code of the amount, for example `usd`. Only meaningful with amount.
+        #
+        #   @return [String, nil]
+        optional :currency, String
+
+        # @!attribute first
+        #   Number of payout methods to return from the start of the window. Capped at 25
+        #   when an amount is provided.
+        #
+        #   @return [Integer, nil]
+        optional :first, Integer
+
+        # @!attribute include_available
+        #   When true, the response also carries available_destinations — payout rails the
+        #   account could add as a new payout method, with per-currency quotes when an
+        #   amount is provided.
+        #
+        #   @return [Boolean, nil]
+        optional :include_available, WhopSDK::Internal::Type::Boolean
+
+        # @!attribute last
+        #   Number of payout methods to return from the end of the window.
+        #
+        #   @return [Integer, nil]
+        optional :last, Integer
+
+        # @!attribute status
+        #   Optional status filter. `created` means saved but unused, `active` means a
+        #   payout through it succeeded, `broken` means the last payout failed and the
+        #   method needs fixing.
+        #
+        #   @return [Symbol, WhopSDK::Models::Payouts::MethodListParams::Status, nil]
+        optional :status, enum: -> { WhopSDK::Payouts::MethodListParams::Status }
+
+        # @!attribute user_id
+        #   The owning user ID (a user\_ identifier). Provide this or account_id.
+        #
+        #   @return [String, nil]
+        optional :user_id, String
+
+        # @!method initialize(account_id: nil, after: nil, amount: nil, before: nil, currency: nil, first: nil, include_available: nil, last: nil, status: nil, user_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::Payouts::MethodListParams} for more details.
+        #
+        #   @param account_id [String] The owning account ID (a biz\_ identifier). Provide this or user_id.
+        #
+        #   @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
+        #
+        #   @param amount [Float] Optional withdrawal amount in whole currency units, for example `250.00`. When p
+        #
+        #   @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
+        #
+        #   @param currency [String] Currency code of the amount, for example `usd`. Only meaningful with amount.
+        #
+        #   @param first [Integer] Number of payout methods to return from the start of the window. Capped at 25 wh
+        #
+        #   @param include_available [Boolean] When true, the response also carries available_destinations — payout rails the a
+        #
+        #   @param last [Integer] Number of payout methods to return from the end of the window.
+        #
+        #   @param status [Symbol, WhopSDK::Models::Payouts::MethodListParams::Status] Optional status filter. `created` means saved but unused, `active` means a payou
+        #
+        #   @param user_id [String] The owning user ID (a user\_ identifier). Provide this or account_id.
+        #
+        #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+        # Optional status filter. `created` means saved but unused, `active` means a
+        # payout through it succeeded, `broken` means the last payout failed and the
+        # method needs fixing.
+        module Status
+          extend WhopSDK::Internal::Type::Enum
+
+          CREATED = :created
+          ACTIVE = :active
+          BROKEN = :broken
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/payouts/method_list_response.rb

@@ -0,0 +1,315 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    module Payouts
+      # @see WhopSDK::Resources::Payouts::Methods#list
+      class MethodListResponse < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   Payout method ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute account_reference
+        #   Masked identifier for the destination, such as the last four digits of a bank
+        #   account.
+        #
+        #   @return [String, nil]
+        required :account_reference, String, nil?: true
+
+        # @!attribute created_at
+        #   When the payout method was added.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute destination_currency
+        #   Currency payouts are delivered in for this method.
+        #
+        #   @return [String]
+        required :destination_currency, String
+
+        # @!attribute institution_name
+        #   Name of the bank or institution receiving payouts.
+        #
+        #   @return [String, nil]
+        required :institution_name, String, nil?: true
+
+        # @!attribute is_default
+        #   Whether this is the default payout method for the account.
+        #
+        #   @return [Boolean]
+        required :is_default, WhopSDK::Internal::Type::Boolean
+
+        # @!attribute nickname
+        #   User-defined label for the payout method.
+        #
+        #   @return [String, nil]
+        required :nickname, String, nil?: true
+
+        # @!attribute object
+        #
+        #   @return [Symbol, WhopSDK::Models::Payouts::MethodListResponse::Object]
+        required :object, enum: -> { WhopSDK::Models::Payouts::MethodListResponse::Object }
+
+        # @!attribute payer_name
+        #   Display name of the payout rail, such as `ACH Bank Deposit`.
+        #
+        #   @return [String, nil]
+        required :payer_name, String, nil?: true
+
+        # @!attribute payout_destination
+        #   The payout rail this method delivers through.
+        #
+        #   @return [WhopSDK::Models::Payouts::MethodListResponse::PayoutDestination, nil]
+        required :payout_destination,
+                 -> { WhopSDK::Models::Payouts::MethodListResponse::PayoutDestination },
+                 nil?: true
+
+        # @!attribute quote
+        #   Fee and delivery estimate for withdrawing the requested amount through this
+        #   method. Null unless an amount was provided, or when the estimate is unavailable.
+        #
+        #   @return [WhopSDK::Models::Payouts::MethodListResponse::Quote, nil]
+        required :quote, -> { WhopSDK::Models::Payouts::MethodListResponse::Quote }, nil?: true
+
+        # @!attribute status
+        #   Lifecycle status: `created` means saved but unused, `active` means a payout
+        #   succeeded through it, `broken` means the last payout failed.
+        #
+        #   @return [Symbol, WhopSDK::Models::Payouts::MethodListResponse::Status]
+        required :status, enum: -> { WhopSDK::Models::Payouts::MethodListResponse::Status }
+
+        # @!method initialize(id:, account_reference:, created_at:, destination_currency:, institution_name:, is_default:, nickname:, object:, payer_name:, payout_destination:, quote:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::Payouts::MethodListResponse} for more details.
+        #
+        #   @param id [String] Payout method ID.
+        #
+        #   @param account_reference [String, nil] Masked identifier for the destination, such as the last four digits of a bank ac
+        #
+        #   @param created_at [Time] When the payout method was added.
+        #
+        #   @param destination_currency [String] Currency payouts are delivered in for this method.
+        #
+        #   @param institution_name [String, nil] Name of the bank or institution receiving payouts.
+        #
+        #   @param is_default [Boolean] Whether this is the default payout method for the account.
+        #
+        #   @param nickname [String, nil] User-defined label for the payout method.
+        #
+        #   @param object [Symbol, WhopSDK::Models::Payouts::MethodListResponse::Object]
+        #
+        #   @param payer_name [String, nil] Display name of the payout rail, such as `ACH Bank Deposit`.
+        #
+        #   @param payout_destination [WhopSDK::Models::Payouts::MethodListResponse::PayoutDestination, nil] The payout rail this method delivers through.
+        #
+        #   @param quote [WhopSDK::Models::Payouts::MethodListResponse::Quote, nil] Fee and delivery estimate for withdrawing the requested amount through this meth
+        #
+        #   @param status [Symbol, WhopSDK::Models::Payouts::MethodListResponse::Status] Lifecycle status: `created` means saved but unused, `active` means a payout succ
+
+        # @see WhopSDK::Models::Payouts::MethodListResponse#object
+        module Object
+          extend WhopSDK::Internal::Type::Enum
+
+          PAYOUT_METHOD = :payout_method
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see WhopSDK::Models::Payouts::MethodListResponse#payout_destination
+        class PayoutDestination < WhopSDK::Internal::Type::BaseModel
+          # @!attribute delivery_type
+          #   How funds are delivered, for example `bank_deposit`.
+          #
+          #   @return [String]
+          required :delivery_type, String
+
+          # @!attribute icon_url
+          #   Payout destination icon URL.
+          #
+          #   @return [String, nil]
+          required :icon_url, String, nil?: true
+
+          # @!attribute name
+          #   Payout destination display name.
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
+          # @!attribute supports_instant_delivery
+          #
+          #   @return [Boolean]
+          required :supports_instant_delivery, WhopSDK::Internal::Type::Boolean
+
+          # @!attribute supports_standard_delivery
+          #
+          #   @return [Boolean]
+          required :supports_standard_delivery, WhopSDK::Internal::Type::Boolean
+
+          # @!method initialize(delivery_type:, icon_url:, name:, supports_instant_delivery:, supports_standard_delivery:)
+          #   The payout rail this method delivers through.
+          #
+          #   @param delivery_type [String] How funds are delivered, for example `bank_deposit`.
+          #
+          #   @param icon_url [String, nil] Payout destination icon URL.
+          #
+          #   @param name [String, nil] Payout destination display name.
+          #
+          #   @param supports_instant_delivery [Boolean]
+          #
+          #   @param supports_standard_delivery [Boolean]
+        end
+
+        # @see WhopSDK::Models::Payouts::MethodListResponse#quote
+        class Quote < WhopSDK::Internal::Type::BaseModel
+          # @!attribute amount
+          #   The withdrawal amount the quote is for.
+          #
+          #   @return [Float]
+          required :amount, Float
+
+          # @!attribute currency
+          #   Currency of the quoted amount.
+          #
+          #   @return [String]
+          required :currency, String
+
+          # @!attribute exchange_rate
+          #   Exchange rate from the withdrawal currency to the destination currency.
+          #
+          #   @return [Float]
+          required :exchange_rate, Float
+
+          # @!attribute instant
+          #   Instant-delivery estimate. Null if the method does not support instant delivery,
+          #   instant delivery is unavailable for the account, or the amount does not cover
+          #   the fee.
+          #
+          #   @return [WhopSDK::Models::Payouts::MethodListResponse::Quote::Instant, nil]
+          required :instant, -> { WhopSDK::Models::Payouts::MethodListResponse::Quote::Instant }, nil?: true
+
+          # @!attribute max_limit
+          #   Maximum withdrawal amount for this method, in the withdrawal currency.
+          #
+          #   @return [Float, nil]
+          required :max_limit, Float, nil?: true
+
+          # @!attribute min_limit
+          #   Minimum withdrawal amount for this method, in the withdrawal currency.
+          #
+          #   @return [Float]
+          required :min_limit, Float
+
+          # @!attribute standard
+          #   Standard-delivery estimate. Null if the method does not support standard
+          #   delivery, or the amount does not cover the fee.
+          #
+          #   @return [WhopSDK::Models::Payouts::MethodListResponse::Quote::Standard, nil]
+          required :standard, -> { WhopSDK::Models::Payouts::MethodListResponse::Quote::Standard }, nil?: true
+
+          # @!method initialize(amount:, currency:, exchange_rate:, instant:, max_limit:, min_limit:, standard:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::Payouts::MethodListResponse::Quote} for more details.
+          #
+          #   Fee and delivery estimate for withdrawing the requested amount through this
+          #   method. Null unless an amount was provided, or when the estimate is unavailable.
+          #
+          #   @param amount [Float] The withdrawal amount the quote is for.
+          #
+          #   @param currency [String] Currency of the quoted amount.
+          #
+          #   @param exchange_rate [Float] Exchange rate from the withdrawal currency to the destination currency.
+          #
+          #   @param instant [WhopSDK::Models::Payouts::MethodListResponse::Quote::Instant, nil] Instant-delivery estimate. Null if the method does not support instant delivery,
+          #
+          #   @param max_limit [Float, nil] Maximum withdrawal amount for this method, in the withdrawal currency.
+          #
+          #   @param min_limit [Float] Minimum withdrawal amount for this method, in the withdrawal currency.
+          #
+          #   @param standard [WhopSDK::Models::Payouts::MethodListResponse::Quote::Standard, nil] Standard-delivery estimate. Null if the method does not support standard deliver
+
+          # @see WhopSDK::Models::Payouts::MethodListResponse::Quote#instant
+          class Instant < WhopSDK::Internal::Type::BaseModel
+            # @!attribute estimated_arrival
+            #   Estimated time the funds become available.
+            #
+            #   @return [Time]
+            required :estimated_arrival, Time
+
+            # @!attribute fee
+            #   Total fee charged, in the withdrawal currency.
+            #
+            #   @return [Float]
+            required :fee, Float
+
+            # @!attribute total_received
+            #   Amount delivered after fees, in the withdrawal currency.
+            #
+            #   @return [Float]
+            required :total_received, Float
+
+            # @!method initialize(estimated_arrival:, fee:, total_received:)
+            #   Instant-delivery estimate. Null if the method does not support instant delivery,
+            #   instant delivery is unavailable for the account, or the amount does not cover
+            #   the fee.
+            #
+            #   @param estimated_arrival [Time] Estimated time the funds become available.
+            #
+            #   @param fee [Float] Total fee charged, in the withdrawal currency.
+            #
+            #   @param total_received [Float] Amount delivered after fees, in the withdrawal currency.
+          end
+
+          # @see WhopSDK::Models::Payouts::MethodListResponse::Quote#standard
+          class Standard < WhopSDK::Internal::Type::BaseModel
+            # @!attribute estimated_arrival
+            #   Estimated time the funds become available.
+            #
+            #   @return [Time]
+            required :estimated_arrival, Time
+
+            # @!attribute fee
+            #   Total fee charged, in the withdrawal currency.
+            #
+            #   @return [Float]
+            required :fee, Float
+
+            # @!attribute total_received
+            #   Amount delivered after fees, in the withdrawal currency.
+            #
+            #   @return [Float]
+            required :total_received, Float
+
+            # @!method initialize(estimated_arrival:, fee:, total_received:)
+            #   Standard-delivery estimate. Null if the method does not support standard
+            #   delivery, or the amount does not cover the fee.
+            #
+            #   @param estimated_arrival [Time] Estimated time the funds become available.
+            #
+            #   @param fee [Float] Total fee charged, in the withdrawal currency.
+            #
+            #   @param total_received [Float] Amount delivered after fees, in the withdrawal currency.
+          end
+        end
+
+        # Lifecycle status: `created` means saved but unused, `active` means a payout
+        # succeeded through it, `broken` means the last payout failed.
+        #
+        # @see WhopSDK::Models::Payouts::MethodListResponse#status
+        module Status
+          extend WhopSDK::Internal::Type::Enum
+
+          CREATED = :created
+          ACTIVE = :active
+          BROKEN = :broken
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end