mencoro 1.0.0

data/docs/ApplyClusteringJobOutcome.md

@@ -0,0 +1,26 @@
+# Mencoro::ApplyClusteringJobOutcome
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **successful** | [**Array<ApplyClusteringJobOutcomeSuccessfulInner>**](ApplyClusteringJobOutcomeSuccessfulInner.md) | Tracked queries written, each with the cluster ids it ended up with - the resulting state, not the delta. | [optional] |
+| **failed** | [**Array<ApplyClusteringJobOutcomeFailedInner>**](ApplyClusteringJobOutcomeFailedInner.md) | Always present, empty list included: read it rather than inferring success from the status code. | [optional] |
+| **clusters** | [**Array<ApplyClusteringJobOutcomeClustersInner>**](ApplyClusteringJobOutcomeClustersInner.md) | Every cluster the assignments referred to, and whether this call created it. | [optional] |
+| **skipped_clusters** | [**Array<ApplyClusteringJobOutcomeSkippedClustersInner>**](ApplyClusteringJobOutcomeSkippedClustersInner.md) | Proposed names the store cannot hold. A tracked query whose proposed cluster was skipped ends up with fewer clusters than the proposal showed. | [optional] |
+| **unassigned** | **Array<String>** | Tracked queries the job produced no assignment for. Nothing was written for them and they keep the clusters they already had, under every merge mode. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ApplyClusteringJobOutcome.new(
+  successful: null,
+  failed: null,
+  clusters: null,
+  skipped_clusters: null,
+  unassigned: null
+)
+```
+

data/docs/ApplyClusteringJobOutcomeClustersInner.md

@@ -0,0 +1,22 @@
+# Mencoro::ApplyClusteringJobOutcomeClustersInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **created** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ApplyClusteringJobOutcomeClustersInner.new(
+  id: null,
+  name: null,
+  created: null
+)
+```
+

data/docs/ApplyClusteringJobOutcomeFailedInner.md

@@ -0,0 +1,22 @@
+# Mencoro::ApplyClusteringJobOutcomeFailedInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tracked_query_id** | **String** |  | [optional] |
+| **error_code** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ApplyClusteringJobOutcomeFailedInner.new(
+  tracked_query_id: null,
+  error_code: null,
+  error_message: null
+)
+```
+

data/docs/ApplyClusteringJobOutcomeSkippedClustersInner.md

@@ -0,0 +1,20 @@
+# Mencoro::ApplyClusteringJobOutcomeSkippedClustersInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **reason** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ApplyClusteringJobOutcomeSkippedClustersInner.new(
+  name: null,
+  reason: null
+)
+```
+

data/docs/ApplyClusteringJobOutcomeSuccessfulInner.md

@@ -0,0 +1,20 @@
+# Mencoro::ApplyClusteringJobOutcomeSuccessfulInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tracked_query_id** | **String** |  | [optional] |
+| **query_cluster_ids** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ApplyClusteringJobOutcomeSuccessfulInner.new(
+  tracked_query_id: null,
+  query_cluster_ids: null
+)
+```
+

data/docs/AsyncJobResource.md

@@ -0,0 +1,24 @@
+# Mencoro::AsyncJobResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** |  |  |
+| **type** | **String** | What the job produces, and therefore the shape of `result` |  |
+| **status** | **String** | A job in `pending`, `running` or `awaiting_retry` is still in flight; `completed` and `failed` are terminal. |  |
+| **result** | **Object** | The job output, shaped by `type`. Null while the job is still in flight and for a job that failed: it means the result is not known, never that the job produced nothing. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::AsyncJobResource.new(
+  job_id: null,
+  type: null,
+  status: null,
+  result: null
+)
+```
+

data/docs/BatchChangeTrackedQueryCheckFrequencyRequestData.md

@@ -0,0 +1,20 @@
+# Mencoro::BatchChangeTrackedQueryCheckFrequencyRequestData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **Array<String>** | Ids of the tracked queries to change. Duplicates are collapsed. |  |
+| **check_frequency** | **String** | How often each query is checked while it is active. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchChangeTrackedQueryCheckFrequencyRequestData.new(
+  ids: null,
+  check_frequency: null
+)
+```
+

data/docs/BatchChangeTrackedQueryPassesRequestData.md

@@ -0,0 +1,20 @@
+# Mencoro::BatchChangeTrackedQueryPassesRequestData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **Array<String>** | Ids of the tracked queries to change. Duplicates are collapsed. |  |
+| **n_passes** | **Integer** | Passes run per check. Only an AI engine accepts more than one; a non-AI target is reported under \"failed\". |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchChangeTrackedQueryPassesRequestData.new(
+  ids: null,
+  n_passes: null
+)
+```
+

data/docs/BatchCreateQueryClustersOutcome.md

@@ -0,0 +1,20 @@
+# Mencoro::BatchCreateQueryClustersOutcome
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **successful** | [**Array<BatchCreateQueryClustersOutcomeSuccessfulInner>**](BatchCreateQueryClustersOutcomeSuccessfulInner.md) | Clusters created by this call. | [optional] |
+| **failed** | [**Array<BatchCreateQueryClustersOutcomeFailedInner>**](BatchCreateQueryClustersOutcomeFailedInner.md) | Always present, empty list included: read it rather than inferring success from the status code. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchCreateQueryClustersOutcome.new(
+  successful: null,
+  failed: null
+)
+```
+

data/docs/BatchCreateQueryClustersOutcomeFailedInner.md

@@ -0,0 +1,22 @@
+# Mencoro::BatchCreateQueryClustersOutcomeFailedInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **error_code** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchCreateQueryClustersOutcomeFailedInner.new(
+  name: null,
+  error_code: null,
+  error_message: null
+)
+```
+

data/docs/BatchCreateQueryClustersOutcomeSuccessfulInner.md

@@ -0,0 +1,20 @@
+# Mencoro::BatchCreateQueryClustersOutcomeSuccessfulInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchCreateQueryClustersOutcomeSuccessfulInner.new(
+  name: null,
+  id: null
+)
+```
+

data/docs/BatchCreateQueryClustersRequestData.md

@@ -0,0 +1,18 @@
+# Mencoro::BatchCreateQueryClustersRequestData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **names** | **Array<String>** | Cluster names to create, already trimmed and lower-cased on the server. Duplicates are collapsed. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchCreateQueryClustersRequestData.new(
+  names: null
+)
+```
+

data/docs/BatchCreateTrackedQueriesRequestData.md

@@ -0,0 +1,30 @@
+# Mencoro::BatchCreateTrackedQueriesRequestData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query_texts** | **Array<String>** | Prompts or keywords to track. Stored lower-cased with whitespace collapsed and leading list markers removed. |  |
+| **engines** | **Array<String>** | Engines each text is asked in. |  |
+| **countries** | **Array<String>** | ISO 3166-1 alpha-2 countries each text is asked from. |  |
+| **locale** | **String** | ISO 639-1 language the queries are asked in. Omit it to ask the engine without a language. | [optional] |
+| **check_frequency** | **String** | How often every created query is checked. |  |
+| **n_passes** | **Integer** | Passes run per check. Applied to AI-engine combinations only: a non-AI engine is always created with 1, whatever is sent here. |  |
+| **query_cluster_ids** | **Array<String>** | Clusters every created query joins. Must already exist in the project. A combination that is already tracked has these clusters merged into it. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchCreateTrackedQueriesRequestData.new(
+  query_texts: null,
+  engines: null,
+  countries: null,
+  locale: null,
+  check_frequency: null,
+  n_passes: null,
+  query_cluster_ids: null
+)
+```
+

data/docs/BatchCreateTrackedQueriesResultResource.md

@@ -0,0 +1,20 @@
+# Mencoro::BatchCreateTrackedQueriesResultResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **successful** | [**Array<BatchCreateTrackedQueriesResultResourceSuccessfulInner>**](BatchCreateTrackedQueriesResultResourceSuccessfulInner.md) | Tracked queries created by this call, one entry per query text, engine and country combination. | [optional] |
+| **failed** | [**Array<BatchCreateTrackedQueriesResultResourceFailedInner>**](BatchCreateTrackedQueriesResultResourceFailedInner.md) | Always present, empty list included: read it rather than inferring success from the status code. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchCreateTrackedQueriesResultResource.new(
+  successful: null,
+  failed: null
+)
+```
+

data/docs/BatchCreateTrackedQueriesResultResourceFailedInner.md

@@ -0,0 +1,26 @@
+# Mencoro::BatchCreateTrackedQueriesResultResourceFailedInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query_text** | **String** |  | [optional] |
+| **engine** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **error_code** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchCreateTrackedQueriesResultResourceFailedInner.new(
+  query_text: null,
+  engine: null,
+  country: null,
+  error_code: null,
+  error_message: null
+)
+```
+

data/docs/BatchCreateTrackedQueriesResultResourceSuccessfulInner.md

@@ -0,0 +1,24 @@
+# Mencoro::BatchCreateTrackedQueriesResultResourceSuccessfulInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **query_text** | **String** |  | [optional] |
+| **engine** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchCreateTrackedQueriesResultResourceSuccessfulInner.new(
+  id: null,
+  query_text: null,
+  engine: null,
+  country: null
+)
+```
+

data/docs/BatchForceCheckTrackedQueries200Response.md

@@ -0,0 +1,20 @@
+# Mencoro::BatchForceCheckTrackedQueries200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **successful** | [**Array<BatchPauseTrackedQueries200ResponseSuccessfulInner>**](BatchPauseTrackedQueries200ResponseSuccessfulInner.md) | Tracked queries whose check was accepted for submission. Accepted is not completed. | [optional] |
+| **failed** | [**Array<BatchForceCheckTrackedQueries200ResponseFailedInner>**](BatchForceCheckTrackedQueries200ResponseFailedInner.md) | Tracked queries no check was submitted for, each with the reason: check_budget_forecast_exhausted, subscription_not_found, tracked_query_already_paused or tracked_query_not_found. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchForceCheckTrackedQueries200Response.new(
+  successful: null,
+  failed: null
+)
+```
+

data/docs/BatchForceCheckTrackedQueries200ResponseFailedInner.md

@@ -0,0 +1,22 @@
+# Mencoro::BatchForceCheckTrackedQueries200ResponseFailedInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **error_code** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchForceCheckTrackedQueries200ResponseFailedInner.new(
+  id: null,
+  error_code: check_budget_forecast_exhausted,
+  error_message: null
+)
+```
+

data/docs/BatchPauseTrackedQueries200Response.md

@@ -0,0 +1,20 @@
+# Mencoro::BatchPauseTrackedQueries200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **successful** | [**Array<BatchPauseTrackedQueries200ResponseSuccessfulInner>**](BatchPauseTrackedQueries200ResponseSuccessfulInner.md) | Tracked queries that are now paused, including ones that already were. | [optional] |
+| **failed** | [**Array<BatchPauseTrackedQueries200ResponseFailedInner>**](BatchPauseTrackedQueries200ResponseFailedInner.md) | Tracked queries left untouched, each with the domain error code a single-item call would have returned. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchPauseTrackedQueries200Response.new(
+  successful: null,
+  failed: null
+)
+```
+

data/docs/BatchPauseTrackedQueries200ResponseFailedInner.md

@@ -0,0 +1,22 @@
+# Mencoro::BatchPauseTrackedQueries200ResponseFailedInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **error_code** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchPauseTrackedQueries200ResponseFailedInner.new(
+  id: null,
+  error_code: tracked_query_not_found,
+  error_message: null
+)
+```
+

data/docs/BatchPauseTrackedQueries200ResponseSuccessfulInner.md

@@ -0,0 +1,18 @@
+# Mencoro::BatchPauseTrackedQueries200ResponseSuccessfulInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchPauseTrackedQueries200ResponseSuccessfulInner.new(
+  id: null
+)
+```
+

data/docs/BatchResumeTrackedQueries200Response.md

@@ -0,0 +1,20 @@
+# Mencoro::BatchResumeTrackedQueries200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **successful** | [**Array<BatchPauseTrackedQueries200ResponseSuccessfulInner>**](BatchPauseTrackedQueries200ResponseSuccessfulInner.md) | Tracked queries that are now active, including ones that already were. | [optional] |
+| **failed** | [**Array<BatchPauseTrackedQueries200ResponseFailedInner>**](BatchPauseTrackedQueries200ResponseFailedInner.md) | Tracked queries left untouched, each with the domain error code a single-item call would have returned. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchResumeTrackedQueries200Response.new(
+  successful: null,
+  failed: null
+)
+```
+

data/docs/BatchTargetsRequestData.md

@@ -0,0 +1,18 @@
+# Mencoro::BatchTargetsRequestData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **Array<String>** | Ids of the resources to act on. Duplicates are collapsed. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchTargetsRequestData.new(
+  ids: null
+)
+```
+

data/docs/BatchWriteOutcome.md

@@ -0,0 +1,20 @@
+# Mencoro::BatchWriteOutcome
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **successful** | [**Array<BatchPauseTrackedQueries200ResponseSuccessfulInner>**](BatchPauseTrackedQueries200ResponseSuccessfulInner.md) | The resources the operation was applied to. | [optional] |
+| **failed** | [**Array<BatchWriteOutcomeFailedInner>**](BatchWriteOutcomeFailedInner.md) | Always present, empty list included: read it rather than inferring success from the status code. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchWriteOutcome.new(
+  successful: null,
+  failed: null
+)
+```
+

data/docs/BatchWriteOutcomeFailedInner.md

@@ -0,0 +1,22 @@
+# Mencoro::BatchWriteOutcomeFailedInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **error_code** | **String** | The same code a single-item call returns for this problem. | [optional] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BatchWriteOutcomeFailedInner.new(
+  id: null,
+  error_code: null,
+  error_message: null
+)
+```
+

data/docs/BillingApi.md

@@ -0,0 +1,77 @@
+# Mencoro::BillingApi
+
+All URIs are relative to *https://api.mencoro.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_subscription**](BillingApi.md#get_subscription) | **GET** /api/v1/organizations/{organizationId}/subscription | Get the subscription of an organization |
+
+
+## get_subscription
+
+> <SubscriptionResource> get_subscription(organization_id)
+
+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.
+
+### 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::BillingApi.new
+organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get the subscription of an organization
+  result = api_instance.get_subscription(organization_id)
+  p result
+rescue Mencoro::ApiError => e
+  puts "Error when calling BillingApi->get_subscription: #{e}"
+end
+```
+
+#### Using the get_subscription_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriptionResource>, Integer, Hash)> get_subscription_with_http_info(organization_id)
+
+```ruby
+begin
+  # Get the subscription of an organization
+  data, status_code, headers = api_instance.get_subscription_with_http_info(organization_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriptionResource>
+rescue Mencoro::ApiError => e
+  puts "Error when calling BillingApi->get_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+
+### Return type
+
+[**SubscriptionResource**](SubscriptionResource.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BrandProfileResource.md

@@ -0,0 +1,24 @@
+# Mencoro::BrandProfileResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project_id** | **String** | The project this profile belongs to |  |
+| **brand_names** | **Array<String>** | The brand terms a mention in an AI answer is matched against. Empty when none has been configured yet. |  |
+| **website_domains** | **Array<String>** | The domains a cited link or a search result is matched against. Empty when none has been configured yet. |  |
+| **description** | **String** | What the brand does, as generated from its names and domains. Null means it has not been generated yet, which is not the same as an empty description. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::BrandProfileResource.new(
+  project_id: null,
+  brand_names: null,
+  website_domains: null,
+  description: null
+)
+```
+