cadenya 0.46.0 → 0.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79b84ab7e78753cc37c18d14681dcef08e55da6d0cb3d8e778bc614a05e77439
-  data.tar.gz: b570f4930f97d350ae32f1dda1c088b30aab8a3c78593c1c3da54d461de2c8f7
+  metadata.gz: d5a9b1ef46409d82f62b8be667e5eb848b4342a1e78ff2598f5c0bf08dfbcba9
+  data.tar.gz: f9b1458109789eb38dda8487621bdce7b73698c351b8b0c102624d8b72906d30
 SHA512:
-  metadata.gz: 3648ee30bb158dee7efaff3057cb08377b8755dd27ee594bf54b06aa77f2ac9c0be5ba7bcbd887254e3ff0f130ff1cf0084376c77fde53452e495953d04ebbc9
-  data.tar.gz: ece4840ac89cd0a7c2472a5a1c44fd13c722018bdc52c19e82c7013d66a367351203f9c79cc3dc6114bcb83ceaaccc2b681496b3d207e9fbfcb5b9375626389f
+  metadata.gz: 99de39a30f26701c5a20ae71cb42eeb8a78ea02e86b1f5790648eb428a9d1f6dee0844af0c6b1c71749e3945f3dd28e6bec31034e529ad2aab99ea18fd74df56
+  data.tar.gz: 2e98c90c7306b66b45aeb79a4fb5ef0be0e1ca90cef3f7d387d6860dedbce7ef56316437b251b2b483bb4e328da4bee2a15e2f4cd372ec1c2bbcbe9266f19905

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.47.0 (2026-07-18)
+
+Full Changelog: [v0.46.0...v0.47.0](https://github.com/cadenya/cadenya-ruby/compare/v0.46.0...v0.47.0)
+
+### Features
+
+* **api:** api update ([f7674c5](https://github.com/cadenya/cadenya-ruby/commit/f7674c54e9dd5db75c397908323e2032a5f7dc64))
+
 ## 0.46.0 (2026-07-17)
 
 Full Changelog: [v0.45.0...v0.46.0](https://github.com/cadenya/cadenya-ruby/compare/v0.45.0...v0.46.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "cadenya", "~> 0.46.0"
+gem "cadenya", "~> 0.47.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/cadenya/client.rb

@@ -71,11 +71,18 @@ module Cadenya
     # @return [Cadenya::Resources::ToolSets]
     attr_reader :tool_sets
 
-    # Issue, rotate, and revoke API keys for the account, and grant or revoke each
-    # key's access to individual workspaces.
+    # Issue, rotate, disable, and revoke a workspace's API keys. Every key belongs to
+    # exactly one workspace; the system-managed global account key is managed via
+    # GlobalAPIKeyService instead.
     # @return [Cadenya::Resources::APIKeys]
     attr_reader :api_keys
 
+    # Manage the account's system-provisioned global API key. The global key is the
+    # only key that spans every workspace; it is created by the system and cannot be
+    # deleted, so the surface is retrieve, rotate, and the disable/enable kill switch.
+    # @return [Cadenya::Resources::GlobalAPIKey]
+    attr_reader :global_api_key
+
     # @return [Cadenya::Resources::WorkspaceSecrets]
     attr_reader :workspace_secrets
 
@@ -176,6 +183,7 @@ module Cadenya
       @search = Cadenya::Resources::Search.new(client: self)
       @tool_sets = Cadenya::Resources::ToolSets.new(client: self)
       @api_keys = Cadenya::Resources::APIKeys.new(client: self)
+      @global_api_key = Cadenya::Resources::GlobalAPIKey.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)

data/lib/cadenya/models/account_info.rb

@@ -15,9 +15,10 @@ module Cadenya
         optional :challenge_token, String, api_name: :challengeToken
 
         # @!attribute global_api_key
-        #   An API key for the account. Use workspace-association RPCs to grant the key
-        #   access to specific workspaces; a key with zero workspaces is valid but cannot
-        #   access workspace-scoped resources.
+        #   An API key. Every key belongs to exactly one workspace and is managed via the
+        #   workspace-scoped API key routes. The only exception is the system-managed global
+        #   account key, which spans all workspaces and is managed via the account
+        #   global_api_key routes.
         #
         #   @return [Cadenya::Models::APIKey, nil]
         optional :global_api_key, -> { Cadenya::APIKey }, api_name: :globalApiKey
@@ -39,7 +40,7 @@ module Cadenya
       #
       #   @param challenge_token [String] The challenge token Cadenya sends in the X-Cadenya-Challenge-Token header
       #
-      #   @param global_api_key [Cadenya::Models::APIKey] An API key for the account. Use workspace-association RPCs to grant the
+      #   @param global_api_key [Cadenya::Models::APIKey] An API key. Every key belongs to exactly one workspace and is managed via
       #
       #   @param webhook_events_hmac_secret [String] The generated secret that will sign all webhooks that are sent to your configure
     end

data/lib/cadenya/models/api_key.rb

@@ -22,19 +22,48 @@ module Cadenya
       #   @return [Cadenya::Models::APIKeyInfo, nil]
       optional :info, -> { Cadenya::APIKeyInfo }
 
-      # @!method initialize(metadata:, spec:, info: nil)
+      response_only do
+        # @!attribute state
+        #   The current lifecycle state of the API key. Output only. Keys are created
+        #   STATE_ENABLED; use the :disable and :enable actions to transition between
+        #   states.
+        #
+        #   @return [Symbol, Cadenya::Models::APIKey::State]
+        required :state, enum: -> { Cadenya::APIKey::State }
+      end
+
+      # @!method initialize(metadata:, spec:, state:, info: nil)
       #   Some parameter documentations has been truncated, see {Cadenya::Models::APIKey}
       #   for more details.
       #
-      #   An API key for the account. Use workspace-association RPCs to grant the key
-      #   access to specific workspaces; a key with zero workspaces is valid but cannot
-      #   access workspace-scoped resources.
+      #   An API key. Every key belongs to exactly one workspace and is managed via the
+      #   workspace-scoped API key routes. The only exception is the system-managed global
+      #   account key, which spans all workspaces and is managed via the account
+      #   global_api_key routes.
       #
       #   @param metadata [Cadenya::Models::AccountResourceMetadata] AccountResourceMetadata is used to represent a resource that is associated to an
       #
       #   @param spec [Cadenya::Models::APIKeySpec] Configuration for an API key.
       #
+      #   @param state [Symbol, Cadenya::Models::APIKey::State] The current lifecycle state of the API key. Output only. Keys are
+      #
       #   @param info [Cadenya::Models::APIKeyInfo]
+
+      # The current lifecycle state of the API key. Output only. Keys are created
+      # STATE_ENABLED; use the :disable and :enable actions to transition between
+      # states.
+      #
+      # @see Cadenya::Models::APIKey#state
+      module State
+        extend Cadenya::Internal::Type::Enum
+
+        STATE_UNSPECIFIED = :STATE_UNSPECIFIED
+        STATE_ENABLED = :STATE_ENABLED
+        STATE_DISABLED = :STATE_DISABLED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/cadenya/models/api_key_create_params.rb

@@ -7,6 +7,11 @@ module Cadenya
       extend Cadenya::Internal::Type::RequestParameters::Converter
       include Cadenya::Internal::Type::RequestParameters
 
+      # @!attribute workspace_id
+      #
+      #   @return [String]
+      required :workspace_id, String
+
       # @!attribute metadata
       #   CreateAccountResourceMetadata contains the user-provided fields for creating an
       #   account-scoped resource. Read-only fields (id, account_id, profile_id) are
@@ -21,25 +26,16 @@ module Cadenya
       #   @return [Cadenya::Models::APIKeySpec]
       required :spec, -> { Cadenya::APIKeySpec }
 
-      # @!attribute initial_workspace_ids
-      #   Workspaces this API key will have access to on creation. Optional — a key can be
-      #   created with no workspace access and granted later via AddAPIKeyWorkspace.
-      #
-      #   @return [Array<String>, nil]
-      optional :initial_workspace_ids,
-               Cadenya::Internal::Type::ArrayOf[String],
-               api_name: :initialWorkspaceIds
-
-      # @!method initialize(metadata:, spec:, initial_workspace_ids: nil, request_options: {})
+      # @!method initialize(workspace_id:, metadata:, spec:, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Cadenya::Models::APIKeyCreateParams} for more details.
       #
+      #   @param workspace_id [String]
+      #
       #   @param metadata [Cadenya::Models::APIKeyCreateParams::Metadata] CreateAccountResourceMetadata contains the user-provided fields for creating
       #
       #   @param spec [Cadenya::Models::APIKeySpec] Configuration for an API key.
       #
-      #   @param initial_workspace_ids [Array<String>] Workspaces this API key will have access to on creation. Optional —
-      #
       #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
 
       class Metadata < Cadenya::Internal::Type::BaseModel

data/lib/cadenya/models/api_key_delete_params.rb

@@ -7,12 +7,18 @@ module Cadenya
       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(id:, request_options: {})
+      # @!method initialize(workspace_id:, id:, request_options: {})
+      #   @param workspace_id [String]
       #   @param id [String]
       #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/cadenya/models/api_key_disable_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::APIKeys#disable
+    class APIKeyDisableParams < 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/api_key_enable_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::APIKeys#enable
+    class APIKeyEnableParams < 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/api_key_info.rb

@@ -11,33 +11,13 @@ module Cadenya
         #
         #   @return [Cadenya::Models::Profile, nil]
         optional :created_by, -> { Cadenya::Profile }, api_name: :createdBy
-
-        # @!attribute workspaces_preview
-        #   Up to a small number of workspaces this key has access to, intended for display
-        #   ("Workspace 1, Workspace 2, and 4 more"). Use ListAPIKeyWorkspaces for the full
-        #   paginated list.
-        #
-        #   @return [Array<Cadenya::Models::BareMetadata>, nil]
-        optional :workspaces_preview,
-                 -> { Cadenya::Internal::Type::ArrayOf[Cadenya::BareMetadata] },
-                 api_name: :workspacesPreview
-
-        # @!attribute workspaces_total
-        #   Total number of workspaces this key has access to.
-        #
-        #   @return [Integer, nil]
-        optional :workspaces_total, Integer, api_name: :workspacesTotal
       end
 
-      # @!method initialize(created_by: nil, workspaces_preview: nil, workspaces_total: nil)
+      # @!method initialize(created_by: nil)
       #   Some parameter documentations has been truncated, see
       #   {Cadenya::Models::APIKeyInfo} for more details.
       #
       #   @param created_by [Cadenya::Models::Profile] A profile identifies a user or non-human principal (such as an API key)
-      #
-      #   @param workspaces_preview [Array<Cadenya::Models::BareMetadata>] Up to a small number of workspaces this key has access to, intended
-      #
-      #   @param workspaces_total [Integer] Total number of workspaces this key has access to.
     end
   end
 end

data/lib/cadenya/models/api_key_list_params.rb

@@ -7,6 +7,11 @@ module Cadenya
       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.
       #
@@ -52,10 +57,12 @@ module Cadenya
       #   @return [String, nil]
       optional :sort_order, String
 
-      # @!method initialize(cursor: nil, include_info: nil, labels: nil, limit: nil, prefix: nil, query: nil, sort_order: nil, request_options: {})
+      # @!method initialize(workspace_id:, cursor: nil, include_info: nil, labels: 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 workspace_id [String]
+      #
       #   @param cursor [String] Pagination cursor from previous response.
       #
       #   @param include_info [Boolean] When true, included info fields are populated. Requests with this

data/lib/cadenya/models/api_key_retrieve_params.rb

@@ -7,12 +7,18 @@ module Cadenya
       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(id:, request_options: {})
+      # @!method initialize(workspace_id:, id:, request_options: {})
+      #   @param workspace_id [String]
       #   @param id [String]
       #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/cadenya/models/api_key_rotate_params.rb

@@ -7,12 +7,18 @@ module Cadenya
       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(id:, request_options: {})
+      # @!method initialize(workspace_id:, id:, request_options: {})
+      #   @param workspace_id [String]
       #   @param id [String]
       #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/cadenya/models/api_key_spec.rb

@@ -33,7 +33,7 @@ module Cadenya
         optional :token, String
 
         # @!attribute system_
-        #   True when this key is managed by the system (e.g. the auto-provisioned global
+        #   True when this key is managed by the system (i.e. the auto-provisioned global
         #   account key). System keys cannot be deleted but can be rotated.
         #
         #   @return [Boolean, nil]
@@ -52,7 +52,7 @@ module Cadenya
       #
       #   @param permissions [Array<String>] Scopes 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
+      #   @param system_ [Boolean] True when this key is managed by the system (i.e. the auto-provisioned
     end
   end
 end

data/lib/cadenya/models/api_key_update_params.rb

@@ -7,6 +7,11 @@ module Cadenya
       extend Cadenya::Internal::Type::RequestParameters::Converter
       include Cadenya::Internal::Type::RequestParameters
 
+      # @!attribute workspace_id
+      #
+      #   @return [String]
+      required :workspace_id, String
+
       # @!attribute id
       #
       #   @return [String]
@@ -32,10 +37,12 @@ module Cadenya
       #   @return [String, nil]
       optional :update_mask, String, api_name: :updateMask
 
-      # @!method initialize(id:, metadata: nil, spec: nil, update_mask: nil, request_options: {})
+      # @!method initialize(workspace_id:, id:, metadata: nil, spec: nil, update_mask: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Cadenya::Models::APIKeyUpdateParams} for more details.
       #
+      #   @param workspace_id [String]
+      #
       #   @param id [String]
       #
       #   @param metadata [Cadenya::Models::APIKeyUpdateParams::Metadata] UpdateAccountResourceMetadata contains the user-provided fields for updating

data/lib/cadenya/models/global_api_key_disable_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::GlobalAPIKey#disable
+    class GlobalAPIKeyDisableParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/global_api_key_enable_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::GlobalAPIKey#enable
+    class GlobalAPIKeyEnableParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/global_api_key_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::GlobalAPIKey#retrieve
+    class GlobalAPIKeyRetrieveParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models/global_api_key_rotate_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Cadenya
+  module Models
+    # @see Cadenya::Resources::GlobalAPIKey#rotate
+    class GlobalAPIKeyRotateParams < Cadenya::Internal::Type::BaseModel
+      extend Cadenya::Internal::Type::RequestParameters::Converter
+      include Cadenya::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Cadenya::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/cadenya/models.rb

@@ -99,6 +99,10 @@ module Cadenya
 
   APIKeyDeleteParams = Cadenya::Models::APIKeyDeleteParams
 
+  APIKeyDisableParams = Cadenya::Models::APIKeyDisableParams
+
+  APIKeyEnableParams = Cadenya::Models::APIKeyEnableParams
+
   APIKeyInfo = Cadenya::Models::APIKeyInfo
 
   APIKeyListParams = Cadenya::Models::APIKeyListParams
@@ -107,8 +111,6 @@ module Cadenya
 
   APIKeyRotateParams = Cadenya::Models::APIKeyRotateParams
 
-  APIKeys = Cadenya::Models::APIKeys
-
   APIKeySpec = Cadenya::Models::APIKeySpec
 
   APIKeyUpdateParams = Cadenya::Models::APIKeyUpdateParams
@@ -133,6 +135,14 @@ module Cadenya
 
   CreateResourceMetadata = Cadenya::Models::CreateResourceMetadata
 
+  GlobalAPIKeyDisableParams = Cadenya::Models::GlobalAPIKeyDisableParams
+
+  GlobalAPIKeyEnableParams = Cadenya::Models::GlobalAPIKeyEnableParams
+
+  GlobalAPIKeyRetrieveParams = Cadenya::Models::GlobalAPIKeyRetrieveParams
+
+  GlobalAPIKeyRotateParams = Cadenya::Models::GlobalAPIKeyRotateParams
+
   MemoryLayer = Cadenya::Models::MemoryLayer
 
   MemoryLayerCreateParams = Cadenya::Models::MemoryLayerCreateParams