mencoro 1.0.0

data/lib/mencoro/models/search_result_resource.rb

@@ -0,0 +1,284 @@
+=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
+  # One organic result of a captured search page
+  class SearchResultResource < ApiModelBase
+    # Rank on the captured page, starting at 1
+    attr_accessor :position
+
+    # The result URL as captured, redirector included when unresolved is true
+    attr_accessor :url
+
+    # Result title, when the page showed one
+    attr_accessor :title
+
+    # Result snippet, when the page showed one
+    attr_accessor :snippet
+
+    # Host of url. Belongs to the redirector, not the publisher, when unresolved is true
+    attr_accessor :domain
+
+    # Star rating shown in the rich result, when there was one
+    attr_accessor :rating
+
+    # Number of votes behind rating, when the rich result reported one
+    attr_accessor :rating_votes
+
+    # True when url still points at a redirector: count the result, do not attribute the domain
+    attr_accessor :unresolved
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'position' => :'position',
+        :'url' => :'url',
+        :'title' => :'title',
+        :'snippet' => :'snippet',
+        :'domain' => :'domain',
+        :'rating' => :'rating',
+        :'rating_votes' => :'ratingVotes',
+        :'unresolved' => :'unresolved'
+      }
+    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
+      {
+        :'position' => :'Integer',
+        :'url' => :'String',
+        :'title' => :'String',
+        :'snippet' => :'String',
+        :'domain' => :'String',
+        :'rating' => :'Float',
+        :'rating_votes' => :'Integer',
+        :'unresolved' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'title',
+        :'snippet',
+        :'domain',
+        :'rating',
+        :'rating_votes',
+      ])
+    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::SearchResultResource` 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::SearchResultResource`. 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?(:'position')
+        self.position = attributes[:'position']
+      else
+        self.position = nil
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = nil
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'snippet')
+        self.snippet = attributes[:'snippet']
+      end
+
+      if attributes.key?(:'domain')
+        self.domain = attributes[:'domain']
+      end
+
+      if attributes.key?(:'rating')
+        self.rating = attributes[:'rating']
+      end
+
+      if attributes.key?(:'rating_votes')
+        self.rating_votes = attributes[:'rating_votes']
+      end
+
+      if attributes.key?(:'unresolved')
+        self.unresolved = attributes[:'unresolved']
+      else
+        self.unresolved = 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 @position.nil?
+        invalid_properties.push('invalid value for "position", position cannot be nil.')
+      end
+
+      if @position < 1
+        invalid_properties.push('invalid value for "position", must be greater than or equal to 1.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @unresolved.nil?
+        invalid_properties.push('invalid value for "unresolved", unresolved 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 @position.nil?
+      return false if @position < 1
+      return false if @url.nil?
+      return false if @unresolved.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] position Value to be assigned
+    def position=(position)
+      if position.nil?
+        fail ArgumentError, 'position cannot be nil'
+      end
+
+      if position < 1
+        fail ArgumentError, 'invalid value for "position", must be greater than or equal to 1.'
+      end
+
+      @position = position
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      if url.nil?
+        fail ArgumentError, 'url cannot be nil'
+      end
+
+      @url = url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unresolved Value to be assigned
+    def unresolved=(unresolved)
+      if unresolved.nil?
+        fail ArgumentError, 'unresolved cannot be nil'
+      end
+
+      @unresolved = unresolved
+    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 &&
+          position == o.position &&
+          url == o.url &&
+          title == o.title &&
+          snippet == o.snippet &&
+          domain == o.domain &&
+          rating == o.rating &&
+          rating_votes == o.rating_votes &&
+          unresolved == o.unresolved
+    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
+      [position, url, title, snippet, domain, rating, rating_votes, unresolved].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/search_snapshot_resource.rb

@@ -0,0 +1,302 @@
+=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
+  # One captured search-results page
+  class SearchSnapshotResource < ApiModelBase
+    attr_accessor :id
+
+    # The project this capture belongs to
+    attr_accessor :project_id
+
+    # The tracked query that was searched
+    attr_accessor :tracked_query_id
+
+    # The search engine that was captured
+    attr_accessor :engine
+
+    # Organic results in rank order
+    attr_accessor :results
+
+    # When the page was captured, UTC
+    attr_accessor :captured_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'project_id' => :'projectId',
+        :'tracked_query_id' => :'trackedQueryId',
+        :'engine' => :'engine',
+        :'results' => :'results',
+        :'captured_at' => :'capturedAt'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'project_id' => :'String',
+        :'tracked_query_id' => :'String',
+        :'engine' => :'String',
+        :'results' => :'Array<SearchResultResource>',
+        :'captured_at' => :'Time'
+      }
+    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::SearchSnapshotResource` 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::SearchSnapshotResource`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      else
+        self.project_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?(:'engine')
+        self.engine = attributes[:'engine']
+      else
+        self.engine = nil
+      end
+
+      if attributes.key?(:'results')
+        if (value = attributes[:'results']).is_a?(Array)
+          self.results = value
+        end
+      else
+        self.results = nil
+      end
+
+      if attributes.key?(:'captured_at')
+        self.captured_at = attributes[:'captured_at']
+      else
+        self.captured_at = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @project_id.nil?
+        invalid_properties.push('invalid value for "project_id", project_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 @engine.nil?
+        invalid_properties.push('invalid value for "engine", engine cannot be nil.')
+      end
+
+      if @results.nil?
+        invalid_properties.push('invalid value for "results", results cannot be nil.')
+      end
+
+      if @captured_at.nil?
+        invalid_properties.push('invalid value for "captured_at", captured_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 @id.nil?
+      return false if @project_id.nil?
+      return false if @tracked_query_id.nil?
+      return false if @engine.nil?
+      return false if @results.nil?
+      return false if @captured_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = 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] 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] 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] results Value to be assigned
+    def results=(results)
+      if results.nil?
+        fail ArgumentError, 'results cannot be nil'
+      end
+
+      @results = results
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] captured_at Value to be assigned
+    def captured_at=(captured_at)
+      if captured_at.nil?
+        fail ArgumentError, 'captured_at cannot be nil'
+      end
+
+      @captured_at = captured_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 &&
+          id == o.id &&
+          project_id == o.project_id &&
+          tracked_query_id == o.tracked_query_id &&
+          engine == o.engine &&
+          results == o.results &&
+          captured_at == o.captured_at
+    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
+      [id, project_id, tracked_query_id, engine, results, captured_at].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