rankvectors 1.0.0

data/lib/openapi_client/models/suggestion.rb

@@ -0,0 +1,497 @@
+=begin
+#RankVectors API
+
+#Intelligent internal linking optimization API using AI.   RankVectors helps you automatically discover and implement optimal internal links  across your website to improve SEO performance and user experience.  ## Key Features - **AI-Powered Analysis**: Uses OpenAI embeddings to find optimal linking opportunities - **Smart Crawling**: Automatically crawls and analyzes your website content - **Automated Implementation**: Implement links via webhooks or manual instructions - **Credit-Based System**: Pay-per-use model with transparent pricing - **Multi-Platform Support**: Works with any CMS or platform via REST API  ## Getting Started 1. Create a project with your website URL 2. Start a crawl to analyze your content 3. Generate AI-powered link suggestions 4. Implement suggestions via API or webhook 5. Track performance and manage credits  ## Authentication All API endpoints require authentication using your RankVectors API key. Include your API key in the `Authorization` header: ``` Authorization: Bearer YOUR_API_KEY ```  Get your API key from your RankVectors dashboard: Settings → API Keys 
+
+The version of the OpenAPI document: 1.2.0
+Contact: support@rankvectors.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'date'
+require 'time'
+
+module OpenapiClient
+  class Suggestion
+    # Unique suggestion identifier
+    attr_accessor :id
+
+    # Project identifier
+    attr_accessor :project_id
+
+    # Suggestion status
+    attr_accessor :status
+
+    # AI-calculated relevance score (0-1)
+    attr_accessor :relevance_score
+
+    # Suggested anchor text
+    attr_accessor :anchor_text
+
+    # Context where the link should be placed
+    attr_accessor :context
+
+    attr_accessor :source_page
+
+    attr_accessor :target_page
+
+    # AI reasoning for the suggestion
+    attr_accessor :reasoning
+
+    # Suggestion creation timestamp
+    attr_accessor :created_at
+
+    # Last update timestamp
+    attr_accessor :updated_at
+
+    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
+      {
+        :'id' => :'id',
+        :'project_id' => :'projectId',
+        :'status' => :'status',
+        :'relevance_score' => :'relevanceScore',
+        :'anchor_text' => :'anchorText',
+        :'context' => :'context',
+        :'source_page' => :'sourcePage',
+        :'target_page' => :'targetPage',
+        :'reasoning' => :'reasoning',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
+      }
+    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',
+        :'status' => :'String',
+        :'relevance_score' => :'Float',
+        :'anchor_text' => :'String',
+        :'context' => :'String',
+        :'source_page' => :'PageInfo',
+        :'target_page' => :'PageInfo',
+        :'reasoning' => :'String',
+        :'created_at' => :'Time',
+        :'updated_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 `OpenapiClient::Suggestion` 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 `OpenapiClient::Suggestion`. 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?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'relevance_score')
+        self.relevance_score = attributes[:'relevance_score']
+      else
+        self.relevance_score = nil
+      end
+
+      if attributes.key?(:'anchor_text')
+        self.anchor_text = attributes[:'anchor_text']
+      else
+        self.anchor_text = nil
+      end
+
+      if attributes.key?(:'context')
+        self.context = attributes[:'context']
+      end
+
+      if attributes.key?(:'source_page')
+        self.source_page = attributes[:'source_page']
+      else
+        self.source_page = nil
+      end
+
+      if attributes.key?(:'target_page')
+        self.target_page = attributes[:'target_page']
+      else
+        self.target_page = nil
+      end
+
+      if attributes.key?(:'reasoning')
+        self.reasoning = attributes[:'reasoning']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      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 @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @relevance_score.nil?
+        invalid_properties.push('invalid value for "relevance_score", relevance_score cannot be nil.')
+      end
+
+      if @relevance_score > 1
+        invalid_properties.push('invalid value for "relevance_score", must be smaller than or equal to 1.')
+      end
+
+      if @relevance_score < 0
+        invalid_properties.push('invalid value for "relevance_score", must be greater than or equal to 0.')
+      end
+
+      if @anchor_text.nil?
+        invalid_properties.push('invalid value for "anchor_text", anchor_text cannot be nil.')
+      end
+
+      if @source_page.nil?
+        invalid_properties.push('invalid value for "source_page", source_page cannot be nil.')
+      end
+
+      if @target_page.nil?
+        invalid_properties.push('invalid value for "target_page", target_page cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_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 @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["pending", "approved", "rejected", "implemented"])
+      return false unless status_validator.valid?(@status)
+      return false if @relevance_score.nil?
+      return false if @relevance_score > 1
+      return false if @relevance_score < 0
+      return false if @anchor_text.nil?
+      return false if @source_page.nil?
+      return false if @target_page.nil?
+      return false if @created_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 checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["pending", "approved", "rejected", "implemented"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] relevance_score Value to be assigned
+    def relevance_score=(relevance_score)
+      if relevance_score.nil?
+        fail ArgumentError, 'relevance_score cannot be nil'
+      end
+
+      if relevance_score > 1
+        fail ArgumentError, 'invalid value for "relevance_score", must be smaller than or equal to 1.'
+      end
+
+      if relevance_score < 0
+        fail ArgumentError, 'invalid value for "relevance_score", must be greater than or equal to 0.'
+      end
+
+      @relevance_score = relevance_score
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] anchor_text Value to be assigned
+    def anchor_text=(anchor_text)
+      if anchor_text.nil?
+        fail ArgumentError, 'anchor_text cannot be nil'
+      end
+
+      @anchor_text = anchor_text
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] source_page Value to be assigned
+    def source_page=(source_page)
+      if source_page.nil?
+        fail ArgumentError, 'source_page cannot be nil'
+      end
+
+      @source_page = source_page
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] target_page Value to be assigned
+    def target_page=(target_page)
+      if target_page.nil?
+        fail ArgumentError, 'target_page cannot be nil'
+      end
+
+      @target_page = target_page
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_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 &&
+          status == o.status &&
+          relevance_score == o.relevance_score &&
+          anchor_text == o.anchor_text &&
+          context == o.context &&
+          source_page == o.source_page &&
+          target_page == o.target_page &&
+          reasoning == o.reasoning &&
+          created_at == o.created_at &&
+          updated_at == o.updated_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, status, relevance_score, anchor_text, context, source_page, target_page, reasoning, created_at, updated_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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = OpenapiClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end