mencoro 1.0.0

data/docs/QueryClusterResource.md

@@ -0,0 +1,22 @@
+# Mencoro::QueryClusterResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Pass this value in the queryClusterIds filter of the analytics operations |  |
+| **project_id** | **String** | The project this cluster belongs to |  |
+| **name** | **String** | Unique within the project, stored lower-cased |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::QueryClusterResource.new(
+  id: null,
+  project_id: null,
+  name: null
+)
+```
+

data/docs/ReportAiResponseRequest.md

@@ -0,0 +1,22 @@
+# Mencoro::ReportAiResponseRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | What is wrong with the capture. |  |
+| **comment** | **String** | Optional note for the reviewer, at most 1000 characters. An empty string is stored as no comment. | [optional] |
+| **missed_brand_names** | **Array<String>** | Brands the engine mentioned that the pipeline did not record. Most useful with type \"missed_mention\"; accepted with either. At most 50 distinct names of 255 characters each. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ReportAiResponseRequest.new(
+  type: null,
+  comment: null,
+  missed_brand_names: null
+)
+```
+

data/docs/SearchResultResource.md

@@ -0,0 +1,32 @@
+# Mencoro::SearchResultResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **position** | **Integer** | Rank on the captured page, starting at 1 |  |
+| **url** | **String** | The result URL as captured, redirector included when unresolved is true |  |
+| **title** | **String** | Result title, when the page showed one | [optional] |
+| **snippet** | **String** | Result snippet, when the page showed one | [optional] |
+| **domain** | **String** | Host of url. Belongs to the redirector, not the publisher, when unresolved is true | [optional] |
+| **rating** | **Float** | Star rating shown in the rich result, when there was one | [optional] |
+| **rating_votes** | **Integer** | Number of votes behind rating, when the rich result reported one | [optional] |
+| **unresolved** | **Boolean** | True when url still points at a redirector: count the result, do not attribute the domain |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::SearchResultResource.new(
+  position: null,
+  url: null,
+  title: null,
+  snippet: null,
+  domain: null,
+  rating: null,
+  rating_votes: null,
+  unresolved: null
+)
+```
+

data/docs/SearchSnapshotResource.md

@@ -0,0 +1,28 @@
+# Mencoro::SearchSnapshotResource
+
+## 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 searched |  |
+| **engine** | **String** | The search engine that was captured |  |
+| **results** | [**Array<SearchResultResource>**](SearchResultResource.md) | Organic results in rank order |  |
+| **captured_at** | **Time** | When the page was captured, UTC |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::SearchSnapshotResource.new(
+  id: null,
+  project_id: null,
+  tracked_query_id: null,
+  engine: null,
+  results: null,
+  captured_at: null
+)
+```
+

data/docs/SearchTrackedQueries200Response.md

@@ -0,0 +1,20 @@
+# Mencoro::SearchTrackedQueries200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<TrackedQueryResource>**](TrackedQueryResource.md) |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::SearchTrackedQueries200Response.new(
+  items: null,
+  total: null
+)
+```
+

data/docs/ShoppingOfferResource.md

@@ -0,0 +1,38 @@
+# Mencoro::ShoppingOfferResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rank** | **Integer** | Rank on the captured page, starting at 1 |  |
+| **title** | **String** | Product title as the marketplace showed it |  |
+| **product_url** | **String** | Link to the offer |  |
+| **seller_name** | **String** | Seller name as the marketplace showed it |  |
+| **seller_domain** | **String** | Seller host, when the marketplace reported one | [optional] |
+| **product_id** | **String** | The marketplace's own identifier for this listing, not a Mencoro id |  |
+| **thumbnail_url** | **String** | Product image the marketplace showed, when it showed one | [optional] |
+| **price** | **Float** | Price as shown at capture time: no tax normalisation, no shipping, no conversion |  |
+| **currency** | **String** | ISO-4217 currency of price. May differ between offers in one snapshot |  |
+| **rating** | **Float** | Star rating shown for the offer, when there was one | [optional] |
+| **rating_votes** | **Integer** | Number of votes behind rating, when the marketplace reported one | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ShoppingOfferResource.new(
+  rank: null,
+  title: null,
+  product_url: null,
+  seller_name: null,
+  seller_domain: null,
+  product_id: null,
+  thumbnail_url: null,
+  price: null,
+  currency: null,
+  rating: null,
+  rating_votes: null
+)
+```
+

data/docs/ShoppingSnapshotResource.md

@@ -0,0 +1,28 @@
+# Mencoro::ShoppingSnapshotResource
+
+## 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 searched |  |
+| **engine** | **String** | The shopping surface that was captured |  |
+| **offers** | [**Array<ShoppingOfferResource>**](ShoppingOfferResource.md) | Offers in rank order |  |
+| **captured_at** | **Time** | When the page was captured, UTC |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ShoppingSnapshotResource.new(
+  id: null,
+  project_id: null,
+  tracked_query_id: null,
+  engine: null,
+  offers: null,
+  captured_at: null
+)
+```
+

data/docs/StartBrandDiscoveryJobRequest.md

@@ -0,0 +1,20 @@
+# Mencoro::StartBrandDiscoveryJobRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **shopping_enabled** | **Boolean** | Adds a shopping discovery pass. Set it only for a project that tracks a shopping engine: on any other project the pass spends provider budget on results nothing will use. | [optional][default to false] |
+| **country** | **String** | ISO 3166-1 alpha-2 country used to localize the discovery. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::StartBrandDiscoveryJobRequest.new(
+  shopping_enabled: null,
+  country: ES
+)
+```
+

data/docs/StartBrandNameSuggestionJobRequest.md

@@ -0,0 +1,24 @@
+# Mencoro::StartBrandNameSuggestionJobRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The display name of the entity to find aliases for. |  |
+| **website_domains** | **Array<String>** | The entity website domains. At least one is required: the web search is grounded on them, and without one the name alone is ambiguous. Duplicates are collapsed, after the entry count has been checked against maxItems. |  |
+| **entered_brand_names** | **Array<String>** | Names already known, excluded from the suggestions. Duplicates are collapsed, after the entry count has been checked against maxItems. | [optional] |
+| **country** | **String** | ISO 3166-1 alpha-2 country used to localize the web search. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::StartBrandNameSuggestionJobRequest.new(
+  name: Acme,
+  website_domains: ["https://acme.com"],
+  entered_brand_names: ["Acme","Acme Inc"],
+  country: ES
+)
+```
+

data/docs/StartClusteringJobRequestData.md

@@ -0,0 +1,22 @@
+# Mencoro::StartClusteringJobRequestData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tracked_query_ids** | **Array<String>** | The tracked queries to cluster. Duplicates are collapsed. |  |
+| **mode** | **String** | fill_gaps groups only tracked queries that belong to no cluster; add_on_top adds the new clusters to whatever each query already has; full_regroup replaces the current clusters with the job's. |  |
+| **restrict_to_existing_clusters** | **Boolean** | When true the job may only use clusters the project already has, and leaves a query ungrouped rather than inventing a name for it. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::StartClusteringJobRequestData.new(
+  tracked_query_ids: null,
+  mode: null,
+  restrict_to_existing_clusters: null
+)
+```
+

data/docs/StartKeywordDiscoveryJobRequest.md

@@ -0,0 +1,24 @@
+# Mencoro::StartKeywordDiscoveryJobRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input** | **String** | Free text describing the keywords or topics to expand. |  |
+| **language** | **String** | Language code. Omit to let the provider detect it from the input. | [optional] |
+| **country** | **String** | ISO 3166-1 alpha-2 country. Omit to let the provider infer it. | [optional] |
+| **exclude_queries** | **Array<String>** | Extra queries to keep out of the suggestions for this run. Duplicates are collapsed, after the entry count has been checked against maxItems. The project tracked queries are excluded whether or not this is sent. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::StartKeywordDiscoveryJobRequest.new(
+  input: crm for plumbers, field service software,
+  language: es,
+  country: ES,
+  exclude_queries: null
+)
+```
+

data/docs/StartPromptDiscoveryJobRequest.md

@@ -0,0 +1,24 @@
+# Mencoro::StartPromptDiscoveryJobRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input** | **String** | Free text describing the topics to turn into prompts. |  |
+| **country** | **String** | ISO 3166-1 alpha-2 country the prompts are asked from. |  |
+| **language** | **String** | Language code. Omit to let the provider detect it from the input. | [optional] |
+| **exclude_queries** | **Array<String>** | Extra queries to keep out of the suggestions for this run. Duplicates are collapsed, after the entry count has been checked against maxItems. The project tracked queries are excluded whether or not this is sent. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::StartPromptDiscoveryJobRequest.new(
+  input: crm for plumbers, field service software,
+  country: ES,
+  language: es,
+  exclude_queries: null
+)
+```
+

data/docs/SubmittedChecksResource.md

@@ -0,0 +1,20 @@
+# Mencoro::SubmittedChecksResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **submitted** | **Integer** | How many tracked queries were submitted. Zero is a valid answer: it means nothing in the project was eligible. |  |
+| **tracked_query_ids** | **Array<String>** | The tracked queries submitted, in the order they were submitted (least recently checked first). Poll these to follow progress. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::SubmittedChecksResource.new(
+  submitted: null,
+  tracked_query_ids: null
+)
+```
+

data/docs/SubscriptionResource.md

@@ -0,0 +1,42 @@
+# Mencoro::SubscriptionResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | Contract state. \"none\" when the organization has never held a subscription. |  |
+| **tier_code** | **String** | Public tier identifier derived from the check budget. | [optional] |
+| **billing_cycle_type** | **String** | Billing interval of the contract. | [optional] |
+| **billing_cycle_anchor** | **Time** | Instant the billing cycle is anchored to. | [optional] |
+| **check_budget** | **Integer** | Checks the current cycle grants. Null when there is no subscription, never a stand-in for zero. | [optional] |
+| **checks_consumed** | **Integer** | Checks consumed so far in the current cycle. Null when there is no subscription; zero means none consumed yet. | [optional] |
+| **checks_available** | **Integer** | Checks still available in the current cycle. Null when there is no subscription; zero means the budget is exhausted. | [optional] |
+| **next_reset_at** | **Time** | When the check budget resets next. | [optional] |
+| **cancelled_at** | **Time** | When the subscription was terminally cancelled. Null while it has not been. | [optional] |
+| **scheduled_to_cancel_at** | **Time** | When a scheduled cancellation takes effect, while the subscription is still running. Null when none is scheduled. | [optional] |
+| **grace_period_ends_at** | **Time** | When paid access ends after a cancellation. Null when the subscription is not cancelled. | [optional] |
+| **deactivation_reason** | **String** | Why the subscription is currently inactive. Null for an active subscription, and meaningless once \"cancelledAt\" is set - the cancellation supersedes it. | [optional] |
+| **is_entitled** | **Boolean** | Whether the organization may use paid features right now: active, or cancelled but still inside its paid grace window. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::SubscriptionResource.new(
+  status: null,
+  tier_code: tier_2000,
+  billing_cycle_type: null,
+  billing_cycle_anchor: null,
+  check_budget: null,
+  checks_consumed: null,
+  checks_available: null,
+  next_reset_at: null,
+  cancelled_at: null,
+  scheduled_to_cancel_at: null,
+  grace_period_ends_at: null,
+  deactivation_reason: null,
+  is_entitled: null
+)
+```
+