mencoro 1.0.1 → 2.0.1

data/lib/mencoro/models/mention_match_resource.rb

@@ -0,0 +1,432 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
+
+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
+  # A stored mention match; no provider credentials or operational metadata
+  class MentionMatchResource < ApiModelBase
+    attr_accessor :tracked_query_id
+
+    attr_accessor :project_id
+
+    attr_accessor :engine
+
+    attr_accessor :ai_response_id
+
+    attr_accessor :competitor_id
+
+    attr_accessor :mention_position
+
+    attr_accessor :sentiment
+
+    attr_accessor :mention_type
+
+    attr_accessor :mention_type_condition
+
+    attr_accessor :response_context
+
+    attr_accessor :detected_at
+
+    attr_accessor :mention_relation
+
+    attr_accessor :brand_name
+
+    attr_accessor :brand_name_as_mentioned
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'tracked_query_id' => :'trackedQueryId',
+        :'project_id' => :'projectId',
+        :'engine' => :'engine',
+        :'ai_response_id' => :'aiResponseId',
+        :'competitor_id' => :'competitorId',
+        :'mention_position' => :'mentionPosition',
+        :'sentiment' => :'sentiment',
+        :'mention_type' => :'mentionType',
+        :'mention_type_condition' => :'mentionTypeCondition',
+        :'response_context' => :'responseContext',
+        :'detected_at' => :'detectedAt',
+        :'mention_relation' => :'mentionRelation',
+        :'brand_name' => :'brandName',
+        :'brand_name_as_mentioned' => :'brandNameAsMentioned'
+      }
+    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
+      {
+        :'tracked_query_id' => :'String',
+        :'project_id' => :'String',
+        :'engine' => :'String',
+        :'ai_response_id' => :'String',
+        :'competitor_id' => :'String',
+        :'mention_position' => :'Integer',
+        :'sentiment' => :'String',
+        :'mention_type' => :'String',
+        :'mention_type_condition' => :'String',
+        :'response_context' => :'String',
+        :'detected_at' => :'Time',
+        :'mention_relation' => :'String',
+        :'brand_name' => :'String',
+        :'brand_name_as_mentioned' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'competitor_id',
+        :'mention_type_condition',
+        :'mention_relation',
+        :'brand_name',
+        :'brand_name_as_mentioned'
+      ])
+    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::MentionMatchResource` 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::MentionMatchResource`. 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?(:'tracked_query_id')
+        self.tracked_query_id = attributes[:'tracked_query_id']
+      else
+        self.tracked_query_id = nil
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      else
+        self.project_id = nil
+      end
+
+      if attributes.key?(:'engine')
+        self.engine = attributes[:'engine']
+      else
+        self.engine = nil
+      end
+
+      if attributes.key?(:'ai_response_id')
+        self.ai_response_id = attributes[:'ai_response_id']
+      else
+        self.ai_response_id = nil
+      end
+
+      if attributes.key?(:'competitor_id')
+        self.competitor_id = attributes[:'competitor_id']
+      end
+
+      if attributes.key?(:'mention_position')
+        self.mention_position = attributes[:'mention_position']
+      else
+        self.mention_position = nil
+      end
+
+      if attributes.key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      else
+        self.sentiment = nil
+      end
+
+      if attributes.key?(:'mention_type')
+        self.mention_type = attributes[:'mention_type']
+      else
+        self.mention_type = nil
+      end
+
+      if attributes.key?(:'mention_type_condition')
+        self.mention_type_condition = attributes[:'mention_type_condition']
+      end
+
+      if attributes.key?(:'response_context')
+        self.response_context = attributes[:'response_context']
+      else
+        self.response_context = nil
+      end
+
+      if attributes.key?(:'detected_at')
+        self.detected_at = attributes[:'detected_at']
+      else
+        self.detected_at = nil
+      end
+
+      if attributes.key?(:'mention_relation')
+        self.mention_relation = attributes[:'mention_relation']
+      end
+
+      if attributes.key?(:'brand_name')
+        self.brand_name = attributes[:'brand_name']
+      end
+
+      if attributes.key?(:'brand_name_as_mentioned')
+        self.brand_name_as_mentioned = attributes[:'brand_name_as_mentioned']
+      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 @tracked_query_id.nil?
+        invalid_properties.push('invalid value for "tracked_query_id", tracked_query_id cannot be nil.')
+      end
+
+      if @project_id.nil?
+        invalid_properties.push('invalid value for "project_id", project_id cannot be nil.')
+      end
+
+      if @engine.nil?
+        invalid_properties.push('invalid value for "engine", engine cannot be nil.')
+      end
+
+      if @ai_response_id.nil?
+        invalid_properties.push('invalid value for "ai_response_id", ai_response_id cannot be nil.')
+      end
+
+      if @mention_position.nil?
+        invalid_properties.push('invalid value for "mention_position", mention_position cannot be nil.')
+      end
+
+      if @mention_position < 1
+        invalid_properties.push('invalid value for "mention_position", must be greater than or equal to 1.')
+      end
+
+      if @sentiment.nil?
+        invalid_properties.push('invalid value for "sentiment", sentiment cannot be nil.')
+      end
+
+      if @mention_type.nil?
+        invalid_properties.push('invalid value for "mention_type", mention_type cannot be nil.')
+      end
+
+      if @response_context.nil?
+        invalid_properties.push('invalid value for "response_context", response_context cannot be nil.')
+      end
+
+      if @detected_at.nil?
+        invalid_properties.push('invalid value for "detected_at", detected_at 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 @tracked_query_id.nil?
+      return false if @project_id.nil?
+      return false if @engine.nil?
+      return false if @ai_response_id.nil?
+      return false if @mention_position.nil?
+      return false if @mention_position < 1
+      return false if @sentiment.nil?
+      return false if @mention_type.nil?
+      return false if @response_context.nil?
+      return false if @detected_at.nil?
+      true
+    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 with validation
+    # @param [Object] project_id Value to be assigned
+    def project_id=(project_id)
+      if project_id.nil?
+        fail ArgumentError, 'project_id cannot be nil'
+      end
+
+      @project_id = project_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] engine Value to be assigned
+    def engine=(engine)
+      if engine.nil?
+        fail ArgumentError, 'engine cannot be nil'
+      end
+
+      @engine = engine
+    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] mention_position Value to be assigned
+    def mention_position=(mention_position)
+      if mention_position.nil?
+        fail ArgumentError, 'mention_position cannot be nil'
+      end
+
+      if mention_position < 1
+        fail ArgumentError, 'invalid value for "mention_position", must be greater than or equal to 1.'
+      end
+
+      @mention_position = mention_position
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sentiment Value to be assigned
+    def sentiment=(sentiment)
+      if sentiment.nil?
+        fail ArgumentError, 'sentiment cannot be nil'
+      end
+
+      @sentiment = sentiment
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mention_type Value to be assigned
+    def mention_type=(mention_type)
+      if mention_type.nil?
+        fail ArgumentError, 'mention_type cannot be nil'
+      end
+
+      @mention_type = mention_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] response_context Value to be assigned
+    def response_context=(response_context)
+      if response_context.nil?
+        fail ArgumentError, 'response_context cannot be nil'
+      end
+
+      @response_context = response_context
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] detected_at Value to be assigned
+    def detected_at=(detected_at)
+      if detected_at.nil?
+        fail ArgumentError, 'detected_at cannot be nil'
+      end
+
+      @detected_at = detected_at
+    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 &&
+          tracked_query_id == o.tracked_query_id &&
+          project_id == o.project_id &&
+          engine == o.engine &&
+          ai_response_id == o.ai_response_id &&
+          competitor_id == o.competitor_id &&
+          mention_position == o.mention_position &&
+          sentiment == o.sentiment &&
+          mention_type == o.mention_type &&
+          mention_type_condition == o.mention_type_condition &&
+          response_context == o.response_context &&
+          detected_at == o.detected_at &&
+          mention_relation == o.mention_relation &&
+          brand_name == o.brand_name &&
+          brand_name_as_mentioned == o.brand_name_as_mentioned
+    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
+      [tracked_query_id, project_id, engine, ai_response_id, competitor_id, mention_position, sentiment, mention_type, mention_type_condition, response_context, detected_at, mention_relation, brand_name, brand_name_as_mentioned].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