cadenya 0.1.0

data/lib/cadenya/models/api_key_list_params.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::APIKeys#list
+    class APIKeyListParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!attribute bundle_key
+      #   Filter by bundle_key — return only resources owned by this bundle.
+      #
+      #   @return [String, nil]
+      optional :bundle_key, String
+
+      # @!attribute cursor
+      #   Pagination cursor from previous response.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute include_info
+      #   When true, included info fields are populated. Requests with this flag count
+      #   more against your 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 prefix
+      #   Filter by ID 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(bundle_key: nil, cursor: nil, include_info: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::APIKeyListParams} for more details.
+      #
+      #   @param bundle_key [String] Filter by bundle_key — return only resources owned by this bundle.
+      #
+      #   @param cursor [String] Pagination cursor from previous response.
+      #
+      #   @param include_info [Boolean] When true, included info fields are populated. Requests with this
+      #
+      #   @param limit [Integer] Maximum number of results to return.
+      #
+      #   @param prefix [String] Filter by ID 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/api_key_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::APIKeys#retrieve
+    class APIKeyRetrieveParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/api_key_rotate_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::APIKeys#rotate
+    class APIKeyRotateParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/api_key_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class APIKeySpec < Cadenya::Internal::Type::BaseModel
+      # @!attribute description
+      #   Free-form description of what this API key is used for.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute permissions
+      #   Permissions granted to this key. Each entry is a colon-separated verb:resource
+      #   string (e.g. "manage:agents"). Currently has no enforced effect; reserved for
+      #   future fine-grained authorization.
+      #
+      #   @return [Array<String>, nil]
+      optional :permissions, Cadenya::Internal::Type::ArrayOf[String]
+
+      response_only do
+        # @!attribute token
+        #   The bearer token used to authenticate as this API key. Returned only on creation
+        #   and rotation; subsequent reads omit this field.
+        #
+        #   @return [String, nil]
+        optional :token, String
+
+        # @!attribute system_
+        #   True when this key is managed by the system (e.g. the auto-provisioned global
+        #   account key). System keys cannot be deleted but can be rotated.
+        #
+        #   @return [Boolean, nil]
+        optional :system_, Cadenya::Internal::Type::Boolean, api_name: :system
+      end
+
+      # @!method initialize(token: nil, description: nil, permissions: nil, system_: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::APIKeySpec} for more details.
+      #
+      #   Configuration for an API key.
+      #
+      #   @param token [String] The bearer token used to authenticate as this API key. Returned only on
+      #
+      #   @param description [String] Free-form description of what this API key is used for.
+      #
+      #   @param permissions [Array<String>] Permissions granted to this key. Each entry is a colon-separated
+      #
+      #   @param system_ [Boolean] True when this key is managed by the system (e.g. the auto-provisioned
+    end
+  end
+end

data/lib/cadenya/models/api_key_update_params.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::APIKeys#update
+    class APIKeyUpdateParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute metadata
+      #   UpdateAccountResourceMetadata contains the user-provided fields for updating an
+      #   account-scoped resource. Read-only fields (id, account_id, profile_id) are
+      #   excluded since they are set by the server.
+      #
+      #   @return [Cadenya::Models::APIKeyUpdateParams::Metadata, nil]
+      optional :metadata, -> { Cadenya::APIKeyUpdateParams::Metadata }
+
+      # @!attribute spec
+      #   Configuration for an API key.
+      #
+      #   @return [Cadenya::Models::APIKeySpec, nil]
+      optional :spec, -> { Cadenya::APIKeySpec }
+
+      # @!attribute update_mask
+      #   Fields to update.
+      #
+      #   @return [String, nil]
+      optional :update_mask, String, api_name: :updateMask
+
+      # @!method initialize(id:, metadata: nil, spec: nil, update_mask: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::APIKeyUpdateParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param metadata [Cadenya::Models::APIKeyUpdateParams::Metadata] UpdateAccountResourceMetadata contains the user-provided fields for updating
+      #
+      #   @param spec [Cadenya::Models::APIKeySpec] Configuration for an API key.
+      #
+      #   @param update_mask [String] Fields to update.
+      #
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+
+      class Metadata < Cadenya::Internal::Type::BaseModel
+        # @!attribute name
+        #   Human-readable name for the resource (e.g., "Production API Key", "Staging
+        #   Workspace")
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute external_id
+        #   External ID for the resource (e.g., a workflow ID from an external system)
+        #
+        #   @return [String, nil]
+        optional :external_id, String, api_name: :externalId
+
+        # @!attribute labels
+        #   Arbitrary key-value pairs for categorization and filtering Examples:
+        #   {"environment": "production", "team": "platform", "version": "v2"}
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :labels, Cadenya::Internal::Type::HashOf[String]
+
+        # @!method initialize(name:, external_id: nil, labels: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Cadenya::Models::APIKeyUpdateParams::Metadata} for more details.
+        #
+        #   UpdateAccountResourceMetadata contains the user-provided fields for updating an
+        #   account-scoped resource. Read-only fields (id, account_id, profile_id) are
+        #   excluded since they are set by the server.
+        #
+        #   @param name [String] Human-readable name for the resource (e.g., "Production API Key", "Staging Works
+        #
+        #   @param external_id [String] External ID for the resource (e.g., a workflow ID from an external system)
+        #
+        #   @param labels [Hash{Symbol=>String}] Arbitrary key-value pairs for categorization and filtering
+      end
+    end
+  end
+end

data/lib/cadenya/models/api_keys/access_add_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    module APIKeys
+      # @see Cadenya::Resources::APIKeys::Access#add
+      class AccessAddParams < Cadenya::Internal::Type::BaseModel
+        extend Cadenya::Internal::Type::RequestParameters::Converter
+        include Cadenya::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute workspace_id
+        #   The workspace to grant access to.
+        #
+        #   @return [String, nil]
+        optional :workspace_id, String, api_name: :workspaceId
+
+        # @!method initialize(id:, workspace_id: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param workspace_id [String] The workspace to grant access to.
+        #
+        #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/cadenya/models/api_keys/access_list_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    module APIKeys
+      # @see Cadenya::Resources::APIKeys::Access#list
+      class AccessListParams < Cadenya::Internal::Type::BaseModel
+        extend Cadenya::Internal::Type::RequestParameters::Converter
+        include Cadenya::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :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
+
+        # @!method initialize(id:, cursor: nil, limit: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param cursor [String] Pagination cursor from previous response.
+        #
+        #   @param limit [Integer] Maximum number of results to return.
+        #
+        #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/cadenya/models/api_keys/access_remove_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    module APIKeys
+      # @see Cadenya::Resources::APIKeys::Access#remove
+      class AccessRemoveParams < Cadenya::Internal::Type::BaseModel
+        extend Cadenya::Internal::Type::RequestParameters::Converter
+        include Cadenya::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute workspace_id
+        #
+        #   @return [String]
+        required :workspace_id, String
+
+        # @!method initialize(id:, workspace_id:, request_options: {})
+        #   @param id [String]
+        #   @param workspace_id [String]
+        #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/cadenya/models/assistant_message.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class AssistantMessage < Cadenya::Internal::Type::BaseModel
+      # @!attribute content
+      #
+      #   @return [String, nil]
+      optional :content, String
+
+      # @!attribute tool_calls
+      #
+      #   @return [Array<Cadenya::Models::AssistantToolCall>, nil]
+      optional :tool_calls,
+               -> { Cadenya::Internal::Type::ArrayOf[Cadenya::AssistantToolCall] },
+               api_name: :toolCalls
+
+      # @!method initialize(content: nil, tool_calls: nil)
+      #   @param content [String]
+      #   @param tool_calls [Array<Cadenya::Models::AssistantToolCall>]
+    end
+  end
+end

data/lib/cadenya/models/assistant_tool_call.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class AssistantToolCall < Cadenya::Internal::Type::BaseModel
+      # @!attribute arguments
+      #
+      #   @return [String, nil]
+      optional :arguments, String
+
+      # @!attribute function_name
+      #
+      #   @return [String, nil]
+      optional :function_name, String, api_name: :functionName
+
+      # @!attribute tool
+      #   CallableTool is a union that represents a tool that can be called by an agent.
+      #   In Cadenya, a tool that is used within an agent objective might be a
+      #   user-defined tool (IE: MCP, HTTP), another Agent (useful to separate context),
+      #   or a Cadenya Tool (one Cadenya provides).
+      #
+      #   @return [Cadenya::Models::CallableTool, nil]
+      optional :tool, -> { Cadenya::CallableTool }
+
+      # @!method initialize(arguments: nil, function_name: nil, tool: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::AssistantToolCall} for more details.
+      #
+      #   @param arguments [String]
+      #
+      #   @param function_name [String]
+      #
+      #   @param tool [Cadenya::Models::CallableTool] CallableTool is a union that represents a tool that can be called by an agent. I
+    end
+  end
+end

data/lib/cadenya/models/bare_metadata.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class BareMetadata < Cadenya::Internal::Type::BaseModel
+      response_only do
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute name
+        #   Human-readable name of the referenced resource, populated by the server on reads
+        #   for convenience. Absent on references to resources that do not have a name
+        #   (e.g., objective tasks).
+        #
+        #   @return [String, nil]
+        optional :name, String
+      end
+
+      # @!method initialize(id: nil, name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::BareMetadata} for more details.
+      #
+      #   BareMetadata contains the minimal metadata for a resource: the ID and an
+      #   optional human-readable name. These are used for reference fields where the full
+      #   metadata (account scoping, timestamps, labels, external IDs) is not needed —
+      #   e.g., the tool references inside an agent variation spec or the tools assigned
+      #   to an objective. Both fields are server-populated; clients provide IDs through
+      #   sibling fields rather than by constructing a BareMetadata themselves.
+      #
+      #   @param id [String]
+      #
+      #   @param name [String] Human-readable name of the referenced resource, populated by the server
+    end
+  end
+end

data/lib/cadenya/models/bulk_workspace_apply.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::BulkWorkspaceResources#retrieve
+    class BulkWorkspaceApply < Cadenya::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Cadenya::Models::BulkWorkspaceApplyData]
+      required :data, -> { Cadenya::BulkWorkspaceApplyData }
+
+      # @!attribute metadata
+      #   Metadata for ephemeral operations and activities (e.g., objectives, executions,
+      #   runs)
+      #
+      #   @return [Cadenya::Models::OperationMetadata]
+      required :metadata, -> { Cadenya::OperationMetadata }
+
+      # @!attribute status
+      #
+      #   @return [Cadenya::Models::BulkWorkspaceApplyStatus]
+      required :status, -> { Cadenya::BulkWorkspaceApplyStatus }
+
+      # @!attribute info
+      #
+      #   @return [Cadenya::Models::BulkWorkspaceApplyInfo, nil]
+      optional :info, -> { Cadenya::BulkWorkspaceApplyInfo }
+
+      # @!method initialize(data:, metadata:, status:, info: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::BulkWorkspaceApply} for more details.
+      #
+      #   The operation resource produced by a call to BulkWorkspaceResources.Apply. It
+      #   carries the input bundle in `data`, the lifecycle state in `status`, and
+      #   aggregate counts in `info`.
+      #
+      #   @param data [Cadenya::Models::BulkWorkspaceApplyData]
+      #
+      #   @param metadata [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
+      #
+      #   @param status [Cadenya::Models::BulkWorkspaceApplyStatus]
+      #
+      #   @param info [Cadenya::Models::BulkWorkspaceApplyInfo]
+    end
+  end
+end

data/lib/cadenya/models/bulk_workspace_apply_data.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class BulkWorkspaceApplyData < Cadenya::Internal::Type::BaseModel
+      # @!attribute bundle_key
+      #   Required. Bundle ownership key. Resources created or updated by an Apply have
+      #   their `metadata.bundle_key` set to this value. On subsequent applies with the
+      #   same bundle_key, resources currently bearing this bundle_key but absent from the
+      #   spec are soft-deleted.
+      #
+      #   @return [String]
+      required :bundle_key, String, api_name: :bundleKey
+
+      # @!attribute agents
+      #   Agents to upsert, keyed by external_id.
+      #
+      #   @return [Hash{Symbol=>Cadenya::Models::AgentEntry}, nil]
+      optional :agents, -> { Cadenya::Internal::Type::HashOf[Cadenya::AgentEntry] }
+
+      # @!attribute automatically_publish_agents
+      #   When true, every agent created or updated by this Apply has its status forced to
+      #   AGENT_STATUS_PUBLISHED, regardless of the status declared in the agent's
+      #   AgentSpec. Useful when the bundle represents a production configuration and you
+      #   want all of its agents live without setting status: AGENT_STATUS_PUBLISHED on
+      #   each entry.
+      #
+      #   Default false: each agent's AgentSpec.status controls (which is
+      #   AGENT_STATUS_DRAFT on create when unspecified).
+      #
+      #   @return [Boolean, nil]
+      optional :automatically_publish_agents,
+               Cadenya::Internal::Type::Boolean,
+               api_name: :automaticallyPublishAgents
+
+      # @!attribute memory_layers
+      #   Memory layers to upsert, keyed by external_id.
+      #
+      #   @return [Hash{Symbol=>Cadenya::Models::MemoryLayerEntry}, nil]
+      optional :memory_layers,
+               -> { Cadenya::Internal::Type::HashOf[Cadenya::MemoryLayerEntry] },
+               api_name: :memoryLayers
+
+      # @!attribute source_url
+      #   Optional URL pointing to the source of this apply (GitHub PR, Jenkins build,
+      #   GitLab pipeline, etc.). Surfaced in the dashboard so users can jump from an
+      #   apply back to the change that produced it. Free-form HTTPS URI; not interpreted
+      #   by the server.
+      #
+      #   @return [String, nil]
+      optional :source_url, String, api_name: :sourceUrl
+
+      # @!attribute tool_sets
+      #   Tool sets to upsert, keyed by external_id.
+      #
+      #   @return [Hash{Symbol=>Cadenya::Models::ToolSetEntry}, nil]
+      optional :tool_sets, -> { Cadenya::Internal::Type::HashOf[Cadenya::ToolSetEntry] }, api_name: :toolSets
+
+      # @!method initialize(bundle_key:, agents: nil, automatically_publish_agents: nil, memory_layers: nil, source_url: nil, tool_sets: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::BulkWorkspaceApplyData} for more details.
+      #
+      #   @param bundle_key [String] Required. Bundle ownership key. Resources created or updated by an
+      #
+      #   @param agents [Hash{Symbol=>Cadenya::Models::AgentEntry}] Agents to upsert, keyed by external_id.
+      #
+      #   @param automatically_publish_agents [Boolean] When true, every agent created or updated by this Apply has its
+      #
+      #   @param memory_layers [Hash{Symbol=>Cadenya::Models::MemoryLayerEntry}] Memory layers to upsert, keyed by external_id.
+      #
+      #   @param source_url [String] Optional URL pointing to the source of this apply (GitHub PR,
+      #
+      #   @param tool_sets [Hash{Symbol=>Cadenya::Models::ToolSetEntry}] Tool sets to upsert, keyed by external_id.
+    end
+  end
+end

data/lib/cadenya/models/bulk_workspace_apply_info.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class BulkWorkspaceApplyInfo < 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
+
+      response_only do
+        # @!attribute completed_at
+        #
+        #   @return [Time, nil]
+        optional :completed_at, Time, api_name: :completedAt
+
+        # @!attribute created_count
+        #
+        #   @return [Integer, nil]
+        optional :created_count, Integer, api_name: :createdCount
+
+        # @!attribute deleted_count
+        #
+        #   @return [Integer, nil]
+        optional :deleted_count, Integer, api_name: :deletedCount
+
+        # @!attribute failed_count
+        #
+        #   @return [Integer, nil]
+        optional :failed_count, Integer, api_name: :failedCount
+
+        # @!attribute started_at
+        #
+        #   @return [Time, nil]
+        optional :started_at, Time, api_name: :startedAt
+
+        # @!attribute total_count
+        #
+        #   @return [Integer, nil]
+        optional :total_count, Integer, api_name: :totalCount
+
+        # @!attribute unchanged_count
+        #
+        #   @return [Integer, nil]
+        optional :unchanged_count, Integer, api_name: :unchangedCount
+
+        # @!attribute updated_count
+        #
+        #   @return [Integer, nil]
+        optional :updated_count, Integer, api_name: :updatedCount
+      end
+
+      # @!method initialize(completed_at: nil, created_by: nil, created_count: nil, deleted_count: nil, failed_count: nil, started_at: nil, total_count: nil, unchanged_count: nil, updated_count: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::BulkWorkspaceApplyInfo} for more details.
+      #
+      #   @param completed_at [Time]
+      #
+      #   @param created_by [Cadenya::Models::Profile] A profile identifies a user or non-human principal (such as an API key)
+      #
+      #   @param created_count [Integer]
+      #
+      #   @param deleted_count [Integer]
+      #
+      #   @param failed_count [Integer]
+      #
+      #   @param started_at [Time]
+      #
+      #   @param total_count [Integer]
+      #
+      #   @param unchanged_count [Integer]
+      #
+      #   @param updated_count [Integer]
+    end
+  end
+end