rankvectors 1.0.0

data/docs/CreditBalance.md

@@ -0,0 +1,30 @@
+# OpenapiClient::CreditBalance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  |  |
+| **balance** | [**CreditBalanceInfo**](CreditBalanceInfo.md) |  |  |
+| **page_limit** | [**PageLimitStatus**](PageLimitStatus.md) |  |  |
+| **spending_limit** | [**SpendingLimitStatus**](SpendingLimitStatus.md) |  |  |
+| **auto_recharge** | [**AutoRechargeSettings**](AutoRechargeSettings.md) |  |  |
+| **current_period** | [**PeriodCharges**](PeriodCharges.md) |  |  |
+| **usage_history** | [**Array<UsageHistoryItem>**](UsageHistoryItem.md) | Usage history (if requested) | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::CreditBalance.new(
+  success: true,
+  balance: null,
+  page_limit: null,
+  spending_limit: null,
+  auto_recharge: null,
+  current_period: null,
+  usage_history: null
+)
+```
+

data/docs/CreditBalanceInfo.md

@@ -0,0 +1,26 @@
+# OpenapiClient::CreditBalanceInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Project identifier |  |
+| **credits_total** | **Float** | Total credits purchased |  |
+| **credits_used** | **Float** | Credits consumed |  |
+| **credits_remaining** | **Float** | Credits remaining |  |
+| **last_reset_at** | **Time** | Last credit reset timestamp | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::CreditBalanceInfo.new(
+  project_id: proj-123,
+  credits_total: 100,
+  credits_used: 25.5,
+  credits_remaining: 74.5,
+  last_reset_at: 2025-01-01T00:00Z
+)
+```
+

data/docs/CreditsApi.md

@@ -0,0 +1,161 @@
+# OpenapiClient::CreditsApi
+
+All URIs are relative to *https://api.rankvectors.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_credits**](CreditsApi.md#add_credits) | **POST** /api/projects/{projectId}/credits | Add credits |
+| [**get_credits**](CreditsApi.md#get_credits) | **GET** /api/projects/{projectId}/credits | Get credit balance |
+
+
+## add_credits
+
+> <AddCredits200Response> add_credits(project_id, add_credits_request)
+
+Add credits
+
+Add credits to a project (admin or payment webhook use)
+
+### 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::CreditsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+add_credits_request = OpenapiClient::AddCreditsRequest.new({amount: 100}) # AddCreditsRequest | 
+
+begin
+  # Add credits
+  result = api_instance.add_credits(project_id, add_credits_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling CreditsApi->add_credits: #{e}"
+end
+```
+
+#### Using the add_credits_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddCredits200Response>, Integer, Hash)> add_credits_with_http_info(project_id, add_credits_request)
+
+```ruby
+begin
+  # Add credits
+  data, status_code, headers = api_instance.add_credits_with_http_info(project_id, add_credits_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddCredits200Response>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling CreditsApi->add_credits_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **add_credits_request** | [**AddCreditsRequest**](AddCreditsRequest.md) |  |  |
+
+### Return type
+
+[**AddCredits200Response**](AddCredits200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_credits
+
+> <CreditBalance> get_credits(project_id, opts)
+
+Get credit balance
+
+Get credit balance and usage 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::CreditsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+opts = {
+  include_history: true, # Boolean | Include usage history
+  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | History start date (ISO 8601)
+  end_date: Time.parse('2013-10-20T19:20:30+01:00') # Time | History end date (ISO 8601)
+}
+
+begin
+  # Get credit balance
+  result = api_instance.get_credits(project_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling CreditsApi->get_credits: #{e}"
+end
+```
+
+#### Using the get_credits_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreditBalance>, Integer, Hash)> get_credits_with_http_info(project_id, opts)
+
+```ruby
+begin
+  # Get credit balance
+  data, status_code, headers = api_instance.get_credits_with_http_info(project_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreditBalance>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling CreditsApi->get_credits_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **include_history** | **Boolean** | Include usage history | [optional][default to false] |
+| **start_date** | **Time** | History start date (ISO 8601) | [optional] |
+| **end_date** | **Time** | History end date (ISO 8601) | [optional] |
+
+### Return type
+
+[**CreditBalance**](CreditBalance.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CustomCredentials.md

@@ -0,0 +1,20 @@
+# OpenapiClient::CustomCredentials
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_url** | **String** | Webhook URL for implementation |  |
+| **api_key** | **String** | Webhook secret key |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::CustomCredentials.new(
+  webhook_url: https://yourapi.com/rankvectors-webhook,
+  api_key: your-webhook-secret-key
+)
+```
+

data/docs/DeleteProject200Response.md

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

data/docs/Error.md

@@ -0,0 +1,24 @@
+# OpenapiClient::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** | Error message |  |
+| **details** | **String** | Additional error details | [optional] |
+| **code** | **String** | Error code | [optional] |
+| **name** | **String** | Error name | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Error.new(
+  error: Invalid parameters,
+  details: Name and domain are required,
+  code: VALIDATION_ERROR,
+  name: ValidationError
+)
+```
+

data/docs/GenerateSuggestions200Response.md

@@ -0,0 +1,22 @@
+# OpenapiClient::GenerateSuggestions200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **count** | **Integer** | Number of suggestions generated | [optional] |
+| **opportunities** | [**Array<LinkOpportunity>**](LinkOpportunity.md) | Top 10 opportunities preview | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::GenerateSuggestions200Response.new(
+  success: true,
+  count: 15,
+  opportunities: null
+)
+```
+

data/docs/GenerateSuggestionsRequest.md

@@ -0,0 +1,18 @@
+# OpenapiClient::GenerateSuggestionsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **min_relevance_score** | **Float** | Minimum relevance score for suggestions | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::GenerateSuggestionsRequest.new(
+  min_relevance_score: 0.7
+)
+```
+

data/docs/GetImplementation200Response.md

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

data/docs/Implementation.md

@@ -0,0 +1,36 @@
+# OpenapiClient::Implementation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique implementation identifier |  |
+| **status** | **String** | Implementation status |  |
+| **platform** | **String** | Platform used |  |
+| **implementation_method** | **String** | Implementation method | [optional] |
+| **credits_used** | **Float** | Credits consumed |  |
+| **created_at** | **Time** | Implementation start timestamp |  |
+| **completed_at** | **Time** | Implementation completion timestamp | [optional] |
+| **metadata** | **Hash<String, Object>** | Platform-specific metadata | [optional] |
+| **suggestion** | [**Suggestion**](Suggestion.md) |  |  |
+| **rollbacks** | [**Array<Rollback>**](Rollback.md) | Rollback history | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::Implementation.new(
+  id: impl-123,
+  status: success,
+  platform: custom,
+  implementation_method: api,
+  credits_used: 1,
+  created_at: 2025-01-15T10:00Z,
+  completed_at: 2025-01-15T10:00:05Z,
+  metadata: {"postId":456,"postUrl":"https://example.com/source"},
+  suggestion: null,
+  rollbacks: null
+)
+```
+

data/docs/ImplementationInstructions.md

@@ -0,0 +1,28 @@
+# OpenapiClient::ImplementationInstructions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **suggestion_id** | **String** | Suggestion identifier |  |
+| **page_url** | **String** | URL of the page to modify |  |
+| **anchor_text** | **String** | Text to turn into a link |  |
+| **target_url** | **String** | URL to link to |  |
+| **context** | **String** | Context where the link should be placed |  |
+| **instructions** | [**StepByStepInstructions**](StepByStepInstructions.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ImplementationInstructions.new(
+  suggestion_id: sugg-123,
+  page_url: https://example.com/page,
+  anchor_text: internal linking,
+  target_url: https://example.com/target,
+  context: Learn more about internal linking strategies.,
+  instructions: null
+)
+```
+

data/docs/ImplementationRequest.md

@@ -0,0 +1,26 @@
+# OpenapiClient::ImplementationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **suggestion_ids** | **Array<String>** | Array of suggestion IDs to implement |  |
+| **platform** | **String** | Platform type |  |
+| **credentials** | [**CustomCredentials**](CustomCredentials.md) |  |  |
+| **skip_content_verification** | **Boolean** | Skip content change detection | [optional][default to false] |
+| **implementation_method** | **String** | Implementation method | [optional][default to 'api'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ImplementationRequest.new(
+  suggestion_ids: ["sugg-1","sugg-2"],
+  platform: custom,
+  credentials: null,
+  skip_content_verification: false,
+  implementation_method: api
+)
+```
+

data/docs/ImplementationResponse.md

@@ -0,0 +1,22 @@
+# OpenapiClient::ImplementationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Whether any implementations succeeded |  |
+| **results** | [**Array<ImplementationResult>**](ImplementationResult.md) | Individual implementation results |  |
+| **summary** | [**ImplementationSummary**](ImplementationSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ImplementationResponse.new(
+  success: true,
+  results: null,
+  summary: null
+)
+```
+

data/docs/ImplementationResult.md

@@ -0,0 +1,24 @@
+# OpenapiClient::ImplementationResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Whether implementation succeeded |  |
+| **implementation_id** | **String** | Implementation identifier | [optional] |
+| **credits_used** | **Float** | Credits consumed | [optional] |
+| **error** | **String** | Error message if failed | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ImplementationResult.new(
+  success: true,
+  implementation_id: impl-123,
+  credits_used: 1,
+  error: Insufficient credits
+)
+```
+

data/docs/ImplementationSummary.md

@@ -0,0 +1,24 @@
+# OpenapiClient::ImplementationSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Total number of implementations |  |
+| **succeeded** | **Integer** | Number of successful implementations |  |
+| **failed** | **Integer** | Number of failed implementations |  |
+| **credits_used** | **Float** | Total credits used |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::ImplementationSummary.new(
+  total: 2,
+  succeeded: 2,
+  failed: 0,
+  credits_used: 2
+)
+```
+