rankvectors 1.0.0

data/docs/ProjectsApi.md

@@ -0,0 +1,292 @@
+# OpenapiClient::ProjectsApi
+
+All URIs are relative to *https://api.rankvectors.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_project**](ProjectsApi.md#create_project) | **POST** /api/projects | Create a new project |
+| [**delete_project**](ProjectsApi.md#delete_project) | **DELETE** /api/projects/{projectId} | Delete a project |
+| [**get_project**](ProjectsApi.md#get_project) | **GET** /api/projects/{projectId} | Get project details |
+| [**list_projects**](ProjectsApi.md#list_projects) | **GET** /api/projects | List all projects |
+
+
+## create_project
+
+> <Project> create_project(create_project_request)
+
+Create a new project
+
+Create a new project for internal linking optimization
+
+### 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::ProjectsApi.new
+create_project_request = OpenapiClient::CreateProjectRequest.new({name: 'My Website', domain: 'https://example.com'}) # CreateProjectRequest | 
+
+begin
+  # Create a new project
+  result = api_instance.create_project(create_project_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ProjectsApi->create_project: #{e}"
+end
+```
+
+#### Using the create_project_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Project>, Integer, Hash)> create_project_with_http_info(create_project_request)
+
+```ruby
+begin
+  # Create a new project
+  data, status_code, headers = api_instance.create_project_with_http_info(create_project_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Project>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ProjectsApi->create_project_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_project_request** | [**CreateProjectRequest**](CreateProjectRequest.md) |  |  |
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_project
+
+> <DeleteProject200Response> delete_project(project_id)
+
+Delete a project
+
+Delete a project and all associated data
+
+### 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::ProjectsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+
+begin
+  # Delete a project
+  result = api_instance.delete_project(project_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ProjectsApi->delete_project: #{e}"
+end
+```
+
+#### Using the delete_project_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteProject200Response>, Integer, Hash)> delete_project_with_http_info(project_id)
+
+```ruby
+begin
+  # Delete a project
+  data, status_code, headers = api_instance.delete_project_with_http_info(project_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteProject200Response>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ProjectsApi->delete_project_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+
+### Return type
+
+[**DeleteProject200Response**](DeleteProject200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_project
+
+> <Project> get_project(project_id)
+
+Get project details
+
+Get detailed information about a specific 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::ProjectsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+
+begin
+  # Get project details
+  result = api_instance.get_project(project_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ProjectsApi->get_project: #{e}"
+end
+```
+
+#### Using the get_project_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Project>, Integer, Hash)> get_project_with_http_info(project_id)
+
+```ruby
+begin
+  # Get project details
+  data, status_code, headers = api_instance.get_project_with_http_info(project_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Project>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ProjectsApi->get_project_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+
+### Return type
+
+[**Project**](Project.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_projects
+
+> <Array<Project>> list_projects
+
+List all projects
+
+Get a list of all projects for the authenticated user
+
+### 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::ProjectsApi.new
+
+begin
+  # List all projects
+  result = api_instance.list_projects
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ProjectsApi->list_projects: #{e}"
+end
+```
+
+#### Using the list_projects_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Project>>, Integer, Hash)> list_projects_with_http_info
+
+```ruby
+begin
+  # List all projects
+  data, status_code, headers = api_instance.list_projects_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Project>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling ProjectsApi->list_projects_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Project&gt;**](Project.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ReportImplementationStatus200Response.md

@@ -0,0 +1,20 @@
+# OpenapiClient::ReportImplementationStatus200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ReportImplementationStatus200Response.new(
+  success: true,
+  message: Implementation status updated
+)
+```
+

data/docs/ReportImplementationStatusRequest.md

@@ -0,0 +1,22 @@
+# OpenapiClient::ReportImplementationStatusRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **suggestion_id** | **String** | ID of the suggestion |  |
+| **api_key** | **String** | Your RankVectors API key |  |
+| **status** | **String** | Implementation status |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ReportImplementationStatusRequest.new(
+  suggestion_id: sugg-123,
+  api_key: rv_1234567890abcdef,
+  status: success
+)
+```
+

data/docs/Rollback.md

@@ -0,0 +1,24 @@
+# OpenapiClient::Rollback
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique rollback identifier |  |
+| **reason** | **String** | Reason for rollback |  |
+| **created_at** | **Time** | Rollback timestamp |  |
+| **credits_refunded** | **Float** | Credits refunded | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Rollback.new(
+  id: rollback-123,
+  reason: Incorrect link placement,
+  created_at: 2025-01-15T10:00Z,
+  credits_refunded: 0.5
+)
+```
+

data/docs/RollbackImplementation200Response.md

@@ -0,0 +1,22 @@
+# OpenapiClient::RollbackImplementation200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **credits_refunded** | **Float** | Credits refunded (50% of implementation cost) | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::RollbackImplementation200Response.new(
+  success: true,
+  credits_refunded: 0.5,
+  message: Successfully rolled back implementation. 0.5 credits refunded.
+)
+```
+

data/docs/RollbackImplementationRequest.md

@@ -0,0 +1,20 @@
+# OpenapiClient::RollbackImplementationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason** | **String** | Reason for rollback |  |
+| **credentials** | [**CustomCredentials**](CustomCredentials.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::RollbackImplementationRequest.new(
+  reason: Incorrect link placement,
+  credentials: null
+)
+```
+

data/docs/SpendingLimitStatus.md

@@ -0,0 +1,24 @@
+# OpenapiClient::SpendingLimitStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** | Whether spending limit is enabled |  |
+| **limit** | **Float** | Spending limit |  |
+| **used** | **Float** | Amount used |  |
+| **remaining** | **Float** | Amount remaining |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::SpendingLimitStatus.new(
+  enabled: true,
+  limit: 100,
+  used: 25.5,
+  remaining: 74.5
+)
+```
+

data/docs/StartCrawlRequest.md

@@ -0,0 +1,18 @@
+# OpenapiClient::StartCrawlRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Maximum number of pages to crawl | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::StartCrawlRequest.new(
+  limit: 100
+)
+```
+

data/docs/StepByStepInstructions.md

@@ -0,0 +1,20 @@
+# OpenapiClient::StepByStepInstructions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **steps** | **Array<String>** | Step-by-step instructions |  |
+| **html_example** | **String** | HTML example of the implementation |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::StepByStepInstructions.new(
+  steps: ["Navigate to the page: https://example.com/page","Locate the text: 'Learn more about internal linking strategies.'","Replace 'internal linking' with a link to https://example.com/target"],
+  html_example: <a href="https://example.com/target">internal linking</a>
+)
+```
+

data/docs/Suggestion.md

@@ -0,0 +1,38 @@
+# OpenapiClient::Suggestion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique suggestion identifier |  |
+| **project_id** | **String** | Project identifier |  |
+| **status** | **String** | Suggestion status |  |
+| **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] |
+| **created_at** | **Time** | Suggestion creation timestamp |  |
+| **updated_at** | **Time** | Last update timestamp | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Suggestion.new(
+  id: sugg-123,
+  project_id: proj-123,
+  status: pending,
+  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,
+  created_at: 2025-01-15T10:00Z,
+  updated_at: 2025-01-15T10:00Z
+)
+```
+