mencoro 1.0.0

data/lib/mencoro/models/ai_response_report_resource.rb

@@ -0,0 +1,311 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mencoro
+  # Acknowledgement of a report about a captured AI answer
+  class AiResponseReportResource < ApiModelBase
+    # The captured AI answer the report is about
+    attr_accessor :ai_response_id
+
+    # The tracked query that answer was captured for
+    attr_accessor :tracked_query_id
+
+    # The kind of problem reported
+    attr_accessor :type
+
+    # The note as stored. An empty or whitespace-only comment is stored as null.
+    attr_accessor :comment
+
+    # Brand names reported as missed, de-duplicated and trimmed.
+    attr_accessor :missed_brand_names
+
+    # True once the report has been accepted for review. It is never false: a report that could not be delivered answers with an error instead.
+    attr_accessor :accepted
+
+    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
+      {
+        :'ai_response_id' => :'aiResponseId',
+        :'tracked_query_id' => :'trackedQueryId',
+        :'type' => :'type',
+        :'comment' => :'comment',
+        :'missed_brand_names' => :'missedBrandNames',
+        :'accepted' => :'accepted'
+      }
+    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
+      {
+        :'ai_response_id' => :'String',
+        :'tracked_query_id' => :'String',
+        :'type' => :'String',
+        :'comment' => :'String',
+        :'missed_brand_names' => :'Array<String>',
+        :'accepted' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'comment',
+      ])
+    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 `Mencoro::AiResponseReportResource` 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 `Mencoro::AiResponseReportResource`. 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?(:'ai_response_id')
+        self.ai_response_id = attributes[:'ai_response_id']
+      else
+        self.ai_response_id = nil
+      end
+
+      if attributes.key?(:'tracked_query_id')
+        self.tracked_query_id = attributes[:'tracked_query_id']
+      else
+        self.tracked_query_id = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'comment')
+        self.comment = attributes[:'comment']
+      end
+
+      if attributes.key?(:'missed_brand_names')
+        if (value = attributes[:'missed_brand_names']).is_a?(Array)
+          self.missed_brand_names = value
+        end
+      else
+        self.missed_brand_names = nil
+      end
+
+      if attributes.key?(:'accepted')
+        self.accepted = attributes[:'accepted']
+      else
+        self.accepted = 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 @ai_response_id.nil?
+        invalid_properties.push('invalid value for "ai_response_id", ai_response_id cannot be nil.')
+      end
+
+      if @tracked_query_id.nil?
+        invalid_properties.push('invalid value for "tracked_query_id", tracked_query_id cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @missed_brand_names.nil?
+        invalid_properties.push('invalid value for "missed_brand_names", missed_brand_names cannot be nil.')
+      end
+
+      if @accepted.nil?
+        invalid_properties.push('invalid value for "accepted", accepted 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 @ai_response_id.nil?
+      return false if @tracked_query_id.nil?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["missed_mention", "other"])
+      return false unless type_validator.valid?(@type)
+      return false if @missed_brand_names.nil?
+      return false if @accepted.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ai_response_id Value to be assigned
+    def ai_response_id=(ai_response_id)
+      if ai_response_id.nil?
+        fail ArgumentError, 'ai_response_id cannot be nil'
+      end
+
+      @ai_response_id = ai_response_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tracked_query_id Value to be assigned
+    def tracked_query_id=(tracked_query_id)
+      if tracked_query_id.nil?
+        fail ArgumentError, 'tracked_query_id cannot be nil'
+      end
+
+      @tracked_query_id = tracked_query_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["missed_mention", "other"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] missed_brand_names Value to be assigned
+    def missed_brand_names=(missed_brand_names)
+      if missed_brand_names.nil?
+        fail ArgumentError, 'missed_brand_names cannot be nil'
+      end
+
+      @missed_brand_names = missed_brand_names
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] accepted Value to be assigned
+    def accepted=(accepted)
+      if accepted.nil?
+        fail ArgumentError, 'accepted cannot be nil'
+      end
+
+      @accepted = accepted
+    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 &&
+          ai_response_id == o.ai_response_id &&
+          tracked_query_id == o.tracked_query_id &&
+          type == o.type &&
+          comment == o.comment &&
+          missed_brand_names == o.missed_brand_names &&
+          accepted == o.accepted
+    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
+      [ai_response_id, tracked_query_id, type, comment, missed_brand_names, accepted].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