agentcat-api 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7b1f5c728d7bc6339e19c754b402ec14c931a78f1df1a9f8b4b4a37d67ca81f
-  data.tar.gz: 1f1d0fb4638e40f7c76f56bb1777a0744b13707bc6ec2445892d5f4aa908b421
+  metadata.gz: 97ea1ee39dc1549a89892802359082a491dc2e9e3e061d220556d008fa8f5ebd
+  data.tar.gz: 4c01fdb5762f7e56a69318a9f65324e7fab96b6914ef510b96d365f6bc57ed9c
 SHA512:
-  metadata.gz: 9f1c04b046ec3570efca0237b376600d9b126bfcfd04b451edf6064ab49b1699ca878a01edcf6adf799a49ba3af50ce45d6a7f6520bf7425da1a63cf35505386
-  data.tar.gz: 779e1403ab7454d5cef82b0e4bfad2aeb74a0570e3502c1ea81f46c0779b47b933607659898837892e23d2c54e123df93b39bd3b8d831dcb9f91fa2e3a3c940d
+  metadata.gz: 66ed1a79a53443690e64f7f3c158d4f5d1171afb6df69b007a1421fa4ed958978be27338dae309fb4501aab708a6b8123474e9fa6316cca513fdec1eb9406517
+  data.tar.gz: 75d2fd41e39e5f14cb963ad417ff1fe6ca5b01e7692702222ec6e41d35a64d9d668faf27b8953d933486c8d330cdad84433557fa27008a5bd5492f8d54521e1f

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,110 @@
 # 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.3
+- 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.3.gem
+```
+
+(for development, run `gem install --dev ./agentcat-api-0.0.3.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.3'
+
+### 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'
+
+api_instance = AgentCatApi::AlertsApi.new
+opts = {
+  token: 'token_example' # String | 
+}
+
+begin
+  #Show the confirmation page for removing an email address from one alert rule
+  result = api_instance.unsubscribe_alert_get(opts)
+  p result
+rescue AgentCatApi::ApiError => e
+  puts "Exception when calling AlertsApi->unsubscribe_alert_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.agentcat.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AgentCatApi::AlertsApi* | [**unsubscribe_alert_get**](docs/AlertsApi.md#unsubscribe_alert_get) | **GET** /v1/public/alerts/unsubscribe | Show the confirmation page for removing an email address from one alert rule
+*AgentCatApi::AlertsApi* | [**unsubscribe_alert_post**](docs/AlertsApi.md#unsubscribe_alert_post) | **POST** /v1/public/alerts/unsubscribe | Remove an email address from one alert rule (List-Unsubscribe-Post and the confirmation form)
+*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
+*AgentCatApi::NotificationsApi* | [**verify_email_channel**](docs/NotificationsApi.md#verify_email_channel) | **POST** /v1/public/notifications/channels/verify | Activate an email channel from its verification link
+
+
+## Documentation for Models
+
+ - [AgentCatApi::EmailChannelVerifyRequest](docs/EmailChannelVerifyRequest.md)
+ - [AgentCatApi::EmailChannelVerifyResponse](docs/EmailChannelVerifyResponse.md)
+ - [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/AlertsApi.md

@@ -0,0 +1,141 @@
+# AgentCatApi::AlertsApi
+
+All URIs are relative to *https://api.agentcat.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**unsubscribe_alert_get**](AlertsApi.md#unsubscribe_alert_get) | **GET** /v1/public/alerts/unsubscribe | Show the confirmation page for removing an email address from one alert rule |
+| [**unsubscribe_alert_post**](AlertsApi.md#unsubscribe_alert_post) | **POST** /v1/public/alerts/unsubscribe | Remove an email address from one alert rule (List-Unsubscribe-Post and the confirmation form) |
+
+
+## unsubscribe_alert_get
+
+> String unsubscribe_alert_get(opts)
+
+Show the confirmation page for removing an email address from one alert rule
+
+GET, the link in the email, shows a confirmation page and changes nothing, because mail scanners fetch links. POST removes the address from the rule; the page's form and the List-Unsubscribe-Post header both send it. POST is idempotent.
+
+### Examples
+
+```ruby
+require 'time'
+require 'agentcat-api'
+
+api_instance = AgentCatApi::AlertsApi.new
+opts = {
+  token: 'token_example' # String | 
+}
+
+begin
+  # Show the confirmation page for removing an email address from one alert rule
+  result = api_instance.unsubscribe_alert_get(opts)
+  p result
+rescue AgentCatApi::ApiError => e
+  puts "Error when calling AlertsApi->unsubscribe_alert_get: #{e}"
+end
+```
+
+#### Using the unsubscribe_alert_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> unsubscribe_alert_get_with_http_info(opts)
+
+```ruby
+begin
+  # Show the confirmation page for removing an email address from one alert rule
+  data, status_code, headers = api_instance.unsubscribe_alert_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue AgentCatApi::ApiError => e
+  puts "Error when calling AlertsApi->unsubscribe_alert_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/html, text/plain, application/json
+
+
+## unsubscribe_alert_post
+
+> String unsubscribe_alert_post(opts)
+
+Remove an email address from one alert rule (List-Unsubscribe-Post and the confirmation form)
+
+GET, the link in the email, shows a confirmation page and changes nothing, because mail scanners fetch links. POST removes the address from the rule; the page's form and the List-Unsubscribe-Post header both send it. POST is idempotent.
+
+### Examples
+
+```ruby
+require 'time'
+require 'agentcat-api'
+
+api_instance = AgentCatApi::AlertsApi.new
+opts = {
+  token: 'token_example' # String | 
+}
+
+begin
+  # Remove an email address from one alert rule (List-Unsubscribe-Post and the confirmation form)
+  result = api_instance.unsubscribe_alert_post(opts)
+  p result
+rescue AgentCatApi::ApiError => e
+  puts "Error when calling AlertsApi->unsubscribe_alert_post: #{e}"
+end
+```
+
+#### Using the unsubscribe_alert_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> unsubscribe_alert_post_with_http_info(opts)
+
+```ruby
+begin
+  # Remove an email address from one alert rule (List-Unsubscribe-Post and the confirmation form)
+  data, status_code, headers = api_instance.unsubscribe_alert_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue AgentCatApi::ApiError => e
+  puts "Error when calling AlertsApi->unsubscribe_alert_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+

data/docs/EmailChannelVerifyRequest.md

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

data/docs/EmailChannelVerifyResponse.md

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

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,143 @@
+# 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 |
+| [**verify_email_channel**](NotificationsApi.md#verify_email_channel) | **POST** /v1/public/notifications/channels/verify | Activate an email channel from its verification link |
+
+
+## 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
+
+
+## verify_email_channel
+
+> <EmailChannelVerifyResponse> verify_email_channel(opts)
+
+Activate an email channel from its verification link
+
+### Examples
+
+```ruby
+require 'time'
+require 'agentcat-api'
+
+api_instance = AgentCatApi::NotificationsApi.new
+opts = {
+  token: 'token_example', # String | 
+  email_channel_verify_request: AgentCatApi::EmailChannelVerifyRequest.new # EmailChannelVerifyRequest | 
+}
+
+begin
+  # Activate an email channel from its verification link
+  result = api_instance.verify_email_channel(opts)
+  p result
+rescue AgentCatApi::ApiError => e
+  puts "Error when calling NotificationsApi->verify_email_channel: #{e}"
+end
+```
+
+#### Using the verify_email_channel_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailChannelVerifyResponse>, Integer, Hash)> verify_email_channel_with_http_info(opts)
+
+```ruby
+begin
+  # Activate an email channel from its verification link
+  data, status_code, headers = api_instance.verify_email_channel_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailChannelVerifyResponse>
+rescue AgentCatApi::ApiError => e
+  puts "Error when calling NotificationsApi->verify_email_channel_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** |  | [optional] |
+| **email_channel_verify_request** | [**EmailChannelVerifyRequest**](EmailChannelVerifyRequest.md) |  | [optional] |
+
+### Return type
+
+[**EmailChannelVerifyResponse**](EmailChannelVerifyResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+