rankvectors 1.0.0

data/lib/openapi_client/models/implementation_instructions.rb

@@ -0,0 +1,372 @@
+=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 ImplementationInstructions
+    # Suggestion identifier
+    attr_accessor :suggestion_id
+
+    # URL of the page to modify
+    attr_accessor :page_url
+
+    # Text to turn into a link
+    attr_accessor :anchor_text
+
+    # URL to link to
+    attr_accessor :target_url
+
+    # Context where the link should be placed
+    attr_accessor :context
+
+    attr_accessor :instructions
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'suggestion_id' => :'suggestionId',
+        :'page_url' => :'pageUrl',
+        :'anchor_text' => :'anchorText',
+        :'target_url' => :'targetUrl',
+        :'context' => :'context',
+        :'instructions' => :'instructions'
+      }
+    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
+      {
+        :'suggestion_id' => :'String',
+        :'page_url' => :'String',
+        :'anchor_text' => :'String',
+        :'target_url' => :'String',
+        :'context' => :'String',
+        :'instructions' => :'StepByStepInstructions'
+      }
+    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::ImplementationInstructions` 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::ImplementationInstructions`. 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?(:'suggestion_id')
+        self.suggestion_id = attributes[:'suggestion_id']
+      else
+        self.suggestion_id = nil
+      end
+
+      if attributes.key?(:'page_url')
+        self.page_url = attributes[:'page_url']
+      else
+        self.page_url = nil
+      end
+
+      if attributes.key?(:'anchor_text')
+        self.anchor_text = attributes[:'anchor_text']
+      else
+        self.anchor_text = nil
+      end
+
+      if attributes.key?(:'target_url')
+        self.target_url = attributes[:'target_url']
+      else
+        self.target_url = nil
+      end
+
+      if attributes.key?(:'context')
+        self.context = attributes[:'context']
+      else
+        self.context = nil
+      end
+
+      if attributes.key?(:'instructions')
+        self.instructions = attributes[:'instructions']
+      else
+        self.instructions = 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 @suggestion_id.nil?
+        invalid_properties.push('invalid value for "suggestion_id", suggestion_id cannot be nil.')
+      end
+
+      if @page_url.nil?
+        invalid_properties.push('invalid value for "page_url", page_url cannot be nil.')
+      end
+
+      if @anchor_text.nil?
+        invalid_properties.push('invalid value for "anchor_text", anchor_text cannot be nil.')
+      end
+
+      if @target_url.nil?
+        invalid_properties.push('invalid value for "target_url", target_url cannot be nil.')
+      end
+
+      if @context.nil?
+        invalid_properties.push('invalid value for "context", context cannot be nil.')
+      end
+
+      if @instructions.nil?
+        invalid_properties.push('invalid value for "instructions", instructions 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 @suggestion_id.nil?
+      return false if @page_url.nil?
+      return false if @anchor_text.nil?
+      return false if @target_url.nil?
+      return false if @context.nil?
+      return false if @instructions.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] suggestion_id Value to be assigned
+    def suggestion_id=(suggestion_id)
+      if suggestion_id.nil?
+        fail ArgumentError, 'suggestion_id cannot be nil'
+      end
+
+      @suggestion_id = suggestion_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page_url Value to be assigned
+    def page_url=(page_url)
+      if page_url.nil?
+        fail ArgumentError, 'page_url cannot be nil'
+      end
+
+      @page_url = page_url
+    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] target_url Value to be assigned
+    def target_url=(target_url)
+      if target_url.nil?
+        fail ArgumentError, 'target_url cannot be nil'
+      end
+
+      @target_url = target_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] context Value to be assigned
+    def context=(context)
+      if context.nil?
+        fail ArgumentError, 'context cannot be nil'
+      end
+
+      @context = context
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] instructions Value to be assigned
+    def instructions=(instructions)
+      if instructions.nil?
+        fail ArgumentError, 'instructions cannot be nil'
+      end
+
+      @instructions = instructions
+    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 &&
+          suggestion_id == o.suggestion_id &&
+          page_url == o.page_url &&
+          anchor_text == o.anchor_text &&
+          target_url == o.target_url &&
+          context == o.context &&
+          instructions == o.instructions
+    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
+      [suggestion_id, page_url, anchor_text, target_url, context, instructions].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