rankvectors 1.0.0

data/lib/openapi_client/models/create_project_request.rb

@@ -0,0 +1,541 @@
+=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 CreateProjectRequest
+    # Project name
+    attr_accessor :name
+
+    # Website domain URL
+    attr_accessor :domain
+
+    # Natural language prompt for crawling
+    attr_accessor :prompt
+
+    # Search query for targeted crawling
+    attr_accessor :search_query
+
+    # How to handle sitemaps
+    attr_accessor :sitemap_mode
+
+    # Whether to include subdomains
+    attr_accessor :include_subdomains
+
+    # Whether to ignore URL query parameters
+    attr_accessor :ignore_query_params
+
+    # Maximum crawl depth
+    attr_accessor :max_discovery_depth
+
+    # Paths to exclude from crawling
+    attr_accessor :exclude_paths
+
+    # Specific paths to include
+    attr_accessor :include_paths
+
+    # Whether to crawl the entire domain
+    attr_accessor :crawl_entire_domain
+
+    # Whether to allow external links
+    attr_accessor :allow_external_links
+
+    # Maximum number of pages to crawl
+    attr_accessor :max_pages
+
+    # Delay between crawl requests (ms)
+    attr_accessor :crawl_delay
+
+    # Maximum concurrent crawl requests
+    attr_accessor :crawl_max_concurrency
+
+    # Whether to extract only main content
+    attr_accessor :only_main_content
+
+    # Custom headers for crawling
+    attr_accessor :custom_headers
+
+    # Wait time for page load (ms)
+    attr_accessor :wait_for
+
+    # Whether to block ads
+    attr_accessor :block_ads
+
+    # Proxy mode for crawling
+    attr_accessor :proxy_mode
+
+    # Whether to use AI reranking
+    attr_accessor :use_reranking
+
+    # Whether to enable change tracking
+    attr_accessor :enable_change_tracking
+
+    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
+      {
+        :'name' => :'name',
+        :'domain' => :'domain',
+        :'prompt' => :'prompt',
+        :'search_query' => :'searchQuery',
+        :'sitemap_mode' => :'sitemapMode',
+        :'include_subdomains' => :'includeSubdomains',
+        :'ignore_query_params' => :'ignoreQueryParams',
+        :'max_discovery_depth' => :'maxDiscoveryDepth',
+        :'exclude_paths' => :'excludePaths',
+        :'include_paths' => :'includePaths',
+        :'crawl_entire_domain' => :'crawlEntireDomain',
+        :'allow_external_links' => :'allowExternalLinks',
+        :'max_pages' => :'maxPages',
+        :'crawl_delay' => :'crawlDelay',
+        :'crawl_max_concurrency' => :'crawlMaxConcurrency',
+        :'only_main_content' => :'onlyMainContent',
+        :'custom_headers' => :'customHeaders',
+        :'wait_for' => :'waitFor',
+        :'block_ads' => :'blockAds',
+        :'proxy_mode' => :'proxyMode',
+        :'use_reranking' => :'useReranking',
+        :'enable_change_tracking' => :'enableChangeTracking'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'domain' => :'String',
+        :'prompt' => :'String',
+        :'search_query' => :'String',
+        :'sitemap_mode' => :'String',
+        :'include_subdomains' => :'Boolean',
+        :'ignore_query_params' => :'Boolean',
+        :'max_discovery_depth' => :'Integer',
+        :'exclude_paths' => :'Array<String>',
+        :'include_paths' => :'Array<String>',
+        :'crawl_entire_domain' => :'Boolean',
+        :'allow_external_links' => :'Boolean',
+        :'max_pages' => :'Integer',
+        :'crawl_delay' => :'Integer',
+        :'crawl_max_concurrency' => :'Integer',
+        :'only_main_content' => :'Boolean',
+        :'custom_headers' => :'Hash<String, String>',
+        :'wait_for' => :'Integer',
+        :'block_ads' => :'Boolean',
+        :'proxy_mode' => :'String',
+        :'use_reranking' => :'Boolean',
+        :'enable_change_tracking' => :'Boolean'
+      }
+    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::CreateProjectRequest` 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::CreateProjectRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'domain')
+        self.domain = attributes[:'domain']
+      else
+        self.domain = nil
+      end
+
+      if attributes.key?(:'prompt')
+        self.prompt = attributes[:'prompt']
+      end
+
+      if attributes.key?(:'search_query')
+        self.search_query = attributes[:'search_query']
+      end
+
+      if attributes.key?(:'sitemap_mode')
+        self.sitemap_mode = attributes[:'sitemap_mode']
+      else
+        self.sitemap_mode = 'include'
+      end
+
+      if attributes.key?(:'include_subdomains')
+        self.include_subdomains = attributes[:'include_subdomains']
+      else
+        self.include_subdomains = true
+      end
+
+      if attributes.key?(:'ignore_query_params')
+        self.ignore_query_params = attributes[:'ignore_query_params']
+      else
+        self.ignore_query_params = true
+      end
+
+      if attributes.key?(:'max_discovery_depth')
+        self.max_discovery_depth = attributes[:'max_discovery_depth']
+      end
+
+      if attributes.key?(:'exclude_paths')
+        if (value = attributes[:'exclude_paths']).is_a?(Array)
+          self.exclude_paths = value
+        end
+      end
+
+      if attributes.key?(:'include_paths')
+        if (value = attributes[:'include_paths']).is_a?(Array)
+          self.include_paths = value
+        end
+      end
+
+      if attributes.key?(:'crawl_entire_domain')
+        self.crawl_entire_domain = attributes[:'crawl_entire_domain']
+      else
+        self.crawl_entire_domain = false
+      end
+
+      if attributes.key?(:'allow_external_links')
+        self.allow_external_links = attributes[:'allow_external_links']
+      else
+        self.allow_external_links = false
+      end
+
+      if attributes.key?(:'max_pages')
+        self.max_pages = attributes[:'max_pages']
+      else
+        self.max_pages = 100
+      end
+
+      if attributes.key?(:'crawl_delay')
+        self.crawl_delay = attributes[:'crawl_delay']
+      end
+
+      if attributes.key?(:'crawl_max_concurrency')
+        self.crawl_max_concurrency = attributes[:'crawl_max_concurrency']
+      end
+
+      if attributes.key?(:'only_main_content')
+        self.only_main_content = attributes[:'only_main_content']
+      else
+        self.only_main_content = true
+      end
+
+      if attributes.key?(:'custom_headers')
+        if (value = attributes[:'custom_headers']).is_a?(Hash)
+          self.custom_headers = value
+        end
+      end
+
+      if attributes.key?(:'wait_for')
+        self.wait_for = attributes[:'wait_for']
+      else
+        self.wait_for = 0
+      end
+
+      if attributes.key?(:'block_ads')
+        self.block_ads = attributes[:'block_ads']
+      else
+        self.block_ads = true
+      end
+
+      if attributes.key?(:'proxy_mode')
+        self.proxy_mode = attributes[:'proxy_mode']
+      else
+        self.proxy_mode = 'auto'
+      end
+
+      if attributes.key?(:'use_reranking')
+        self.use_reranking = attributes[:'use_reranking']
+      else
+        self.use_reranking = true
+      end
+
+      if attributes.key?(:'enable_change_tracking')
+        self.enable_change_tracking = attributes[:'enable_change_tracking']
+      else
+        self.enable_change_tracking = false
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @domain.nil?
+        invalid_properties.push('invalid value for "domain", domain 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 @name.nil?
+      return false if @domain.nil?
+      sitemap_mode_validator = EnumAttributeValidator.new('String', ["include", "exclude", "only"])
+      return false unless sitemap_mode_validator.valid?(@sitemap_mode)
+      proxy_mode_validator = EnumAttributeValidator.new('String', ["auto", "residential", "datacenter"])
+      return false unless proxy_mode_validator.valid?(@proxy_mode)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] domain Value to be assigned
+    def domain=(domain)
+      if domain.nil?
+        fail ArgumentError, 'domain cannot be nil'
+      end
+
+      @domain = domain
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sitemap_mode Object to be assigned
+    def sitemap_mode=(sitemap_mode)
+      validator = EnumAttributeValidator.new('String', ["include", "exclude", "only"])
+      unless validator.valid?(sitemap_mode)
+        fail ArgumentError, "invalid value for \"sitemap_mode\", must be one of #{validator.allowable_values}."
+      end
+      @sitemap_mode = sitemap_mode
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] proxy_mode Object to be assigned
+    def proxy_mode=(proxy_mode)
+      validator = EnumAttributeValidator.new('String', ["auto", "residential", "datacenter"])
+      unless validator.valid?(proxy_mode)
+        fail ArgumentError, "invalid value for \"proxy_mode\", must be one of #{validator.allowable_values}."
+      end
+      @proxy_mode = proxy_mode
+    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 &&
+          name == o.name &&
+          domain == o.domain &&
+          prompt == o.prompt &&
+          search_query == o.search_query &&
+          sitemap_mode == o.sitemap_mode &&
+          include_subdomains == o.include_subdomains &&
+          ignore_query_params == o.ignore_query_params &&
+          max_discovery_depth == o.max_discovery_depth &&
+          exclude_paths == o.exclude_paths &&
+          include_paths == o.include_paths &&
+          crawl_entire_domain == o.crawl_entire_domain &&
+          allow_external_links == o.allow_external_links &&
+          max_pages == o.max_pages &&
+          crawl_delay == o.crawl_delay &&
+          crawl_max_concurrency == o.crawl_max_concurrency &&
+          only_main_content == o.only_main_content &&
+          custom_headers == o.custom_headers &&
+          wait_for == o.wait_for &&
+          block_ads == o.block_ads &&
+          proxy_mode == o.proxy_mode &&
+          use_reranking == o.use_reranking &&
+          enable_change_tracking == o.enable_change_tracking
+    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
+      [name, domain, prompt, search_query, sitemap_mode, include_subdomains, ignore_query_params, max_discovery_depth, exclude_paths, include_paths, crawl_entire_domain, allow_external_links, max_pages, crawl_delay, crawl_max_concurrency, only_main_content, custom_headers, wait_for, block_ads, proxy_mode, use_reranking, enable_change_tracking].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