cadenya 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dff0947b39a815faaea2a4f68747c1d0117318d8f2aee08f8bca4cab40b69f7
-  data.tar.gz: ec5c0bb41033ed07ab07d33fd24dac1853b9ec65280dc8493902646d62e5eb03
+  metadata.gz: f2d3ccc2b08967b6c09113b9f86077582cecb2ff914643efd624d35f590ee2e9
+  data.tar.gz: 7e2cfc5c58da2c628a855f586bc46aba2b96c936ac13611c3cb0761b54c0e028
 SHA512:
-  metadata.gz: 146f613ac26f3669be288789e44d5727defcbf3373b5fe74c0b5cd11352476be830358a4def179cddb144192629ad7e14c798cb25ac48907c7379879e6ce5a60
-  data.tar.gz: 553296baa57d871c6f99976e480f3f67c60cb1afc6fda396816a4a3c4f263e3ceb588ebb64f9ce2070a53cbf1ecf03ba14c0b90d9f0ef48773786715ea3c04e2
+  metadata.gz: 577b0a9463ee0830ec2f85033e6e858172101ca5580f398c919c4c45b6c5d5867358fa2c3e1dc18f316040ce50bde17065d18991a7bc053a8d4a4dcae936ac54
+  data.tar.gz: 623d30dc59554aeb07440ac9c163fc99ff2cb45120c36601a74133b3cb7cb02301f37b5abcf47addf165eacdc2652254846a81d9bf0f2d02ce49d71ac3f091f3

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.5.0 (2026-06-07)
+
+Full Changelog: [v0.4.0...v0.5.0](https://github.com/cadenya/cadenya-ruby/compare/v0.4.0...v0.5.0)
+
+### Features
+
+* **api:** api update ([d88fdeb](https://github.com/cadenya/cadenya-ruby/commit/d88fdeb06d9d9ba77523cb5b36818c74119ec466))
+
+## 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)

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.3.0"
+gem "cadenya", "~> 0.5.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]
@@ -163,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)

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/ai_provider_key.rb

@@ -0,0 +1,66 @@
+# 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 }
+
+      response_only do
+        # @!attribute info
+        #   AIProviderKeyInfo carries server-derived, read-only details about a key, for AI
+        #   provider management UIs.
+        #
+        #   @return [Cadenya::Models::AIProviderKey::Info, nil]
+        optional :info, -> { Cadenya::AIProviderKey::Info }
+      end
+
+      # @!method initialize(metadata:, spec:, info: nil)
+      #   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]
+      #
+      #   @param info [Cadenya::Models::AIProviderKey::Info] AIProviderKeyInfo carries server-derived, read-only details about a key, for
+
+      # @see Cadenya::Models::AIProviderKey#info
+      class Info < Cadenya::Internal::Type::BaseModel
+        response_only do
+          # @!attribute disabled_model_count
+          #   Number of disabled models provisioned on this key.
+          #
+          #   @return [Integer, nil]
+          optional :disabled_model_count, Integer, api_name: :disabledModelCount
+
+          # @!attribute enabled_model_count
+          #   Number of enabled models provisioned on this key.
+          #
+          #   @return [Integer, nil]
+          optional :enabled_model_count, Integer, api_name: :enabledModelCount
+        end
+
+        # @!method initialize(disabled_model_count: nil, enabled_model_count: nil)
+        #   AIProviderKeyInfo carries server-derived, read-only details about a key, for AI
+        #   provider management UIs.
+        #
+        #   @param disabled_model_count [Integer] Number of disabled models provisioned on this key.
+        #
+        #   @param enabled_model_count [Integer] Number of enabled models provisioned on this key.
+      end
+    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,73 @@
+# 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 include_info
+      #   When true, populate each item's info (model counts), at the cost of extra
+      #   lookups.
+      #
+      #   @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 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, include_info: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::AIProviderKeyListParams} for more details.
+      #
+      #   @param workspace_id [String]
+      #
+      #   @param cursor [String] Pagination cursor from previous response
+      #
+      #   @param include_info [Boolean] When true, populate each item's info (model counts), at the cost of extra
+      #
+      #   @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,51 @@
+# 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 openrouter
+      #   OpenRouterConfig holds OpenRouter-specific settings. Empty for now; it exists as
+      #   the oneof seam so provider-specific options (region, base URL, etc.) can be
+      #   added later without restructuring the spec.
+      #
+      #   @return [Object, nil]
+      optional :openrouter, Cadenya::Internal::Type::Unknown
+
+      # @!attribute provider
+      #   The AI provider this key authenticates against.
+      #
+      #   @return [Symbol, Cadenya::Models::AIProviderKeySpec::Provider, nil]
+      optional :provider, enum: -> { Cadenya::AIProviderKeySpec::Provider }
+
+      # @!method initialize(api_key: nil, openrouter: nil, provider: 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 openrouter [Object] OpenRouterConfig holds OpenRouter-specific settings. Empty for now; it exists
+      #
+      #   @param provider [Symbol, Cadenya::Models::AIProviderKeySpec::Provider] The AI provider this key authenticates against.
+
+      # The AI provider this key authenticates against.
+      #
+      # @see Cadenya::Models::AIProviderKeySpec#provider
+      module Provider
+        extend Cadenya::Internal::Type::Enum
+
+        AI_PROVIDER_UNSPECIFIED = :AI_PROVIDER_UNSPECIFIED
+        AI_PROVIDER_OPENROUTER = :AI_PROVIDER_OPENROUTER
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    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/model.rb

@@ -16,13 +16,68 @@ module Cadenya
       #   @return [Cadenya::Models::ModelSpec]
       required :spec, -> { Cadenya::ModelSpec }
 
-      # @!method initialize(metadata:, spec:)
+      response_only do
+        # @!attribute info
+        #   ModelInfo carries server-derived, read-only details about a model.
+        #
+        #   @return [Cadenya::Models::Model::Info, nil]
+        optional :info, -> { Cadenya::Model::Info }
+      end
+
+      # @!method initialize(metadata:, spec:, info: nil)
       #   Some parameter documentations has been truncated, see {Cadenya::Models::Model}
       #   for more details.
       #
       #   @param metadata [Cadenya::Models::ResourceMetadata] Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
       #
       #   @param spec [Cadenya::Models::ModelSpec] Model specification
+      #
+      #   @param info [Cadenya::Models::Model::Info] ModelInfo carries server-derived, read-only details about a model.
+
+      # @see Cadenya::Models::Model#info
+      class Info < Cadenya::Internal::Type::BaseModel
+        response_only do
+          # @!attribute ai_provider_key
+          #   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.
+          #
+          #   @return [Cadenya::Models::BareMetadata, nil]
+          optional :ai_provider_key, -> { Cadenya::BareMetadata }, api_name: :aiProviderKey
+
+          # @!attribute provider
+          #   The AI provider this model routes through (via its provider key).
+          #
+          #   @return [Symbol, Cadenya::Models::Model::Info::Provider, nil]
+          optional :provider, enum: -> { Cadenya::Model::Info::Provider }
+        end
+
+        # @!method initialize(ai_provider_key: nil, provider: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Cadenya::Models::Model::Info} for more details.
+        #
+        #   ModelInfo carries server-derived, read-only details about a model.
+        #
+        #   @param ai_provider_key [Cadenya::Models::BareMetadata] BareMetadata contains the minimal metadata for a resource: the ID and an
+        #
+        #   @param provider [Symbol, Cadenya::Models::Model::Info::Provider] The AI provider this model routes through (via its provider key).
+
+        # The AI provider this model routes through (via its provider key).
+        #
+        # @see Cadenya::Models::Model::Info#provider
+        module Provider
+          extend Cadenya::Internal::Type::Enum
+
+          AI_PROVIDER_UNSPECIFIED = :AI_PROVIDER_UNSPECIFIED
+          AI_PROVIDER_OPENROUTER = :AI_PROVIDER_OPENROUTER
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
     end
   end
 end

data/lib/cadenya/models/model_list_params.rb

@@ -12,6 +12,13 @@ module Cadenya
       #   @return [String]
       required :workspace_id, String
 
+      # @!attribute ai_provider_key_id
+      #   Filter to models provisioned on a specific AI provider key. Accepts the key's id
+      #   or an "external_id:"-prefixed slug.
+      #
+      #   @return [String, nil]
+      optional :ai_provider_key_id, String
+
       # @!attribute bundle_key
       #   Filter by bundle_key — return only resources owned by this bundle.
       #
@@ -24,6 +31,13 @@ module Cadenya
       #   @return [String, nil]
       optional :cursor, String
 
+      # @!attribute include_info
+      #   When true, populate each item's info (e.g. the AI provider), at the cost of
+      #   extra lookups.
+      #
+      #   @return [Boolean, nil]
+      optional :include_info, Cadenya::Internal::Type::Boolean
+
       # @!attribute limit
       #   Maximum number of results to return
       #
@@ -54,13 +68,20 @@ module Cadenya
       #   @return [Symbol, Cadenya::Models::ModelListParams::Status, nil]
       optional :status, enum: -> { Cadenya::ModelListParams::Status }
 
-      # @!method initialize(workspace_id:, bundle_key: nil, cursor: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, status: nil, request_options: {})
+      # @!method initialize(workspace_id:, ai_provider_key_id: nil, bundle_key: nil, cursor: nil, include_info: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Cadenya::Models::ModelListParams} for more details.
+      #
       #   @param workspace_id [String]
       #
+      #   @param ai_provider_key_id [String] Filter to models provisioned on a specific AI provider key. Accepts the
+      #
       #   @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, populate each item's info (e.g. the AI provider), at the cost of
+      #
       #   @param limit [Integer] Maximum number of results to return
       #
       #   @param prefix [String] Filter by name prefix

data/lib/cadenya/models.rb

@@ -75,6 +75,20 @@ module Cadenya
 
   AgentVariationEntry = Cadenya::Models::AgentVariationEntry
 
+  AIProviderKey = Cadenya::Models::AIProviderKey
+
+  AIProviderKeyCreateParams = Cadenya::Models::AIProviderKeyCreateParams
+
+  AIProviderKeyDeleteParams = Cadenya::Models::AIProviderKeyDeleteParams
+
+  AIProviderKeyListParams = Cadenya::Models::AIProviderKeyListParams
+
+  AIProviderKeyRetrieveParams = Cadenya::Models::AIProviderKeyRetrieveParams
+
+  AIProviderKeySpec = Cadenya::Models::AIProviderKeySpec
+
+  AIProviderKeyUpdateParams = Cadenya::Models::AIProviderKeyUpdateParams
+
   APIKey = Cadenya::Models::APIKey
 
   APIKeyCreateParams = Cadenya::Models::APIKeyCreateParams