agentcat-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52e68f69b6df580017a5fcc27ca413bc0f93fbcce6c6dfe544b253921a9ba136
-  data.tar.gz: 971ec413f37b89def36bac8d203243b279cff39af5406ec86317efafc465bf41
+  metadata.gz: 97ea1ee39dc1549a89892802359082a491dc2e9e3e061d220556d008fa8f5ebd
+  data.tar.gz: 4c01fdb5762f7e56a69318a9f65324e7fab96b6914ef510b96d365f6bc57ed9c
 SHA512:
-  metadata.gz: d3bc7021a22563f40049948a73810096df6ffe72cdf97ab9543596cf63b213c645ad12e51ddb00e287f1bef4d707d437f2c9743b79d62f3417a33f92c55d8daf
-  data.tar.gz: afdd2d5f7605354efbf8b976570c13cce2805db2525bce87edde6217d2ed005d71bc59c57eaeb2bb3ef487df5af3b44de5adc83fcb4c072d2fbe47d734d4c0e9
+  metadata.gz: 66ed1a79a53443690e64f7f3c158d4f5d1171afb6df69b007a1421fa4ed958978be27338dae309fb4501aab708a6b8123474e9fa6316cca513fdec1eb9406517
+  data.tar.gz: 75d2fd41e39e5f14cb963ad417ff1fe6ca5b01e7692702222ec6e41d35a64d9d668faf27b8953d933486c8d330cdad84433557fa27008a5bd5492f8d54521e1f

data/README.md

@@ -7,7 +7,7 @@ API for AgentCat application
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 0.0.2
+- Package version: 0.0.3
 - Generator version: 7.14.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -24,16 +24,16 @@ gem build agentcat-api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./agentcat-api-0.0.2.gem
+gem install ./agentcat-api-0.0.3.gem
 ```
 
-(for development, run `gem install --dev ./agentcat-api-0.0.2.gem` to install the development dependencies)
+(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.2'
+    gem 'agentcat-api', '~> 0.0.3'
 
 ### Install from Git
 
@@ -57,27 +57,17 @@ Please follow the [installation](#installation) procedure and then run the follo
 # 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
+api_instance = AgentCatApi::AlertsApi.new
 opts = {
-  publish_event_request: AgentCatApi::PublishEventRequest.new({project_id: 'project_id_example'}) # PublishEventRequest | 
+  token: 'token_example' # String | 
 }
 
 begin
-  #Publish analytics event
-  result = api_instance.publish_event(opts)
+  #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 EventsApi->publish_event: #{e}"
+  puts "Exception when calling AlertsApi->unsubscribe_alert_get: #{e}"
 end
 
 ```
@@ -88,12 +78,17 @@ 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)

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/NotificationsApi.md

@@ -5,6 +5,7 @@ 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
@@ -74,3 +75,69 @@ No authorization required
 - **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
+

data/docs/PublishEventRequest.md

@@ -14,6 +14,8 @@
 | **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] |
+| **input_tokens** | **Integer** | Token count of the request side as measured by the SDK. When absent, the server estimates it from the stored parameters. | [optional] |
+| **output_tokens** | **Integer** | Token count of the response side as measured by the SDK. When absent, the server estimates it from the stored response. Drives the oversized-tool-response rule. | [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] |
@@ -47,6 +49,8 @@ instance = AgentCatApi::PublishEventRequest.new(
   error: null,
   resource_name: null,
   duration: null,
+  input_tokens: null,
+  output_tokens: null,
   timestamp: null,
   user_intent: null,
   parameters: null,

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

@@ -0,0 +1,142 @@
+=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 AlertsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :token 
+    # @return [String]
+    def unsubscribe_alert_get(opts = {})
+      data, _status_code, _headers = unsubscribe_alert_get_with_http_info(opts)
+      data
+    end
+
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :token 
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def unsubscribe_alert_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AlertsApi.unsubscribe_alert_get ...'
+      end
+      # resource path
+      local_var_path = '/v1/public/alerts/unsubscribe'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/html', 'text/plain', 'application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'String'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AlertsApi.unsubscribe_alert_get",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AlertsApi#unsubscribe_alert_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :token 
+    # @return [String]
+    def unsubscribe_alert_post(opts = {})
+      data, _status_code, _headers = unsubscribe_alert_post_with_http_info(opts)
+      data
+    end
+
+    # 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&#39;s form and the List-Unsubscribe-Post header both send it. POST is idempotent.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :token 
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def unsubscribe_alert_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AlertsApi.unsubscribe_alert_post ...'
+      end
+      # resource path
+      local_var_path = '/v1/public/alerts/unsubscribe'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'String'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AlertsApi.unsubscribe_alert_post",
+        :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: AlertsApi#unsubscribe_alert_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -85,5 +85,70 @@ module AgentCatApi
       end
       return data, status_code, headers
     end
+
+    # Activate an email channel from its verification link
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :token 
+    # @option opts [EmailChannelVerifyRequest] :email_channel_verify_request 
+    # @return [EmailChannelVerifyResponse]
+    def verify_email_channel(opts = {})
+      data, _status_code, _headers = verify_email_channel_with_http_info(opts)
+      data
+    end
+
+    # Activate an email channel from its verification link
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :token 
+    # @option opts [EmailChannelVerifyRequest] :email_channel_verify_request 
+    # @return [Array<(EmailChannelVerifyResponse, Integer, Hash)>] EmailChannelVerifyResponse data, response status code and response headers
+    def verify_email_channel_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NotificationsApi.verify_email_channel ...'
+      end
+      # resource path
+      local_var_path = '/v1/public/notifications/channels/verify'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
+
+      # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      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[:'email_channel_verify_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailChannelVerifyResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"NotificationsApi.verify_email_channel",
+        :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: NotificationsApi#verify_email_channel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end