cadenya 0.1.0

data/lib/cadenya/models/objective_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class ObjectiveError < Cadenya::Internal::Type::BaseModel
+      # @!attribute message
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute type
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(message: nil, type: nil)
+      #   @param message [String]
+      #   @param type [String]
+    end
+  end
+end

data/lib/cadenya/models/objective_event_data.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class ObjectiveEventData < Cadenya::Internal::Type::BaseModel
+      # @!attribute assistant_message
+      #
+      #   @return [Cadenya::Models::AssistantMessage, nil]
+      optional :assistant_message, -> { Cadenya::AssistantMessage }, api_name: :assistantMessage
+
+      # @!attribute cancelled
+      #   ObjectiveCancelled is the terminal event written when an objective is cancelled.
+      #   After this event, the objective is super-terminal: no further iterations,
+      #   compaction, or continuation are permitted.
+      #
+      #   @return [Cadenya::Models::ObjectiveEventData::Cancelled, nil]
+      optional :cancelled, -> { Cadenya::ObjectiveEventData::Cancelled }
+
+      # @!attribute context_window_compacted
+      #
+      #   @return [Cadenya::Models::ContextWindowCompacted, nil]
+      optional :context_window_compacted,
+               -> { Cadenya::ContextWindowCompacted },
+               api_name: :contextWindowCompacted
+
+      # @!attribute error
+      #
+      #   @return [Cadenya::Models::ObjectiveError, nil]
+      optional :error, -> { Cadenya::ObjectiveError }
+
+      # @!attribute memory_read
+      #   MemoryRead is emitted each time the agent resolves a key against the memory
+      #   stack and loads an entry. Lookups that miss (key not found in any layer) do not
+      #   emit this event.
+      #
+      #   @return [Cadenya::Models::MemoryRead, nil]
+      optional :memory_read, -> { Cadenya::MemoryRead }, api_name: :memoryRead
+
+      # @!attribute sub_objective_created
+      #
+      #   @return [Cadenya::Models::SubObjectiveCreated, nil]
+      optional :sub_objective_created, -> { Cadenya::SubObjectiveCreated }, api_name: :subObjectiveCreated
+
+      # @!attribute tool_approval_requested
+      #
+      #   @return [Cadenya::Models::ToolApprovalRequested, nil]
+      optional :tool_approval_requested,
+               -> {
+                 Cadenya::ToolApprovalRequested
+               },
+               api_name: :toolApprovalRequested
+
+      # @!attribute tool_approved
+      #
+      #   @return [Cadenya::Models::ToolApproved, nil]
+      optional :tool_approved, -> { Cadenya::ToolApproved }, api_name: :toolApproved
+
+      # @!attribute tool_called
+      #
+      #   @return [Cadenya::Models::ToolCalled, nil]
+      optional :tool_called, -> { Cadenya::ToolCalled }, api_name: :toolCalled
+
+      # @!attribute tool_denied
+      #
+      #   @return [Cadenya::Models::ToolDenied, nil]
+      optional :tool_denied, -> { Cadenya::ToolDenied }, api_name: :toolDenied
+
+      # @!attribute tool_error
+      #
+      #   @return [Cadenya::Models::ToolError, nil]
+      optional :tool_error, -> { Cadenya::ToolError }, api_name: :toolError
+
+      # @!attribute tool_result
+      #
+      #   @return [Cadenya::Models::ToolResult, nil]
+      optional :tool_result, -> { Cadenya::ToolResult }, api_name: :toolResult
+
+      # @!attribute type
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!attribute user_message
+      #
+      #   @return [Cadenya::Models::UserMessage, nil]
+      optional :user_message, -> { Cadenya::UserMessage }, api_name: :userMessage
+
+      # @!method initialize(assistant_message: nil, cancelled: nil, context_window_compacted: nil, error: nil, memory_read: nil, sub_objective_created: nil, tool_approval_requested: nil, tool_approved: nil, tool_called: nil, tool_denied: nil, tool_error: nil, tool_result: nil, type: nil, user_message: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::ObjectiveEventData} for more details.
+      #
+      #   @param assistant_message [Cadenya::Models::AssistantMessage]
+      #
+      #   @param cancelled [Cadenya::Models::ObjectiveEventData::Cancelled] ObjectiveCancelled is the terminal event written when an objective is
+      #
+      #   @param context_window_compacted [Cadenya::Models::ContextWindowCompacted]
+      #
+      #   @param error [Cadenya::Models::ObjectiveError]
+      #
+      #   @param memory_read [Cadenya::Models::MemoryRead] MemoryRead is emitted each time the agent resolves a key against the
+      #
+      #   @param sub_objective_created [Cadenya::Models::SubObjectiveCreated]
+      #
+      #   @param tool_approval_requested [Cadenya::Models::ToolApprovalRequested]
+      #
+      #   @param tool_approved [Cadenya::Models::ToolApproved]
+      #
+      #   @param tool_called [Cadenya::Models::ToolCalled]
+      #
+      #   @param tool_denied [Cadenya::Models::ToolDenied]
+      #
+      #   @param tool_error [Cadenya::Models::ToolError]
+      #
+      #   @param tool_result [Cadenya::Models::ToolResult]
+      #
+      #   @param type [String]
+      #
+      #   @param user_message [Cadenya::Models::UserMessage]
+
+      # @see Cadenya::Models::ObjectiveEventData#cancelled
+      class Cancelled < Cadenya::Internal::Type::BaseModel
+        # @!attribute message
+        #   Optional human-readable note recorded at cancel time. Today the workflow sets
+        #   "Cancelled" but this field leaves room for richer reasons (e.g. "Cancelled by
+        #   user", "Cancelled by schedule sweep", "Credit balance exhausted").
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!method initialize(message: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Cadenya::Models::ObjectiveEventData::Cancelled} for more details.
+        #
+        #   ObjectiveCancelled is the terminal event written when an objective is cancelled.
+        #   After this event, the objective is super-terminal: no further iterations,
+        #   compaction, or continuation are permitted.
+        #
+        #   @param message [String] Optional human-readable note recorded at cancel time. Today the workflow
+      end
+    end
+  end
+end

data/lib/cadenya/models/objective_event_info.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class ObjectiveEventInfo < Cadenya::Internal::Type::BaseModel
+      # @!attribute created_by
+      #   A profile identifies a user or non-human principal (such as an API key) at the
+      #   account level. Profiles are account-scoped and can be granted access to multiple
+      #   workspaces.
+      #
+      #   @return [Cadenya::Models::Profile, nil]
+      optional :created_by, -> { Cadenya::Profile }, api_name: :createdBy
+
+      # @!attribute objective
+      #   Metadata for ephemeral operations and activities (e.g., objectives, executions,
+      #   runs)
+      #
+      #   @return [Cadenya::Models::OperationMetadata, nil]
+      optional :objective, -> { Cadenya::OperationMetadata }
+
+      # @!method initialize(created_by: nil, objective: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::ObjectiveEventInfo} for more details.
+      #
+      #   @param created_by [Cadenya::Models::Profile] A profile identifies a user or non-human principal (such as an API key)
+      #
+      #   @param objective [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
+    end
+  end
+end

data/lib/cadenya/models/objective_event_webhook_data.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class ObjectiveEventWebhookData < Cadenya::Internal::Type::BaseModel
+      # @!attribute data
+      #   The webhook data payload with flat top-level keys for agent, variation,
+      #   objective, and event.
+      #
+      #   @return [Cadenya::Models::ObjectiveEventWebhookData::Data]
+      required :data, -> { Cadenya::ObjectiveEventWebhookData::Data }
+
+      # @!attribute timestamp
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The event type, prefixed with objective_event. (e.g.,
+      #   objective_event.tool_result)
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!method initialize(data:, timestamp:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::ObjectiveEventWebhookData} for more details.
+      #
+      #   The envelope for an objective event webhook delivery. Contains timestamp, event
+      #   type, and the webhook data payload.
+      #
+      #   @param data [Cadenya::Models::ObjectiveEventWebhookData::Data] The webhook data payload with flat top-level keys for agent, variation, objectiv
+      #
+      #   @param timestamp [Time]
+      #
+      #   @param type [String] The event type, prefixed with objective_event. (e.g., objective_event.tool_resul
+
+      # @see Cadenya::Models::ObjectiveEventWebhookData#data
+      class Data < Cadenya::Internal::Type::BaseModel
+        # @!attribute agent
+        #   Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+        #
+        #   @return [Cadenya::Models::ResourceMetadata]
+        required :agent, -> { Cadenya::ResourceMetadata }
+
+        # @!attribute agent_variation
+        #   Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+        #
+        #   @return [Cadenya::Models::ResourceMetadata]
+        required :agent_variation, -> { Cadenya::ResourceMetadata }, api_name: :agentVariation
+
+        # @!attribute objective
+        #   Metadata for ephemeral operations and activities (e.g., objectives, executions,
+        #   runs)
+        #
+        #   @return [Cadenya::Models::OperationMetadata]
+        required :objective, -> { Cadenya::OperationMetadata }
+
+        # @!attribute objective_event
+        #
+        #   @return [Cadenya::Models::ObjectiveEventWebhookData::Data::ObjectiveEvent]
+        required :objective_event,
+                 -> { Cadenya::ObjectiveEventWebhookData::Data::ObjectiveEvent },
+                 api_name: :objectiveEvent
+
+        # @!method initialize(agent:, agent_variation:, objective:, objective_event:)
+        #   Some parameter documentations has been truncated, see
+        #   {Cadenya::Models::ObjectiveEventWebhookData::Data} for more details.
+        #
+        #   The webhook data payload with flat top-level keys for agent, variation,
+        #   objective, and event.
+        #
+        #   @param agent [Cadenya::Models::ResourceMetadata] Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+        #
+        #   @param agent_variation [Cadenya::Models::ResourceMetadata] Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+        #
+        #   @param objective [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
+        #
+        #   @param objective_event [Cadenya::Models::ObjectiveEventWebhookData::Data::ObjectiveEvent]
+
+        # @see Cadenya::Models::ObjectiveEventWebhookData::Data#objective_event
+        class ObjectiveEvent < Cadenya::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Cadenya::Models::ObjectiveEventData]
+          required :data, -> { Cadenya::ObjectiveEventData }
+
+          # @!attribute metadata
+          #   Metadata for ephemeral operations and activities (e.g., objectives, executions,
+          #   runs)
+          #
+          #   @return [Cadenya::Models::OperationMetadata]
+          required :metadata, -> { Cadenya::OperationMetadata }
+
+          # @!attribute context_window_id
+          #
+          #   @return [String, nil]
+          optional :context_window_id, String, api_name: :contextWindowId
+
+          # @!attribute info
+          #
+          #   @return [Cadenya::Models::ObjectiveEventInfo, nil]
+          optional :info, -> { Cadenya::ObjectiveEventInfo }
+
+          # @!method initialize(data:, metadata:, context_window_id: nil, info: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Cadenya::Models::ObjectiveEventWebhookData::Data::ObjectiveEvent} for more
+          #   details.
+          #
+          #   @param data [Cadenya::Models::ObjectiveEventData]
+          #
+          #   @param metadata [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
+          #
+          #   @param context_window_id [String]
+          #
+          #   @param info [Cadenya::Models::ObjectiveEventInfo]
+        end
+      end
+    end
+  end
+end

data/lib/cadenya/models/objective_info.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class ObjectiveInfo < Cadenya::Internal::Type::BaseModel
+      # @!attribute agent
+      #   Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+      #
+      #   @return [Cadenya::Models::ResourceMetadata, nil]
+      optional :agent, -> { Cadenya::ResourceMetadata }
+
+      # @!attribute agent_variation
+      #   Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+      #
+      #   @return [Cadenya::Models::ResourceMetadata, nil]
+      optional :agent_variation, -> { Cadenya::ResourceMetadata }, api_name: :agentVariation
+
+      # @!attribute created_by
+      #   A profile identifies a user or non-human principal (such as an API key) at the
+      #   account level. Profiles are account-scoped and can be granted access to multiple
+      #   workspaces.
+      #
+      #   @return [Cadenya::Models::Profile, nil]
+      optional :created_by, -> { Cadenya::Profile }, api_name: :createdBy
+
+      response_only do
+        # @!attribute effective_memory_stack
+        #   The effective memory stack at objective creation time, flattened from the
+        #   variation's baseline plus ObjectiveData.memory_stack. Order is push order (last
+        #   = top). Returned on reads so clients can see exactly what stack the objective is
+        #   using without having to re-join variation state.
+        #
+        #   @return [Array<Cadenya::Models::MemoryReference>, nil]
+        optional :effective_memory_stack,
+                 -> { Cadenya::Internal::Type::ArrayOf[Cadenya::MemoryReference] },
+                 api_name: :effectiveMemoryStack
+
+        # @!attribute total_context_windows
+        #   Total number of context windows that this objective has generated
+        #
+        #   @return [Integer, nil]
+        optional :total_context_windows, Integer, api_name: :totalContextWindows
+
+        # @!attribute total_events
+        #   Total number of events generated during this objective's execution
+        #
+        #   @return [Integer, nil]
+        optional :total_events, Integer, api_name: :totalEvents
+
+        # @!attribute total_input_tokens
+        #   Total input tokens consumed across all LLM completions across all context
+        #   windows
+        #
+        #   @return [Integer, nil]
+        optional :total_input_tokens, Integer, api_name: :totalInputTokens
+
+        # @!attribute total_output_tokens
+        #   Total output tokens generated across all LLM completions across all context
+        #   windows
+        #
+        #   @return [Integer, nil]
+        optional :total_output_tokens, Integer, api_name: :totalOutputTokens
+
+        # @!attribute total_tool_calls
+        #   Total number of tool calls made during execution
+        #
+        #   @return [Integer, nil]
+        optional :total_tool_calls, Integer, api_name: :totalToolCalls
+      end
+
+      # @!method initialize(agent: nil, agent_variation: nil, created_by: nil, effective_memory_stack: nil, total_context_windows: nil, total_events: nil, total_input_tokens: nil, total_output_tokens: nil, total_tool_calls: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::ObjectiveInfo} for more details.
+      #
+      #   ObjectiveInfo provides read-only aggregated statistics about an objective's
+      #   execution
+      #
+      #   @param agent [Cadenya::Models::ResourceMetadata] Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+      #
+      #   @param agent_variation [Cadenya::Models::ResourceMetadata] Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+      #
+      #   @param created_by [Cadenya::Models::Profile] A profile identifies a user or non-human principal (such as an API key)
+      #
+      #   @param effective_memory_stack [Array<Cadenya::Models::MemoryReference>] The effective memory stack at objective creation time, flattened
+      #
+      #   @param total_context_windows [Integer] Total number of context windows that this objective has generated
+      #
+      #   @param total_events [Integer] Total number of events generated during this objective's execution
+      #
+      #   @param total_input_tokens [Integer] Total input tokens consumed across all LLM completions across all context window
+      #
+      #   @param total_output_tokens [Integer] Total output tokens generated across all LLM completions across all context wind
+      #
+      #   @param total_tool_calls [Integer] Total number of tool calls made during execution
+    end
+  end
+end

data/lib/cadenya/models/objective_list_context_windows_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::Objectives#list_context_windows
+    class ObjectiveListContextWindowsParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!attribute workspace_id
+      #
+      #   @return [String]
+      required :workspace_id, String
+
+      # @!attribute objective_id
+      #
+      #   @return [String]
+      required :objective_id, String
+
+      # @!attribute cursor
+      #   Pagination cursor from previous response
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute include_info
+      #   When set to true you may use more of your alloted API rate-limit
+      #
+      #   @return [Boolean, nil]
+      optional :include_info, Cadenya::Internal::Type::Boolean
+
+      # @!attribute limit
+      #   Maximum number of results to return
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(workspace_id:, objective_id:, cursor: nil, include_info: nil, limit: nil, request_options: {})
+      #   @param workspace_id [String]
+      #
+      #   @param objective_id [String]
+      #
+      #   @param cursor [String] Pagination cursor from previous response
+      #
+      #   @param include_info [Boolean] When set to true you may use more of your alloted API rate-limit
+      #
+      #   @param limit [Integer] Maximum number of results to return
+      #
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/objective_list_events_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::Objectives#list_events
+    class ObjectiveListEventsParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!attribute workspace_id
+      #
+      #   @return [String]
+      required :workspace_id, String
+
+      # @!attribute objective_id
+      #
+      #   @return [String]
+      required :objective_id, String
+
+      # @!attribute cursor
+      #   Pagination cursor from previous response
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute include_info
+      #   When set to true you may use more of your alloted API rate-limit
+      #
+      #   @return [Boolean, nil]
+      optional :include_info, Cadenya::Internal::Type::Boolean
+
+      # @!attribute limit
+      #   Maximum number of results to return
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute sort_order
+      #   Sort order for results (asc or desc by creation time)
+      #
+      #   @return [String, nil]
+      optional :sort_order, String
+
+      # @!attribute window_id
+      #   Optional context window ID to filter events by
+      #
+      #   @return [String, nil]
+      optional :window_id, String
+
+      # @!method initialize(workspace_id:, objective_id:, cursor: nil, include_info: nil, limit: nil, sort_order: nil, window_id: nil, request_options: {})
+      #   @param workspace_id [String]
+      #
+      #   @param objective_id [String]
+      #
+      #   @param cursor [String] Pagination cursor from previous response
+      #
+      #   @param include_info [Boolean] When set to true you may use more of your alloted API rate-limit
+      #
+      #   @param limit [Integer] Maximum number of results to return
+      #
+      #   @param sort_order [String] Sort order for results (asc or desc by creation time)
+      #
+      #   @param window_id [String] Optional context window ID to filter events by
+      #
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/objective_list_events_response.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::Objectives#list_events
+    class ObjectiveListEventsResponse < Cadenya::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Cadenya::Models::ObjectiveEventData]
+      required :data, -> { Cadenya::ObjectiveEventData }
+
+      # @!attribute metadata
+      #   Metadata for ephemeral operations and activities (e.g., objectives, executions,
+      #   runs)
+      #
+      #   @return [Cadenya::Models::OperationMetadata]
+      required :metadata, -> { Cadenya::OperationMetadata }
+
+      # @!attribute context_window_id
+      #
+      #   @return [String, nil]
+      optional :context_window_id, String, api_name: :contextWindowId
+
+      # @!attribute info
+      #
+      #   @return [Cadenya::Models::ObjectiveEventInfo, nil]
+      optional :info, -> { Cadenya::ObjectiveEventInfo }
+
+      # @!method initialize(data:, metadata:, context_window_id: nil, info: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::ObjectiveListEventsResponse} for more details.
+      #
+      #   @param data [Cadenya::Models::ObjectiveEventData]
+      #
+      #   @param metadata [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
+      #
+      #   @param context_window_id [String]
+      #
+      #   @param info [Cadenya::Models::ObjectiveEventInfo]
+    end
+  end
+end

data/lib/cadenya/models/objective_list_params.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::Objectives#list
+    class ObjectiveListParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!attribute workspace_id
+      #
+      #   @return [String]
+      required :workspace_id, String
+
+      # @!attribute agent_id
+      #   Agent ID for filtering
+      #
+      #   @return [String, nil]
+      optional :agent_id, String
+
+      # @!attribute agent_schedule_id
+      #   Filter to objectives produced by a specific AgentSchedule. Accepts canonical
+      #   as\_… form or external_id:<value> form.
+      #
+      #   @return [String, nil]
+      optional :agent_schedule_id, String
+
+      # @!attribute cursor
+      #   Pagination cursor from previous response
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute include_info
+      #   When set to true you may use more of your alloted API rate-limit
+      #
+      #   @return [Boolean, nil]
+      optional :include_info, Cadenya::Internal::Type::Boolean
+
+      # @!attribute limit
+      #   Maximum number of results to return
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute parent_objective_id
+      #   Optional filters
+      #
+      #   @return [String, nil]
+      optional :parent_objective_id, String
+
+      # @!attribute profile_id
+      #
+      #   @return [String, nil]
+      optional :profile_id, String
+
+      # @!attribute sort_order
+      #   Sort order for results (asc or desc by creation time)
+      #
+      #   @return [String, nil]
+      optional :sort_order, String
+
+      # @!attribute state
+      #   Filter by state
+      #
+      #   @return [Symbol, Cadenya::Models::ObjectiveListParams::State, nil]
+      optional :state, enum: -> { Cadenya::ObjectiveListParams::State }
+
+      # @!method initialize(workspace_id:, agent_id: nil, agent_schedule_id: nil, cursor: nil, include_info: nil, limit: nil, parent_objective_id: nil, profile_id: nil, sort_order: nil, state: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::ObjectiveListParams} for more details.
+      #
+      #   @param workspace_id [String]
+      #
+      #   @param agent_id [String] Agent ID for filtering
+      #
+      #   @param agent_schedule_id [String] Filter to objectives produced by a specific AgentSchedule. Accepts
+      #
+      #   @param cursor [String] Pagination cursor from previous response
+      #
+      #   @param include_info [Boolean] When set to true you may use more of your alloted API rate-limit
+      #
+      #   @param limit [Integer] Maximum number of results to return
+      #
+      #   @param parent_objective_id [String] Optional filters
+      #
+      #   @param profile_id [String]
+      #
+      #   @param sort_order [String] Sort order for results (asc or desc by creation time)
+      #
+      #   @param state [Symbol, Cadenya::Models::ObjectiveListParams::State] Filter by state
+      #
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+
+      # Filter by state
+      module State
+        extend Cadenya::Internal::Type::Enum
+
+        STATE_UNSPECIFIED = :STATE_UNSPECIFIED
+        STATE_PENDING = :STATE_PENDING
+        STATE_RUNNING = :STATE_RUNNING
+        STATE_COMPLETED = :STATE_COMPLETED
+        STATE_FAILED = :STATE_FAILED
+        STATE_CANCELLED = :STATE_CANCELLED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end