rankvectors 1.0.0

data/docs/ImplementationsApi.md

@@ -0,0 +1,313 @@
+# OpenapiClient::ImplementationsApi
+
+All URIs are relative to *https://api.rankvectors.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_implementation**](ImplementationsApi.md#get_implementation) | **GET** /api/projects/{projectId}/implementations/{implementationId} | Get implementation details |
+| [**implement_links**](ImplementationsApi.md#implement_links) | **POST** /api/projects/{projectId}/implementations | Implement link suggestions |
+| [**list_implementations**](ImplementationsApi.md#list_implementations) | **GET** /api/projects/{projectId}/implementations | List implementations |
+| [**rollback_implementation**](ImplementationsApi.md#rollback_implementation) | **POST** /api/projects/{projectId}/implementations/{implementationId}/rollback | Rollback implementation |
+
+
+## get_implementation
+
+> <GetImplementation200Response> get_implementation(project_id, implementation_id)
+
+Get implementation details
+
+Get detailed information about a specific implementation
+
+### 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::ImplementationsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+implementation_id = 'impl-123' # String | Unique identifier for the implementation
+
+begin
+  # Get implementation details
+  result = api_instance.get_implementation(project_id, implementation_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ImplementationsApi->get_implementation: #{e}"
+end
+```
+
+#### Using the get_implementation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetImplementation200Response>, Integer, Hash)> get_implementation_with_http_info(project_id, implementation_id)
+
+```ruby
+begin
+  # Get implementation details
+  data, status_code, headers = api_instance.get_implementation_with_http_info(project_id, implementation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetImplementation200Response>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ImplementationsApi->get_implementation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **implementation_id** | **String** | Unique identifier for the implementation |  |
+
+### Return type
+
+[**GetImplementation200Response**](GetImplementation200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## implement_links
+
+> <ImplementationResponse> implement_links(project_id, implementation_request)
+
+Implement link suggestions
+
+Implement one or more link suggestions
+
+### 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::ImplementationsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+implementation_request = OpenapiClient::ImplementationRequest.new({suggestion_ids: ["sugg-1", "sugg-2"], platform: 'custom', credentials: OpenapiClient::CustomCredentials.new({webhook_url: 'https://yourapi.com/rankvectors-webhook', api_key: 'your-webhook-secret-key'})}) # ImplementationRequest | 
+
+begin
+  # Implement link suggestions
+  result = api_instance.implement_links(project_id, implementation_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ImplementationsApi->implement_links: #{e}"
+end
+```
+
+#### Using the implement_links_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ImplementationResponse>, Integer, Hash)> implement_links_with_http_info(project_id, implementation_request)
+
+```ruby
+begin
+  # Implement link suggestions
+  data, status_code, headers = api_instance.implement_links_with_http_info(project_id, implementation_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ImplementationResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ImplementationsApi->implement_links_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **implementation_request** | [**ImplementationRequest**](ImplementationRequest.md) |  |  |
+
+### Return type
+
+[**ImplementationResponse**](ImplementationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_implementations
+
+> <ListImplementations200Response> list_implementations(project_id, opts)
+
+List implementations
+
+Get implementation 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::ImplementationsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+opts = {
+  status: 'pending', # String | Filter by implementation status
+  platform: 'custom', # String | Filter by platform
+  limit: 56, # Integer | Results per page
+  offset: 56 # Integer | Pagination offset
+}
+
+begin
+  # List implementations
+  result = api_instance.list_implementations(project_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ImplementationsApi->list_implementations: #{e}"
+end
+```
+
+#### Using the list_implementations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListImplementations200Response>, Integer, Hash)> list_implementations_with_http_info(project_id, opts)
+
+```ruby
+begin
+  # List implementations
+  data, status_code, headers = api_instance.list_implementations_with_http_info(project_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListImplementations200Response>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ImplementationsApi->list_implementations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **status** | **String** | Filter by implementation status | [optional] |
+| **platform** | **String** | Filter by platform | [optional] |
+| **limit** | **Integer** | Results per page | [optional][default to 50] |
+| **offset** | **Integer** | Pagination offset | [optional][default to 0] |
+
+### Return type
+
+[**ListImplementations200Response**](ListImplementations200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## rollback_implementation
+
+> <RollbackImplementation200Response> rollback_implementation(project_id, implementation_id, rollback_implementation_request)
+
+Rollback implementation
+
+Undo a link implementation and restore original content
+
+### 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::ImplementationsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+implementation_id = 'impl-123' # String | Unique identifier for the implementation
+rollback_implementation_request = OpenapiClient::RollbackImplementationRequest.new({reason: 'Incorrect link placement'}) # RollbackImplementationRequest | 
+
+begin
+  # Rollback implementation
+  result = api_instance.rollback_implementation(project_id, implementation_id, rollback_implementation_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ImplementationsApi->rollback_implementation: #{e}"
+end
+```
+
+#### Using the rollback_implementation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RollbackImplementation200Response>, Integer, Hash)> rollback_implementation_with_http_info(project_id, implementation_id, rollback_implementation_request)
+
+```ruby
+begin
+  # Rollback implementation
+  data, status_code, headers = api_instance.rollback_implementation_with_http_info(project_id, implementation_id, rollback_implementation_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RollbackImplementation200Response>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ImplementationsApi->rollback_implementation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **implementation_id** | **String** | Unique identifier for the implementation |  |
+| **rollback_implementation_request** | [**RollbackImplementationRequest**](RollbackImplementationRequest.md) |  |  |
+
+### Return type
+
+[**RollbackImplementation200Response**](RollbackImplementation200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/LinkOpportunity.md

@@ -0,0 +1,28 @@
+# OpenapiClient::LinkOpportunity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **relevance_score** | **Float** | AI-calculated relevance score (0-1) |  |
+| **anchor_text** | **String** | Suggested anchor text |  |
+| **context** | **String** | Context where the link should be placed | [optional] |
+| **source_page** | [**PageInfo**](PageInfo.md) |  |  |
+| **target_page** | [**PageInfo**](PageInfo.md) |  |  |
+| **reasoning** | **String** | AI reasoning for the suggestion | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::LinkOpportunity.new(
+  relevance_score: 0.85,
+  anchor_text: internal linking,
+  context: Learn more about internal linking strategies.,
+  source_page: null,
+  target_page: null,
+  reasoning: High semantic similarity between source and target content
+)
+```
+

data/docs/ListImplementations200Response.md

@@ -0,0 +1,24 @@
+# OpenapiClient::ListImplementations200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **implementations** | [**Array<Implementation>**](Implementation.md) |  | [optional] |
+| **count** | **Integer** | Number of implementations returned | [optional] |
+| **filters** | **Object** | Applied filters | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ListImplementations200Response.new(
+  success: true,
+  implementations: null,
+  count: 25,
+  filters: null
+)
+```
+

data/docs/PageInfo.md

@@ -0,0 +1,24 @@
+# OpenapiClient::PageInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Page URL |  |
+| **title** | **String** | Page title |  |
+| **description** | **String** | Page description | [optional] |
+| **word_count** | **Integer** | Page word count | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::PageInfo.new(
+  url: https://example.com/page,
+  title: Page Title,
+  description: Page description,
+  word_count: 500
+)
+```
+

data/docs/PageLimitStatus.md

@@ -0,0 +1,22 @@
+# OpenapiClient::PageLimitStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Page limit |  |
+| **used** | **Integer** | Pages used |  |
+| **remaining** | **Integer** | Pages remaining |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::PageLimitStatus.new(
+  limit: 1000,
+  used: 150,
+  remaining: 850
+)
+```
+

data/docs/PeriodCharges.md

@@ -0,0 +1,22 @@
+# OpenapiClient::PeriodCharges
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **Time** | Period start date |  |
+| **end_date** | **Time** | Period end date |  |
+| **total_charges** | **Float** | Total charges for the period |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::PeriodCharges.new(
+  start_date: 2025-01-01T00:00Z,
+  end_date: 2025-01-31T23:59:59Z,
+  total_charges: 25.5
+)
+```
+

data/docs/Project.md

@@ -0,0 +1,70 @@
+# OpenapiClient::Project
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique project identifier |  |
+| **name** | **String** | Project name |  |
+| **domain** | **String** | Website domain URL |  |
+| **user_id** | **String** | User who owns the project |  |
+| **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] |
+| **include_subdomains** | **Boolean** | Whether to include subdomains | [optional] |
+| **ignore_query_params** | **Boolean** | Whether to ignore URL query parameters | [optional] |
+| **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] |
+| **allow_external_links** | **Boolean** | Whether to allow external links | [optional] |
+| **max_pages** | **Integer** | Maximum number of pages to crawl | [optional] |
+| **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] |
+| **custom_headers** | **Hash<String, String>** | Custom headers for crawling | [optional] |
+| **wait_for** | **Integer** | Wait time for page load (ms) | [optional] |
+| **block_ads** | **Boolean** | Whether to block ads | [optional] |
+| **proxy_mode** | **String** | Proxy mode for crawling | [optional] |
+| **use_reranking** | **Boolean** | Whether to use AI reranking | [optional] |
+| **enable_change_tracking** | **Boolean** | Whether to enable change tracking | [optional] |
+| **created_at** | **Time** | Project creation timestamp |  |
+| **updated_at** | **Time** | Last update timestamp |  |
+| **_count** | [**ProjectCount**](ProjectCount.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Project.new(
+  id: proj-123,
+  name: My Website,
+  domain: https://example.com,
+  user_id: user-456,
+  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,
+  created_at: 2025-01-15T10:00Z,
+  updated_at: 2025-01-15T10:00Z,
+  _count: null
+)
+```
+

data/docs/ProjectCount.md

@@ -0,0 +1,20 @@
+# OpenapiClient::ProjectCount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pages** | **Integer** |  | [optional] |
+| **suggestions** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ProjectCount.new(
+  pages: 150,
+  suggestions: 25
+)
+```
+