openai 0.19.0 → 0.21.0

data/lib/openai/models/realtime/realtime_client_event.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      # A realtime client event.
+      module RealtimeClientEvent
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Add a new Item to the Conversation's context, including messages, function
+        # calls, and function call responses. This event can be used both to populate a
+        # "history" of the conversation and to add new items mid-stream, but has the
+        # current limitation that it cannot populate assistant audio messages.
+        #
+        # If successful, the server will respond with a `conversation.item.created`
+        # event, otherwise an `error` event will be sent.
+        variant :"conversation.item.create", -> { OpenAI::Realtime::ConversationItemCreateEvent }
+
+        # Send this event when you want to remove any item from the conversation
+        # history. The server will respond with a `conversation.item.deleted` event,
+        # unless the item does not exist in the conversation history, in which case the
+        # server will respond with an error.
+        variant :"conversation.item.delete", -> { OpenAI::Realtime::ConversationItemDeleteEvent }
+
+        # Send this event when you want to retrieve the server's representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD.
+        # The server will respond with a `conversation.item.retrieved` event,
+        # unless the item does not exist in the conversation history, in which case the
+        # server will respond with an error.
+        variant :"conversation.item.retrieve", -> { OpenAI::Realtime::ConversationItemRetrieveEvent }
+
+        # Send this event to truncate a previous assistant message’s audio. The server
+        # will produce audio faster than realtime, so this event is useful when the user
+        # interrupts to truncate audio that has already been sent to the client but not
+        # yet played. This will synchronize the server's understanding of the audio with
+        # the client's playback.
+        #
+        # Truncating audio will delete the server-side text transcript to ensure there
+        # is not text in the context that hasn't been heard by the user.
+        #
+        # If successful, the server will respond with a `conversation.item.truncated`
+        # event.
+        variant :"conversation.item.truncate", -> { OpenAI::Realtime::ConversationItemTruncateEvent }
+
+        # Send this event to append audio bytes to the input audio buffer. The audio
+        # buffer is temporary storage you can write to and later commit. In Server VAD
+        # mode, the audio buffer is used to detect speech and the server will decide
+        # when to commit. When Server VAD is disabled, you must commit the audio buffer
+        # manually.
+        #
+        # The client may choose how much audio to place in each event up to a maximum
+        # of 15 MiB, for example streaming smaller chunks from the client may allow the
+        # VAD to be more responsive. Unlike made other client events, the server will
+        # not send a confirmation response to this event.
+        variant :"input_audio_buffer.append", -> { OpenAI::Realtime::InputAudioBufferAppendEvent }
+
+        # Send this event to clear the audio bytes in the buffer. The server will
+        # respond with an `input_audio_buffer.cleared` event.
+        variant :"input_audio_buffer.clear", -> { OpenAI::Realtime::InputAudioBufferClearEvent }
+
+        # **WebRTC Only:** Emit to cut off the current audio response. This will trigger the server to
+        # stop generating audio and emit a `output_audio_buffer.cleared` event. This
+        # event should be preceded by a `response.cancel` client event to stop the
+        # generation of the current response.
+        # [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+        variant :"output_audio_buffer.clear", -> { OpenAI::Realtime::OutputAudioBufferClearEvent }
+
+        # Send this event to commit the user input audio buffer, which will create a
+        # new user message item in the conversation. This event will produce an error
+        # if the input audio buffer is empty. When in Server VAD mode, the client does
+        # not need to send this event, the server will commit the audio buffer
+        # automatically.
+        #
+        # Committing the input audio buffer will trigger input audio transcription
+        # (if enabled in session configuration), but it will not create a response
+        # from the model. The server will respond with an `input_audio_buffer.committed`
+        # event.
+        variant :"input_audio_buffer.commit", -> { OpenAI::Realtime::InputAudioBufferCommitEvent }
+
+        # Send this event to cancel an in-progress response. The server will respond
+        # with a `response.done` event with a status of `response.status=cancelled`. If
+        # there is no response to cancel, the server will respond with an error.
+        variant :"response.cancel", -> { OpenAI::Realtime::ResponseCancelEvent }
+
+        # This event instructs the server to create a Response, which means triggering
+        # model inference. When in Server VAD mode, the server will create Responses
+        # automatically.
+        #
+        # A Response will include at least one Item, and may have two, in which case
+        # the second will be a function call. These Items will be appended to the
+        # conversation history.
+        #
+        # The server will respond with a `response.created` event, events for Items
+        # and content created, and finally a `response.done` event to indicate the
+        # Response is complete.
+        #
+        # The `response.create` event includes inference configuration like
+        # `instructions`, and `temperature`. These fields will override the Session's
+        # configuration for this Response only.
+        variant :"response.create", -> { OpenAI::Realtime::ResponseCreateEvent }
+
+        # Send this event to update the session’s default configuration.
+        # The client may send this event at any time to update any field,
+        # except for `voice`. However, note that once a session has been
+        # initialized with a particular `model`, it can’t be changed to
+        # another model using `session.update`.
+        #
+        # When the server receives a `session.update`, it will respond
+        # with a `session.updated` event showing the full, effective configuration.
+        # Only the fields that are present are updated. To clear a field like
+        # `instructions`, pass an empty string.
+        variant :"session.update", -> { OpenAI::Realtime::SessionUpdateEvent }
+
+        # Send this event to update a transcription session.
+        variant :"transcription_session.update", -> { OpenAI::Realtime::TranscriptionSessionUpdate }
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Realtime::ConversationItemCreateEvent, OpenAI::Models::Realtime::ConversationItemDeleteEvent, OpenAI::Models::Realtime::ConversationItemRetrieveEvent, OpenAI::Models::Realtime::ConversationItemTruncateEvent, OpenAI::Models::Realtime::InputAudioBufferAppendEvent, OpenAI::Models::Realtime::InputAudioBufferClearEvent, OpenAI::Models::Realtime::OutputAudioBufferClearEvent, OpenAI::Models::Realtime::InputAudioBufferCommitEvent, OpenAI::Models::Realtime::ResponseCancelEvent, OpenAI::Models::Realtime::ResponseCreateEvent, OpenAI::Models::Realtime::SessionUpdateEvent, OpenAI::Models::Realtime::TranscriptionSessionUpdate)]
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_client_secret_config.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeClientSecretConfig < OpenAI::Internal::Type::BaseModel
+        # @!attribute expires_after
+        #   Configuration for the ephemeral token expiration.
+        #
+        #   @return [OpenAI::Models::Realtime::RealtimeClientSecretConfig::ExpiresAfter, nil]
+        optional :expires_after, -> { OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter }
+
+        # @!method initialize(expires_after: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Realtime::RealtimeClientSecretConfig} for more details.
+        #
+        #   Configuration options for the generated client secret.
+        #
+        #   @param expires_after [OpenAI::Models::Realtime::RealtimeClientSecretConfig::ExpiresAfter] Configuration for the ephemeral token expiration.
+
+        # @see OpenAI::Models::Realtime::RealtimeClientSecretConfig#expires_after
+        class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+          # @!attribute anchor
+          #   The anchor point for the ephemeral token expiration. Only `created_at` is
+          #   currently supported.
+          #
+          #   @return [Symbol, OpenAI::Models::Realtime::RealtimeClientSecretConfig::ExpiresAfter::Anchor]
+          required :anchor, enum: -> { OpenAI::Realtime::RealtimeClientSecretConfig::ExpiresAfter::Anchor }
+
+          # @!attribute seconds
+          #   The number of seconds from the anchor point to the expiration. Select a value
+          #   between `10` and `7200`.
+          #
+          #   @return [Integer, nil]
+          optional :seconds, Integer
+
+          # @!method initialize(anchor:, seconds: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Realtime::RealtimeClientSecretConfig::ExpiresAfter} for more
+          #   details.
+          #
+          #   Configuration for the ephemeral token expiration.
+          #
+          #   @param anchor [Symbol, OpenAI::Models::Realtime::RealtimeClientSecretConfig::ExpiresAfter::Anchor] The anchor point for the ephemeral token expiration. Only `created_at` is curren
+          #
+          #   @param seconds [Integer] The number of seconds from the anchor point to the expiration. Select a value be
+
+          # The anchor point for the ephemeral token expiration. Only `created_at` is
+          # currently supported.
+          #
+          # @see OpenAI::Models::Realtime::RealtimeClientSecretConfig::ExpiresAfter#anchor
+          module Anchor
+            extend OpenAI::Internal::Type::Enum
+
+            CREATED_AT = :created_at
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_conversation_item_assistant_message.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemAssistantMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The content of the message.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content>]
+        required :content,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content] }
+
+        # @!attribute role
+        #   The role of the message sender. Always `assistant`.
+        #
+        #   @return [Symbol, :assistant]
+        required :role, const: :assistant
+
+        # @!attribute type
+        #   The type of the item. Always `message`.
+        #
+        #   @return [Symbol, :message]
+        required :type, const: :message
+
+        # @!attribute id
+        #   The unique ID of the item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Object }
+
+        # @!attribute status
+        #   The status of the item. Has no effect on the conversation.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Status }
+
+        # @!method initialize(content:, id: nil, object: nil, status: nil, role: :assistant, type: :message)
+        #   An assistant message item in a Realtime conversation.
+        #
+        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content>] The content of the message.
+        #
+        #   @param id [String] The unique ID of the item.
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Object] Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Status] The status of the item. Has no effect on the conversation.
+        #
+        #   @param role [Symbol, :assistant] The role of the message sender. Always `assistant`.
+        #
+        #   @param type [Symbol, :message] The type of the item. Always `message`.
+
+        class Content < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   The text content.
+          #
+          #   @return [String, nil]
+          optional :text, String
+
+          # @!attribute type
+          #   The content type. Always `text` for assistant messages.
+          #
+          #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::Type, nil]
+          optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemAssistantMessage::Content::Type }
+
+          # @!method initialize(text: nil, type: nil)
+          #   @param text [String] The text content.
+          #
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content::Type] The content type. Always `text` for assistant messages.
+
+          # The content type. Always `text` for assistant messages.
+          #
+          # @see OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage::Content#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            TEXT = :text
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM = :"realtime.item"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_conversation_item_function_call.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemFunctionCall < OpenAI::Internal::Type::BaseModel
+        # @!attribute arguments
+        #   The arguments of the function call.
+        #
+        #   @return [String]
+        required :arguments, String
+
+        # @!attribute name
+        #   The name of the function being called.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   The type of the item. Always `function_call`.
+        #
+        #   @return [Symbol, :function_call]
+        required :type, const: :function_call
+
+        # @!attribute id
+        #   The unique ID of the item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute call_id
+        #   The ID of the function call.
+        #
+        #   @return [String, nil]
+        optional :call_id, String
+
+        # @!attribute object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCall::Object }
+
+        # @!attribute status
+        #   The status of the item. Has no effect on the conversation.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCall::Status }
+
+        # @!method initialize(arguments:, name:, id: nil, call_id: nil, object: nil, status: nil, type: :function_call)
+        #   A function call item in a Realtime conversation.
+        #
+        #   @param arguments [String] The arguments of the function call.
+        #
+        #   @param name [String] The name of the function being called.
+        #
+        #   @param id [String] The unique ID of the item.
+        #
+        #   @param call_id [String] The ID of the function call.
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Object] Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall::Status] The status of the item. Has no effect on the conversation.
+        #
+        #   @param type [Symbol, :function_call] The type of the item. Always `function_call`.
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM = :"realtime.item"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_conversation_item_function_call_output.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemFunctionCallOutput < OpenAI::Internal::Type::BaseModel
+        # @!attribute call_id
+        #   The ID of the function call this output is for.
+        #
+        #   @return [String]
+        required :call_id, String
+
+        # @!attribute output
+        #   The output of the function call.
+        #
+        #   @return [String]
+        required :output, String
+
+        # @!attribute type
+        #   The type of the item. Always `function_call_output`.
+        #
+        #   @return [Symbol, :function_call_output]
+        required :type, const: :function_call_output
+
+        # @!attribute id
+        #   The unique ID of the item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput::Object }
+
+        # @!attribute status
+        #   The status of the item. Has no effect on the conversation.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemFunctionCallOutput::Status }
+
+        # @!method initialize(call_id:, output:, id: nil, object: nil, status: nil, type: :function_call_output)
+        #   A function call output item in a Realtime conversation.
+        #
+        #   @param call_id [String] The ID of the function call this output is for.
+        #
+        #   @param output [String] The output of the function call.
+        #
+        #   @param id [String] The unique ID of the item.
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Object] Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput::Status] The status of the item. Has no effect on the conversation.
+        #
+        #   @param type [Symbol, :function_call_output] The type of the item. Always `function_call_output`.
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM = :"realtime.item"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/realtime/realtime_conversation_item_system_message.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Realtime
+      class RealtimeConversationItemSystemMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The content of the message.
+        #
+        #   @return [Array<OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content>]
+        required :content,
+                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Realtime::RealtimeConversationItemSystemMessage::Content] }
+
+        # @!attribute role
+        #   The role of the message sender. Always `system`.
+        #
+        #   @return [Symbol, :system]
+        required :role, const: :system
+
+        # @!attribute type
+        #   The type of the item. Always `message`.
+        #
+        #   @return [Symbol, :message]
+        required :type, const: :message
+
+        # @!attribute id
+        #   The unique ID of the item.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute object
+        #   Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Object, nil]
+        optional :object, enum: -> { OpenAI::Realtime::RealtimeConversationItemSystemMessage::Object }
+
+        # @!attribute status
+        #   The status of the item. Has no effect on the conversation.
+        #
+        #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Status, nil]
+        optional :status, enum: -> { OpenAI::Realtime::RealtimeConversationItemSystemMessage::Status }
+
+        # @!method initialize(content:, id: nil, object: nil, status: nil, role: :system, type: :message)
+        #   A system message item in a Realtime conversation.
+        #
+        #   @param content [Array<OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content>] The content of the message.
+        #
+        #   @param id [String] The unique ID of the item.
+        #
+        #   @param object [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Object] Identifier for the API object being returned - always `realtime.item`.
+        #
+        #   @param status [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Status] The status of the item. Has no effect on the conversation.
+        #
+        #   @param role [Symbol, :system] The role of the message sender. Always `system`.
+        #
+        #   @param type [Symbol, :message] The type of the item. Always `message`.
+
+        class Content < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   The text content.
+          #
+          #   @return [String, nil]
+          optional :text, String
+
+          # @!attribute type
+          #   The content type. Always `input_text` for system messages.
+          #
+          #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content::Type, nil]
+          optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemSystemMessage::Content::Type }
+
+          # @!method initialize(text: nil, type: nil)
+          #   @param text [String] The text content.
+          #
+          #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content::Type] The content type. Always `input_text` for system messages.
+
+          # The content type. Always `input_text` for system messages.
+          #
+          # @see OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage::Content#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            INPUT_TEXT = :input_text
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # Identifier for the API object being returned - always `realtime.item`.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage#object
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          REALTIME_ITEM = :"realtime.item"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the item. Has no effect on the conversation.
+        #
+        # @see OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+          IN_PROGRESS = :in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end