mencoro 1.0.0

data/docs/PreviewOrganizationOperation200Response.md

@@ -0,0 +1,34 @@
+# Mencoro::PreviewOrganizationOperation200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** |  | [optional] |
+| **organization** | [**PreviewOrganizationOperation200ResponseOrganization**](PreviewOrganizationOperation200ResponseOrganization.md) |  | [optional] |
+| **resource_id** | **String** | The member or invitation the action acts on; null for the actions that name none. | [optional] |
+| **changes** | [**Array<OperationEffect>**](OperationEffect.md) | What the operation itself will do. | [optional] |
+| **side_effects** | [**Array<OperationEffect>**](OperationEffect.md) | What else it will cause, with the records it will touch in `targets`. | [optional] |
+| **warnings** | [**Array<OperationEffect>**](OperationEffect.md) | How the system behaves around it. Not part of the effects digest: rewording one does not invalidate a confirmation. | [optional] |
+| **conditions** | [**Array<OperationEffect>**](OperationEffect.md) | What must hold for the operation to be allowed. | [optional] |
+| **actor** | **Object** | Who the confirmation is issued to: the user and the API key. It is valid for that pair only. | [optional] |
+| **confirmation** | **Object** | The token to send back, the header to send it in, and how long it lives. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::PreviewOrganizationOperation200Response.new(
+  action: null,
+  organization: null,
+  resource_id: null,
+  changes: null,
+  side_effects: null,
+  warnings: null,
+  conditions: null,
+  actor: null,
+  confirmation: null
+)
+```
+

data/docs/PreviewOrganizationOperation200ResponseOrganization.md

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

data/docs/PreviewOrganizationOperationRequest.md

@@ -0,0 +1,24 @@
+# Mencoro::PreviewOrganizationOperationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** |  | [optional] |
+| **organization_id** | **String** | Required for every action except createOrganization. | [optional] |
+| **resource_id** | **String** | The member or invitation the action acts on, for the actions that name one. | [optional] |
+| **payload** | **Object** | The body you intend to send to the operation itself. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::PreviewOrganizationOperationRequest.new(
+  action: null,
+  organization_id: null,
+  resource_id: null,
+  payload: null
+)
+```
+

data/docs/ProjectDetailResource.md

@@ -0,0 +1,32 @@
+# Mencoro::ProjectDetailResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **organization_id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **status** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **website_domains** | **Array<String>** | Domains the project is monitored for. Empty when the project has no brand monitoring profile yet. |  |
+| **brand_names** | **Array<String>** | Brand names matched in AI answers and search results. Empty when the project has no brand monitoring profile yet. |  |
+| **competitors** | [**Array<ProjectDetailResourceCompetitorsInner>**](ProjectDetailResourceCompetitorsInner.md) | Competitors this project is measured against. Empty when none are configured. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ProjectDetailResource.new(
+  id: null,
+  organization_id: null,
+  name: null,
+  status: null,
+  created_at: null,
+  website_domains: null,
+  brand_names: null,
+  competitors: null
+)
+```
+

data/docs/ProjectDetailResourceCompetitorsInner.md

@@ -0,0 +1,24 @@
+# Mencoro::ProjectDetailResourceCompetitorsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **website_domains** | **Array<String>** |  | [optional] |
+| **brand_names** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ProjectDetailResourceCompetitorsInner.new(
+  id: null,
+  name: null,
+  website_domains: null,
+  brand_names: null
+)
+```
+

data/docs/ProjectResource.md

@@ -0,0 +1,50 @@
+# Mencoro::ProjectResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **status** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **tracked_query_count** | **Integer** | Number of tracked queries in the project |  |
+| **avg_serp_position** | **Float** | Average position in traditional search results. Null when unknown. | [optional] |
+| **avg_shopping_position** | **Float** | Average position in shopping results. Null when unknown. | [optional] |
+| **avg_mention_position** | **Float** | Average position of the brand mention inside AI answers. Null when unknown. | [optional] |
+| **avg_link_position** | **Float** | Average position of a cited link to the brand. Null when unknown. | [optional] |
+| **mention_rate** | **Integer** | Share of checks where the brand was mentioned. Null when unknown. | [optional] |
+| **serp_rate** | **Integer** |  | [optional] |
+| **shopping_rate** | **Integer** |  | [optional] |
+| **positivity_index** | **Integer** | Sentiment balance of the brand's mentions. Null when unknown. | [optional] |
+| **share_of_voice** | **Float** | Share of voice against the tracked competitors. Null when unknown. | [optional] |
+| **serp_position_stability** | **Float** |  | [optional] |
+| **shopping_position_stability** | **Float** |  | [optional] |
+| **last_rank_detected_at** | **Time** | When a rank was last detected for this project. | [optional] |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ProjectResource.new(
+  id: null,
+  name: null,
+  status: null,
+  created_at: null,
+  tracked_query_count: null,
+  avg_serp_position: null,
+  avg_shopping_position: null,
+  avg_mention_position: null,
+  avg_link_position: null,
+  mention_rate: null,
+  serp_rate: null,
+  shopping_rate: null,
+  positivity_index: null,
+  share_of_voice: null,
+  serp_position_stability: null,
+  shopping_position_stability: null,
+  last_rank_detected_at: null
+)
+```
+

data/docs/ProjectedMonthlyChecksResource.md

@@ -0,0 +1,20 @@
+# Mencoro::ProjectedMonthlyChecksResource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **projected_monthly_checks** | **Integer** | Checks a month of the current configuration would consume: for each ACTIVE tracked query, its runs per month (daily 30, weekly 4, monthly 1) multiplied by its nPasses, summed. Never null. |  |
+| **active_tracked_query_count** | **Integer** | Active tracked queries the projection was summed over, across every project of the organization, archived projects included. Paused queries are excluded from both figures. Never null. |  |
+
+## Example
+
+```ruby
+require 'mencoro'
+
+instance = Mencoro::ProjectedMonthlyChecksResource.new(
+  projected_monthly_checks: 720,
+  active_tracked_query_count: 24
+)
+```
+