mencoro 1.0.1 → 2.0.1

data/lib/mencoro/models/cited_source_row.rb

@@ -0,0 +1,298 @@
+=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
+  class CitedSourceRow < ApiModelBase
+    attr_accessor :group_key
+
+    attr_accessor :domain
+
+    attr_accessor :citation_count
+
+    attr_accessor :distinct_query_count
+
+    attr_accessor :distinct_response_count
+
+    attr_accessor :avg_position
+
+    attr_accessor :sample_title
+
+    attr_accessor :sample_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'group_key' => :'groupKey',
+        :'domain' => :'domain',
+        :'citation_count' => :'citationCount',
+        :'distinct_query_count' => :'distinctQueryCount',
+        :'distinct_response_count' => :'distinctResponseCount',
+        :'avg_position' => :'avgPosition',
+        :'sample_title' => :'sampleTitle',
+        :'sample_url' => :'sampleUrl'
+      }
+    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
+      {
+        :'group_key' => :'String',
+        :'domain' => :'String',
+        :'citation_count' => :'Integer',
+        :'distinct_query_count' => :'Integer',
+        :'distinct_response_count' => :'Integer',
+        :'avg_position' => :'Float',
+        :'sample_title' => :'String',
+        :'sample_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'domain',
+        :'avg_position',
+        :'sample_title',
+      ])
+    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::CitedSourceRow` 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::CitedSourceRow`. 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?(:'group_key')
+        self.group_key = attributes[:'group_key']
+      else
+        self.group_key = nil
+      end
+
+      if attributes.key?(:'domain')
+        self.domain = attributes[:'domain']
+      end
+
+      if attributes.key?(:'citation_count')
+        self.citation_count = attributes[:'citation_count']
+      else
+        self.citation_count = nil
+      end
+
+      if attributes.key?(:'distinct_query_count')
+        self.distinct_query_count = attributes[:'distinct_query_count']
+      else
+        self.distinct_query_count = nil
+      end
+
+      if attributes.key?(:'distinct_response_count')
+        self.distinct_response_count = attributes[:'distinct_response_count']
+      else
+        self.distinct_response_count = nil
+      end
+
+      if attributes.key?(:'avg_position')
+        self.avg_position = attributes[:'avg_position']
+      end
+
+      if attributes.key?(:'sample_title')
+        self.sample_title = attributes[:'sample_title']
+      end
+
+      if attributes.key?(:'sample_url')
+        self.sample_url = attributes[:'sample_url']
+      else
+        self.sample_url = 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 @group_key.nil?
+        invalid_properties.push('invalid value for "group_key", group_key cannot be nil.')
+      end
+
+      if @citation_count.nil?
+        invalid_properties.push('invalid value for "citation_count", citation_count cannot be nil.')
+      end
+
+      if @distinct_query_count.nil?
+        invalid_properties.push('invalid value for "distinct_query_count", distinct_query_count cannot be nil.')
+      end
+
+      if @distinct_response_count.nil?
+        invalid_properties.push('invalid value for "distinct_response_count", distinct_response_count cannot be nil.')
+      end
+
+      if @sample_url.nil?
+        invalid_properties.push('invalid value for "sample_url", sample_url 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 @group_key.nil?
+      return false if @citation_count.nil?
+      return false if @distinct_query_count.nil?
+      return false if @distinct_response_count.nil?
+      return false if @sample_url.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] group_key Value to be assigned
+    def group_key=(group_key)
+      if group_key.nil?
+        fail ArgumentError, 'group_key cannot be nil'
+      end
+
+      @group_key = group_key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] citation_count Value to be assigned
+    def citation_count=(citation_count)
+      if citation_count.nil?
+        fail ArgumentError, 'citation_count cannot be nil'
+      end
+
+      @citation_count = citation_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] distinct_query_count Value to be assigned
+    def distinct_query_count=(distinct_query_count)
+      if distinct_query_count.nil?
+        fail ArgumentError, 'distinct_query_count cannot be nil'
+      end
+
+      @distinct_query_count = distinct_query_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] distinct_response_count Value to be assigned
+    def distinct_response_count=(distinct_response_count)
+      if distinct_response_count.nil?
+        fail ArgumentError, 'distinct_response_count cannot be nil'
+      end
+
+      @distinct_response_count = distinct_response_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sample_url Value to be assigned
+    def sample_url=(sample_url)
+      if sample_url.nil?
+        fail ArgumentError, 'sample_url cannot be nil'
+      end
+
+      @sample_url = sample_url
+    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 &&
+          group_key == o.group_key &&
+          domain == o.domain &&
+          citation_count == o.citation_count &&
+          distinct_query_count == o.distinct_query_count &&
+          distinct_response_count == o.distinct_response_count &&
+          avg_position == o.avg_position &&
+          sample_title == o.sample_title &&
+          sample_url == o.sample_url
+    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
+      [group_key, domain, citation_count, distinct_query_count, distinct_response_count, avg_position, sample_title, sample_url].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/mencoro/models/cited_sources_response.rb

@@ -0,0 +1,192 @@
+=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
+  class CitedSourcesResponse < ApiModelBase
+    attr_accessor :sources
+
+    attr_accessor :total
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sources' => :'sources',
+        :'total' => :'total'
+      }
+    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
+      {
+        :'sources' => :'Array<CitedSourceRow>',
+        :'total' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::CitedSourcesResponse` 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::CitedSourcesResponse`. 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?(:'sources')
+        if (value = attributes[:'sources']).is_a?(Array)
+          self.sources = value
+        end
+      else
+        self.sources = nil
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      else
+        self.total = 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 @sources.nil?
+        invalid_properties.push('invalid value for "sources", sources cannot be nil.')
+      end
+
+      if @total.nil?
+        invalid_properties.push('invalid value for "total", total 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 @sources.nil?
+      return false if @total.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sources Value to be assigned
+    def sources=(sources)
+      if sources.nil?
+        fail ArgumentError, 'sources cannot be nil'
+      end
+
+      @sources = sources
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total Value to be assigned
+    def total=(total)
+      if total.nil?
+        fail ArgumentError, 'total cannot be nil'
+      end
+
+      @total = total
+    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 &&
+          sources == o.sources &&
+          total == o.total
+    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
+      [sources, total].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