rankvectors 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 52a1c30f0a17b7581b9969606a62575bd926c7d18780021d0c3ccaa862265924
+  data.tar.gz: c5a1cf0e14c55342eff68fd990d11544a06f8101ad086e96548bdcb2c1366e3f
+SHA512:
+  metadata.gz: abbfbd5e374a782470e3cfd40e602b441763bfc6d549bd2ebfa94b8e06dc2659d6ae54938ad5c2124bd824c613667b71941ef7428f0a50c67b3e5daf38c757a5
+  data.tar.gz: ad3720dbab4bf5da632467011241310f8fdf3011587b86a361a3b2fbaa97d7ac5a271e139806677e46720f7bded9a691d40738947f8cd5be391cb3d523ae366a

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,191 @@
+# openapi_client
+
+OpenapiClient - the Ruby gem for the 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
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.2.0
+- Package version: 1.0.0
+- Generator version: 7.16.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://docs.rankvectors.com](https://docs.rankvectors.com)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build openapi_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./openapi_client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'openapi_client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/rankvectors/rankvectors-ruby-sdk, then add the following in the Gemfile:
+
+    gem 'openapi_client', :git => 'https://github.com/rankvectors/rankvectors-ruby-sdk.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'openapi_client'
+
+# Setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::ContentVerificationApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+verify_content_request = OpenapiClient::VerifyContentRequest.new({page_url: 'https://example.com/page', suggestion_id: 'sugg-123'}) # VerifyContentRequest | 
+
+begin
+  #Verify page content
+  result = api_instance.verify_content(project_id, verify_content_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling ContentVerificationApi->verify_content: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.rankvectors.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*OpenapiClient::ContentVerificationApi* | [**verify_content**](docs/ContentVerificationApi.md#verify_content) | **POST** /api/projects/{projectId}/verify-content | Verify page content
+*OpenapiClient::CrawlingApi* | [**get_crawl_history**](docs/CrawlingApi.md#get_crawl_history) | **GET** /api/projects/{projectId}/crawl | Get crawl history
+*OpenapiClient::CrawlingApi* | [**start_crawl**](docs/CrawlingApi.md#start_crawl) | **POST** /api/projects/{projectId}/crawl | Start website crawl
+*OpenapiClient::CreditsApi* | [**add_credits**](docs/CreditsApi.md#add_credits) | **POST** /api/projects/{projectId}/credits | Add credits
+*OpenapiClient::CreditsApi* | [**get_credits**](docs/CreditsApi.md#get_credits) | **GET** /api/projects/{projectId}/credits | Get credit balance
+*OpenapiClient::ImplementationsApi* | [**get_implementation**](docs/ImplementationsApi.md#get_implementation) | **GET** /api/projects/{projectId}/implementations/{implementationId} | Get implementation details
+*OpenapiClient::ImplementationsApi* | [**implement_links**](docs/ImplementationsApi.md#implement_links) | **POST** /api/projects/{projectId}/implementations | Implement link suggestions
+*OpenapiClient::ImplementationsApi* | [**list_implementations**](docs/ImplementationsApi.md#list_implementations) | **GET** /api/projects/{projectId}/implementations | List implementations
+*OpenapiClient::ImplementationsApi* | [**rollback_implementation**](docs/ImplementationsApi.md#rollback_implementation) | **POST** /api/projects/{projectId}/implementations/{implementationId}/rollback | Rollback implementation
+*OpenapiClient::ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /api/projects | Create a new project
+*OpenapiClient::ProjectsApi* | [**delete_project**](docs/ProjectsApi.md#delete_project) | **DELETE** /api/projects/{projectId} | Delete a project
+*OpenapiClient::ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /api/projects/{projectId} | Get project details
+*OpenapiClient::ProjectsApi* | [**list_projects**](docs/ProjectsApi.md#list_projects) | **GET** /api/projects | List all projects
+*OpenapiClient::SuggestionsApi* | [**generate_suggestions**](docs/SuggestionsApi.md#generate_suggestions) | **POST** /api/projects/{projectId}/suggestions | Generate link suggestions
+*OpenapiClient::SuggestionsApi* | [**get_suggestions**](docs/SuggestionsApi.md#get_suggestions) | **GET** /api/projects/{projectId}/suggestions | Get link suggestions
+*OpenapiClient::SuggestionsApi* | [**update_suggestion**](docs/SuggestionsApi.md#update_suggestion) | **PATCH** /api/projects/{projectId}/suggestions/{suggestionId} | Update suggestion status
+*OpenapiClient::WebhooksApi* | [**get_implementation_instructions**](docs/WebhooksApi.md#get_implementation_instructions) | **GET** /api/webhook/implement-link | Get implementation instructions
+*OpenapiClient::WebhooksApi* | [**report_implementation_status**](docs/WebhooksApi.md#report_implementation_status) | **POST** /api/webhook/implement-link | Report implementation status
+
+
+## Documentation for Models
+
+ - [OpenapiClient::AddCredits200Response](docs/AddCredits200Response.md)
+ - [OpenapiClient::AddCreditsRequest](docs/AddCreditsRequest.md)
+ - [OpenapiClient::AutoRechargeSettings](docs/AutoRechargeSettings.md)
+ - [OpenapiClient::ChangeResult](docs/ChangeResult.md)
+ - [OpenapiClient::ContentVerification](docs/ContentVerification.md)
+ - [OpenapiClient::Crawl](docs/Crawl.md)
+ - [OpenapiClient::CreateProjectRequest](docs/CreateProjectRequest.md)
+ - [OpenapiClient::CreditBalance](docs/CreditBalance.md)
+ - [OpenapiClient::CreditBalanceInfo](docs/CreditBalanceInfo.md)
+ - [OpenapiClient::CustomCredentials](docs/CustomCredentials.md)
+ - [OpenapiClient::DeleteProject200Response](docs/DeleteProject200Response.md)
+ - [OpenapiClient::Error](docs/Error.md)
+ - [OpenapiClient::GenerateSuggestions200Response](docs/GenerateSuggestions200Response.md)
+ - [OpenapiClient::GenerateSuggestionsRequest](docs/GenerateSuggestionsRequest.md)
+ - [OpenapiClient::GetImplementation200Response](docs/GetImplementation200Response.md)
+ - [OpenapiClient::Implementation](docs/Implementation.md)
+ - [OpenapiClient::ImplementationInstructions](docs/ImplementationInstructions.md)
+ - [OpenapiClient::ImplementationRequest](docs/ImplementationRequest.md)
+ - [OpenapiClient::ImplementationResponse](docs/ImplementationResponse.md)
+ - [OpenapiClient::ImplementationResult](docs/ImplementationResult.md)
+ - [OpenapiClient::ImplementationSummary](docs/ImplementationSummary.md)
+ - [OpenapiClient::LinkOpportunity](docs/LinkOpportunity.md)
+ - [OpenapiClient::ListImplementations200Response](docs/ListImplementations200Response.md)
+ - [OpenapiClient::PageInfo](docs/PageInfo.md)
+ - [OpenapiClient::PageLimitStatus](docs/PageLimitStatus.md)
+ - [OpenapiClient::PeriodCharges](docs/PeriodCharges.md)
+ - [OpenapiClient::Project](docs/Project.md)
+ - [OpenapiClient::ProjectCount](docs/ProjectCount.md)
+ - [OpenapiClient::ReportImplementationStatus200Response](docs/ReportImplementationStatus200Response.md)
+ - [OpenapiClient::ReportImplementationStatusRequest](docs/ReportImplementationStatusRequest.md)
+ - [OpenapiClient::Rollback](docs/Rollback.md)
+ - [OpenapiClient::RollbackImplementation200Response](docs/RollbackImplementation200Response.md)
+ - [OpenapiClient::RollbackImplementationRequest](docs/RollbackImplementationRequest.md)
+ - [OpenapiClient::SpendingLimitStatus](docs/SpendingLimitStatus.md)
+ - [OpenapiClient::StartCrawlRequest](docs/StartCrawlRequest.md)
+ - [OpenapiClient::StepByStepInstructions](docs/StepByStepInstructions.md)
+ - [OpenapiClient::Suggestion](docs/Suggestion.md)
+ - [OpenapiClient::UpdateSuggestionRequest](docs/UpdateSuggestionRequest.md)
+ - [OpenapiClient::UsageHistoryItem](docs/UsageHistoryItem.md)
+ - [OpenapiClient::VerifyContent200Response](docs/VerifyContent200Response.md)
+ - [OpenapiClient::VerifyContentRequest](docs/VerifyContentRequest.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### ApiKeyAuth
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AddCredits200Response.md

@@ -0,0 +1,22 @@
+# OpenapiClient::AddCredits200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **balance** | [**CreditBalanceInfo**](CreditBalanceInfo.md) |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::AddCredits200Response.new(
+  success: true,
+  balance: null,
+  message: Successfully added 100 credits
+)
+```
+

data/docs/AddCreditsRequest.md

@@ -0,0 +1,20 @@
+# OpenapiClient::AddCreditsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Number of credits to add |  |
+| **source** | **String** | Source of credits | [optional][default to 'manual_addition'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::AddCreditsRequest.new(
+  amount: 100,
+  source: purchase
+)
+```
+

data/docs/AutoRechargeSettings.md

@@ -0,0 +1,22 @@
+# OpenapiClient::AutoRechargeSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** | Whether auto-recharge is enabled |  |
+| **threshold** | **Float** | Credit threshold for auto-recharge |  |
+| **amount** | **Float** | Amount to recharge |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::AutoRechargeSettings.new(
+  enabled: false,
+  threshold: 10,
+  amount: 500
+)
+```
+

data/docs/ChangeResult.md

@@ -0,0 +1,24 @@
+# OpenapiClient::ChangeResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_url** | **String** | URL of the page |  |
+| **change_status** | **String** | Change status |  |
+| **visibility** | **String** | Page visibility |  |
+| **previous_scrape_at** | **Time** | Previous scrape timestamp | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ChangeResult.new(
+  page_url: https://example.com/page,
+  change_status: same,
+  visibility: visible,
+  previous_scrape_at: 2025-01-14T10:00Z
+)
+```
+

data/docs/ContentVerification.md

@@ -0,0 +1,22 @@
+# OpenapiClient::ContentVerification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **safe** | **Boolean** | Whether it's safe to implement the link |  |
+| **reason** | **String** | Reason for the verification result |  |
+| **change_result** | [**ChangeResult**](ChangeResult.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ContentVerification.new(
+  safe: true,
+  reason: Page is same,
+  change_result: null
+)
+```
+

data/docs/ContentVerificationApi.md

@@ -0,0 +1,81 @@
+# OpenapiClient::ContentVerificationApi
+
+All URIs are relative to *https://api.rankvectors.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**verify_content**](ContentVerificationApi.md#verify_content) | **POST** /api/projects/{projectId}/verify-content | Verify page content |
+
+
+## verify_content
+
+> <VerifyContent200Response> verify_content(project_id, verify_content_request)
+
+Verify page content
+
+Check if page content has changed since last crawl
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::ContentVerificationApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+verify_content_request = OpenapiClient::VerifyContentRequest.new({page_url: 'https://example.com/page', suggestion_id: 'sugg-123'}) # VerifyContentRequest | 
+
+begin
+  # Verify page content
+  result = api_instance.verify_content(project_id, verify_content_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ContentVerificationApi->verify_content: #{e}"
+end
+```
+
+#### Using the verify_content_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerifyContent200Response>, Integer, Hash)> verify_content_with_http_info(project_id, verify_content_request)
+
+```ruby
+begin
+  # Verify page content
+  data, status_code, headers = api_instance.verify_content_with_http_info(project_id, verify_content_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerifyContent200Response>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ContentVerificationApi->verify_content_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **verify_content_request** | [**VerifyContentRequest**](VerifyContentRequest.md) |  |  |
+
+### Return type
+
+[**VerifyContent200Response**](VerifyContent200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Crawl.md

@@ -0,0 +1,30 @@
+# OpenapiClient::Crawl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique crawl identifier |  |
+| **project_id** | **String** | Project identifier |  |
+| **status** | **String** | Crawl status |  |
+| **started_at** | **Time** | Crawl start timestamp |  |
+| **completed_at** | **Time** | Crawl completion timestamp | [optional] |
+| **pages_crawled** | **Integer** | Number of pages crawled | [optional] |
+| **error_message** | **String** | Error message if crawl failed | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Crawl.new(
+  id: crawl-123,
+  project_id: proj-123,
+  status: completed,
+  started_at: 2025-01-15T10:00Z,
+  completed_at: 2025-01-15T10:05Z,
+  pages_crawled: 150,
+  error_message: Connection timeout
+)
+```
+

data/docs/CrawlingApi.md

@@ -0,0 +1,155 @@
+# OpenapiClient::CrawlingApi
+
+All URIs are relative to *https://api.rankvectors.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_crawl_history**](CrawlingApi.md#get_crawl_history) | **GET** /api/projects/{projectId}/crawl | Get crawl history |
+| [**start_crawl**](CrawlingApi.md#start_crawl) | **POST** /api/projects/{projectId}/crawl | Start website crawl |
+
+
+## get_crawl_history
+
+> <Array<Crawl>> get_crawl_history(project_id)
+
+Get crawl history
+
+Get the crawl history for a project
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::CrawlingApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+
+begin
+  # Get crawl history
+  result = api_instance.get_crawl_history(project_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling CrawlingApi->get_crawl_history: #{e}"
+end
+```
+
+#### Using the get_crawl_history_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Crawl>>, Integer, Hash)> get_crawl_history_with_http_info(project_id)
+
+```ruby
+begin
+  # Get crawl history
+  data, status_code, headers = api_instance.get_crawl_history_with_http_info(project_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Crawl>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling CrawlingApi->get_crawl_history_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+
+### Return type
+
+[**Array&lt;Crawl&gt;**](Crawl.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## start_crawl
+
+> <Crawl> start_crawl(project_id, opts)
+
+Start website crawl
+
+Start crawling a website to analyze content for link opportunities
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = OpenapiClient::CrawlingApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+opts = {
+  start_crawl_request: OpenapiClient::StartCrawlRequest.new # StartCrawlRequest | 
+}
+
+begin
+  # Start website crawl
+  result = api_instance.start_crawl(project_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling CrawlingApi->start_crawl: #{e}"
+end
+```
+
+#### Using the start_crawl_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Crawl>, Integer, Hash)> start_crawl_with_http_info(project_id, opts)
+
+```ruby
+begin
+  # Start website crawl
+  data, status_code, headers = api_instance.start_crawl_with_http_info(project_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Crawl>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling CrawlingApi->start_crawl_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **start_crawl_request** | [**StartCrawlRequest**](StartCrawlRequest.md) |  | [optional] |
+
+### Return type
+
+[**Crawl**](Crawl.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CreateProjectRequest.md

@@ -0,0 +1,60 @@
+# OpenapiClient::CreateProjectRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Project name |  |
+| **domain** | **String** | Website domain URL |  |
+| **prompt** | **String** | Natural language prompt for crawling | [optional] |
+| **search_query** | **String** | Search query for targeted crawling | [optional] |
+| **sitemap_mode** | **String** | How to handle sitemaps | [optional][default to 'include'] |
+| **include_subdomains** | **Boolean** | Whether to include subdomains | [optional][default to true] |
+| **ignore_query_params** | **Boolean** | Whether to ignore URL query parameters | [optional][default to true] |
+| **max_discovery_depth** | **Integer** | Maximum crawl depth | [optional] |
+| **exclude_paths** | **Array<String>** | Paths to exclude from crawling | [optional] |
+| **include_paths** | **Array<String>** | Specific paths to include | [optional] |
+| **crawl_entire_domain** | **Boolean** | Whether to crawl the entire domain | [optional][default to false] |
+| **allow_external_links** | **Boolean** | Whether to allow external links | [optional][default to false] |
+| **max_pages** | **Integer** | Maximum number of pages to crawl | [optional][default to 100] |
+| **crawl_delay** | **Integer** | Delay between crawl requests (ms) | [optional] |
+| **crawl_max_concurrency** | **Integer** | Maximum concurrent crawl requests | [optional] |
+| **only_main_content** | **Boolean** | Whether to extract only main content | [optional][default to true] |
+| **custom_headers** | **Hash<String, String>** | Custom headers for crawling | [optional] |
+| **wait_for** | **Integer** | Wait time for page load (ms) | [optional][default to 0] |
+| **block_ads** | **Boolean** | Whether to block ads | [optional][default to true] |
+| **proxy_mode** | **String** | Proxy mode for crawling | [optional][default to 'auto'] |
+| **use_reranking** | **Boolean** | Whether to use AI reranking | [optional][default to true] |
+| **enable_change_tracking** | **Boolean** | Whether to enable change tracking | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::CreateProjectRequest.new(
+  name: My Website,
+  domain: https://example.com,
+  prompt: Only crawl blog posts and documentation,
+  search_query: SEO optimization,
+  sitemap_mode: include,
+  include_subdomains: true,
+  ignore_query_params: true,
+  max_discovery_depth: 3,
+  exclude_paths: ["/admin","/private"],
+  include_paths: ["/blog","/docs"],
+  crawl_entire_domain: false,
+  allow_external_links: false,
+  max_pages: 100,
+  crawl_delay: 1000,
+  crawl_max_concurrency: 5,
+  only_main_content: true,
+  custom_headers: null,
+  wait_for: 0,
+  block_ads: true,
+  proxy_mode: auto,
+  use_reranking: true,
+  enable_change_tracking: false
+)
+```
+