agentcat-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7b1f5c728d7bc6339e19c754b402ec14c931a78f1df1a9f8b4b4a37d67ca81f
-  data.tar.gz: 1f1d0fb4638e40f7c76f56bb1777a0744b13707bc6ec2445892d5f4aa908b421
+  metadata.gz: 52e68f69b6df580017a5fcc27ca413bc0f93fbcce6c6dfe544b253921a9ba136
+  data.tar.gz: 971ec413f37b89def36bac8d203243b279cff39af5406ec86317efafc465bf41
 SHA512:
-  metadata.gz: 9f1c04b046ec3570efca0237b376600d9b126bfcfd04b451edf6064ab49b1699ca878a01edcf6adf799a49ba3af50ce45d6a7f6520bf7425da1a63cf35505386
-  data.tar.gz: 779e1403ab7454d5cef82b0e4bfad2aeb74a0570e3502c1ea81f46c0779b47b933607659898837892e23d2c54e123df93b39bd3b8d831dcb9f91fa2e3a3c940d
+  metadata.gz: d3bc7021a22563f40049948a73810096df6ffe72cdf97ab9543596cf63b213c645ad12e51ddb00e287f1bef4d707d437f2c9743b79d62f3417a33f92c55d8daf
+  data.tar.gz: afdd2d5f7605354efbf8b976570c13cce2805db2525bce87edde6217d2ed005d71bc59c57eaeb2bb3ef487df5af3b44de5adc83fcb4c072d2fbe47d734d4c0e9

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -1,25 +1,115 @@
 # agentcat-api
 
-Generated HTTP client for the [AgentCat](https://agentcat.com) API.
+AgentCatApi - the Ruby gem for the AgentCat API
 
-> **Status: placeholder.** This gem reserves the `agentcat-api` name for the
-> generated Ruby API client, which will ship as `1.0.0`. It has no functionality
-> yet — do not depend on it.
+API for AgentCat application
 
-## You probably want `agentcat` instead
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-This is the low-level generated transport, produced from the AgentCat OpenAPI
-specification. It is consumed by the [`agentcat`](https://rubygems.org/gems/agentcat)
-gem, which is the supported integration surface for MCP server authors.
+- API version: v1
+- Package version: 0.0.2
+- Generator version: 7.14.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
-Its siblings in other languages:
+## Installation
 
-| Language   | Generated client                                                            |
-| ---------- | --------------------------------------------------------------------------- |
-| TypeScript | [`agentcat-api`](https://www.npmjs.com/package/agentcat-api)                  |
-| Python     | [`agentcat-api`](https://pypi.org/project/agentcat-api/)                      |
-| Go         | [`agentcat-go-api`](https://github.com/agentcathq/agentcat-go-api)            |
+### Build a gem
 
-## License
+To build the Ruby code into a gem:
+
+```shell
+gem build agentcat-api.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./agentcat-api-0.0.2.gem
+```
+
+(for development, run `gem install --dev ./agentcat-api-0.0.2.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'agentcat-api', '~> 0.0.2'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'agentcat-api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'agentcat-api'
+
+# Setup authorization
+AgentCatApi.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+end
+
+api_instance = AgentCatApi::EventsApi.new
+opts = {
+  publish_event_request: AgentCatApi::PublishEventRequest.new({project_id: 'project_id_example'}) # PublishEventRequest | 
+}
+
+begin
+  #Publish analytics event
+  result = api_instance.publish_event(opts)
+  p result
+rescue AgentCatApi::ApiError => e
+  puts "Exception when calling EventsApi->publish_event: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.agentcat.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AgentCatApi::EventsApi* | [**publish_event**](docs/EventsApi.md#publish_event) | **POST** /v1/public/events/ | Publish analytics event
+*AgentCatApi::NotificationsApi* | [**unsubscribe_notification**](docs/NotificationsApi.md#unsubscribe_notification) | **POST** /v1/public/notifications/unsubscribe | Disable an email notification type for the token's user
+
+
+## Documentation for Models
+
+ - [AgentCatApi::Error](docs/Error.md)
+ - [AgentCatApi::EventAcceptedResponse](docs/EventAcceptedResponse.md)
+ - [AgentCatApi::PublishEventRequest](docs/PublishEventRequest.md)
+ - [AgentCatApi::QueryTimeout](docs/QueryTimeout.md)
+ - [AgentCatApi::UnsubscribeRequestRequest](docs/UnsubscribeRequestRequest.md)
+ - [AgentCatApi::ValidationErrorValue](docs/ValidationErrorValue.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### tokenAuth
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
 
-MIT © AgentCat, Inc.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/agentcat-api.gemspec

@@ -1,34 +1,41 @@
-# frozen_string_literal: true
-
-require_relative "lib/agentcat/api/version"
-
-Gem::Specification.new do |spec|
-  spec.name        = "agentcat-api"
-  spec.version     = AgentCat::API::VERSION
-  spec.authors     = ["AgentCat, Inc."]
-  spec.email       = ["support@agentcat.com"]
-
-  spec.summary     = "AgentCat API - generated Ruby client (placeholder)"
-  spec.description = "Generated HTTP client for the AgentCat API, consumed by the " \
-                     "agentcat gem. This release reserves the gem name for the " \
-                     "generated client, which is in active development. Use the " \
-                     "agentcat gem instead."
-  spec.homepage    = "https://agentcat.com"
-  spec.license     = "MIT"
-
-  spec.required_ruby_version = ">= 2.7.0"
-
-  spec.metadata = {
-    "homepage_uri"      => "https://agentcat.com",
-    "source_code_uri"   => "https://github.com/agentcathq/agentcat-ruby-api",
-    "bug_tracker_uri"   => "https://github.com/agentcathq/agentcat-ruby-api/issues",
-    "documentation_uri" => "https://docs.agentcat.com",
-    "rubygems_mfa_required" => "true"
-  }
-
-  # Deliberately scoped under lib/agentcat/api/ only: the `agentcat` gem owns
-  # lib/agentcat.rb and lib/agentcat/version.rb, and shipping either path here
-  # would shadow it on the load path.
-  spec.files = %w[README.md LICENSE agentcat-api.gemspec] + Dir["lib/agentcat/api.rb", "lib/agentcat/api/**/*.rb"]
-  spec.require_paths = ["lib"]
+# -*- encoding: utf-8 -*-
+
+=begin
+#AgentCat API
+
+#API for AgentCat application
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "agentcat-api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "agentcat-api"
+  s.version     = AgentCatApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["AgentCat"]
+  s.email       = ["hi@agentcat.com"]
+  s.homepage    = "https://agentcat.com"
+  s.summary     = 'AgentCat API - Ruby SDK'
+  s.description = 'Generated HTTP client for the AgentCat API, consumed by the agentcat gem.'
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_runtime_dependency 'faraday-multipart'
+  s.add_runtime_dependency 'marcel'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
 end

data/docs/Error.md

@@ -0,0 +1,18 @@
+# AgentCatApi::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detail** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'agentcat-api'
+
+instance = AgentCatApi::Error.new(
+  detail: null
+)
+```
+

data/docs/EventAcceptedResponse.md

@@ -0,0 +1,18 @@
+# AgentCatApi::EventAcceptedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional][default to 'accepted'] |
+
+## Example
+
+```ruby
+require 'agentcat-api'
+
+instance = AgentCatApi::EventAcceptedResponse.new(
+  status: null
+)
+```
+

data/docs/EventsApi.md

@@ -0,0 +1,81 @@
+# AgentCatApi::EventsApi
+
+All URIs are relative to *https://api.agentcat.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**publish_event**](EventsApi.md#publish_event) | **POST** /v1/public/events/ | Publish analytics event |
+
+
+## publish_event
+
+> <EventAcceptedResponse> publish_event(opts)
+
+Publish analytics event
+
+Submit analytics events for a project. Returns immediately with 202 Accepted.
+
+### Examples
+
+```ruby
+require 'time'
+require 'agentcat-api'
+# setup authorization
+AgentCatApi.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = AgentCatApi::EventsApi.new
+opts = {
+  publish_event_request: AgentCatApi::PublishEventRequest.new({project_id: 'project_id_example'}) # PublishEventRequest | 
+}
+
+begin
+  # Publish analytics event
+  result = api_instance.publish_event(opts)
+  p result
+rescue AgentCatApi::ApiError => e
+  puts "Error when calling EventsApi->publish_event: #{e}"
+end
+```
+
+#### Using the publish_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EventAcceptedResponse>, Integer, Hash)> publish_event_with_http_info(opts)
+
+```ruby
+begin
+  # Publish analytics event
+  data, status_code, headers = api_instance.publish_event_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EventAcceptedResponse>
+rescue AgentCatApi::ApiError => e
+  puts "Error when calling EventsApi->publish_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **publish_event_request** | [**PublishEventRequest**](PublishEventRequest.md) |  | [optional] |
+
+### Return type
+
+[**EventAcceptedResponse**](EventAcceptedResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/NotificationsApi.md

@@ -0,0 +1,76 @@
+# AgentCatApi::NotificationsApi
+
+All URIs are relative to *https://api.agentcat.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**unsubscribe_notification**](NotificationsApi.md#unsubscribe_notification) | **POST** /v1/public/notifications/unsubscribe | Disable an email notification type for the token's user |
+
+
+## unsubscribe_notification
+
+> String unsubscribe_notification(opts)
+
+Disable an email notification type for the token's user
+
+Anonymous endpoint reached from email unsubscribe links and the List-Unsubscribe header POST. The token encodes the user and the notification type to disable. Response bodies are plain text.
+
+### Examples
+
+```ruby
+require 'time'
+require 'agentcat-api'
+
+api_instance = AgentCatApi::NotificationsApi.new
+opts = {
+  token: 'token_example', # String | Signed unsubscribe token. May also be passed in the request body.
+  unsubscribe_request_request: AgentCatApi::UnsubscribeRequestRequest.new # UnsubscribeRequestRequest | 
+}
+
+begin
+  # Disable an email notification type for the token's user
+  result = api_instance.unsubscribe_notification(opts)
+  p result
+rescue AgentCatApi::ApiError => e
+  puts "Error when calling NotificationsApi->unsubscribe_notification: #{e}"
+end
+```
+
+#### Using the unsubscribe_notification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> unsubscribe_notification_with_http_info(opts)
+
+```ruby
+begin
+  # Disable an email notification type for the token's user
+  data, status_code, headers = api_instance.unsubscribe_notification_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue AgentCatApi::ApiError => e
+  puts "Error when calling NotificationsApi->unsubscribe_notification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | Signed unsubscribe token. May also be passed in the request body. | [optional] |
+| **unsubscribe_request_request** | [**UnsubscribeRequestRequest**](UnsubscribeRequestRequest.md) |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: text/plain, application/json
+

data/docs/PublishEventRequest.md

@@ -0,0 +1,68 @@
+# AgentCatApi::PublishEventRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the event, typically auto-generated by the AgentCat Agent | [optional] |
+| **project_id** | **String** | ID of the project this event belongs to |  |
+| **session_id** | **String** | ID of the session this event belongs to. Null for stateless mode (server assigns session). | [optional] |
+| **actor_id** | **String** | Optional actor ID | [optional] |
+| **event_id** | **String** | Optional custom event ID (must be unique) | [optional] |
+| **event_type** | **String** | Type of event (e.g., mcp:tools/call, agentcat:identify) | [optional] |
+| **is_error** | **Boolean** | Whether this event represents an error | [optional] |
+| **error** | **Object** | Error details if is_error is true | [optional] |
+| **resource_name** | **String** | Name of the resource accessed (for resource events) | [optional] |
+| **duration** | **Integer** | Duration of the operation in milliseconds | [optional] |
+| **timestamp** | **Time** | Agent-provided timestamp of when the event occurred | [optional] |
+| **user_intent** | **String** | Captured explanation of why the actor made this request | [optional] |
+| **parameters** | **Object** | Parameters sent with the request | [optional] |
+| **response** | **Object** | Response data from the operation | [optional] |
+| **identify_actor_given_id** | **String** | Actor ID for agentcat:identify events | [optional] |
+| **identify_actor_name** | **String** | Actor name for agentcat:identify events | [optional] |
+| **identify_data** | **Object** | Additional data for agentcat:identify events | [optional] |
+| **tags** | **Hash<String, String>** | Custom string key-value pairs. Keys: max 32 chars, alphanumeric/underscore/period/colon/dash/dollar-sign only. Values: max 200 chars, no newlines. Max 50 entries. | [optional] |
+| **properties** | **Object** | Custom structured data. Keys are strings, values can be string, number, boolean, array, object, or null (null values are filtered out). | [optional] |
+| **ip_address** | **String** | IP address of the client | [optional] |
+| **sdk_language** | **String** | Programming language of the SDK used | [optional] |
+| **agentcat_version** | **String** | Version of AgentCat being used | [optional] |
+| **server_name** | **String** | Name of the MCP server | [optional] |
+| **server_version** | **String** | Version of the MCP server | [optional] |
+| **client_name** | **String** | Name of the MCP client | [optional] |
+| **client_version** | **String** | Version of the MCP client | [optional] |
+
+## Example
+
+```ruby
+require 'agentcat-api'
+
+instance = AgentCatApi::PublishEventRequest.new(
+  id: null,
+  project_id: null,
+  session_id: null,
+  actor_id: null,
+  event_id: null,
+  event_type: null,
+  is_error: null,
+  error: null,
+  resource_name: null,
+  duration: null,
+  timestamp: null,
+  user_intent: null,
+  parameters: null,
+  response: null,
+  identify_actor_given_id: null,
+  identify_actor_name: null,
+  identify_data: null,
+  tags: null,
+  properties: null,
+  ip_address: null,
+  sdk_language: null,
+  agentcat_version: null,
+  server_name: null,
+  server_version: null,
+  client_name: null,
+  client_version: null
+)
+```
+

data/docs/QueryTimeout.md

@@ -0,0 +1,20 @@
+# AgentCatApi::QueryTimeout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detail** | **String** |  |  |
+| **code** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'agentcat-api'
+
+instance = AgentCatApi::QueryTimeout.new(
+  detail: null,
+  code: null
+)
+```
+

data/docs/UnsubscribeRequestRequest.md

@@ -0,0 +1,18 @@
+# AgentCatApi::UnsubscribeRequestRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'agentcat-api'
+
+instance = AgentCatApi::UnsubscribeRequestRequest.new(
+  token: null
+)
+```
+

data/docs/ValidationErrorValue.md

@@ -0,0 +1,49 @@
+# AgentCatApi::ValidationErrorValue
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'agentcat-api'
+
+AgentCatApi::ValidationErrorValue.openapi_one_of
+# =>
+# [
+#   :'Array<String>',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'agentcat-api'
+
+AgentCatApi::ValidationErrorValue.build(data)
+# => #<Array<String>:0x00007fdd4aab02a0>
+
+AgentCatApi::ValidationErrorValue.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<String>`
+- `String`
+- `nil` (if no type matches)
+

data/lib/agentcat-api/api/events_api.rb

@@ -0,0 +1,86 @@
+=begin
+#AgentCat API
+
+#API for AgentCat application
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module AgentCatApi
+  class EventsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Publish analytics event
+    # Submit analytics events for a project. Returns immediately with 202 Accepted.
+    # @param [Hash] opts the optional parameters
+    # @option opts [PublishEventRequest] :publish_event_request 
+    # @return [EventAcceptedResponse]
+    def publish_event(opts = {})
+      data, _status_code, _headers = publish_event_with_http_info(opts)
+      data
+    end
+
+    # Publish analytics event
+    # Submit analytics events for a project. Returns immediately with 202 Accepted.
+    # @param [Hash] opts the optional parameters
+    # @option opts [PublishEventRequest] :publish_event_request 
+    # @return [Array<(EventAcceptedResponse, Integer, Hash)>] EventAcceptedResponse data, response status code and response headers
+    def publish_event_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.publish_event ...'
+      end
+      # resource path
+      local_var_path = '/v1/public/events/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'publish_event_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EventAcceptedResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['tokenAuth']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.publish_event",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#publish_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end