sz-apimatic-sdk 0.0.1

data/lib/seltz_api/models/base_model.rb

@@ -0,0 +1,110 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/seltz_api/models/content_options.rb

@@ -0,0 +1,99 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # The ceiling on the content returned. The ceiling is an upper bound; the
+  # response carries at most what is specified here. The service may hold
+  # callers to a tighter bound than the range below. A larger request is then
+  # served at that bound rather than refused, which still carries at most what
+  # was specified. Only a value outside the range below is rejected.
+  class ContentOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Ceiling on the characters of any single result's content.
+    # Counts Unicode code points -- Rust `char`, Python `len(s)`, JavaScript
+    # `\[...s\].length`.
+    # Defaults to 20000, accepted range 100-1000000.
+    # @return [Integer]
+    attr_accessor :max_characters_per_result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['max_characters_per_result'] = 'max_characters_per_result'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        max_characters_per_result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        max_characters_per_result
+      ]
+    end
+
+    def initialize(max_characters_per_result: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless max_characters_per_result == SKIP
+        @max_characters_per_result =
+          max_characters_per_result
+      end
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      max_characters_per_result =
+        hash.key?('max_characters_per_result') ? hash['max_characters_per_result'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ContentOptions.new(max_characters_per_result: max_characters_per_result,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ContentOptions | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} max_characters_per_result: #{@max_characters_per_result},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} max_characters_per_result: #{@max_characters_per_result.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/create_agent_run_request.rb

@@ -0,0 +1,104 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # CreateAgentRunRequest Model.
+  class CreateAgentRunRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The API key, on gRPC requests. REST reads the `x-api-key` header instead.
+    # @return [String]
+    attr_accessor :api_key
+
+    # Effort level: how much research the run may do, and its price. One of
+    # the configured level names (e.g. `low`, `medium`, `high`, `max`).
+    # Omitted = the default level.
+    # @return [String]
+    attr_accessor :effort
+
+    # Optional OpenAI-style `response_format` object requesting structured
+    # output: `{"type": "text" | "json_object" | "json_schema", ...}`, with
+    # `name` / `schema` / `strict` for type `json_schema`. A structured type
+    # adds `output.structured` and its `grounding` alongside the cited text;
+    # type `text` is accepted and requests no structure. On gRPC the object is
+    # JSON-encoded.
+    # @return [Object]
+    attr_accessor :output_schema
+
+    # The natural-language question. Instructions inside the query are
+    # followed.
+    # @return [String]
+    attr_accessor :query
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['api_key'] = 'api_key'
+      @_hash['effort'] = 'effort'
+      @_hash['output_schema'] = 'output_schema'
+      @_hash['query'] = 'query'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        api_key
+        effort
+        output_schema
+        query
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        api_key
+        effort
+        output_schema
+      ]
+    end
+
+    def initialize(api_key: SKIP, effort: SKIP, output_schema: SKIP,
+                   query: SKIP)
+      @api_key = api_key unless api_key == SKIP
+      @effort = effort unless effort == SKIP
+      @output_schema = output_schema unless output_schema == SKIP
+      @query = query unless query == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      api_key = hash.key?('api_key') ? hash['api_key'] : SKIP
+      effort = hash.key?('effort') ? hash['effort'] : SKIP
+      output_schema = hash.key?('output_schema') ? hash['output_schema'] : SKIP
+      query = hash.key?('query') ? hash['query'] : SKIP
+
+      # Create object from extracted values.
+      CreateAgentRunRequest.new(api_key: api_key,
+                                effort: effort,
+                                output_schema: output_schema,
+                                query: query)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} api_key: #{@api_key}, effort: #{@effort}, output_schema: #{@output_schema},"\
+      " query: #{@query}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} api_key: #{@api_key.inspect}, effort: #{@effort.inspect}, output_schema:"\
+      " #{@output_schema.inspect}, query: #{@query.inspect}>"
+    end
+  end
+end

data/lib/seltz_api/models/create_monitor_request.rb

@@ -0,0 +1,143 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # CreateMonitorRequest Model.
+  class CreateMonitorRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cadence
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :api_key
+
+    # Unique per org among live monitors; a deleted monitor's name becomes
+    # available again. At most 512 bytes of UTF-8.
+    # @return [String]
+    attr_accessor :name
+
+    # At least one, at most 1000. Every request runs on every run. A request
+    # with an `api_key` set, a blank `query`, or a body identical to another in
+    # the list is rejected.
+    # @return [Array[SearchRequest]]
+    attr_accessor :search_requests
+
+    # At least one, at most 1000. Every request runs on every run. A request
+    # with an `api_key` set, a blank `query`, or a body identical to another in
+    # the list is rejected.
+    # @return [MonitorStatus2]
+    attr_accessor :status
+
+    # At least one, at most 1000. Every request runs on every run. A request
+    # with an `api_key` set, a blank `query`, or a body identical to another in
+    # the list is rejected.
+    # @return [Webhook]
+    attr_accessor :webhook
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cadence'] = 'cadence'
+      @_hash['api_key'] = 'api_key'
+      @_hash['name'] = 'name'
+      @_hash['search_requests'] = 'search_requests'
+      @_hash['status'] = 'status'
+      @_hash['webhook'] = 'webhook'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        api_key
+        name
+        search_requests
+        status
+        webhook
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        api_key
+        webhook
+      ]
+    end
+
+    def initialize(cadence:, api_key: SKIP, name: SKIP, search_requests: SKIP,
+                   status: SKIP, webhook: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cadence = cadence
+      @api_key = api_key unless api_key == SKIP
+      @name = name unless name == SKIP
+      @search_requests = search_requests unless search_requests == SKIP
+      @status = status unless status == SKIP
+      @webhook = webhook unless webhook == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      cadence = hash.key?('cadence') ? hash['cadence'] : nil
+      api_key = hash.key?('api_key') ? hash['api_key'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      search_requests = nil
+      unless hash['search_requests'].nil?
+        search_requests = []
+        hash['search_requests'].each do |structure|
+          search_requests << (SearchRequest.from_hash(structure) if structure)
+        end
+      end
+
+      search_requests = SKIP unless hash.key?('search_requests')
+      status = hash.key?('status') ? hash['status'] : SKIP
+      webhook = Webhook.from_hash(hash['webhook']) if hash['webhook']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CreateMonitorRequest.new(cadence: cadence,
+                               api_key: api_key,
+                               name: name,
+                               search_requests: search_requests,
+                               status: status,
+                               webhook: webhook,
+                               additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cadence: #{@cadence}, api_key: #{@api_key}, name: #{@name},"\
+      " search_requests: #{@search_requests}, status: #{@status}, webhook: #{@webhook},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cadence: #{@cadence.inspect}, api_key: #{@api_key.inspect}, name:"\
+      " #{@name.inspect}, search_requests: #{@search_requests.inspect}, status:"\
+      " #{@status.inspect}, webhook: #{@webhook.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/create_monitor_response.rb

@@ -0,0 +1,90 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # CreateMonitorResponse Model.
+  class CreateMonitorResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Monitor]
+    attr_accessor :monitor
+
+    # Returned once, at create, and never again. Issued whether or not the
+    # create supplied a webhook, so keep it.
+    # @return [String]
+    attr_accessor :webhook_secret
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['monitor'] = 'monitor'
+      @_hash['webhook_secret'] = 'webhook_secret'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        monitor
+        webhook_secret
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        monitor
+      ]
+    end
+
+    def initialize(monitor: SKIP, webhook_secret: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @monitor = monitor unless monitor == SKIP
+      @webhook_secret = webhook_secret unless webhook_secret == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      monitor = Monitor.from_hash(hash['monitor']) if hash['monitor']
+      webhook_secret =
+        hash.key?('webhook_secret') ? hash['webhook_secret'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CreateMonitorResponse.new(monitor: monitor,
+                                webhook_secret: webhook_secret,
+                                additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} monitor: #{@monitor}, webhook_secret: #{@webhook_secret},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} monitor: #{@monitor.inspect}, webhook_secret: #{@webhook_secret.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/document.rb

@@ -0,0 +1,128 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # A single search result. `url` and `published_date` are returned without
+  # being asked for, and either may still be absent for a document that carries
+  # no such value. The remaining members are populated only when
+  # `SearchRequest.fields` asked for them.
+  class Document < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :content
+
+    # Publication date as ISO 8601 string (e.g. "2024-03-15T00:00:00Z")
+    # @return [String]
+    attr_accessor :published_date
+
+    # The document's highest-scoring snippets, in the order they appear in the
+    # document.
+    # Populated when `fields.snippets` is selected and passages are available;
+    # empty otherwise.
+    # @return [Array[Snippet]]
+    attr_accessor :snippets
+
+    # The document's highest-scoring snippets, in the order they appear in the
+    # document.
+    # Populated when `fields.snippets` is selected and passages are available;
+    # empty otherwise.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['content'] = 'content'
+      @_hash['published_date'] = 'published_date'
+      @_hash['snippets'] = 'snippets'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        content
+        published_date
+        snippets
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        content
+        published_date
+        url
+      ]
+    end
+
+    def initialize(content: SKIP, published_date: SKIP, snippets: SKIP,
+                   url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @content = content unless content == SKIP
+      @published_date = published_date unless published_date == SKIP
+      @snippets = snippets unless snippets == SKIP
+      @url = url unless url == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      content = hash.key?('content') ? hash['content'] : SKIP
+      published_date =
+        hash.key?('published_date') ? hash['published_date'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      snippets = nil
+      unless hash['snippets'].nil?
+        snippets = []
+        hash['snippets'].each do |structure|
+          snippets << (Snippet.from_hash(structure) if structure)
+        end
+      end
+
+      snippets = SKIP unless hash.key?('snippets')
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Document.new(content: content,
+                   published_date: published_date,
+                   snippets: snippets,
+                   url: url,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content: #{@content}, published_date: #{@published_date}, snippets:"\
+      " #{@snippets}, url: #{@url}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content: #{@content.inspect}, published_date: #{@published_date.inspect},"\
+      " snippets: #{@snippets.inspect}, url: #{@url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end