mencoro 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f2c309e4f9d914ee8e9d67cf8c0c4b2fd6fcb351351b10d4e9714bbde010ed5
+  data.tar.gz: 30827e520aecbe6cc2c9e75ebdccca5b3dbb1bb63ac24881820ebc04f5748b9e
+SHA512:
+  metadata.gz: 1c74fb126f987ced2ab1525e9419ef0e7bfd5ce8bfe7be988d2ae0c2591666218132339c847f660bd82afaa896725770b2462a8b7107a822f43f9599e60d1ac1
+  data.tar.gz: a17e849bf0802b0198f7a10dabfad3a60b57a74f32f6a68031e1772549257388f7f646810f837bf47555ac30e10930fe41bb1b8d80d7033aa4802556732800ad

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,304 @@
+# mencoro
+
+Mencoro - the Ruby gem for the Mencoro API
+
+Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Generator version: 7.24.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://mencoro.com/contact/](https://mencoro.com/contact/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build mencoro.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./mencoro-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./mencoro-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 'mencoro', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/mencoro/mencoro-api-sdk, then add the following in the Gemfile:
+
+    gem 'mencoro', :git => 'https://github.com/mencoro/mencoro-api-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 'mencoro'
+
+# Setup authorization
+Mencoro.configure do |config|
+  # Configure Bearer authorization: ApiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+end
+
+api_instance = Mencoro::AccountApi.new
+
+begin
+  #Get the authenticated identity
+  result = api_instance.get_me
+  p result
+rescue Mencoro::ApiError => e
+  puts "Exception when calling AccountApi->get_me: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.mencoro.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Mencoro::AccountApi* | [**get_me**](docs/AccountApi.md#get_me) | **GET** /api/v1/me | Get the authenticated identity
+*Mencoro::AccountApi* | [**get_me_stats**](docs/AccountApi.md#get_me_stats) | **GET** /api/v1/me/stats | Counts across everything the key can reach
+*Mencoro::AnalyticsApi* | [**get_available_filters**](docs/AnalyticsApi.md#get_available_filters) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/available-filters | Filter values a project is configured for
+*Mencoro::AnalyticsApi* | [**get_cited_sources**](docs/AnalyticsApi.md#get_cited_sources) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/cited-sources | Domains and pages the AI answers cited
+*Mencoro::AnalyticsApi* | [**get_cluster_breakdown**](docs/AnalyticsApi.md#get_cluster_breakdown) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/metrics/clusters | Rank-tracking metrics per keyword cluster
+*Mencoro::AnalyticsApi* | [**get_competitor_co_occurrence**](docs/AnalyticsApi.md#get_competitor_co_occurrence) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/co-occurrence | Head-to-head record of the brand against each tracked competitor
+*Mencoro::AnalyticsApi* | [**get_mention_mix**](docs/AnalyticsApi.md#get_mention_mix) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/mentions/mix | Composition of a project brand mentions in AI answers
+*Mencoro::AnalyticsApi* | [**get_mention_samples**](docs/AnalyticsApi.md#get_mention_samples) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/mentions | Sample of the raw AI mention texts of a project
+*Mencoro::AnalyticsApi* | [**get_metric_glossary**](docs/AnalyticsApi.md#get_metric_glossary) | **GET** /api/v1/metric-glossary | Map everyday wording to a metric and the operation that serves it
+*Mencoro::AnalyticsApi* | [**get_organization_overview**](docs/AnalyticsApi.md#get_organization_overview) | **GET** /api/v1/organizations/{organizationId}/overview | Snapshot rank-health board across an organization active projects
+*Mencoro::AnalyticsApi* | [**get_project_metrics**](docs/AnalyticsApi.md#get_project_metrics) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/metrics | Headline visibility metrics of a project
+*Mencoro::AnalyticsApi* | [**get_project_sentiment**](docs/AnalyticsApi.md#get_project_sentiment) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/sentiment | Sentiment breakdown of a project brand mentions
+*Mencoro::AnalyticsApi* | [**get_project_time_series**](docs/AnalyticsApi.md#get_project_time_series) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/timeseries | Rank-tracking metrics of a project over time
+*Mencoro::AnalyticsApi* | [**get_query_movers**](docs/AnalyticsApi.md#get_query_movers) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/metrics/movers | Tracked queries ranked by how much a metric moved
+*Mencoro::AnalyticsApi* | [**get_share_of_voice_formula**](docs/AnalyticsApi.md#get_share_of_voice_formula) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/metrics/share-of-voice-formula | The constants behind the Share of Voice score
+*Mencoro::AnalyticsApi* | [**get_tracked_query_time_series**](docs/AnalyticsApi.md#get_tracked_query_time_series) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/timeseries | Rank-tracking time series of a single tracked query
+*Mencoro::AnalyticsApi* | [**get_tracking_coverage**](docs/AnalyticsApi.md#get_tracking_coverage) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/coverage | Coverage and staleness of a project tracked queries
+*Mencoro::AnalyticsApi* | [**list_keyword_listings**](docs/AnalyticsApi.md#list_keyword_listings) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/keyword-listings | List a project's keywords with their windowed metrics
+*Mencoro::BillingApi* | [**get_subscription**](docs/BillingApi.md#get_subscription) | **GET** /api/v1/organizations/{organizationId}/subscription | Get the subscription of an organization
+*Mencoro::CapturesApi* | [**list_ai_responses**](docs/CapturesApi.md#list_ai_responses) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/ai-responses | List captured AI answers
+*Mencoro::CapturesApi* | [**list_search_snapshots**](docs/CapturesApi.md#list_search_snapshots) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/search-snapshots | List captured search-results pages
+*Mencoro::CapturesApi* | [**list_shopping_snapshots**](docs/CapturesApi.md#list_shopping_snapshots) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/shopping-snapshots | List captured shopping-results pages
+*Mencoro::ClustersApi* | [**apply_clustering_job**](docs/ClustersApi.md#apply_clustering_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/jobs/{jobId}/apply | Apply the result of a clustering job
+*Mencoro::ClustersApi* | [**batch_create_query_clusters**](docs/ClustersApi.md#batch_create_query_clusters) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/batch | Create several keyword clusters at once
+*Mencoro::ClustersApi* | [**create_query_cluster**](docs/ClustersApi.md#create_query_cluster) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters | Create a keyword cluster
+*Mencoro::ClustersApi* | [**delete_query_cluster**](docs/ClustersApi.md#delete_query_cluster) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId} | Delete a keyword cluster
+*Mencoro::ClustersApi* | [**rename_query_cluster**](docs/ClustersApi.md#rename_query_cluster) | **PATCH** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId} | Rename a keyword cluster
+*Mencoro::ClustersApi* | [**start_clustering_job**](docs/ClustersApi.md#start_clustering_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/jobs | Start a keyword clustering job
+*Mencoro::DiscoveryApi* | [**start_brand_discovery_job**](docs/DiscoveryApi.md#start_brand_discovery_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/brands | Start a brand discovery job for a project
+*Mencoro::DiscoveryApi* | [**start_brand_name_suggestion_job**](docs/DiscoveryApi.md#start_brand_name_suggestion_job) | **POST** /api/v1/organizations/{organizationId}/brand-name-suggestions | Start a brand-name alias suggestion job
+*Mencoro::DiscoveryApi* | [**start_keyword_discovery_job**](docs/DiscoveryApi.md#start_keyword_discovery_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/keywords | Start a keyword discovery job for a project
+*Mencoro::DiscoveryApi* | [**start_prompt_discovery_job**](docs/DiscoveryApi.md#start_prompt_discovery_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/prompts | Start a geo prompt discovery job for a project
+*Mencoro::InvitationsApi* | [**cancel_invitation**](docs/InvitationsApi.md#cancel_invitation) | **POST** /api/v1/organizations/{organizationId}/invitations/{invitationId}/cancel | Cancel a pending invitation
+*Mencoro::InvitationsApi* | [**create_invitation**](docs/InvitationsApi.md#create_invitation) | **POST** /api/v1/organizations/{organizationId}/invitations | Invite somebody to an organization
+*Mencoro::InvitationsApi* | [**list_invitations**](docs/InvitationsApi.md#list_invitations) | **GET** /api/v1/organizations/{organizationId}/invitations | List an organization's invitations
+*Mencoro::JobsApi* | [**get_async_job**](docs/JobsApi.md#get_async_job) | **GET** /api/v1/organizations/{organizationId}/jobs/{jobId} | Get an asynchronous job
+*Mencoro::MembersApi* | [**change_member_role**](docs/MembersApi.md#change_member_role) | **PATCH** /api/v1/organizations/{organizationId}/members/{memberId} | Change a member role
+*Mencoro::MembersApi* | [**get_member**](docs/MembersApi.md#get_member) | **GET** /api/v1/organizations/{organizationId}/members/{memberId} | Get one organization membership
+*Mencoro::MembersApi* | [**list_members**](docs/MembersApi.md#list_members) | **GET** /api/v1/organizations/{organizationId}/members | List an organization's members
+*Mencoro::MembersApi* | [**reactivate_member**](docs/MembersApi.md#reactivate_member) | **POST** /api/v1/organizations/{organizationId}/members/{memberId}/reactivate | Reactivate a suspended member
+*Mencoro::MembersApi* | [**suspend_member**](docs/MembersApi.md#suspend_member) | **POST** /api/v1/organizations/{organizationId}/members/{memberId}/suspend | Suspend a member
+*Mencoro::OrganizationOperationsApi* | [**preview_organization_operation**](docs/OrganizationOperationsApi.md#preview_organization_operation) | **POST** /api/v1/organization-operation-previews | Preview an organization operation and obtain a confirmation
+*Mencoro::OrganizationsApi* | [**archive_organization**](docs/OrganizationsApi.md#archive_organization) | **POST** /api/v1/organizations/{organizationId}/archive | Archive an organization
+*Mencoro::OrganizationsApi* | [**count_organization_tracked_queries**](docs/OrganizationsApi.md#count_organization_tracked_queries) | **GET** /api/v1/organizations/{organizationId}/usage/tracked-queries | Count the tracked queries an organization has configured
+*Mencoro::OrganizationsApi* | [**create_organization**](docs/OrganizationsApi.md#create_organization) | **POST** /api/v1/organizations | Create an organization
+*Mencoro::OrganizationsApi* | [**get_entitlements**](docs/OrganizationsApi.md#get_entitlements) | **GET** /api/v1/organizations/{organizationId}/entitlements | Get an organization's plan allowance and consumption
+*Mencoro::OrganizationsApi* | [**get_membership_stats**](docs/OrganizationsApi.md#get_membership_stats) | **GET** /api/v1/organizations/{organizationId}/membership-stats | Membership, project and invitation counts for an organization
+*Mencoro::OrganizationsApi* | [**get_organization**](docs/OrganizationsApi.md#get_organization) | **GET** /api/v1/organizations/{organizationId} | Get an organization
+*Mencoro::OrganizationsApi* | [**get_organization_projected_monthly_checks**](docs/OrganizationsApi.md#get_organization_projected_monthly_checks) | **GET** /api/v1/organizations/{organizationId}/usage/projected-monthly-checks | Project a month of check consumption from the current tracking configuration
+*Mencoro::OrganizationsApi* | [**get_organization_stats**](docs/OrganizationsApi.md#get_organization_stats) | **GET** /api/v1/organizations/{organizationId}/stats | Headline counts for an organization
+*Mencoro::OrganizationsApi* | [**list_organizations**](docs/OrganizationsApi.md#list_organizations) | **GET** /api/v1/organizations | List accessible organizations
+*Mencoro::OrganizationsApi* | [**restore_organization**](docs/OrganizationsApi.md#restore_organization) | **POST** /api/v1/organizations/{organizationId}/restore | Restore an archived organization
+*Mencoro::OrganizationsApi* | [**update_organization**](docs/OrganizationsApi.md#update_organization) | **PATCH** /api/v1/organizations/{organizationId} | Update an organization profile
+*Mencoro::ProjectsApi* | [**archive_project**](docs/ProjectsApi.md#archive_project) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/archive | Archive a project
+*Mencoro::ProjectsApi* | [**create_competitor**](docs/ProjectsApi.md#create_competitor) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors | Add a competitor to a project
+*Mencoro::ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /api/v1/organizations/{organizationId}/projects | Create a project and the brand monitoring profile its checks run against
+*Mencoro::ProjectsApi* | [**delete_competitor**](docs/ProjectsApi.md#delete_competitor) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/{competitorId} | Remove a competitor from a project
+*Mencoro::ProjectsApi* | [**get_brand_profile**](docs/ProjectsApi.md#get_brand_profile) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/brand-profile | Get a project's brand monitoring profile
+*Mencoro::ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId} | Get a project and its brand monitoring configuration
+*Mencoro::ProjectsApi* | [**list_competitors**](docs/ProjectsApi.md#list_competitors) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors | List the competitors tracked by a project
+*Mencoro::ProjectsApi* | [**list_projects**](docs/ProjectsApi.md#list_projects) | **GET** /api/v1/organizations/{organizationId}/projects | List an organization's projects
+*Mencoro::ProjectsApi* | [**list_query_clusters**](docs/ProjectsApi.md#list_query_clusters) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters | List the keyword clusters of a project
+*Mencoro::ProjectsApi* | [**restore_project**](docs/ProjectsApi.md#restore_project) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/restore | Restore an archived project
+*Mencoro::ProjectsApi* | [**update_competitor**](docs/ProjectsApi.md#update_competitor) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/{competitorId} | Replace a competitor
+*Mencoro::ProjectsApi* | [**update_project**](docs/ProjectsApi.md#update_project) | **PATCH** /api/v1/organizations/{organizationId}/projects/{projectId} | Rename a project
+*Mencoro::ProjectsApi* | [**update_project_brand_profile**](docs/ProjectsApi.md#update_project_brand_profile) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/brand-profile | Replace a project's brand monitoring profile
+*Mencoro::TrackedQueriesApi* | [**add_clusters_to_tracked_query**](docs/TrackedQueriesApi.md#add_clusters_to_tracked_query) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/clusters | Add a tracked query to clusters
+*Mencoro::TrackedQueriesApi* | [**batch_change_tracked_queries_check_frequency**](docs/TrackedQueriesApi.md#batch_change_tracked_queries_check_frequency) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/check-frequency | Change how often several tracked queries are checked
+*Mencoro::TrackedQueriesApi* | [**batch_change_tracked_queries_n_passes**](docs/TrackedQueriesApi.md#batch_change_tracked_queries_n_passes) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/passes | Change how many passes several tracked queries run per check
+*Mencoro::TrackedQueriesApi* | [**batch_create_tracked_queries**](docs/TrackedQueriesApi.md#batch_create_tracked_queries) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries | Create tracked queries
+*Mencoro::TrackedQueriesApi* | [**batch_force_check_tracked_queries**](docs/TrackedQueriesApi.md#batch_force_check_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/check | Check several tracked queries now
+*Mencoro::TrackedQueriesApi* | [**batch_pause_tracked_queries**](docs/TrackedQueriesApi.md#batch_pause_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/pause | Pause several tracked queries
+*Mencoro::TrackedQueriesApi* | [**batch_resume_tracked_queries**](docs/TrackedQueriesApi.md#batch_resume_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/batch/resume | Resume several tracked queries
+*Mencoro::TrackedQueriesApi* | [**bulk_add_clusters_to_tracked_queries**](docs/TrackedQueriesApi.md#bulk_add_clusters_to_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk/clusters | Add many tracked queries to clusters
+*Mencoro::TrackedQueriesApi* | [**bulk_delete_tracked_queries**](docs/TrackedQueriesApi.md#bulk_delete_tracked_queries) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk-delete | Delete tracked queries
+*Mencoro::TrackedQueriesApi* | [**bulk_remove_clusters_from_tracked_queries**](docs/TrackedQueriesApi.md#bulk_remove_clusters_from_tracked_queries) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/bulk/clusters | Remove many tracked queries from clusters
+*Mencoro::TrackedQueriesApi* | [**change_tracked_query_check_frequency**](docs/TrackedQueriesApi.md#change_tracked_query_check_frequency) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/check-frequency | Change how often a tracked query is checked
+*Mencoro::TrackedQueriesApi* | [**change_tracked_query_n_passes**](docs/TrackedQueriesApi.md#change_tracked_query_n_passes) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/passes | Change how many passes a tracked query runs per check
+*Mencoro::TrackedQueriesApi* | [**count_tracked_queries**](docs/TrackedQueriesApi.md#count_tracked_queries) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/count | Count a project's tracked queries and price checking them
+*Mencoro::TrackedQueriesApi* | [**force_check_all_active_tracked_queries**](docs/TrackedQueriesApi.md#force_check_all_active_tracked_queries) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/check-all | Check every eligible tracked query of a project now
+*Mencoro::TrackedQueriesApi* | [**get_tracked_query**](docs/TrackedQueriesApi.md#get_tracked_query) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId} | Get a tracked query
+*Mencoro::TrackedQueriesApi* | [**pause_tracked_query**](docs/TrackedQueriesApi.md#pause_tracked_query) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/pause | Pause a tracked query
+*Mencoro::TrackedQueriesApi* | [**remove_clusters_from_tracked_query**](docs/TrackedQueriesApi.md#remove_clusters_from_tracked_query) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/clusters | Remove a tracked query from clusters
+*Mencoro::TrackedQueriesApi* | [**report_ai_response**](docs/TrackedQueriesApi.md#report_ai_response) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/responses/{aiResponseId}/report | Report a problem with a captured AI answer
+*Mencoro::TrackedQueriesApi* | [**resume_tracked_query**](docs/TrackedQueriesApi.md#resume_tracked_query) | **PUT** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/resume | Resume a tracked query
+*Mencoro::TrackedQueriesApi* | [**search_tracked_queries**](docs/TrackedQueriesApi.md#search_tracked_queries) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries | Search a project's tracked queries
+
+
+## Documentation for Models
+
+ - [Mencoro::AcceptedJobResource](docs/AcceptedJobResource.md)
+ - [Mencoro::AiResponseReportResource](docs/AiResponseReportResource.md)
+ - [Mencoro::AiResponseResource](docs/AiResponseResource.md)
+ - [Mencoro::ApplyClusteringJobOutcome](docs/ApplyClusteringJobOutcome.md)
+ - [Mencoro::ApplyClusteringJobOutcomeClustersInner](docs/ApplyClusteringJobOutcomeClustersInner.md)
+ - [Mencoro::ApplyClusteringJobOutcomeFailedInner](docs/ApplyClusteringJobOutcomeFailedInner.md)
+ - [Mencoro::ApplyClusteringJobOutcomeSkippedClustersInner](docs/ApplyClusteringJobOutcomeSkippedClustersInner.md)
+ - [Mencoro::ApplyClusteringJobOutcomeSuccessfulInner](docs/ApplyClusteringJobOutcomeSuccessfulInner.md)
+ - [Mencoro::AsyncJobResource](docs/AsyncJobResource.md)
+ - [Mencoro::BatchChangeTrackedQueryCheckFrequencyRequestData](docs/BatchChangeTrackedQueryCheckFrequencyRequestData.md)
+ - [Mencoro::BatchChangeTrackedQueryPassesRequestData](docs/BatchChangeTrackedQueryPassesRequestData.md)
+ - [Mencoro::BatchCreateQueryClustersOutcome](docs/BatchCreateQueryClustersOutcome.md)
+ - [Mencoro::BatchCreateQueryClustersOutcomeFailedInner](docs/BatchCreateQueryClustersOutcomeFailedInner.md)
+ - [Mencoro::BatchCreateQueryClustersOutcomeSuccessfulInner](docs/BatchCreateQueryClustersOutcomeSuccessfulInner.md)
+ - [Mencoro::BatchCreateQueryClustersRequestData](docs/BatchCreateQueryClustersRequestData.md)
+ - [Mencoro::BatchCreateTrackedQueriesRequestData](docs/BatchCreateTrackedQueriesRequestData.md)
+ - [Mencoro::BatchCreateTrackedQueriesResultResource](docs/BatchCreateTrackedQueriesResultResource.md)
+ - [Mencoro::BatchCreateTrackedQueriesResultResourceFailedInner](docs/BatchCreateTrackedQueriesResultResourceFailedInner.md)
+ - [Mencoro::BatchCreateTrackedQueriesResultResourceSuccessfulInner](docs/BatchCreateTrackedQueriesResultResourceSuccessfulInner.md)
+ - [Mencoro::BatchForceCheckTrackedQueries200Response](docs/BatchForceCheckTrackedQueries200Response.md)
+ - [Mencoro::BatchForceCheckTrackedQueries200ResponseFailedInner](docs/BatchForceCheckTrackedQueries200ResponseFailedInner.md)
+ - [Mencoro::BatchPauseTrackedQueries200Response](docs/BatchPauseTrackedQueries200Response.md)
+ - [Mencoro::BatchPauseTrackedQueries200ResponseFailedInner](docs/BatchPauseTrackedQueries200ResponseFailedInner.md)
+ - [Mencoro::BatchPauseTrackedQueries200ResponseSuccessfulInner](docs/BatchPauseTrackedQueries200ResponseSuccessfulInner.md)
+ - [Mencoro::BatchResumeTrackedQueries200Response](docs/BatchResumeTrackedQueries200Response.md)
+ - [Mencoro::BatchTargetsRequestData](docs/BatchTargetsRequestData.md)
+ - [Mencoro::BatchWriteOutcome](docs/BatchWriteOutcome.md)
+ - [Mencoro::BatchWriteOutcomeFailedInner](docs/BatchWriteOutcomeFailedInner.md)
+ - [Mencoro::BrandProfileResource](docs/BrandProfileResource.md)
+ - [Mencoro::BulkAddClustersToTrackedQueries200Response](docs/BulkAddClustersToTrackedQueries200Response.md)
+ - [Mencoro::BulkAddClustersToTrackedQueriesRequest](docs/BulkAddClustersToTrackedQueriesRequest.md)
+ - [Mencoro::BulkRemoveClustersFromTrackedQueries200Response](docs/BulkRemoveClustersFromTrackedQueries200Response.md)
+ - [Mencoro::BulkRemoveClustersFromTrackedQueriesRequest](docs/BulkRemoveClustersFromTrackedQueriesRequest.md)
+ - [Mencoro::ChangeMemberRoleRequest](docs/ChangeMemberRoleRequest.md)
+ - [Mencoro::ChangeTrackedQueryCheckFrequencyRequestData](docs/ChangeTrackedQueryCheckFrequencyRequestData.md)
+ - [Mencoro::ChangeTrackedQueryPassesRequestData](docs/ChangeTrackedQueryPassesRequestData.md)
+ - [Mencoro::CitationResource](docs/CitationResource.md)
+ - [Mencoro::ClusterMembershipRequestData](docs/ClusterMembershipRequestData.md)
+ - [Mencoro::CompetitorResource](docs/CompetitorResource.md)
+ - [Mencoro::CreateCompetitorRequest](docs/CreateCompetitorRequest.md)
+ - [Mencoro::CreateInvitation200Response](docs/CreateInvitation200Response.md)
+ - [Mencoro::CreateInvitation201Response](docs/CreateInvitation201Response.md)
+ - [Mencoro::CreateInvitationRequest](docs/CreateInvitationRequest.md)
+ - [Mencoro::CreateOrganization201Response](docs/CreateOrganization201Response.md)
+ - [Mencoro::CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
+ - [Mencoro::CreateProjectRequest](docs/CreateProjectRequest.md)
+ - [Mencoro::CreateProjectRequestCompetitorsInner](docs/CreateProjectRequestCompetitorsInner.md)
+ - [Mencoro::CreateQueryCluster409Response](docs/CreateQueryCluster409Response.md)
+ - [Mencoro::CreateQueryClusterRequest](docs/CreateQueryClusterRequest.md)
+ - [Mencoro::DeleteQueryCluster200Response](docs/DeleteQueryCluster200Response.md)
+ - [Mencoro::EntitlementsResource](docs/EntitlementsResource.md)
+ - [Mencoro::GetAvailableFilters200Response](docs/GetAvailableFilters200Response.md)
+ - [Mencoro::GetAvailableFilters200ResponseClustersInner](docs/GetAvailableFilters200ResponseClustersInner.md)
+ - [Mencoro::GetMeStats200Response](docs/GetMeStats200Response.md)
+ - [Mencoro::GetMeStats200ResponseOrganizations](docs/GetMeStats200ResponseOrganizations.md)
+ - [Mencoro::GetMeStats200ResponseProjects](docs/GetMeStats200ResponseProjects.md)
+ - [Mencoro::GetMembershipStats200Response](docs/GetMembershipStats200Response.md)
+ - [Mencoro::GetMentionSamples400Response](docs/GetMentionSamples400Response.md)
+ - [Mencoro::GetMentionSamples400ResponseDetailsValueInner](docs/GetMentionSamples400ResponseDetailsValueInner.md)
+ - [Mencoro::GetMetricGlossary200Response](docs/GetMetricGlossary200Response.md)
+ - [Mencoro::GetMetricGlossary200ResponseMetricsInner](docs/GetMetricGlossary200ResponseMetricsInner.md)
+ - [Mencoro::GetOrganizationOverview200Response](docs/GetOrganizationOverview200Response.md)
+ - [Mencoro::GetOrganizationOverview200ResponseAggregate](docs/GetOrganizationOverview200ResponseAggregate.md)
+ - [Mencoro::GetOrganizationOverview200ResponseProjectsInner](docs/GetOrganizationOverview200ResponseProjectsInner.md)
+ - [Mencoro::GetOrganizationStats200Response](docs/GetOrganizationStats200Response.md)
+ - [Mencoro::GetOrganizationStats200ResponseInvitations](docs/GetOrganizationStats200ResponseInvitations.md)
+ - [Mencoro::GetOrganizationStats200ResponseMembers](docs/GetOrganizationStats200ResponseMembers.md)
+ - [Mencoro::GetOrganizationStats200ResponseProjects](docs/GetOrganizationStats200ResponseProjects.md)
+ - [Mencoro::GetShareOfVoiceFormula200Response](docs/GetShareOfVoiceFormula200Response.md)
+ - [Mencoro::GetTrackingCoverage200Response](docs/GetTrackingCoverage200Response.md)
+ - [Mencoro::GetTrackingCoverage200ResponseSampleInner](docs/GetTrackingCoverage200ResponseSampleInner.md)
+ - [Mencoro::InvitationResource](docs/InvitationResource.md)
+ - [Mencoro::KeywordListingResource](docs/KeywordListingResource.md)
+ - [Mencoro::KeywordListingResourceMentionTypeCounts](docs/KeywordListingResourceMentionTypeCounts.md)
+ - [Mencoro::ListAiResponses200Response](docs/ListAiResponses200Response.md)
+ - [Mencoro::ListCompetitors200Response](docs/ListCompetitors200Response.md)
+ - [Mencoro::ListInvitations200Response](docs/ListInvitations200Response.md)
+ - [Mencoro::ListKeywordListings200Response](docs/ListKeywordListings200Response.md)
+ - [Mencoro::ListMembers200Response](docs/ListMembers200Response.md)
+ - [Mencoro::ListOrganizations200Response](docs/ListOrganizations200Response.md)
+ - [Mencoro::ListProjects200Response](docs/ListProjects200Response.md)
+ - [Mencoro::ListQueryClusters200Response](docs/ListQueryClusters200Response.md)
+ - [Mencoro::ListSearchSnapshots200Response](docs/ListSearchSnapshots200Response.md)
+ - [Mencoro::ListShoppingSnapshots200Response](docs/ListShoppingSnapshots200Response.md)
+ - [Mencoro::MeResource](docs/MeResource.md)
+ - [Mencoro::MemberResource](docs/MemberResource.md)
+ - [Mencoro::OperationEffect](docs/OperationEffect.md)
+ - [Mencoro::OrganizationResource](docs/OrganizationResource.md)
+ - [Mencoro::PreviewOrganizationOperation200Response](docs/PreviewOrganizationOperation200Response.md)
+ - [Mencoro::PreviewOrganizationOperation200ResponseOrganization](docs/PreviewOrganizationOperation200ResponseOrganization.md)
+ - [Mencoro::PreviewOrganizationOperationRequest](docs/PreviewOrganizationOperationRequest.md)
+ - [Mencoro::ProjectDetailResource](docs/ProjectDetailResource.md)
+ - [Mencoro::ProjectDetailResourceCompetitorsInner](docs/ProjectDetailResourceCompetitorsInner.md)
+ - [Mencoro::ProjectResource](docs/ProjectResource.md)
+ - [Mencoro::ProjectedMonthlyChecksResource](docs/ProjectedMonthlyChecksResource.md)
+ - [Mencoro::QueryClusterResource](docs/QueryClusterResource.md)
+ - [Mencoro::ReportAiResponseRequest](docs/ReportAiResponseRequest.md)
+ - [Mencoro::SearchResultResource](docs/SearchResultResource.md)
+ - [Mencoro::SearchSnapshotResource](docs/SearchSnapshotResource.md)
+ - [Mencoro::SearchTrackedQueries200Response](docs/SearchTrackedQueries200Response.md)
+ - [Mencoro::ShoppingOfferResource](docs/ShoppingOfferResource.md)
+ - [Mencoro::ShoppingSnapshotResource](docs/ShoppingSnapshotResource.md)
+ - [Mencoro::StartBrandDiscoveryJobRequest](docs/StartBrandDiscoveryJobRequest.md)
+ - [Mencoro::StartBrandNameSuggestionJobRequest](docs/StartBrandNameSuggestionJobRequest.md)
+ - [Mencoro::StartClusteringJobRequestData](docs/StartClusteringJobRequestData.md)
+ - [Mencoro::StartKeywordDiscoveryJobRequest](docs/StartKeywordDiscoveryJobRequest.md)
+ - [Mencoro::StartPromptDiscoveryJobRequest](docs/StartPromptDiscoveryJobRequest.md)
+ - [Mencoro::SubmittedChecksResource](docs/SubmittedChecksResource.md)
+ - [Mencoro::SubscriptionResource](docs/SubscriptionResource.md)
+ - [Mencoro::TrackedQueryCountResource](docs/TrackedQueryCountResource.md)
+ - [Mencoro::TrackedQueryDetailResource](docs/TrackedQueryDetailResource.md)
+ - [Mencoro::TrackedQueryResource](docs/TrackedQueryResource.md)
+ - [Mencoro::TrackedQueryUsageResource](docs/TrackedQueryUsageResource.md)
+ - [Mencoro::UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
+ - [Mencoro::UpdateProjectBrandProfileRequest](docs/UpdateProjectBrandProfileRequest.md)
+ - [Mencoro::UpdateProjectRequest](docs/UpdateProjectRequest.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### ApiKey
+
+- **Type**: Bearer authentication
+

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/AcceptedJobResource.md

@@ -0,0 +1,22 @@
+# Mencoro::AcceptedJobResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** | The job to poll. May name a job started by an earlier, equivalent request. |  |
+| **deduplicated** | **Boolean** | Whether this call started the job, or joined one that was already running |  |
+| **tracking_url** | **String** | Poll this until the job reaches a terminal status |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::AcceptedJobResource.new(
+  job_id: null,
+  deduplicated: null,
+  tracking_url: null
+)
+```
+

data/docs/AccountApi.md

@@ -0,0 +1,141 @@
+# Mencoro::AccountApi
+
+All URIs are relative to *https://api.mencoro.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_me**](AccountApi.md#get_me) | **GET** /api/v1/me | Get the authenticated identity |
+| [**get_me_stats**](AccountApi.md#get_me_stats) | **GET** /api/v1/me/stats | Counts across everything the key can reach |
+
+
+## get_me
+
+> <MeResource> get_me
+
+Get the authenticated identity
+
+Returns the user the API key belongs to, plus the key's capabilities and scope. Use it to confirm which credential a call runs under.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mencoro'
+# setup authorization
+Mencoro.configure do |config|
+  # Configure Bearer authorization: ApiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mencoro::AccountApi.new
+
+begin
+  # Get the authenticated identity
+  result = api_instance.get_me
+  p result
+rescue Mencoro::ApiError => e
+  puts "Error when calling AccountApi->get_me: #{e}"
+end
+```
+
+#### Using the get_me_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MeResource>, Integer, Hash)> get_me_with_http_info
+
+```ruby
+begin
+  # Get the authenticated identity
+  data, status_code, headers = api_instance.get_me_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MeResource>
+rescue Mencoro::ApiError => e
+  puts "Error when calling AccountApi->get_me_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**MeResource**](MeResource.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_me_stats
+
+> <GetMeStats200Response> get_me_stats
+
+Counts across everything the key can reach
+
+Aggregate counts over every organization the key's owner is an active member of, narrowed to the key's scope — the same set /api/v1/organizations pages through. `organizations.total` is that set's size; `projects.total` and `projects.active` count the projects inside it, archived ones included in the total and excluded from the active figure. Every value is an exact count: zero means zero, and no value here is ever null or unknown. Per-organization billing and usage figures are not part of this response; read them from the subscription and entitlements operations instead.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mencoro'
+# setup authorization
+Mencoro.configure do |config|
+  # Configure Bearer authorization: ApiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Mencoro::AccountApi.new
+
+begin
+  # Counts across everything the key can reach
+  result = api_instance.get_me_stats
+  p result
+rescue Mencoro::ApiError => e
+  puts "Error when calling AccountApi->get_me_stats: #{e}"
+end
+```
+
+#### Using the get_me_stats_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetMeStats200Response>, Integer, Hash)> get_me_stats_with_http_info
+
+```ruby
+begin
+  # Counts across everything the key can reach
+  data, status_code, headers = api_instance.get_me_stats_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetMeStats200Response>
+rescue Mencoro::ApiError => e
+  puts "Error when calling AccountApi->get_me_stats_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetMeStats200Response**](GetMeStats200Response.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AiResponseReportResource.md

@@ -0,0 +1,28 @@
+# Mencoro::AiResponseReportResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ai_response_id** | **String** | The captured AI answer the report is about |  |
+| **tracked_query_id** | **String** | The tracked query that answer was captured for |  |
+| **type** | **String** | The kind of problem reported |  |
+| **comment** | **String** | The note as stored. An empty or whitespace-only comment is stored as null. | [optional] |
+| **missed_brand_names** | **Array<String>** | Brand names reported as missed, de-duplicated and trimmed. |  |
+| **accepted** | **Boolean** | True once the report has been accepted for review. It is never false: a report that could not be delivered answers with an error instead. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::AiResponseReportResource.new(
+  ai_response_id: null,
+  tracked_query_id: null,
+  type: null,
+  comment: null,
+  missed_brand_names: null,
+  accepted: null
+)
+```
+

data/docs/AiResponseResource.md

@@ -0,0 +1,36 @@
+# Mencoro::AiResponseResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **project_id** | **String** | The project this capture belongs to |  |
+| **tracked_query_id** | **String** | The tracked query that was asked |  |
+| **engine** | **String** | The AI engine that answered |  |
+| **response_text** | **String** | The full answer text as the engine produced it |  |
+| **citations** | [**Array<CitationResource>**](CitationResource.md) | Sources the engine cited, in the order it cited them |  |
+| **captured_at** | **Time** | When the answer was captured, UTC |  |
+| **model_name** | **String** | Engine-reported model, when it reported one. Absent on captures taken before engines exposed it | [optional] |
+| **pass_index** | **Integer** | Which sampling pass of the run this answer is, starting at 0 |  |
+| **pass_count** | **Integer** | How many passes that run took. Rows of one run share trackedQueryId and capturedAt |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::AiResponseResource.new(
+  id: null,
+  project_id: null,
+  tracked_query_id: null,
+  engine: null,
+  response_text: null,
+  citations: null,
+  captured_at: null,
+  model_name: null,
+  pass_index: null,
+  pass_count: null
+)
+```
+