cadenya 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3cc49ac49fbdbfff8fb89d30d752845056dc3d02f3c3d85bc0bfda74647948d
-  data.tar.gz: fc413c92248c0b5eea54f808545eaf8207caa90cbbd043e38e798a7b3c05e917
+  metadata.gz: e7f15c89788992e84faa1b1a059033314f7c115317be1f0fdba0e49793bc0aa6
+  data.tar.gz: d56587810401e084e8b5497254d6a6680fc22b3eff1bf70af6bc20461a3b19e1
 SHA512:
-  metadata.gz: c8efd167e60512e6bab2ea8532382565490fdfe2cd5bfa0a9f489b655c4cca369dc69fad7362cf1ff04981a41d297787936ce6a60133c1919e6bc6a09f3f6fd6
-  data.tar.gz: 5626793207092ca923346d462f8a5755e3b297092f9b1ced17379f09ea6be3ad7f4977eb9a798943ef1902989abe722efccf18431ba951ccb5f06ecb79925bfb
+  metadata.gz: c696765a5ffb6e7c97c6b3cb729b711fe424626b45e6e0732ef37a5dc9b56bde28f8ca54d0db305657bf459b4e3dfa3081f905e26a17a6e503b3b5709b82ef38
+  data.tar.gz: 9f178edbcaf810c598ccf931ee62bc8c68479f41128c63143852a255b673dcd69e1306706407cf7c0bb7f2ced5c8c581be9d45be426d04ab0306e3ce13e934cc

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.4.0 (2026-06-07)
+
+Full Changelog: [v0.3.0...v0.4.0](https://github.com/cadenya/cadenya-ruby/compare/v0.3.0...v0.4.0)
+
+### Features
+
+* Add AI Provider CRUD endpoints ([91caf5c](https://github.com/cadenya/cadenya-ruby/commit/91caf5c762a8e75460076b4a9a864c9a34345720))
+
+## 0.3.0 (2026-06-05)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/cadenya/cadenya-ruby/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* Add admin profile search (workspaceAdmin.profiles.list) — ENG-308 ([1e4797b](https://github.com/cadenya/cadenya-ruby/commit/1e4797be9bef5f7382270eb22d4e7ee1cea5a317))
+* **api:** api update ([8721ef8](https://github.com/cadenya/cadenya-ruby/commit/8721ef8a408a83e13ef49da9f8257027da9fa69d))
+* **api:** api update ([e4f7e6e](https://github.com/cadenya/cadenya-ruby/commit/e4f7e6e38b74ecb01be4e006d24ce5878343d481))
+* **api:** api update ([ca33f81](https://github.com/cadenya/cadenya-ruby/commit/ca33f814f4b7dbcdff61c64165a15742c1e281d0))
+* **api:** api update ([e7a5a6d](https://github.com/cadenya/cadenya-ruby/commit/e7a5a6de7e7a9c4f9310e5feff50cc1a733103f1))
+* **api:** api update ([98b0521](https://github.com/cadenya/cadenya-ruby/commit/98b0521380484243a201a4c0c2779808d4a2acad))
+* **api:** api update ([f2e807e](https://github.com/cadenya/cadenya-ruby/commit/f2e807e762dc8d0e4b2dfcd4cf16ff5161ef3003))
+* **api:** api update ([c2c28b1](https://github.com/cadenya/cadenya-ruby/commit/c2c28b16acff45120a9568952a812341502329fc))
+* **api:** api update ([0cb5f64](https://github.com/cadenya/cadenya-ruby/commit/0cb5f6447508b9fa8ed4ca297bc5181955f50c90))
+* **api:** api update ([2975430](https://github.com/cadenya/cadenya-ruby/commit/29754304ee42e35d1c3d38bd02bca0cf45271a16))
+
 ## 0.2.0 (2026-05-14)
 
 Full Changelog: [v0.1.0...v0.2.0](https://github.com/cadenya/cadenya-ruby/compare/v0.1.0...v0.2.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "cadenya", "~> 0.2.0"
+gem "cadenya", "~> 0.4.0"
 ```
 
 <!-- x-release-please-end -->
@@ -53,15 +53,15 @@ List methods in the Cadenya API are paginated.
 This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
 
 ```ruby
-page = cadenya.agents.list
+page = cadenya.ai_provider_keys.list
 
 # Fetch single item from page.
-agent = page.items[0]
-puts(agent.metadata)
+ai_provider_key = page.items[0]
+puts(ai_provider_key.metadata)
 
 # Automatically fetches more pages as needed.
-page.auto_paging_each do |agent|
-  puts(agent.metadata)
+page.auto_paging_each do |ai_provider_key|
+  puts(ai_provider_key.metadata)
 end
 ```
 

data/lib/cadenya/client.rb

@@ -21,6 +21,9 @@ module Cadenya
     # @return [String, nil]
     attr_reader :webhook_key
 
+    # @return [Cadenya::Resources::AIProviderKeys]
+    attr_reader :ai_provider_keys
+
     # Manage the authenticated account. Accounts are the top-level organizational unit
     # and contain one or more workspaces.
     # @return [Cadenya::Resources::Account]
@@ -73,9 +76,22 @@ module Cadenya
 
     # Manage workspaces within an account. Workspaces provide organizational grouping
     # and isolation for resources such as agents, tools, and API keys.
+    #
+    # This is the workspace-scoped, end-user surface. Administrative operations
+    # (create / archive workspaces, manage members) live in WorkspaceAdminService
+    # under /v1/account/workspaces and require the admin role.
     # @return [Cadenya::Resources::Workspaces]
     attr_reader :workspaces
 
+    # Administer workspaces across the account: create and archive workspaces and
+    # manage their membership. These operations are account-scoped and require the
+    # admin role (a token whose profile holds the WorkOS admin role); they live under
+    # /v1/account/workspaces rather than the workspace-scoped /v1/workspaces tree so
+    # an admin can manage any workspace in the account, including ones they are not
+    # themselves a member of.
+    # @return [Cadenya::Resources::WorkspaceAdmin]
+    attr_reader :workspace_admin
+
     # @return [Cadenya::Resources::Webhooks]
     attr_reader :webhooks
 
@@ -150,6 +166,7 @@ module Cadenya
         headers: headers
       )
 
+      @ai_provider_keys = Cadenya::Resources::AIProviderKeys.new(client: self)
       @account = Cadenya::Resources::Account.new(client: self)
       @agents = Cadenya::Resources::Agents.new(client: self)
       @objectives = Cadenya::Resources::Objectives.new(client: self)
@@ -161,6 +178,7 @@ module Cadenya
       @api_keys = Cadenya::Resources::APIKeys.new(client: self)
       @workspace_secrets = Cadenya::Resources::WorkspaceSecrets.new(client: self)
       @workspaces = Cadenya::Resources::Workspaces.new(client: self)
+      @workspace_admin = Cadenya::Resources::WorkspaceAdmin.new(client: self)
       @webhooks = Cadenya::Resources::Webhooks.new(client: self)
       @bulk_workspace_resources = Cadenya::Resources::BulkWorkspaceResources.new(client: self)
     end

data/lib/cadenya/internal/cursor_pagination.rb

@@ -10,8 +10,8 @@ module Cadenya
     #   end
     #
     # @example
-    #   cursor_pagination.auto_paging_each do |agent|
-    #     puts(agent)
+    #   cursor_pagination.auto_paging_each do |ai_provider_key|
+    #     puts(ai_provider_key)
     #   end
     class CursorPagination
       include Cadenya::Internal::Type::BasePage

data/lib/cadenya/models/agent_spec.rb

@@ -31,8 +31,21 @@ module Cadenya
       #   is used as the tool's input parameter schema. If omitted, the sub-agent schema
       #   will be loaded with a simple "prompt" free text string as its schema.
       #
-      #   @return [Object, nil]
-      optional :input_data_schema, Cadenya::Internal::Type::Unknown, api_name: :inputDataSchema
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :input_data_schema,
+               Cadenya::Internal::Type::HashOf[Cadenya::Internal::Type::Unknown],
+               api_name: :inputDataSchema
+
+      # @!attribute output_definition
+      #   Optional output definition for objectives created for this agent. When provided,
+      #   Cadenya will append a tool to that will be called by the LLM in use by the
+      #   variant to extract information in the format provided here. Use this option when
+      #   you want structured data to be created by your objectives.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :output_definition,
+               Cadenya::Internal::Type::HashOf[Cadenya::Internal::Type::Unknown],
+               api_name: :outputDefinition
 
       # @!attribute webhook_events_url
       #   The URL that Cadenya will send events for any objective assigned to the agent.
@@ -40,7 +53,7 @@ module Cadenya
       #   @return [String, nil]
       optional :webhook_events_url, String, api_name: :webhookEventsUrl
 
-      # @!method initialize(status:, variation_selection_mode:, description: nil, input_data_schema: nil, webhook_events_url: nil)
+      # @!method initialize(status:, variation_selection_mode:, description: nil, input_data_schema: nil, output_definition: nil, webhook_events_url: nil)
       #   Some parameter documentations has been truncated, see
       #   {Cadenya::Models::AgentSpec} for more details.
       #
@@ -52,7 +65,9 @@ module Cadenya
       #
       #   @param description [String] Description of the agent's purpose
       #
-      #   @param input_data_schema [Object] InputDataSchema is used for enforcing a data input when objectives are created.
+      #   @param input_data_schema [Hash{Symbol=>Object}] InputDataSchema is used for enforcing a data input when objectives are created.
+      #
+      #   @param output_definition [Hash{Symbol=>Object}] Optional output definition for objectives created for this agent.
       #
       #   @param webhook_events_url [String] The URL that Cadenya will send events for any objective assigned to the agent.
 

data/lib/cadenya/models/agents/webhook_delivery_data.rb

@@ -134,6 +134,7 @@ module Cadenya
           OBJECTIVE_EVENT_TYPE_CANCELLED = :OBJECTIVE_EVENT_TYPE_CANCELLED
           OBJECTIVE_EVENT_TYPE_SUB_AGENT_SPAWNED = :OBJECTIVE_EVENT_TYPE_SUB_AGENT_SPAWNED
           OBJECTIVE_EVENT_TYPE_SUB_AGENT_UPDATED = :OBJECTIVE_EVENT_TYPE_SUB_AGENT_UPDATED
+          OBJECTIVE_EVENT_TYPE_FINALIZED = :OBJECTIVE_EVENT_TYPE_FINALIZED
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/cadenya/models/agents/webhook_delivery_list_params.rb

@@ -76,6 +76,7 @@ module Cadenya
           OBJECTIVE_EVENT_TYPE_CANCELLED = :OBJECTIVE_EVENT_TYPE_CANCELLED
           OBJECTIVE_EVENT_TYPE_SUB_AGENT_SPAWNED = :OBJECTIVE_EVENT_TYPE_SUB_AGENT_SPAWNED
           OBJECTIVE_EVENT_TYPE_SUB_AGENT_UPDATED = :OBJECTIVE_EVENT_TYPE_SUB_AGENT_UPDATED
+          OBJECTIVE_EVENT_TYPE_FINALIZED = :OBJECTIVE_EVENT_TYPE_FINALIZED
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/cadenya/models/ai_provider_key.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::AIProviderKeys#create
+    class AIProviderKey < Cadenya::Internal::Type::BaseModel
+      # @!attribute metadata
+      #   Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+      #
+      #   @return [Cadenya::Models::ResourceMetadata]
+      required :metadata, -> { Cadenya::ResourceMetadata }
+
+      # @!attribute spec
+      #
+      #   @return [Cadenya::Models::AIProviderKeySpec]
+      required :spec, -> { Cadenya::AIProviderKeySpec }
+
+      # @!method initialize(metadata:, spec:)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::AIProviderKey} for more details.
+      #
+      #   AIProviderKey is a customer-provided (BYOK) credential for an AI provider,
+      #   scoped to a workspace. The secret value is never returned in responses.
+      #
+      #   @param metadata [Cadenya::Models::ResourceMetadata] Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+      #
+      #   @param spec [Cadenya::Models::AIProviderKeySpec]
+    end
+  end
+end

data/lib/cadenya/models/ai_provider_key_create_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::AIProviderKeys#create
+    class AIProviderKeyCreateParams < 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 metadata
+      #   CreateResourceMetadata contains the user-provided fields for creating a
+      #   workspace-scoped resource. Read-only fields (id, account_id, workspace_id,
+      #   profile_id, created_at) are excluded since they are set by the server.
+      #
+      #   @return [Cadenya::Models::CreateResourceMetadata]
+      required :metadata, -> { Cadenya::CreateResourceMetadata }
+
+      # @!attribute spec
+      #
+      #   @return [Cadenya::Models::AIProviderKeySpec]
+      required :spec, -> { Cadenya::AIProviderKeySpec }
+
+      # @!method initialize(workspace_id:, metadata:, spec:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::AIProviderKeyCreateParams} for more details.
+      #
+      #   @param workspace_id [String]
+      #
+      #   @param metadata [Cadenya::Models::CreateResourceMetadata] CreateResourceMetadata contains the user-provided fields for creating
+      #
+      #   @param spec [Cadenya::Models::AIProviderKeySpec]
+      #
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/ai_provider_key_delete_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::AIProviderKeys#delete
+    class AIProviderKeyDeleteParams < 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 id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(workspace_id:, id:, request_options: {})
+      #   @param workspace_id [String]
+      #   @param id [String]
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/ai_provider_key_list_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::AIProviderKeys#list
+    class AIProviderKeyListParams < 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 cursor
+      #   Pagination cursor from previous response
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   Maximum number of results to return
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute prefix
+      #   Filter expression (query param: prefix)
+      #
+      #   @return [String, nil]
+      optional :prefix, String
+
+      # @!attribute query
+      #   Free-form search query
+      #
+      #   @return [String, nil]
+      optional :query, String
+
+      # @!attribute sort_order
+      #   Sort order for results (asc or desc by creation time)
+      #
+      #   @return [String, nil]
+      optional :sort_order, String
+
+      # @!method initialize(workspace_id:, cursor: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, request_options: {})
+      #   @param workspace_id [String]
+      #
+      #   @param cursor [String] Pagination cursor from previous response
+      #
+      #   @param limit [Integer] Maximum number of results to return
+      #
+      #   @param prefix [String] Filter expression (query param: prefix)
+      #
+      #   @param query [String] Free-form search query
+      #
+      #   @param sort_order [String] Sort order for results (asc or desc by creation time)
+      #
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/ai_provider_key_retrieve_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::AIProviderKeys#retrieve
+    class AIProviderKeyRetrieveParams < 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 id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(workspace_id:, id:, request_options: {})
+      #   @param workspace_id [String]
+      #   @param id [String]
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/ai_provider_key_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class AIProviderKeySpec < Cadenya::Internal::Type::BaseModel
+      # @!attribute api_key
+      #   The provider credential. Accepted on create/update; never populated in responses
+      #   (the server returns an empty value to avoid leaking it).
+      #
+      #   @return [String, nil]
+      optional :api_key, String, api_name: :apiKey
+
+      # @!attribute provider
+      #   The AI provider this key authenticates against. Currently "openrouter".
+      #
+      #   @return [String, nil]
+      optional :provider, String
+
+      # @!attribute region
+      #   The provider region. "us" or "eu". Defaults to "us".
+      #
+      #   @return [String, nil]
+      optional :region, String
+
+      # @!method initialize(api_key: nil, provider: nil, region: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::AIProviderKeySpec} for more details.
+      #
+      #   @param api_key [String] The provider credential. Accepted on create/update; never populated in
+      #
+      #   @param provider [String] The AI provider this key authenticates against. Currently "openrouter".
+      #
+      #   @param region [String] The provider region. "us" or "eu". Defaults to "us".
+    end
+  end
+end

data/lib/cadenya/models/ai_provider_key_update_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::AIProviderKeys#update
+    class AIProviderKeyUpdateParams < 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 id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute metadata
+      #   UpdateResourceMetadata contains the user-provided fields for updating a
+      #   workspace-scoped resource. Read-only fields (id, account_id, workspace_id,
+      #   profile_id, created_at) are excluded since they are set by the server.
+      #
+      #   @return [Cadenya::Models::UpdateResourceMetadata, nil]
+      optional :metadata, -> { Cadenya::UpdateResourceMetadata }
+
+      # @!attribute spec
+      #
+      #   @return [Cadenya::Models::AIProviderKeySpec, nil]
+      optional :spec, -> { Cadenya::AIProviderKeySpec }
+
+      # @!attribute update_mask
+      #   Fields to update.
+      #
+      #   @return [String, nil]
+      optional :update_mask, String, api_name: :updateMask
+
+      # @!method initialize(workspace_id:, id:, metadata: nil, spec: nil, update_mask: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::AIProviderKeyUpdateParams} for more details.
+      #
+      #   @param workspace_id [String]
+      #
+      #   @param id [String]
+      #
+      #   @param metadata [Cadenya::Models::UpdateResourceMetadata] UpdateResourceMetadata contains the user-provided fields for updating
+      #
+      #   @param spec [Cadenya::Models::AIProviderKeySpec]
+      #
+      #   @param update_mask [String] Fields to update.
+      #
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/approval_requirement_filter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class ApprovalRequirementFilter < Cadenya::Internal::Type::BaseModel
+      # @!attribute always
+      #
+      #   @return [Boolean, nil]
+      optional :always, Cadenya::Internal::Type::Boolean
+
+      # @!attribute only
+      #   Top-level filter with simple boolean logic (no nesting)
+      #
+      #   @return [Cadenya::Models::ToolFilter, nil]
+      optional :only, -> { Cadenya::ToolFilter }
+
+      # @!method initialize(always: nil, only: nil)
+      #   Approval filters that will automatically set the approval requirement on tools
+      #   synced from an external source
+      #
+      #   @param always [Boolean]
+      #
+      #   @param only [Cadenya::Models::ToolFilter] Top-level filter with simple boolean logic (no nesting)
+    end
+  end
+end

data/lib/cadenya/models/attribute_filter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class AttributeFilter < Cadenya::Internal::Type::BaseModel
+      # @!attribute attribute
+      #
+      #   @return [Symbol, Cadenya::Models::AttributeFilter::Attribute]
+      required :attribute, enum: -> { Cadenya::AttributeFilter::Attribute }
+
+      # @!attribute matcher
+      #   String matching operations
+      #
+      #   @return [Cadenya::Models::StringMatcher, nil]
+      optional :matcher, -> { Cadenya::StringMatcher }
+
+      # @!method initialize(attribute:, matcher: nil)
+      #   Single attribute filter
+      #
+      #   @param attribute [Symbol, Cadenya::Models::AttributeFilter::Attribute]
+      #
+      #   @param matcher [Cadenya::Models::StringMatcher] String matching operations
+
+      # @see Cadenya::Models::AttributeFilter#attribute
+      module Attribute
+        extend Cadenya::Internal::Type::Enum
+
+        ATTRIBUTE_UNSPECIFIED = :ATTRIBUTE_UNSPECIFIED
+        ATTRIBUTE_NAME = :ATTRIBUTE_NAME
+        ATTRIBUTE_TITLE = :ATTRIBUTE_TITLE
+        ATTRIBUTE_DESCRIPTION = :ATTRIBUTE_DESCRIPTION
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/cadenya/models/objective_data.rb

@@ -53,6 +53,22 @@ module Cadenya
         #   @return [Cadenya::Models::Agent, nil]
         optional :agent, -> { Cadenya::Agent }
 
+        # @!attribute output
+        #   The output of the objective, populated when the objective completes. Will match
+        #   the schema of output_json_schema or output_json_inferred.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :output, Cadenya::Internal::Type::HashOf[Cadenya::Internal::Type::Unknown]
+
+        # @!attribute output_definition
+        #   Snapshot of the agent spec's output_definition at objective creation time. When
+        #   present, the objective will run an extraction step after the LLM finishes.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :output_definition,
+                 Cadenya::Internal::Type::HashOf[Cadenya::Internal::Type::Unknown],
+                 api_name: :outputDefinition
+
         # @!attribute parent_objective_id
         #   A parent objective means the objective was spawned off using a separate agent to
         #   complete an objective
@@ -81,7 +97,7 @@ module Cadenya
         optional :variation, -> { Cadenya::Agents::AgentVariation }
       end
 
-      # @!method initialize(agent: nil, data: nil, initial_message: nil, memory_stack: nil, parent_objective_id: nil, secrets: nil, source_schedule_id: nil, system_prompt: nil, variation: nil)
+      # @!method initialize(agent: nil, data: nil, initial_message: nil, memory_stack: nil, output: nil, output_definition: nil, parent_objective_id: nil, secrets: nil, source_schedule_id: nil, system_prompt: nil, variation: nil)
       #   Some parameter documentations has been truncated, see
       #   {Cadenya::Models::ObjectiveData} for more details.
       #
@@ -93,6 +109,10 @@ module Cadenya
       #
       #   @param memory_stack [Array<Cadenya::Models::MemoryReference>] Memory layers/entries to push onto this objective's memory stack on
       #
+      #   @param output [Hash{Symbol=>Object}] The output of the objective, populated when the objective completes. Will match
+      #
+      #   @param output_definition [Hash{Symbol=>Object}] Snapshot of the agent spec's output_definition at objective creation time.
+      #
       #   @param parent_objective_id [String] A parent objective means the objective was spawned off using a separate agent to
       #
       #   @param secrets [Array<Cadenya::Models::ObjectiveDataSecret>] Secrets that can be used in the headers for tool calls using the secret interpol

data/lib/cadenya/models/objective_event_data.rb

@@ -28,6 +28,14 @@ module Cadenya
       #   @return [Cadenya::Models::ObjectiveError, nil]
       optional :error, -> { Cadenya::ObjectiveError }
 
+      # @!attribute finalized
+      #   ObjectiveFinalized is the terminal event written when an objective is finalized.
+      #   After this event, the objective is super-terminal: no further iterations,
+      #   compaction, or continuation are permitted.
+      #
+      #   @return [Cadenya::Models::ObjectiveEventData::Finalized, nil]
+      optional :finalized, -> { Cadenya::ObjectiveEventData::Finalized }
+
       # @!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
@@ -90,7 +98,7 @@ module Cadenya
       #   @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_agent_spawned: nil, sub_agent_updated: 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)
+      # @!method initialize(assistant_message: nil, cancelled: nil, context_window_compacted: nil, error: nil, finalized: nil, memory_read: nil, sub_agent_spawned: nil, sub_agent_updated: 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.
       #
@@ -102,6 +110,8 @@ module Cadenya
       #
       #   @param error [Cadenya::Models::ObjectiveError]
       #
+      #   @param finalized [Cadenya::Models::ObjectiveEventData::Finalized] ObjectiveFinalized is the terminal event written when an objective is
+      #
       #   @param memory_read [Cadenya::Models::MemoryRead] MemoryRead is emitted each time the agent resolves a key against the
       #
       #   @param sub_agent_spawned [Cadenya::Models::SubAgentSpawned]
@@ -144,6 +154,27 @@ module Cadenya
         #
         #   @param message [String] Optional human-readable note recorded at cancel time. Today the workflow
       end
+
+      # @see Cadenya::Models::ObjectiveEventData#finalized
+      class Finalized < Cadenya::Internal::Type::BaseModel
+        # @!attribute output
+        #   If the objective was created with an output schema, and the agent successfully
+        #   completed the objective, this field will contain the structured output of the
+        #   objective.
+        #
+        #   @return [Object, nil]
+        optional :output, Cadenya::Internal::Type::Unknown
+
+        # @!method initialize(output: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Cadenya::Models::ObjectiveEventData::Finalized} for more details.
+        #
+        #   ObjectiveFinalized is the terminal event written when an objective is finalized.
+        #   After this event, the objective is super-terminal: no further iterations,
+        #   compaction, or continuation are permitted.
+        #
+        #   @param output [Object] If the objective was created with an output schema, and the agent
+      end
     end
   end
 end

data/lib/cadenya/models/objective_list_params.rb

@@ -99,9 +99,10 @@ module Cadenya
         STATE_UNSPECIFIED = :STATE_UNSPECIFIED
         STATE_PENDING = :STATE_PENDING
         STATE_RUNNING = :STATE_RUNNING
-        STATE_COMPLETED = :STATE_COMPLETED
+        STATE_WAITING = :STATE_WAITING
         STATE_FAILED = :STATE_FAILED
         STATE_CANCELLED = :STATE_CANCELLED
+        STATE_FINALIZED = :STATE_FINALIZED
 
         # @!method self.values
         #   @return [Array<Symbol>]