cadenya 0.1.0

data/lib/cadenya/models/objectives/task_retrieve_params.rb

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

data/lib/cadenya/models/objectives/tool_call_approve_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    module Objectives
+      # @see Cadenya::Resources::Objectives::ToolCalls#approve
+      class ToolCallApproveParams < 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 tool_call_id
+        #
+        #   @return [String]
+        required :tool_call_id, String
+
+        # @!method initialize(workspace_id:, objective_id:, tool_call_id:, request_options: {})
+        #   @param workspace_id [String]
+        #   @param objective_id [String]
+        #   @param tool_call_id [String]
+        #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/cadenya/models/objectives/tool_call_deny_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    module Objectives
+      # @see Cadenya::Resources::Objectives::ToolCalls#deny
+      class ToolCallDenyParams < 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 tool_call_id
+        #
+        #   @return [String]
+        required :tool_call_id, String
+
+        # @!attribute memo
+        #   A memo to associate to the tool call denial. Use a memo to steer the LLM to a
+        #   different decision or usage of the tool.
+        #
+        #   @return [String, nil]
+        optional :memo, String
+
+        # @!method initialize(workspace_id:, objective_id:, tool_call_id:, memo: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Cadenya::Models::Objectives::ToolCallDenyParams} for more details.
+        #
+        #   @param workspace_id [String]
+        #
+        #   @param objective_id [String]
+        #
+        #   @param tool_call_id [String]
+        #
+        #   @param memo [String] A memo to associate to the tool call denial. Use a memo to steer the LLM to a di
+        #
+        #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/cadenya/models/objectives/tool_call_list_params.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    module Objectives
+      # @see Cadenya::Resources::Objectives::ToolCalls#list
+      class ToolCallListParams < 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 status
+        #   Filter by tool call status
+        #
+        #   @return [Symbol, Cadenya::Models::Objectives::ToolCallListParams::Status, nil]
+        optional :status, enum: -> { Cadenya::Objectives::ToolCallListParams::Status }
+
+        # @!method initialize(workspace_id:, objective_id:, cursor: nil, include_info: nil, limit: nil, status: 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 status [Symbol, Cadenya::Models::Objectives::ToolCallListParams::Status] Filter by tool call status
+        #
+        #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+
+        # Filter by tool call status
+        module Status
+          extend Cadenya::Internal::Type::Enum
+
+          TOOL_CALL_STATUS_UNSPECIFIED = :TOOL_CALL_STATUS_UNSPECIFIED
+          TOOL_CALL_STATUS_AUTO_APPROVED = :TOOL_CALL_STATUS_AUTO_APPROVED
+          TOOL_CALL_STATUS_WAITING_FOR_APPROVAL = :TOOL_CALL_STATUS_WAITING_FOR_APPROVAL
+          TOOL_CALL_STATUS_APPROVED = :TOOL_CALL_STATUS_APPROVED
+          TOOL_CALL_STATUS_DENIED = :TOOL_CALL_STATUS_DENIED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/cadenya/models/objectives/tool_list_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    module Objectives
+      # @see Cadenya::Resources::Objectives::Tools#list
+      class ToolListParams < 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 limit
+        #   Maximum number of results to return
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!method initialize(workspace_id:, objective_id:, cursor: nil, limit: nil, request_options: {})
+        #   @param workspace_id [String]
+        #
+        #   @param objective_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/operation_metadata.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class OperationMetadata < Cadenya::Internal::Type::BaseModel
+      # @!attribute external_id
+      #   External ID for the operation (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:
+      #   {"priority": "high", "source": "api", "workflow": "onboarding"}
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, Cadenya::Internal::Type::HashOf[String]
+
+      response_only do
+        # @!attribute id
+        #   Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...")
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute account_id
+        #   Account this operation belongs to for multi-tenant isolation (prefixed ULID)
+        #
+        #   @return [String]
+        required :account_id, String, api_name: :accountId
+
+        # @!attribute created_at
+        #   Timestamp when this operation was created ULID includes timestamp information,
+        #   but this explicit field enables easier querying
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute profile_id
+        #   ID of the actor (user or service account) that created this operation
+        #
+        #   @return [String]
+        required :profile_id, String, api_name: :profileId
+
+        # @!attribute workspace_id
+        #   Workspace this operation belongs to for organizational grouping (prefixed ULID)
+        #
+        #   @return [String]
+        required :workspace_id, String, api_name: :workspaceId
+      end
+
+      # @!method initialize(id:, account_id:, created_at:, profile_id:, workspace_id:, external_id: nil, labels: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::OperationMetadata} for more details.
+      #
+      #   Metadata for ephemeral operations and activities (e.g., objectives, executions,
+      #   runs)
+      #
+      #   @param id [String] Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...")
+      #
+      #   @param account_id [String] Account this operation belongs to for multi-tenant isolation (prefixed ULID)
+      #
+      #   @param created_at [Time] Timestamp when this operation was created
+      #
+      #   @param profile_id [String] ID of the actor (user or service account) that created this operation
+      #
+      #   @param workspace_id [String] Workspace this operation belongs to for organizational grouping (prefixed ULID)
+      #
+      #   @param external_id [String] External ID for the operation (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

data/lib/cadenya/models/page.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class Page < Cadenya::Internal::Type::BaseModel
+      # @!attribute next_cursor
+      #
+      #   @return [String, nil]
+      optional :next_cursor, String, api_name: :nextCursor
+
+      # @!attribute total
+      #
+      #   @return [Integer, nil]
+      optional :total, Integer
+
+      # @!method initialize(next_cursor: nil, total: nil)
+      #   @param next_cursor [String]
+      #   @param total [Integer]
+    end
+  end
+end

data/lib/cadenya/models/profile.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class Profile < Cadenya::Internal::Type::BaseModel
+      # @!attribute metadata
+      #   AccountResourceMetadata is used to represent a resource that is associated to an
+      #   account but not to a workspace.
+      #
+      #   @return [Cadenya::Models::AccountResourceMetadata]
+      required :metadata, -> { Cadenya::AccountResourceMetadata }
+
+      # @!attribute spec
+      #   Configuration for a profile.
+      #
+      #   @return [Cadenya::Models::ProfileSpec]
+      required :spec, -> { Cadenya::ProfileSpec }
+
+      # @!method initialize(metadata:, spec:)
+      #   Some parameter documentations has been truncated, see {Cadenya::Models::Profile}
+      #   for more details.
+      #
+      #   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.
+      #
+      #   @param metadata [Cadenya::Models::AccountResourceMetadata] AccountResourceMetadata is used to represent a resource that is associated to an
+      #
+      #   @param spec [Cadenya::Models::ProfileSpec] Configuration for a profile.
+    end
+  end
+end

data/lib/cadenya/models/profile_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class ProfileSpec < Cadenya::Internal::Type::BaseModel
+      # @!attribute type
+      #   Whether this profile represents a human user, an API key, or a system principal.
+      #
+      #   @return [Symbol, Cadenya::Models::ProfileSpec::Type]
+      required :type, enum: -> { Cadenya::ProfileSpec::Type }
+
+      # @!attribute email
+      #   Email address of the profile. Required and unique within an account for user
+      #   profiles.
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute name
+      #   Display name (e.g., "Bobby Tables").
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(type:, email: nil, name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::ProfileSpec} for more details.
+      #
+      #   Configuration for a profile.
+      #
+      #   @param type [Symbol, Cadenya::Models::ProfileSpec::Type] Whether this profile represents a human user, an API key, or a system
+      #
+      #   @param email [String] Email address of the profile. Required and unique within an account for
+      #
+      #   @param name [String] Display name (e.g., "Bobby Tables").
+
+      # Whether this profile represents a human user, an API key, or a system principal.
+      #
+      # @see Cadenya::Models::ProfileSpec#type
+      module Type
+        extend Cadenya::Internal::Type::Enum
+
+        PROFILE_TYPE_USER = :PROFILE_TYPE_USER
+        PROFILE_TYPE_API_KEY = :PROFILE_TYPE_API_KEY
+        PROFILE_TYPE_SYSTEM = :PROFILE_TYPE_SYSTEM
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/cadenya/models/resource_metadata.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class ResourceMetadata < Cadenya::Internal::Type::BaseModel
+      # @!attribute name
+      #   Human-readable name for the resource (e.g., "Customer Support Agent", "Email
+      #   Tool") Required for resources that users interact with directly
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute bundle_key
+      #   Optional bundle ownership key. When set, indicates the resource is managed by a
+      #   configuration bundle identified by this key. Used by
+      #   BulkWorkspaceResources.Apply to track which resources belong to which bundle for
+      #   reconciliation / soft-delete on re-apply.
+      #
+      #   @return [String, nil]
+      optional :bundle_key, String, api_name: :bundleKey
+
+      # @!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]
+
+      response_only do
+        # @!attribute id
+        #   Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute account_id
+        #   Account this resource belongs to for multi-tenant isolation (prefixed ULID)
+        #
+        #   @return [String]
+        required :account_id, String, api_name: :accountId
+
+        # @!attribute created_at
+        #   Timestamp when this resource was created
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute profile_id
+        #   ID of the actor (user or service account) that created this resource
+        #
+        #   @return [String]
+        required :profile_id, String, api_name: :profileId
+
+        # @!attribute workspace_id
+        #   Workspace this resource belongs to for organizational grouping (prefixed ULID)
+        #
+        #   @return [String]
+        required :workspace_id, String, api_name: :workspaceId
+      end
+
+      # @!method initialize(id:, account_id:, created_at:, name:, profile_id:, workspace_id:, bundle_key: nil, external_id: nil, labels: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::ResourceMetadata} for more details.
+      #
+      #   Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+      #
+      #   @param id [String] Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")
+      #
+      #   @param account_id [String] Account this resource belongs to for multi-tenant isolation (prefixed ULID)
+      #
+      #   @param created_at [Time] Timestamp when this resource was created
+      #
+      #   @param name [String] Human-readable name for the resource (e.g., "Customer Support Agent", "Email Too
+      #
+      #   @param profile_id [String] ID of the actor (user or service account) that created this resource
+      #
+      #   @param workspace_id [String] Workspace this resource belongs to for organizational grouping (prefixed ULID)
+      #
+      #   @param bundle_key [String] Optional bundle ownership key. When set, indicates the resource is
+      #
+      #   @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

data/lib/cadenya/models/rotate_webhook_signing_key_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::Account#rotate_webhook_signing_key
+    class RotateWebhookSigningKeyResponse < Cadenya::Internal::Type::BaseModel
+      # @!attribute webhook_events_hmac_secret
+      #
+      #   @return [String, nil]
+      optional :webhook_events_hmac_secret, String, api_name: :webhookEventsHmacSecret
+
+      # @!method initialize(webhook_events_hmac_secret: nil)
+      #   Response containing the newly generated webhook signing secret.
+      #
+      #   @param webhook_events_hmac_secret [String]
+    end
+  end
+end

data/lib/cadenya/models/search_search_tools_or_tool_sets_params.rb

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

data/lib/cadenya/models/search_search_tools_or_tool_sets_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::Search#search_tools_or_tool_sets
+    class SearchSearchToolsOrToolSetsResponse < Cadenya::Internal::Type::BaseModel
+      # @!attribute agents
+      #
+      #   @return [Array<Cadenya::Models::Agent>, nil]
+      optional :agents, -> { Cadenya::Internal::Type::ArrayOf[Cadenya::Agent] }
+
+      # @!attribute tools
+      #
+      #   @return [Array<Cadenya::Models::ToolSets::Tool>, nil]
+      optional :tools, -> { Cadenya::Internal::Type::ArrayOf[Cadenya::ToolSets::Tool] }
+
+      # @!attribute tool_sets
+      #
+      #   @return [Array<Cadenya::Models::ToolSet>, nil]
+      optional :tool_sets, -> { Cadenya::Internal::Type::ArrayOf[Cadenya::ToolSet] }, api_name: :toolSets
+
+      # @!method initialize(agents: nil, tools: nil, tool_sets: nil)
+      #   @param agents [Array<Cadenya::Models::Agent>]
+      #   @param tools [Array<Cadenya::Models::ToolSets::Tool>]
+      #   @param tool_sets [Array<Cadenya::Models::ToolSet>]
+    end
+  end
+end

data/lib/cadenya/models/sub_objective_created.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class SubObjectiveCreated < Cadenya::Internal::Type::BaseModel
+      # @!attribute metadata
+      #   Metadata for ephemeral operations and activities (e.g., objectives, executions,
+      #   runs)
+      #
+      #   @return [Cadenya::Models::OperationMetadata, nil]
+      optional :metadata, -> { Cadenya::OperationMetadata }
+
+      # @!method initialize(metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::SubObjectiveCreated} for more details.
+      #
+      #   @param metadata [Cadenya::Models::OperationMetadata] Metadata for ephemeral operations and activities (e.g., objectives, executions,
+    end
+  end
+end

data/lib/cadenya/models/sync_completed.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class SyncCompleted < Cadenya::Internal::Type::BaseModel
+      # @!attribute message
+      #   Optional message with additional details.
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute tools_synced
+      #   Number of tools synced.
+      #
+      #   @return [Integer, nil]
+      optional :tools_synced, Integer, api_name: :toolsSynced
+
+      # @!method initialize(message: nil, tools_synced: nil)
+      #   Emitted when a tool set sync operation completes successfully.
+      #
+      #   @param message [String] Optional message with additional details.
+      #
+      #   @param tools_synced [Integer] Number of tools synced.
+    end
+  end
+end

data/lib/cadenya/models/sync_failed.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    class SyncFailed < Cadenya::Internal::Type::BaseModel
+      # @!attribute error
+      #   Indicates this is an error event.
+      #
+      #   @return [Boolean, nil]
+      optional :error, Cadenya::Internal::Type::Boolean
+
+      # @!attribute error_type
+      #   Optional error type/code for programmatic handling.
+      #
+      #   @return [String, nil]
+      optional :error_type, String, api_name: :errorType
+
+      # @!attribute message
+      #   Error message describing what went wrong.
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!method initialize(error: nil, error_type: nil, message: nil)
+      #   Emitted when a tool set sync operation fails.
+      #
+      #   @param error [Boolean] Indicates this is an error event.
+      #
+      #   @param error_type [String] Optional error type/code for programmatic handling.
+      #
+      #   @param message [String] Error message describing what went wrong.
+    end
+  end
+end