mencoro 1.0.0

data/lib/mencoro.rb

@@ -0,0 +1,169 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+# Common files
+require 'mencoro/api_client'
+require 'mencoro/api_error'
+require 'mencoro/api_model_base'
+require 'mencoro/version'
+require 'mencoro/configuration'
+
+# Models
+require 'mencoro/models/accepted_job_resource'
+require 'mencoro/models/ai_response_report_resource'
+require 'mencoro/models/ai_response_resource'
+require 'mencoro/models/apply_clustering_job_outcome'
+require 'mencoro/models/apply_clustering_job_outcome_clusters_inner'
+require 'mencoro/models/apply_clustering_job_outcome_failed_inner'
+require 'mencoro/models/apply_clustering_job_outcome_skipped_clusters_inner'
+require 'mencoro/models/apply_clustering_job_outcome_successful_inner'
+require 'mencoro/models/async_job_resource'
+require 'mencoro/models/batch_change_tracked_query_check_frequency_request_data'
+require 'mencoro/models/batch_change_tracked_query_passes_request_data'
+require 'mencoro/models/batch_create_query_clusters_outcome'
+require 'mencoro/models/batch_create_query_clusters_outcome_failed_inner'
+require 'mencoro/models/batch_create_query_clusters_outcome_successful_inner'
+require 'mencoro/models/batch_create_query_clusters_request_data'
+require 'mencoro/models/batch_create_tracked_queries_request_data'
+require 'mencoro/models/batch_create_tracked_queries_result_resource'
+require 'mencoro/models/batch_create_tracked_queries_result_resource_failed_inner'
+require 'mencoro/models/batch_create_tracked_queries_result_resource_successful_inner'
+require 'mencoro/models/batch_force_check_tracked_queries200_response'
+require 'mencoro/models/batch_force_check_tracked_queries200_response_failed_inner'
+require 'mencoro/models/batch_pause_tracked_queries200_response'
+require 'mencoro/models/batch_pause_tracked_queries200_response_failed_inner'
+require 'mencoro/models/batch_pause_tracked_queries200_response_successful_inner'
+require 'mencoro/models/batch_resume_tracked_queries200_response'
+require 'mencoro/models/batch_targets_request_data'
+require 'mencoro/models/batch_write_outcome'
+require 'mencoro/models/batch_write_outcome_failed_inner'
+require 'mencoro/models/brand_profile_resource'
+require 'mencoro/models/bulk_add_clusters_to_tracked_queries200_response'
+require 'mencoro/models/bulk_add_clusters_to_tracked_queries_request'
+require 'mencoro/models/bulk_remove_clusters_from_tracked_queries200_response'
+require 'mencoro/models/bulk_remove_clusters_from_tracked_queries_request'
+require 'mencoro/models/change_member_role_request'
+require 'mencoro/models/change_tracked_query_check_frequency_request_data'
+require 'mencoro/models/change_tracked_query_passes_request_data'
+require 'mencoro/models/citation_resource'
+require 'mencoro/models/cluster_membership_request_data'
+require 'mencoro/models/competitor_resource'
+require 'mencoro/models/create_competitor_request'
+require 'mencoro/models/create_invitation200_response'
+require 'mencoro/models/create_invitation201_response'
+require 'mencoro/models/create_invitation_request'
+require 'mencoro/models/create_organization201_response'
+require 'mencoro/models/create_organization_request'
+require 'mencoro/models/create_project_request'
+require 'mencoro/models/create_project_request_competitors_inner'
+require 'mencoro/models/create_query_cluster409_response'
+require 'mencoro/models/create_query_cluster_request'
+require 'mencoro/models/delete_query_cluster200_response'
+require 'mencoro/models/entitlements_resource'
+require 'mencoro/models/get_available_filters200_response'
+require 'mencoro/models/get_available_filters200_response_clusters_inner'
+require 'mencoro/models/get_me_stats200_response'
+require 'mencoro/models/get_me_stats200_response_organizations'
+require 'mencoro/models/get_me_stats200_response_projects'
+require 'mencoro/models/get_membership_stats200_response'
+require 'mencoro/models/get_mention_samples400_response'
+require 'mencoro/models/get_mention_samples400_response_details_value_inner'
+require 'mencoro/models/get_metric_glossary200_response'
+require 'mencoro/models/get_metric_glossary200_response_metrics_inner'
+require 'mencoro/models/get_organization_overview200_response'
+require 'mencoro/models/get_organization_overview200_response_aggregate'
+require 'mencoro/models/get_organization_overview200_response_projects_inner'
+require 'mencoro/models/get_organization_stats200_response'
+require 'mencoro/models/get_organization_stats200_response_invitations'
+require 'mencoro/models/get_organization_stats200_response_members'
+require 'mencoro/models/get_organization_stats200_response_projects'
+require 'mencoro/models/get_share_of_voice_formula200_response'
+require 'mencoro/models/get_tracking_coverage200_response'
+require 'mencoro/models/get_tracking_coverage200_response_sample_inner'
+require 'mencoro/models/invitation_resource'
+require 'mencoro/models/keyword_listing_resource'
+require 'mencoro/models/keyword_listing_resource_mention_type_counts'
+require 'mencoro/models/list_ai_responses200_response'
+require 'mencoro/models/list_competitors200_response'
+require 'mencoro/models/list_invitations200_response'
+require 'mencoro/models/list_keyword_listings200_response'
+require 'mencoro/models/list_members200_response'
+require 'mencoro/models/list_organizations200_response'
+require 'mencoro/models/list_projects200_response'
+require 'mencoro/models/list_query_clusters200_response'
+require 'mencoro/models/list_search_snapshots200_response'
+require 'mencoro/models/list_shopping_snapshots200_response'
+require 'mencoro/models/me_resource'
+require 'mencoro/models/member_resource'
+require 'mencoro/models/operation_effect'
+require 'mencoro/models/organization_resource'
+require 'mencoro/models/preview_organization_operation200_response'
+require 'mencoro/models/preview_organization_operation200_response_organization'
+require 'mencoro/models/preview_organization_operation_request'
+require 'mencoro/models/project_detail_resource'
+require 'mencoro/models/project_detail_resource_competitors_inner'
+require 'mencoro/models/project_resource'
+require 'mencoro/models/projected_monthly_checks_resource'
+require 'mencoro/models/query_cluster_resource'
+require 'mencoro/models/report_ai_response_request'
+require 'mencoro/models/search_result_resource'
+require 'mencoro/models/search_snapshot_resource'
+require 'mencoro/models/search_tracked_queries200_response'
+require 'mencoro/models/shopping_offer_resource'
+require 'mencoro/models/shopping_snapshot_resource'
+require 'mencoro/models/start_brand_discovery_job_request'
+require 'mencoro/models/start_brand_name_suggestion_job_request'
+require 'mencoro/models/start_clustering_job_request_data'
+require 'mencoro/models/start_keyword_discovery_job_request'
+require 'mencoro/models/start_prompt_discovery_job_request'
+require 'mencoro/models/submitted_checks_resource'
+require 'mencoro/models/subscription_resource'
+require 'mencoro/models/tracked_query_count_resource'
+require 'mencoro/models/tracked_query_detail_resource'
+require 'mencoro/models/tracked_query_resource'
+require 'mencoro/models/tracked_query_usage_resource'
+require 'mencoro/models/update_organization_request'
+require 'mencoro/models/update_project_brand_profile_request'
+require 'mencoro/models/update_project_request'
+
+# APIs
+require 'mencoro/api/account_api'
+require 'mencoro/api/analytics_api'
+require 'mencoro/api/billing_api'
+require 'mencoro/api/captures_api'
+require 'mencoro/api/clusters_api'
+require 'mencoro/api/discovery_api'
+require 'mencoro/api/invitations_api'
+require 'mencoro/api/jobs_api'
+require 'mencoro/api/members_api'
+require 'mencoro/api/organization_operations_api'
+require 'mencoro/api/organizations_api'
+require 'mencoro/api/projects_api'
+require 'mencoro/api/tracked_queries_api'
+
+module Mencoro
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Mencoro.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/mencoro.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "mencoro/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mencoro"
+  s.version     = Mencoro::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["OpenAPI-Generator"]
+  s.email       = ["support@mencoro.com"]
+  s.homepage    = "https://openapi-generator.tech"
+  s.summary     = "Mencoro API Ruby Gem"
+  s.description = "Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`."
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_runtime_dependency 'faraday-multipart'
+  s.add_runtime_dependency 'marcel'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/account_api_spec.rb

@@ -0,0 +1,57 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Mencoro::AccountApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AccountApi' do
+  before do
+    # run before each test
+    @api_instance = Mencoro::AccountApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountApi' do
+    it 'should create an instance of AccountApi' do
+      expect(@api_instance).to be_instance_of(Mencoro::AccountApi)
+    end
+  end
+
+  # unit tests for 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.
+  # @param [Hash] opts the optional parameters
+  # @return [MeResource]
+  describe 'get_me test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for 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.
+  # @param [Hash] opts the optional parameters
+  # @return [GetMeStats200Response]
+  describe 'get_me_stats test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/analytics_api_spec.rb

@@ -0,0 +1,318 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Mencoro::AnalyticsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AnalyticsApi' do
+  before do
+    # run before each test
+    @api_instance = Mencoro::AnalyticsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AnalyticsApi' do
+    it 'should create an instance of AnalyticsApi' do
+      expect(@api_instance).to be_instance_of(Mencoro::AnalyticsApi)
+    end
+  end
+
+  # unit tests for get_available_filters
+  # Filter values a project is configured for
+  # Minimum role: viewer. Call this first: it is where every other analytics operation sends you for the valid engines, countries and keyword clusters of a project, and the values it returns are the exact strings the engines, countries and queryClusterIds parameters accept — anything else is rejected as a 400. Engines are engine codes, countries are ISO-3166 alpha-2 codes, and clusters are {id, name} objects whose id goes in queryClusterIds. Takes no date window: it describes how the project is configured right now, so a value is listed as soon as a tracked query uses it, even when no response has been captured for it yet. An empty list therefore means nothing is configured for it, not that no data was collected. Competitor ids are not part of this response.
+  # @param organization_id 
+  # @param project_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetAvailableFilters200Response]
+  describe 'get_available_filters test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_cited_sources
+  # Domains and pages the AI answers cited
+  # Minimum role: viewer. The sources the answer engines drew on across a project's AI answers over a date window, ranked by how often they were cited. Per source: citationCount, the total number of citations; distinctResponseCount and distinctQueryCount, how many captured answers and tracked queries it appeared in; avgPosition, its average 1-based rank inside the answers' citation lists, where LOWER is better. A null avgPosition means no citation in the window carried a position, not a rank of zero; a null domain or sampleTitle means the citation never carried one. `total` counts the distinct sources matching the window, before paging. The list is UNFILTERED by ownership: the brand's, competitors' and third-party sources sit in the same ranking. Only the AI answer engines (chatgpt, perplexity, google_ai_overview, google_ai_mode) produce citations, so filtering by google_serp or google_shopping is accepted and returns nothing. Citations still behind an answer engine's redirect (a google.com/goto link, whose URL names the engine rather than the source) are excluded, so a source cited only through such links is absent from this list rather than counted as zero.
+  # @param organization_id 
+  # @param project_id 
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window.
+  # @param date_to Inclusive end of the window, Y-m-d.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :engines Repeatable, or comma-separated. Only the AI engines carry citations.
+  # @option opts [String] :group_by Grain of the roll-up: \&quot;domain\&quot; by host, \&quot;page\&quot; by exact URL.
+  # @option opts [Integer] :limit Page size. A larger value is rejected, never silently reduced.
+  # @option opts [Integer] :offset Number of sources to skip.
+  # @return [nil]
+  describe 'get_cited_sources test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_cluster_breakdown
+  # Rank-tracking metrics per keyword cluster
+  # Minimum role: viewer. One row per keyword cluster over a date window, with its tracked query and keyword counts, average positions, rates, share of voice and sentiment split. A row whose clusterId is null is the ungrouped bucket: the tracked queries belonging to no cluster. Position metrics are 1-based and LOWER is better; rates, positivityIndex and shareOfVoice are 0-100 percentages where higher is better. A null metric means nothing was captured for that cluster in the window — it is not a zero, and averaging or charting it as one would misstate the period. dataDirtySince is non-null while a recalculation is pending, meaning the numbers predate the latest configuration change.
+  # @param organization_id 
+  # @param project_id 
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window.
+  # @param date_to Inclusive end of the window, Y-m-d.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :engines Repeatable, or comma-separated.
+  # @option opts [Array<String>] :countries ISO-3166 alpha-2 codes or English names. Must be configured on the project.
+  # @option opts [Array<String>] :query_cluster_ids Restrict to these clusters. Each must belong to the project.
+  # @option opts [Boolean] :include_ungrouped_queries Sent alone, returns only the ungrouped bucket rather than adding it to every cluster.
+  # @return [nil]
+  describe 'get_cluster_breakdown test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_competitor_co_occurrence
+  # Head-to-head record of the brand against each tracked competitor
+  # Minimum role: viewer. Restricted to the AI answers where the brand and a competitor are BOTH mentioned, one row per tracked competitor: sharedResponseCount is how many such answers there are, and brandWins / competitorWins / ties split them by who holds the better (lower) best mention position. winRate is the percentage 0-100 of those answers the brand wins; avgOwnPosition and avgCompetitorPosition are the average best mention position each side held, 1-based, so LOWER is better. exampleQueryText and exampleAiResponseId point at one representative shared answer. Every nullable field means \&quot;not known yet\&quot; rather than zero: a null winRate or average position is the absence of a shared answer in the window, not a record of losing. Tracked competitors only.
+  # @param organization_id 
+  # @param project_id 
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window.
+  # @param date_to Inclusive end of the window, Y-m-d.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :engines Repeatable, or comma-separated. SERP and Shopping carry no AI answer text, so they contribute no co-occurrence.
+  # @option opts [Array<String>] :countries ISO-3166 alpha-2 codes or English names. Must be configured on the project.
+  # @option opts [String] :competitor_id Restricts the answer to a single tracked competitor. Omit it for every tracked competitor. The available-filters endpoint lists the valid ids.
+  # @return [nil]
+  describe 'get_competitor_co_occurrence test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_mention_mix
+  # Composition of a project brand mentions in AI answers
+  # Minimum role: viewer. Counts of the project brand&#39;s own text mentions in AI answers over a date window, grouped three ways: byType (recommendation, comparison, listing, example, reference), byTone (positive, neutral, negative) and byQualifier (direct, conditional — a conditional mention is one the answer hedged with a condition). These are the inputs behind the Share of Voice weighted score. Every bucket is always present and is a plain count, never null: a zero means no mention of that kind was found in the window. The three groupings count the same mentions, so each one sums to the same total. Only the project brand is counted, never a competitor, and only mentions inside the answer text — a citation of the brand&#39;s URL is not a mention here. Only AI answer engines produce mentions, so restricting engines to google_serp or google_shopping alone returns all zeros. For the positive/neutral/negative split per engine and per competitor use the sentiment endpoint.
+  # @param organization_id 
+  # @param project_id 
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window.
+  # @param date_to Inclusive end of the window, Y-m-d.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :engines Repeatable, or comma-separated. Non-AI engines contribute no mentions.
+  # @option opts [Array<String>] :countries ISO-3166 alpha-2 codes or English names. Must be configured on the project.
+  # @return [nil]
+  describe 'get_mention_mix test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_mention_samples
+  # Sample of the raw AI mention texts of a project
+  # Minimum role: viewer. A paginated page of the individual mention texts behind the aggregate numbers, for qualitative review and for checking sentiment labels by eye. Each sample carries the mention text, the engine and country it was seen in, the tracked query that produced it, its sentiment and mention type, and mentionPosition — a 1-based rank inside the answer where LOWER is better, always present. &#x60;total&#x60; counts every mention matching the filters, not the size of the page returned. Only mentions inside the answer text are returned: a citation of the brand URL is not a mention here, and only AI answer engines produce mentions, so restricting engines to google_serp or google_shopping alone returns an empty page rather than an error. Two fields carry a \&quot;not known\&quot; rather than a zero: country is null and queryText is empty when the tracked query behind the mention has since been deleted, and competitorId is null when the mention row stores no competitor id — which is NOT an assertion that the mention is about your own brand, since an untracked competitor also stores none. Read mentionRelation instead: &#x60;own&#x60; and &#x60;tracked-competitor&#x60; are what the scraper resolved to a configured entity, &#x60;untracked-competitor&#x60; is a rival the project does not track, and null means the row predates the field. brandName carries the mentioned brand, and is the only way to name an untracked competitor, which has no competitor id to resolve one from. Omitting the competitorId filter returns exactly the rows with no competitor id stored — that is, own-brand AND untracked-competitor mentions together, not every competitor; pass a competitor UUID to restrict the page to that competitor, and use mentionRelation to separate the rest. For the aggregate positive/neutral/negative split use the sentiment endpoint, and for weighted mention-type counts the mention mix endpoint.
+  # @param organization_id 
+  # @param project_id 
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window.
+  # @param date_to Inclusive end of the window, Y-m-d.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :engines Repeatable, or comma-separated. Non-AI engines contribute no mentions.
+  # @option opts [Array<String>] :countries ISO-3166 alpha-2 codes or English names. Must be configured on the project.
+  # @option opts [String] :sentiment Restrict to one sentiment label. Omit for every sentiment.
+  # @option opts [String] :mention_type Restrict to one mention type. Omit for every type.
+  # @option opts [String] :competitor_id UUID of a single competitor, as listed by the available-filters endpoint (competitors[].id). Omitted, the page is restricted to mentions storing no competitor id, which is own-brand and untracked-competitor mentions together — see the operation description and read mentionRelation to tell them apart.
+  # @option opts [String] :sort_by recent: newest first. negative: negative sentiment first, then neutral, then positive, newest first inside each. engine and country: grouped alphabetically, newest first inside each group. An unknown value is rejected, not replaced by the default.
+  # @option opts [Integer] :limit Page size. A larger value is rejected, never silently reduced.
+  # @option opts [Integer] :offset Number of matching mentions to skip before the page starts.
+  # @return [nil]
+  describe 'get_mention_samples test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_metric_glossary
+  # Map everyday wording to a metric and the operation that serves it
+  # Static reference, no project data. Each entry gives a metric, the everyday words people use for it, its unit and range, whether higher or lower is better, the operation that returns it, and example questions. Useful when turning a vague or non-technical request into the right call.
+  # @param [Hash] opts the optional parameters
+  # @return [GetMetricGlossary200Response]
+  describe 'get_metric_glossary test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_organization_overview
+  # Snapshot rank-health board across an organization active projects
+  # Minimum role: viewer. One row per active project — share of voice, mention rate, average mention position, positivity index and tracked-query count — ordered by share of voice, plus an organization-level aggregate of the same metrics. Archived projects are excluded. This is a current-state snapshot and takes no date window; for a date-ranged comparison call the per-project operations (getProjectMetrics, getProjectTimeSeries) for each projectId returned here. Every metric is nullable, and a null means the project has no rank data yet — not a score of zero. Higher is better for shareOfVoice, mentionRate and positivityIndex; avgMentionPosition is a 1-based rank, so LOWER is better.
+  # @param organization_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetOrganizationOverview200Response]
+  describe 'get_organization_overview test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_project_metrics
+  # Headline visibility metrics of a project
+  # Minimum role: viewer. The project overview over a date window: share of voice (own and per competitor), mention / SERP / shopping rates, average and best positions, position stability, the sentiment split and the position-distribution buckets. Positions are 1-based, so a LOWER number is better; rates, the positivity index and share of voice are percentages from 0 to 100, where HIGHER is better. Every &#x60;trend*&#x60; field is the signed change against the immediately preceding window of the same length: negative means an improved position, positive means an improved rate or score. A null metric means \&quot;not known yet\&quot;, never zero: a scalar is null when the window holds no checks at all, and a &#x60;trend*&#x60; field is null when there is no earlier window to compare against. The counters (&#x60;mentionCount&#x60;, &#x60;*TrackedQueryCount&#x60;, &#x60;*QueriesWithResult&#x60;, &#x60;sentiment*&#x60; and &#x60;mentionTypeCounts&#x60;) are genuine zeros instead, so an empty window reads as zero counts with null rates. &#x60;dataDirtySince&#x60; is non-null while a recalculation is pending, meaning the figures may still move for dates from then on.
+  # @param organization_id 
+  # @param project_id 
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window.
+  # @param date_to Inclusive end of the window, Y-m-d.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :engines Repeatable, or comma-separated.
+  # @option opts [Array<String>] :countries ISO-3166 alpha-2 codes or English names. Must be configured on the project.
+  # @option opts [Array<String>] :query_cluster_ids Restrict to these keyword clusters. Each must belong to this project.
+  # @option opts [Boolean] :include_ungrouped_queries Only meaningful together with queryClusterIds: also counts the tracked queries that belong to no cluster.
+  # @return [nil]
+  describe 'get_project_metrics test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_project_sentiment
+  # Sentiment breakdown of a project brand mentions
+  # Minimum role: viewer. Positive, neutral and negative split of the brand mentions in AI answers over a date window, per engine and per competitor. A null positivityIndex means no mentions were found in the window, which is not the same as a score of zero.
+  # @param organization_id 
+  # @param project_id 
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window.
+  # @param date_to Inclusive end of the window, Y-m-d.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :engines Repeatable, or comma-separated.
+  # @option opts [Array<String>] :countries ISO-3166 alpha-2 codes or English names. Must be configured on the project.
+  # @option opts [Array<String>] :query_cluster_ids 
+  # @option opts [Boolean] :include_ungrouped_queries 
+  # @return [nil]
+  describe 'get_project_sentiment test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_project_time_series
+  # Rank-tracking metrics of a project over time
+  # Minimum role: viewer. One point per bucket over the date window, each carrying the brand metrics and one same-shaped entry per requested competitor. Rank metrics (serp, shopping, mention, link) are 1-based averages where LOWER is better; positivity (0-100), shareOfVoice (0-100), mentionRate (0-100) and serpRate (0-100) are scores where higher is better. Every metric is nullable, and a null means no data was collected for that bucket, which is not the same as a value of zero. A project with no tracked queries returns an empty points list. Prefer weekly or monthly granularity over a long window to keep the response compact.
+  # @param organization_id 
+  # @param project_id 
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window.
+  # @param date_to Inclusive end of the window, Y-m-d.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :granularity Bucket size of each point.
+  # @option opts [Array<String>] :engines Repeatable, or comma-separated.
+  # @option opts [Array<String>] :countries ISO-3166 alpha-2 codes or English names. Must be configured on the project.
+  # @option opts [Array<String>] :query_cluster_ids 
+  # @option opts [Boolean] :include_ungrouped_queries On its own this NARROWS the series to tracked queries that belong to no cluster; combined with queryClusterIds it widens those clusters to also cover them.
+  # @option opts [Array<String>] :competitor_ids Repeatable, or comma-separated. Each id adds one series under the competitors map of every point.
+  # @return [nil]
+  describe 'get_project_time_series test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_query_movers
+  # Tracked queries ranked by how much a metric moved
+  # Minimum role: viewer. One row per tracked query — a single engine plus country — carrying its current metric envelope and the signed change against the immediately preceding window of equal length: a 7-day window is compared with the 7 days before it. Every trend delta is signed so that POSITIVE means improved, including the position trends, where the underlying avgSerpPosition / avgShoppingPosition / avgMentionPosition / avgLinkPosition are 1-based ranks and therefore LOWER is better. shareOfVoice and positivityIndex are percentages from 0 to 100, where HIGHER is better. Sorting applies to the trend keys only: sortOrder&#x3D;desc gives the top gainers, asc the top losers. Every nullable field means \&quot;not known yet\&quot; rather than zero — a null position or shareOfVoice is a query with no data in the window, and a null positivityIndex or trend is a period with no mentions to score, neither of which is a record of losing ground. total counts the tracked queries the filters match, not the rows on this page. dataDirtySince is a date from which the rank data is being recomputed, or null when nothing is pending; while it is non-null the deltas may still move.
+  # @param organization_id 
+  # @param project_id 
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window. The comparison window is the equally long stretch immediately before it.
+  # @param date_to Inclusive end of the window, Y-m-d.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :engines Repeatable, or comma-separated.
+  # @option opts [Array<String>] :countries ISO-3166 alpha-2 codes or English names. Must be configured on the project.
+  # @option opts [String] :sort_by Which trend delta ranks the rows. Positions improve as they fall, so a positive delta is always an improvement whichever key you pick. An unknown value is rejected, not replaced by the default.
+  # @option opts [String] :sort_order desc for the top gainers, asc for the top losers.
+  # @option opts [Integer] :limit Page size. A value above the maximum is rejected, never clamped.
+  # @option opts [Integer] :offset 
+  # @return [nil]
+  describe 'get_query_movers test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_share_of_voice_formula
+  # The constants behind the Share of Voice score
+  # Minimum role: viewer. Static reference data, the same for every project: the weights and multipliers that turn individual brand mentions into a Share of Voice score. Each mention is worth &#x60;mentionTypeWeights[type] * sentimentMultipliers[tone] * (conditional ? conditionalMultiplier : directMultiplier)&#x60;, and a competitor&#39;s Share of Voice is its share of the summed weights of every brand in the window, as a percentage. mentionTypeWeights is keyed by mention type (recommendation, comparison, listing, example, reference) and sentimentMultipliers by tone (positive, neutral, negative); a negative mention is discounted, not discarded, because it still evidences presence. A conditional mention is one the answer hedged with a condition (\&quot;if you need X\&quot;). Use this to explain a score, not to recompute one: the counts it applies to come from the mention mix endpoint. Every value is always present and is never null.
+  # @param organization_id 
+  # @param project_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetShareOfVoiceFormula200Response]
+  describe 'get_share_of_voice_formula test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_tracked_query_time_series
+  # Rank-tracking time series of a single tracked query
+  # Minimum role: viewer. One point per bucket over the date window, each carrying the brand metrics and one same-shaped entry per requested competitor. Positions (serp, shopping, mention, link) are 1-based, so a LOWER number is better; positivity, shareOfVoice, mentionRate and serpRate are percentages from 0 to 100, where higher is better. Every metric is nullable, and a null means nothing was captured for that entity in that bucket — it is not a zero: a null shareOfVoice means no measurement, a shareOfVoice of 0 means measured and never mentioned. The tracked query fixes its own engine and country, so no engine or country filter is accepted. A non-null dataDirtySince is a timestamp warning that tracked queries were deleted from the project and historical buckets may still include their contributions until the nightly refresh rebuilds them.
+  # @param organization_id 
+  # @param project_id 
+  # @param tracked_query_id Must belong to the project in the path.
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window.
+  # @param date_to Inclusive end of the window, Y-m-d.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :granularity Bucket size. Prefer weekly or monthly for long windows.
+  # @option opts [Array<String>] :competitor_ids Competitors to add as extra series, repeatable or comma-separated. Valid ids come from the available-filters endpoint.
+  # @return [nil]
+  describe 'get_tracked_query_time_series test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_tracking_coverage
+  # Coverage and staleness of a project tracked queries
+  # Minimum role: viewer. A current-state snapshot answering \&quot;what is stale or not being tracked\&quot;: total is every tracked query on the project, active and paused split it by status, neverChecked counts the active queries that have never run, and overdue counts the active queries whose last check is older than their own check-frequency interval (daily, weekly or monthly). neverChecked and overdue are disjoint — a query that has never run is never also counted as overdue — and both ignore paused queries, which are not expected to be checked at all. sample lists up to 20 of the overdue queries, most stale first; it is a sample of overdue only, so it never contains a never-checked query and is empty when overdue is 0. Takes no date window: every count describes the project as it stands right now.
+  # @param organization_id 
+  # @param project_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetTrackingCoverage200Response]
+  describe 'get_tracking_coverage test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_keyword_listings
+  # List a project&#39;s keywords with their windowed metrics
+  # Minimum role: viewer. One row per distinct keyword text of the project — every tracked query asking that text, on any engine in any country, collapsed into a single row whose variantIds name the tracked queries behind it. Each row carries the metrics of the requested window and a signed trend against the window of equal length immediately before it, where POSITIVE ALWAYS MEANS BETTER whichever direction the metric itself runs. Positions are 1-based and lower is better; rates, positivityIndex and shareOfVoice are 0-100 and higher is better; mentionPositionStability is a day-to-day spread, so lower is steadier. A null metric means nothing was captured for that keyword in the window — it is not a zero. &#x60;total&#x60; counts the KEYWORDS matching the filters, not the rows on this page and not tracked queries; &#x60;totalVariantCount&#x60; counts the tracked queries behind the keywords matching every filter EXCEPT &#x60;search&#x60; — with a text search applied it still counts the project&#39;s variants, so do not size a force-check budget from it on a searched page. NEITHER IS THE PROJECT&#39;S TRACKED-QUERY COUNT: the count operation reads the write model, while this listing reads projections refreshed in the background from it, so the numbers legitimately differ while those projections catch up. A project whose cached tracked-query count has not been refreshed yet answers an empty page with total 0 — the same answer as a project with no tracked queries at all — so treat an unexpected empty page right after creating queries as \&quot;not projected yet\&quot;, not as \&quot;no data\&quot;. dataDirtySince is non-null while a recalculation is pending, meaning the metrics predate the latest configuration change. Filters narrow which VARIANTS count towards a row, so engines, countries, statuses, checkFrequencies and nPassesValues each report what the filters selected rather than everything the keyword has. A filter or sort key this endpoint cannot honour is rejected by name, never ignored, and a limit above the maximum is rejected rather than quietly reduced. This operation answers JSON only: a keyword row carries a nested mentionTypeCounts object, so it is not part of the CSV family.
+  # @param organization_id 
+  # @param project_id 
+  # @param date_from Inclusive start of the window, Y-m-d. Must fall inside the data retention window.
+  # @param date_to Inclusive end of the window, Y-m-d. The trend compares against the equally long window ending the day before dateFrom.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :engines Repeatable, or comma-separated. Narrows which variants count towards each row.
+  # @option opts [Array<String>] :countries ISO-3166 alpha-2 codes or English names. Must be configured on the project.
+  # @option opts [Array<String>] :query_cluster_ids Restrict to keywords with a variant in these clusters. Each must belong to the project.
+  # @option opts [Boolean] :include_ungrouped_queries Sent alone, restricts the listing to keywords whose variants belong to no cluster; sent with queryClusterIds, adds them to that selection.
+  # @option opts [String] :status Restrict to variants with this status. A keyword whose variants disagree still reports statusSummary \&quot;mixed\&quot;.
+  # @option opts [Array<String>] :check_frequencies Repeatable, or comma-separated.
+  # @option opts [Array<Integer>] :n_passes Repeatable, or comma-separated. Restrict to variants configured with these pass counts.
+  # @option opts [String] :search Case-insensitive substring match on the keyword text.
+  # @option opts [String] :sort_by Named after the field it orders by. Rows with no value for the chosen key sort last in either direction. An unknown key is rejected, not replaced by the default.
+  # @option opts [String] :sort_order 
+  # @option opts [Integer] :limit Page size. A larger value is rejected, never silently reduced.
+  # @option opts [Integer] :offset Number of matching keywords to skip before the page starts.
+  # @return [ListKeywordListings200Response]
+  describe 'list_keyword_listings test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/billing_api_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Mencoro::BillingApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'BillingApi' do
+  before do
+    # run before each test
+    @api_instance = Mencoro::BillingApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BillingApi' do
+    it 'should create an instance of BillingApi' do
+      expect(@api_instance).to be_instance_of(Mencoro::BillingApi)
+    end
+  end
+
+  # unit tests for get_subscription
+  # Get the subscription of an organization
+  # Minimum role: viewer. The most recent subscription contract of the organization, whatever its state: tier, billing interval, check budget and consumption, and the cancellation and grace dates. An organization that has never subscribed answers 200 with \"status\": \"none\" and every other field null - a null is \"not applicable\", never a stand-in for a zero budget or zero consumption. Stripe identifiers, prices and payment methods are not part of this API.
+  # @param organization_id 
+  # @param [Hash] opts the optional parameters
+  # @return [SubscriptionResource]
+  describe 'get_subscription test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end