rankvectors 1.0.0

data/docs/SuggestionsApi.md

@@ -0,0 +1,235 @@
+# OpenapiClient::SuggestionsApi
+
+All URIs are relative to *https://api.rankvectors.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**generate_suggestions**](SuggestionsApi.md#generate_suggestions) | **POST** /api/projects/{projectId}/suggestions | Generate link suggestions |
+| [**get_suggestions**](SuggestionsApi.md#get_suggestions) | **GET** /api/projects/{projectId}/suggestions | Get link suggestions |
+| [**update_suggestion**](SuggestionsApi.md#update_suggestion) | **PATCH** /api/projects/{projectId}/suggestions/{suggestionId} | Update suggestion status |
+
+
+## generate_suggestions
+
+> <GenerateSuggestions200Response> generate_suggestions(project_id, opts)
+
+Generate link suggestions
+
+Generate new AI-powered link suggestions 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::SuggestionsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+opts = {
+  generate_suggestions_request: OpenapiClient::GenerateSuggestionsRequest.new # GenerateSuggestionsRequest | 
+}
+
+begin
+  # Generate link suggestions
+  result = api_instance.generate_suggestions(project_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling SuggestionsApi->generate_suggestions: #{e}"
+end
+```
+
+#### Using the generate_suggestions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GenerateSuggestions200Response>, Integer, Hash)> generate_suggestions_with_http_info(project_id, opts)
+
+```ruby
+begin
+  # Generate link suggestions
+  data, status_code, headers = api_instance.generate_suggestions_with_http_info(project_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GenerateSuggestions200Response>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling SuggestionsApi->generate_suggestions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **generate_suggestions_request** | [**GenerateSuggestionsRequest**](GenerateSuggestionsRequest.md) |  | [optional] |
+
+### Return type
+
+[**GenerateSuggestions200Response**](GenerateSuggestions200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_suggestions
+
+> <Array<Suggestion>> get_suggestions(project_id, opts)
+
+Get link suggestions
+
+Get AI-generated link suggestions 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::SuggestionsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+opts = {
+  status: 'pending' # String | Filter suggestions by status
+}
+
+begin
+  # Get link suggestions
+  result = api_instance.get_suggestions(project_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling SuggestionsApi->get_suggestions: #{e}"
+end
+```
+
+#### Using the get_suggestions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Suggestion>>, Integer, Hash)> get_suggestions_with_http_info(project_id, opts)
+
+```ruby
+begin
+  # Get link suggestions
+  data, status_code, headers = api_instance.get_suggestions_with_http_info(project_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Suggestion>>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling SuggestionsApi->get_suggestions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **status** | **String** | Filter suggestions by status | [optional] |
+
+### Return type
+
+[**Array&lt;Suggestion&gt;**](Suggestion.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_suggestion
+
+> <Suggestion> update_suggestion(project_id, suggestion_id, update_suggestion_request)
+
+Update suggestion status
+
+Update the status of a link suggestion
+
+### 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::SuggestionsApi.new
+project_id = 'proj-123' # String | Unique identifier for the project
+suggestion_id = 'sugg-123' # String | Unique identifier for the suggestion
+update_suggestion_request = OpenapiClient::UpdateSuggestionRequest.new({status: 'approved'}) # UpdateSuggestionRequest | 
+
+begin
+  # Update suggestion status
+  result = api_instance.update_suggestion(project_id, suggestion_id, update_suggestion_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling SuggestionsApi->update_suggestion: #{e}"
+end
+```
+
+#### Using the update_suggestion_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Suggestion>, Integer, Hash)> update_suggestion_with_http_info(project_id, suggestion_id, update_suggestion_request)
+
+```ruby
+begin
+  # Update suggestion status
+  data, status_code, headers = api_instance.update_suggestion_with_http_info(project_id, suggestion_id, update_suggestion_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Suggestion>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling SuggestionsApi->update_suggestion_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | Unique identifier for the project |  |
+| **suggestion_id** | **String** | Unique identifier for the suggestion |  |
+| **update_suggestion_request** | [**UpdateSuggestionRequest**](UpdateSuggestionRequest.md) |  |  |
+
+### Return type
+
+[**Suggestion**](Suggestion.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/UpdateSuggestionRequest.md

@@ -0,0 +1,18 @@
+# OpenapiClient::UpdateSuggestionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | New status for the suggestion |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UpdateSuggestionRequest.new(
+  status: approved
+)
+```
+

data/docs/UsageHistoryItem.md

@@ -0,0 +1,26 @@
+# OpenapiClient::UsageHistoryItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Usage item identifier |  |
+| **action** | **String** | Action performed |  |
+| **credits_used** | **Float** | Credits used |  |
+| **created_at** | **Time** | Usage timestamp |  |
+| **metadata** | **Hash<String, Object>** | Additional metadata | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UsageHistoryItem.new(
+  id: usage-1,
+  action: link_implemented,
+  credits_used: 1,
+  created_at: 2025-01-15T10:00Z,
+  metadata: {"suggestionId":"sugg-123","implementationId":"impl-123"}
+)
+```
+

data/docs/VerifyContent200Response.md

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

data/docs/VerifyContentRequest.md

@@ -0,0 +1,20 @@
+# OpenapiClient::VerifyContentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_url** | **String** | URL of the page to verify |  |
+| **suggestion_id** | **String** | ID of the suggestion to verify |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::VerifyContentRequest.new(
+  page_url: https://example.com/page,
+  suggestion_id: sugg-123
+)
+```
+

data/docs/WebhooksApi.md

@@ -0,0 +1,151 @@
+# OpenapiClient::WebhooksApi
+
+All URIs are relative to *https://api.rankvectors.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_implementation_instructions**](WebhooksApi.md#get_implementation_instructions) | **GET** /api/webhook/implement-link | Get implementation instructions |
+| [**report_implementation_status**](WebhooksApi.md#report_implementation_status) | **POST** /api/webhook/implement-link | Report implementation status |
+
+
+## get_implementation_instructions
+
+> <ImplementationInstructions> get_implementation_instructions(suggestion_id)
+
+Get implementation instructions
+
+Get step-by-step instructions for implementing a link
+
+### 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::WebhooksApi.new
+suggestion_id = 'sugg-123' # String | ID of the suggestion to implement
+
+begin
+  # Get implementation instructions
+  result = api_instance.get_implementation_instructions(suggestion_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling WebhooksApi->get_implementation_instructions: #{e}"
+end
+```
+
+#### Using the get_implementation_instructions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ImplementationInstructions>, Integer, Hash)> get_implementation_instructions_with_http_info(suggestion_id)
+
+```ruby
+begin
+  # Get implementation instructions
+  data, status_code, headers = api_instance.get_implementation_instructions_with_http_info(suggestion_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ImplementationInstructions>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling WebhooksApi->get_implementation_instructions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **suggestion_id** | **String** | ID of the suggestion to implement |  |
+
+### Return type
+
+[**ImplementationInstructions**](ImplementationInstructions.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## report_implementation_status
+
+> <ReportImplementationStatus200Response> report_implementation_status(report_implementation_status_request)
+
+Report implementation status
+
+Report the status of a link 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::WebhooksApi.new
+report_implementation_status_request = OpenapiClient::ReportImplementationStatusRequest.new({suggestion_id: 'sugg-123', api_key: 'rv_1234567890abcdef', status: 'success'}) # ReportImplementationStatusRequest | 
+
+begin
+  # Report implementation status
+  result = api_instance.report_implementation_status(report_implementation_status_request)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling WebhooksApi->report_implementation_status: #{e}"
+end
+```
+
+#### Using the report_implementation_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ReportImplementationStatus200Response>, Integer, Hash)> report_implementation_status_with_http_info(report_implementation_status_request)
+
+```ruby
+begin
+  # Report implementation status
+  data, status_code, headers = api_instance.report_implementation_status_with_http_info(report_implementation_status_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ReportImplementationStatus200Response>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling WebhooksApi->report_implementation_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **report_implementation_status_request** | [**ReportImplementationStatusRequest**](ReportImplementationStatusRequest.md) |  |  |
+
+### Return type
+
+[**ReportImplementationStatus200Response**](ReportImplementationStatus200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="rankvectors"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="rankvectors-ruby-sdk"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/lib/openapi_client/api/content_verification_api.rb

@@ -0,0 +1,96 @@
+=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 'cgi'
+
+module OpenapiClient
+  class ContentVerificationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Verify page content
+    # Check if page content has changed since last crawl
+    # @param project_id [String] Unique identifier for the project
+    # @param verify_content_request [VerifyContentRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [VerifyContent200Response]
+    def verify_content(project_id, verify_content_request, opts = {})
+      data, _status_code, _headers = verify_content_with_http_info(project_id, verify_content_request, opts)
+      data
+    end
+
+    # Verify page content
+    # Check if page content has changed since last crawl
+    # @param project_id [String] Unique identifier for the project
+    # @param verify_content_request [VerifyContentRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VerifyContent200Response, Integer, Hash)>] VerifyContent200Response data, response status code and response headers
+    def verify_content_with_http_info(project_id, verify_content_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContentVerificationApi.verify_content ...'
+      end
+      # verify the required parameter 'project_id' is set
+      if @api_client.config.client_side_validation && project_id.nil?
+        fail ArgumentError, "Missing the required parameter 'project_id' when calling ContentVerificationApi.verify_content"
+      end
+      # verify the required parameter 'verify_content_request' is set
+      if @api_client.config.client_side_validation && verify_content_request.nil?
+        fail ArgumentError, "Missing the required parameter 'verify_content_request' when calling ContentVerificationApi.verify_content"
+      end
+      # resource path
+      local_var_path = '/api/projects/{projectId}/verify-content'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(verify_content_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'VerifyContent200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ContentVerificationApi.verify_content",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ContentVerificationApi#verify_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end