temper-rb 0.5.1

data/lib/temper/generated/models/search_result_row.rb

@@ -0,0 +1,343 @@
+=begin
+#Temper Cloud API
+
+#Knowledge base management API for temper cloud
+
+The version of the OpenAPI document: 0.5.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Temper::Generated
+  # A single search result.
+  class SearchResultRow < ApiModelBase
+    attr_accessor :context
+
+    attr_accessor :doc_type
+
+    attr_accessor :header_path
+
+    # Canonical kb:// URI: kb://context/doc_type/uuid (from kb_resource_uri SQL function)
+    attr_accessor :kb_uri
+
+    # Original source URL or file reference
+    attr_accessor :origin_uri
+
+    attr_accessor :resource_id
+
+    attr_accessor :score
+
+    attr_accessor :snippet
+
+    attr_accessor :title
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'context' => :'context',
+        :'doc_type' => :'doc_type',
+        :'header_path' => :'header_path',
+        :'kb_uri' => :'kb_uri',
+        :'origin_uri' => :'origin_uri',
+        :'resource_id' => :'resource_id',
+        :'score' => :'score',
+        :'snippet' => :'snippet',
+        :'title' => :'title'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'context' => :'String',
+        :'doc_type' => :'String',
+        :'header_path' => :'String',
+        :'kb_uri' => :'String',
+        :'origin_uri' => :'String',
+        :'resource_id' => :'String',
+        :'score' => :'Float',
+        :'snippet' => :'String',
+        :'title' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'context',
+        :'header_path',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Temper::Generated::SearchResultRow` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Temper::Generated::SearchResultRow`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'context')
+        self.context = attributes[:'context']
+      end
+
+      if attributes.key?(:'doc_type')
+        self.doc_type = attributes[:'doc_type']
+      else
+        self.doc_type = nil
+      end
+
+      if attributes.key?(:'header_path')
+        self.header_path = attributes[:'header_path']
+      end
+
+      if attributes.key?(:'kb_uri')
+        self.kb_uri = attributes[:'kb_uri']
+      else
+        self.kb_uri = nil
+      end
+
+      if attributes.key?(:'origin_uri')
+        self.origin_uri = attributes[:'origin_uri']
+      else
+        self.origin_uri = nil
+      end
+
+      if attributes.key?(:'resource_id')
+        self.resource_id = attributes[:'resource_id']
+      else
+        self.resource_id = nil
+      end
+
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
+      else
+        self.score = nil
+      end
+
+      if attributes.key?(:'snippet')
+        self.snippet = attributes[:'snippet']
+      else
+        self.snippet = nil
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @doc_type.nil?
+        invalid_properties.push('invalid value for "doc_type", doc_type cannot be nil.')
+      end
+
+      if @kb_uri.nil?
+        invalid_properties.push('invalid value for "kb_uri", kb_uri cannot be nil.')
+      end
+
+      if @origin_uri.nil?
+        invalid_properties.push('invalid value for "origin_uri", origin_uri cannot be nil.')
+      end
+
+      if @resource_id.nil?
+        invalid_properties.push('invalid value for "resource_id", resource_id cannot be nil.')
+      end
+
+      if @score.nil?
+        invalid_properties.push('invalid value for "score", score cannot be nil.')
+      end
+
+      if @snippet.nil?
+        invalid_properties.push('invalid value for "snippet", snippet cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @doc_type.nil?
+      return false if @kb_uri.nil?
+      return false if @origin_uri.nil?
+      return false if @resource_id.nil?
+      return false if @score.nil?
+      return false if @snippet.nil?
+      return false if @title.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] doc_type Value to be assigned
+    def doc_type=(doc_type)
+      if doc_type.nil?
+        fail ArgumentError, 'doc_type cannot be nil'
+      end
+
+      @doc_type = doc_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] kb_uri Value to be assigned
+    def kb_uri=(kb_uri)
+      if kb_uri.nil?
+        fail ArgumentError, 'kb_uri cannot be nil'
+      end
+
+      @kb_uri = kb_uri
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] origin_uri Value to be assigned
+    def origin_uri=(origin_uri)
+      if origin_uri.nil?
+        fail ArgumentError, 'origin_uri cannot be nil'
+      end
+
+      @origin_uri = origin_uri
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] resource_id Value to be assigned
+    def resource_id=(resource_id)
+      if resource_id.nil?
+        fail ArgumentError, 'resource_id cannot be nil'
+      end
+
+      @resource_id = resource_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] score Value to be assigned
+    def score=(score)
+      if score.nil?
+        fail ArgumentError, 'score cannot be nil'
+      end
+
+      @score = score
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] snippet Value to be assigned
+    def snippet=(snippet)
+      if snippet.nil?
+        fail ArgumentError, 'snippet cannot be nil'
+      end
+
+      @snippet = snippet
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      @title = title
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          context == o.context &&
+          doc_type == o.doc_type &&
+          header_path == o.header_path &&
+          kb_uri == o.kb_uri &&
+          origin_uri == o.origin_uri &&
+          resource_id == o.resource_id &&
+          score == o.score &&
+          snippet == o.snippet &&
+          title == o.title
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [context, doc_type, header_path, kb_uri, origin_uri, resource_id, score, snippet, title].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/temper/generated/models/search_scope.rb

@@ -0,0 +1,41 @@
+=begin
+#Temper Cloud API
+
+#Knowledge base management API for temper cloud
+
+The version of the OpenAPI document: 0.5.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Temper::Generated
+  class SearchScope
+    GLOBAL = "global".freeze
+    CONTEXT = "context".freeze
+    COGMAP = "cogmap".freeze
+
+    def self.all_vars
+      @all_vars ||= [GLOBAL, CONTEXT, COGMAP].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if SearchScope.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #SearchScope"
+    end
+  end
+end

data/lib/temper/generated/models/search_scope_info.rb

@@ -0,0 +1,199 @@
+=begin
+#Temper Cloud API
+
+#Knowledge base management API for temper cloud
+
+The version of the OpenAPI document: 0.5.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Temper::Generated
+  # What bounded the corpus — shared by both arms, because both were asked the same question of the same scope.
+  class SearchScopeInfo < ApiModelBase
+    # Which selector produced the corpus.
+    attr_accessor :kind
+
+    # Candidate resources the scope admitted, when cheaply knowable. `None` for `global` and `context`, whose corpus is not a bounded id-set at scope-resolution time.
+    attr_accessor :size
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'kind' => :'kind',
+        :'size' => :'size'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'kind' => :'SearchScope',
+        :'size' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'size'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Temper::Generated::SearchScopeInfo` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Temper::Generated::SearchScopeInfo`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'kind')
+        self.kind = attributes[:'kind']
+      else
+        self.kind = nil
+      end
+
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @kind.nil?
+        invalid_properties.push('invalid value for "kind", kind cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @kind.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] kind Value to be assigned
+    def kind=(kind)
+      if kind.nil?
+        fail ArgumentError, 'kind cannot be nil'
+      end
+
+      @kind = kind
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          kind == o.kind &&
+          size == o.size
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [kind, size].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end