sz-apimatic-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcf655cc6865d47e6f6996e6725a8cf1914dee9e92fd41de96e0f9568b324f0e
+  data.tar.gz: bc7340cd321ccd527c474836b17585300076669852a95f1175292b25091a1841
+SHA512:
+  metadata.gz: a77b1717262d639930baa2287a504b3c6927b39ae8b579164db7dd1600cc6156d160ea996ea38b6ee2da1fc672c9ccf5dc5dfc7543a5085673d13c5834618885
+  data.tar.gz: 5d8761c674480606939f39191ddfed9b99c465482097feff8bd1804f07ffca7e981c7c84477d9a1434cf8f6cb4955651c0342e0fb7731e3295b2ea0e95796942

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,153 @@
+
+# Getting Started with Seltz API
+
+## Introduction
+
+REST API for the Seltz platform: context retrieval (`/v1/search`), RAG answers (`/v1/answer`), monitors (`/v1/monitors`), and page fetching (`/v1/fetch`).
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install sz-apimatic-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'sz-apimatic-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the sz-apimatic-sdk gem](https://rubygems.org/gems/sz-apimatic-sdk/versions/0.0.1).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'seltz_api'
+include SeltzApi
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/seltz_api
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| custom_header_authentication_credentials | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'seltz_api'
+include SeltzApi
+
+client = Client.new(
+  custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
+    x_api_key: 'x-api-key'
+  ),
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'seltz_api'
+include SeltzApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`ApiKeyAuth (Custom Header Signature)`](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature.md)
+
+## List of APIs
+
+* [Search](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/search.md)
+* [Answer](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/answer.md)
+* [Monitors](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/monitors.md)
+* [Records](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/records.md)
+* [Runs](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/runs.md)
+* [Agent](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/agent.md)
+* [Fetch](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/fetch.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/sz-apimatic-ruby-sdk/tree/0.0.1/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'seltz_api'
+
+puts 'SeltzApi SDK loaded!'
+puts 'You can now create a client with: client = SeltzApi::Client.new'
+puts 'Or use from_env: client = SeltzApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/seltz_api/api_helper.rb

@@ -0,0 +1,10 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/seltz_api/apis/agent_api.rb

@@ -0,0 +1,140 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # AgentApi
+  class AgentApi < BaseApi
+    # The organization's runs, newest first. Pass one page's `next` as the
+    # following request's `after`.
+    # @param [Integer] limit Optional parameter: Page size, 1-100. Defaults to
+    # 20.
+    # @param [String] after Optional parameter: Pagination cursor: the previous
+    # page's `next`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_agent_runs(limit: nil,
+                        after: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/agent/runs',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(after, key: 'after'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListAgentRunsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Malformed or unknown query parameter.',
+                                 ErrorEnvelopeException)
+                    .local_error('401',
+                                 'Invalid or missing API key.',
+                                 ErrorEnvelopeException)
+                    .local_error('404',
+                                 'Unknown `after` cursor.',
+                                 ErrorEnvelopeException)
+                    .local_error('500',
+                                 'Unexpected server error.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+
+    # Returns the new run in `pending` state. Poll it by id until `status`
+    # reaches a terminal state.
+    # @param [CreateAgentRunRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_agent_run(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/agent/runs',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AgentRun.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Malformed body, unknown field, unknown `effort`, or a rejected'\
+                                  ' `output_schema`.',
+                                 ErrorEnvelopeException)
+                    .local_error('401',
+                                 'Invalid or missing API key.',
+                                 ErrorEnvelopeException)
+                    .local_error('402',
+                                 'Insufficient credits.',
+                                 ErrorEnvelopeException)
+                    .local_error('500',
+                                 'Unexpected server error.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+
+    # Poll until `status` reaches a terminal state.
+    # @param [String] id Required parameter: The run id.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_agent_run(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/agent/runs/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AgentRun.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Invalid or missing API key.',
+                                 ErrorEnvelopeException)
+                    .local_error('404',
+                                 'No such run in this org.',
+                                 ErrorEnvelopeException)
+                    .local_error('500',
+                                 'Unexpected server error.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+
+    # Stop a run that has not finished. Returns the run, unchanged if it had
+    # already ended, so cancelling is safe to retry.
+    # @param [String] id Required parameter: The run id.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def cancel_agent_run(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/agent/runs/{id}/cancel',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AgentRun.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Invalid or missing API key.',
+                                 ErrorEnvelopeException)
+                    .local_error('404',
+                                 'No such run in this org.',
+                                 ErrorEnvelopeException)
+                    .local_error('500',
+                                 'Unexpected server error.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+  end
+end

data/lib/seltz_api/apis/answer_api.rb

@@ -0,0 +1,61 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # AnswerApi
+  class AnswerApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [AnswerHttpRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def answer(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/answer',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AnswerHttpResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Missing or malformed request fields.',
+                                 ErrorEnvelopeException)
+                    .local_error('401',
+                                 'Invalid or missing API key.',
+                                 ErrorEnvelopeException)
+                    .local_error('402',
+                                 'Insufficient credits.',
+                                 ErrorEnvelopeException)
+                    .local_error('404',
+                                 'Endpoint not found, or a scope that matches nothing.',
+                                 ErrorEnvelopeException)
+                    .local_error('405',
+                                 'Wrong method for this endpoint.',
+                                 ErrorEnvelopeException)
+                    .local_error('408',
+                                 'The answer did not complete in time.',
+                                 ErrorEnvelopeException)
+                    .local_error('413',
+                                 'Request body is too large.',
+                                 ErrorEnvelopeException)
+                    .local_error('415',
+                                 '`Content-Type` is not `application/json`.',
+                                 ErrorEnvelopeException)
+                    .local_error('429',
+                                 'Rate limit exceeded. Wait before retrying.',
+                                 ErrorEnvelopeException)
+                    .local_error('500',
+                                 'Unexpected server error.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+  end
+end

data/lib/seltz_api/apis/base_api.rb

@@ -0,0 +1,67 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/seltz_api/apis/fetch_api.rb

@@ -0,0 +1,48 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # FetchApi
+  class FetchApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [FetchRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/fetch',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('ApiKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FetchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Malformed body, an out-of-bounds or duplicated `urls` entry,'\
+                                  ' or an unavailable `formats` or `tier` value. Unrecognized'\
+                                  ' fields are ignored.',
+                                 ErrorEnvelopeException)
+                    .local_error('401',
+                                 'Invalid or missing API key.',
+                                 ErrorEnvelopeException)
+                    .local_error('402',
+                                 'Insufficient credits.',
+                                 ErrorEnvelopeException)
+                    .local_error('429',
+                                 'Rate limited.',
+                                 ErrorEnvelopeException)
+                    .local_error('500',
+                                 'Unexpected server error.',
+                                 ErrorEnvelopeException))
+        .execute
+    end
+  end
+end