sz-apimatic-sdk 0.0.1

data/lib/seltz_api/models/search_request.rb

@@ -0,0 +1,208 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # SearchRequest Model.
+  class SearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # API key. On the HTTP surface, either this or the `x-api-key` header must
+    # be supplied; the header takes precedence.
+    # @return [String]
+    attr_accessor :api_key
+
+    # Exclude results from these domains
+    # @return [Array[String]]
+    attr_accessor :exclude_domains
+
+    # Exclude results from these domains
+    # @return [Fields2]
+    attr_accessor :fields
+
+    # Only include results published on or after this point. UTC throughout.
+    # A date "2025-10-28", a datetime "2025-10-28T23:00:00" or
+    # "2025-10-28T23:00:00Z", or an offset from "now", which is the time the
+    # request is served: "now" itself, or "now-" and one duration such as
+    # "now-7d" for the past week. A datetime written without a zone is read as
+    # UTC, and a date written without a time is the start of that day.
+    # Offset units are s = second, m = minute, h = hour, d = 24 h, w = 7 d,
+    # M = one calendar month and y = one calendar year. A unit and a count are
+    # both required, and the case carries meaning.
+    # A month and a year step the calendar rather than a fixed number of
+    # seconds, and the day of the month is clamped to the length of the target
+    # month. So "now-1M" from the 31st of March lands on the 28th or 29th of
+    # February.
+    # An offset is a filter, not a freshness guarantee: the corpus refreshes on
+    # its own cadence, so a window of an hour or two can return nothing.
+    # Only a single offset before "now" is accepted. Rounding, several terms in
+    # one value, a "+" offset, and any anchor other than "now" are rejected.
+    # @return [String]
+    attr_accessor :from_date
+
+    # Include only results from these domains (e.g., \["google.com",
+    # "example.com"\])
+    # @return [Array[String]]
+    attr_accessor :include_domains
+
+    # Maximum number of results to return. Defaults to 10. A larger value is
+    # served as 1000.
+    # @return [Integer]
+    attr_accessor :max_results
+
+    # The search query.
+    # @return [String]
+    attr_accessor :query
+
+    # Restricts the results to one vertical or data set.
+    # Currently available: "news", "wikipedia", "people", "companies".
+    # When omitted, the default scope is searched. A scope that does not exist,
+    # or that this key cannot reach, returns 404.
+    # @return [String]
+    attr_accessor :scope
+
+    # How much work goes into ordering the results. It does not change which
+    # corpus is searched -- that is `scope` -- so any scope can be requested in
+    # either tier.
+    # `"base"` returns first-stage ranking. `"pro"` adds a ranking stage for
+    # higher precision at the top of the list.
+    # Unset resolves to `"pro"`, so `"base"` is opt-out. A scope with no Pro
+    # configuration serves `"pro"` exactly as `"base"` rather than failing, so a
+    # caller may always ask for `"pro"`.
+    # The name is matched without regard to case, and surrounding whitespace is
+    # ignored, so "pro", "PRO" and " Pro " are one tier. A name that is neither
+    # is rejected rather than defaulted, because the value selects a price.
+    # @return [String]
+    attr_accessor :tier
+
+    # Only include results published on or before this point. UTC throughout.
+    # A date, a datetime, or an offset from "now", in the same spellings
+    # from_date takes. A date written without a time covers the whole of that
+    # day, ending at 23:59:59.999; an offset is an instant.
+    # @return [String]
+    attr_accessor :to_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['api_key'] = 'api_key'
+      @_hash['exclude_domains'] = 'exclude_domains'
+      @_hash['fields'] = 'fields'
+      @_hash['from_date'] = 'from_date'
+      @_hash['include_domains'] = 'include_domains'
+      @_hash['max_results'] = 'max_results'
+      @_hash['query'] = 'query'
+      @_hash['scope'] = 'scope'
+      @_hash['tier'] = 'tier'
+      @_hash['to_date'] = 'to_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        api_key
+        exclude_domains
+        fields
+        from_date
+        include_domains
+        max_results
+        query
+        scope
+        tier
+        to_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        api_key
+        fields
+        from_date
+        max_results
+        scope
+        tier
+        to_date
+      ]
+    end
+
+    def initialize(api_key: SKIP, exclude_domains:, fields: SKIP,
+                   from_date: SKIP, include_domains:, max_results: SKIP,
+                   query: SKIP, scope: SKIP, tier: SKIP, to_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @api_key = api_key unless api_key == SKIP
+      @exclude_domains = exclude_domains unless exclude_domains == SKIP
+      @fields = fields unless fields == SKIP
+      @from_date = from_date unless from_date == SKIP
+      @include_domains = include_domains unless include_domains == SKIP
+      @max_results = max_results unless max_results == SKIP
+      @query = query unless query == SKIP
+      @scope = scope unless scope == SKIP
+      @tier = tier unless tier == SKIP
+      @to_date = to_date unless to_date == 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.
+      api_key = hash.key?('api_key') ? hash['api_key'] : SKIP
+      exclude_domains = hash['exclude_domains'] ||= 
+      fields = Fields2.from_hash(hash['fields']) if hash['fields']
+      from_date = hash.key?('from_date') ? hash['from_date'] : SKIP
+      include_domains = hash['include_domains'] ||= 
+      max_results = hash.key?('max_results') ? hash['max_results'] : SKIP
+      query = hash.key?('query') ? hash['query'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      tier = hash.key?('tier') ? hash['tier'] : SKIP
+      to_date = hash.key?('to_date') ? hash['to_date'] : 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.
+      SearchRequest.new(api_key: api_key,
+                        exclude_domains: exclude_domains,
+                        fields: fields,
+                        from_date: from_date,
+                        include_domains: include_domains,
+                        max_results: max_results,
+                        query: query,
+                        scope: scope,
+                        tier: tier,
+                        to_date: to_date,
+                        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} api_key: #{@api_key}, exclude_domains: #{@exclude_domains}, fields:"\
+      " #{@fields}, from_date: #{@from_date}, include_domains: #{@include_domains}, max_results:"\
+      " #{@max_results}, query: #{@query}, scope: #{@scope}, tier: #{@tier}, to_date: #{@to_date},"\
+      " 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} api_key: #{@api_key.inspect}, exclude_domains: #{@exclude_domains.inspect},"\
+      " fields: #{@fields.inspect}, from_date: #{@from_date.inspect}, include_domains:"\
+      " #{@include_domains.inspect}, max_results: #{@max_results.inspect}, query:"\
+      " #{@query.inspect}, scope: #{@scope.inspect}, tier: #{@tier.inspect}, to_date:"\
+      " #{@to_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/search_request_ref.rb

@@ -0,0 +1,87 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # SearchRequestRef Model.
+  class SearchRequestRef < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The request's query text, carried here so a record can be rendered without
+    # a second lookup.
+    # @return [String]
+    attr_accessor :query
+
+    # The request's query text, carried here so a record can be rendered without
+    # a second lookup.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['query'] = 'query'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        query
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(query: SKIP, request_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @query = query unless query == SKIP
+      @request_id = request_id unless request_id == 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.
+      query = hash.key?('query') ? hash['query'] : SKIP
+      request_id = hash.key?('request_id') ? hash['request_id'] : 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.
+      SearchRequestRef.new(query: query,
+                           request_id: request_id,
+                           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} query: #{@query}, request_id: #{@request_id}, 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} query: #{@query.inspect}, request_id: #{@request_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/search_response.rb

@@ -0,0 +1,85 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # SearchResponse Model.
+  class SearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Documents that are most relevant to the query
+    # @return [Array[Document]]
+    attr_accessor :documents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['documents'] = 'documents'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        documents
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(documents: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @documents = documents unless documents == 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.
+      # Parameter is an array, so we need to iterate through it
+      documents = nil
+      unless hash['documents'].nil?
+        documents = []
+        hash['documents'].each do |structure|
+          documents << (Document.from_hash(structure) if structure)
+        end
+      end
+
+      documents = SKIP unless hash.key?('documents')
+
+      # 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.
+      SearchResponse.new(documents: documents,
+                         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} documents: #{@documents}, 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} documents: #{@documents.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/snippet.rb

@@ -0,0 +1,76 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # One passage selected from a document's body.
+  class Snippet < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['text'] = 'text'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        text
+      ]
+    end
+
+    def initialize(text: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @text = text unless text == 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.
+      text = hash.key?('text') ? hash['text'] : 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.
+      Snippet.new(text: text,
+                  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} text: #{@text}, 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} text: #{@text.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/seltz_api/models/snippet_options.rb

@@ -0,0 +1,151 @@
+# seltz_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SeltzApi
+  # Tuning for snippet selection. Each option is an upper bound; the response
+  # carries at most what is specified here. The service may hold callers to a
+  # tighter bound than the ranges 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 SnippetOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Maximum snippets returned across all documents. Accepted range 1-512.
+    # No default. Left unset, no response-wide ceiling applies at all, which is
+    # the
+    # recommended setting: `max_snippets_per_result` already bounds every
+    # document, so the
+    # response is bounded without one.
+    # This budget is spent one snippet per document at a time, so every document
+    # gets its best
+    # snippet before any document gets a second. This value is potentially
+    # raised to ensure each
+    # document can be given at least one snippet.
+    # @return [Integer]
+    attr_accessor :max_snippets
+
+    # Maximum snippets from any single document.
+    # Defaults to 16, accepted range 1-256.
+    # @return [Integer]
+    attr_accessor :max_snippets_per_result
+
+    # Ceiling on tokens across all snippets in the response.
+    # Defaults to 8192, accepted range 512-65536.
+    # Spent in the same order as `max_snippets`, one snippet per document at a
+    # time, but unlike
+    # `max_snippets` this ceiling is not raised to fit `max_results`. Set it low
+    # against many
+    # results and the budget runs out partway through a round: the documents it
+    # does not reach
+    # are still returned, with no snippets at all. If every result needs a
+    # snippet, raise this
+    # or lower `max_results`.
+    # @return [Integer]
+    attr_accessor :max_tokens
+
+    # Ceiling on tokens of snippets from any single document.
+    # Defaults to 4096, accepted range 128-32768.
+    # @return [Integer]
+    attr_accessor :max_tokens_per_result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['max_snippets'] = 'max_snippets'
+      @_hash['max_snippets_per_result'] = 'max_snippets_per_result'
+      @_hash['max_tokens'] = 'max_tokens'
+      @_hash['max_tokens_per_result'] = 'max_tokens_per_result'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        max_snippets
+        max_snippets_per_result
+        max_tokens
+        max_tokens_per_result
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        max_snippets
+        max_snippets_per_result
+        max_tokens
+        max_tokens_per_result
+      ]
+    end
+
+    def initialize(max_snippets: SKIP, max_snippets_per_result: SKIP,
+                   max_tokens: SKIP, max_tokens_per_result: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @max_snippets = max_snippets unless max_snippets == SKIP
+      @max_snippets_per_result = max_snippets_per_result unless max_snippets_per_result == SKIP
+      @max_tokens = max_tokens unless max_tokens == SKIP
+      @max_tokens_per_result = max_tokens_per_result unless max_tokens_per_result == 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.
+      max_snippets = hash.key?('max_snippets') ? hash['max_snippets'] : SKIP
+      max_snippets_per_result =
+        hash.key?('max_snippets_per_result') ? hash['max_snippets_per_result'] : SKIP
+      max_tokens = hash.key?('max_tokens') ? hash['max_tokens'] : SKIP
+      max_tokens_per_result =
+        hash.key?('max_tokens_per_result') ? hash['max_tokens_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.
+      SnippetOptions.new(max_snippets: max_snippets,
+                         max_snippets_per_result: max_snippets_per_result,
+                         max_tokens: max_tokens,
+                         max_tokens_per_result: max_tokens_per_result,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SnippetOptions | 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_snippets: #{@max_snippets}, max_snippets_per_result:"\
+      " #{@max_snippets_per_result}, max_tokens: #{@max_tokens}, max_tokens_per_result:"\
+      " #{@max_tokens_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_snippets: #{@max_snippets.inspect}, max_snippets_per_result:"\
+      " #{@max_snippets_per_result.inspect}, max_tokens: #{@max_tokens.inspect},"\
+      " max_tokens_per_result: #{@max_tokens_per_result.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end