cadenya 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eba2466a3e34e716fb0216440d0deb94999c5c96466b2c59b5999d39385cd916
+  data.tar.gz: 416782de6e871823e8e184ee7017290e62031b1fb4f594d31b12c791a4dea62b
+SHA512:
+  metadata.gz: 311cde5d3c1c6f74ffbb17cc672329edbf466e3f920daed0a6d4e51528f23b7ccd7be738ef426d7297ef9793959d023695f87bcd5020f5c7d90d51f3c757d4f0
+  data.tar.gz: a12fc8e1371dfde54ba22e8c4bacf630d3ac9f141dd405eb1f2da7727874598ff42818881223e8b6b823c73af89b279145e4b4565c697a338b47a2cc409a482c

data/.ignore

@@ -0,0 +1,2 @@
+rbi/*
+sig/*

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.1.0 (2026-05-06)
+
+Full Changelog: [v0.0.1...v0.1.0](https://github.com/cadenya/cadenya-ruby/compare/v0.0.1...v0.1.0)
+
+### Features
+
+* **api:** api update ([b473bb6](https://github.com/cadenya/cadenya-ruby/commit/b473bb667717a46cb95911910422ef14ed9d3338))
+
+
+### Chores
+
+* configure new SDK language ([8b6e07b](https://github.com/cadenya/cadenya-ruby/commit/8b6e07b09729cd9649e962b18f2549439ebcd32f))

data/README.md

@@ -0,0 +1,271 @@
+# Cadenya Ruby API library
+
+The Cadenya Ruby library provides convenient access to the Cadenya REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/cadenya/cadenya-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## MCP Server
+
+Use the Cadenya MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
+
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=cadenya-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImNhZGVueWEtbWNwIl0sImVudiI6eyJDQURFTllBX0FQSV9LRVkiOiJNeSBBUEkgS2V5IiwiQ0FERU5ZQV9XRUJIT09LX0tFWSI6Ik15IFdlYmhvb2sgS2V5In19)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22cadenya-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22cadenya-mcp%22%5D%2C%22env%22%3A%7B%22CADENYA_API_KEY%22%3A%22My%20API%20Key%22%2C%22CADENYA_WEBHOOK_KEY%22%3A%22My%20Webhook%20Key%22%7D%7D)
+
+> Note: You may need to set environment variables in your MCP client.
+
+## Documentation
+
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/cadenya).
+
+The REST API documentation can be found on [docs.cadenya.com](https://docs.cadenya.com).
+
+## Installation
+
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
+
+```ruby
+gem "cadenya", "~> 0.1.0"
+```
+
+<!-- x-release-please-end -->
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "cadenya"
+
+cadenya = Cadenya::Client.new(
+  api_key: ENV["CADENYA_API_KEY"] # This is the default and can be omitted
+)
+
+account = cadenya.account.retrieve
+
+puts(account.info)
+```
+
+### Pagination
+
+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
+
+# Fetch single item from page.
+agent = page.items[0]
+puts(agent.metadata)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |agent|
+  puts(agent.metadata)
+end
+```
+
+Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
+
+```ruby
+if page.next_page?
+  new_page = page.next_page
+  puts(new_page.items[0].metadata)
+end
+```
+
+### Handling errors
+
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Cadenya::Errors::APIError` will be thrown:
+
+```ruby
+begin
+  account = cadenya.account.retrieve
+rescue Cadenya::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue Cadenya::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue Cadenya::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
+end
+```
+
+Error codes are as follows:
+
+| Cause            | Error Type                 |
+| ---------------- | -------------------------- |
+| HTTP 400         | `BadRequestError`          |
+| HTTP 401         | `AuthenticationError`      |
+| HTTP 403         | `PermissionDeniedError`    |
+| HTTP 404         | `NotFoundError`            |
+| HTTP 409         | `ConflictError`            |
+| HTTP 422         | `UnprocessableEntityError` |
+| HTTP 429         | `RateLimitError`           |
+| HTTP >= 500      | `InternalServerError`      |
+| Other HTTP error | `APIStatusError`           |
+| Timeout          | `APITimeoutError`          |
+| Network error    | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
+
+You can use the `max_retries` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+cadenya = Cadenya::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+cadenya.account.retrieve(request_options: {max_retries: 5})
+```
+
+### Timeouts
+
+By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+cadenya = Cadenya::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+cadenya.account.retrieve(request_options: {timeout: 5})
+```
+
+On timeout, `Cadenya::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `Cadenya::Internal::Type::BaseModel`, which provides several conveniences, including:
+
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
+
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
+
+3. Both instances and the classes themselves can be pretty-printed.
+
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
+
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
+
+Note: the `extra_` parameters of the same name overrides the documented parameters.
+
+```ruby
+account =
+  cadenya.account.retrieve(
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(account[:my_undocumented_property])
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
+
+```ruby
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"hello": "world"}
+)
+```
+
+### Concurrency & connection pooling
+
+The `Cadenya::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `Cadenya::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
+
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+## Sorbet
+
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+
+You can provide typesafe request parameters like so:
+
+```ruby
+cadenya.account.retrieve
+```
+
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+cadenya.account.retrieve
+
+# You can also splat a full Params class:
+params = Cadenya::AccountRetrieveParams.new
+cadenya.account.retrieve(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :AGENT_STATUS_UNSPECIFIED
+puts(Cadenya::AgentListParams::Status::AGENT_STATUS_UNSPECIFIED)
+
+# Revealed type: `T.all(Cadenya::AgentListParams::Status, Symbol)`
+T.reveal_type(Cadenya::AgentListParams::Status::AGENT_STATUS_UNSPECIFIED)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+cadenya.agents.list(
+  status: Cadenya::AgentListParams::Status::AGENT_STATUS_UNSPECIFIED,
+  # …
+)
+
+# Literal values are also permissible:
+cadenya.agents.list(
+  status: :AGENT_STATUS_UNSPECIFIED,
+  # …
+)
+```
+
+## Versioning
+
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
+
+This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
+
+## Requirements
+
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/cadenya/cadenya-ruby/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by Cadenya, please follow the respective company's security reporting guidelines.
+
+### Cadenya Terms and Policies
+
+Please contact support@cadenya.com for any questions or concerns regarding the security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/cadenya/client.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Cadenya
+  class Client < Cadenya::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [String, nil]
+    attr_reader :webhook_key
+
+    # Manage the authenticated account. Accounts are the top-level organizational unit
+    # and contain one or more workspaces.
+    # @return [Cadenya::Resources::Account]
+    attr_reader :account
+
+    # Manage AI agents within a workspace. Agents define AI behavior and tool access.
+    # @return [Cadenya::Resources::Agents]
+    attr_reader :agents
+
+    # @return [Cadenya::Resources::Objectives]
+    attr_reader :objectives
+
+    # Manage memory layers and their entries. Layers are named containers that can be
+    # composed into an objective's memory stack; entries are the keyed values within a
+    # layer. System-managed layers (e.g., episodic layers created by the runtime)
+    # cannot be mutated through this API.
+    # @return [Cadenya::Resources::MemoryLayers]
+    attr_reader :memory_layers
+
+    # Issue short-lived presigned URLs for direct client-to-object-storage uploads.
+    # Created uploads can be referenced by id when creating or updating resources that
+    # accept binary content (e.g., MemoryEntry).
+    # @return [Cadenya::Resources::Uploads]
+    attr_reader :uploads
+
+    # Manage LLM models available to a workspace. Models represent provider and family
+    # pairs (e.g., "anthropic/claude-sonnet-4.6"). Workspaces are seeded with the
+    # supported models and you can enable or disable each one.
+    # @return [Cadenya::Resources::Models]
+    attr_reader :models
+
+    # @return [Cadenya::Resources::Search]
+    attr_reader :search
+
+    # Manage tool sets and the tools they contain. Tool sets group related tools, and
+    # tools define specific capabilities available to agents.
+    #
+    # When a tool set is managed, only API key actors can modify its tools; human
+    # (profile) actors cannot.
+    # @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.
+    # @return [Cadenya::Resources::APIKeys]
+    attr_reader :api_keys
+
+    # @return [Cadenya::Resources::WorkspaceSecrets]
+    attr_reader :workspace_secrets
+
+    # Manage workspaces within an account. Workspaces provide organizational grouping
+    # and isolation for resources such as agents, tools, and API keys.
+    # @return [Cadenya::Resources::Workspaces]
+    attr_reader :workspaces
+
+    # @return [Cadenya::Resources::Webhooks]
+    attr_reader :webhooks
+
+    # Apply a declarative bundle of workspace resources — tool sets, memory layers,
+    # agents, variations, assignments, and schedules — in a single asynchronous
+    # operation.
+    # @return [Cadenya::Resources::BulkWorkspaceResources]
+    attr_reader :bulk_workspace_resources
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @api_key.nil?
+
+      {"authorization" => "Bearer #{@api_key}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_key [String, nil] Defaults to `ENV["CADENYA_API_KEY"]`
+    #
+    # @param webhook_key [String, nil] Defaults to `ENV["CADENYA_WEBHOOK_KEY"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["CADENYA_BASE_URL"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    def initialize(
+      api_key: ENV["CADENYA_API_KEY"],
+      webhook_key: ENV["CADENYA_WEBHOOK_KEY"],
+      base_url: ENV["CADENYA_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://api.cadenya.com"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"CADENYA_API_KEY\"")
+      end
+
+      headers = {}
+      custom_headers_env = ENV["CADENYA_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
+      @api_key = api_key.to_s
+      @webhook_key = webhook_key&.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay,
+        headers: headers
+      )
+
+      @account = Cadenya::Resources::Account.new(client: self)
+      @agents = Cadenya::Resources::Agents.new(client: self)
+      @objectives = Cadenya::Resources::Objectives.new(client: self)
+      @memory_layers = Cadenya::Resources::MemoryLayers.new(client: self)
+      @uploads = Cadenya::Resources::Uploads.new(client: self)
+      @models = Cadenya::Resources::Models.new(client: self)
+      @search = Cadenya::Resources::Search.new(client: self)
+      @tool_sets = Cadenya::Resources::ToolSets.new(client: self)
+      @api_keys = Cadenya::Resources::APIKeys.new(client: self)
+      @workspace_secrets = Cadenya::Resources::WorkspaceSecrets.new(client: self)
+      @workspaces = Cadenya::Resources::Workspaces.new(client: self)
+      @webhooks = Cadenya::Resources::Webhooks.new(client: self)
+      @bulk_workspace_resources = Cadenya::Resources::BulkWorkspaceResources.new(client: self)
+    end
+  end
+end