mencoro 1.0.1 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (260) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +41 -5
  3. data/docs/AccountApi.md +1 -1
  4. data/docs/AnalyticsApi.md +96 -86
  5. data/docs/AsyncJobResource.md +3 -1
  6. data/docs/AsyncJobResourceError.md +20 -0
  7. data/docs/BillingApi.md +1 -1
  8. data/docs/CitedSourceRow.md +32 -0
  9. data/docs/CitedSourcesResponse.md +20 -0
  10. data/docs/ClusterBreakdownRow.md +82 -0
  11. data/docs/ClustersApi.md +74 -0
  12. data/docs/CompetitorCoOccurrenceResponse.md +18 -0
  13. data/docs/CompetitorCoOccurrenceRow.md +36 -0
  14. data/docs/CompetitorShareOfVoice.md +20 -0
  15. data/docs/CreateInvitation201Response.md +4 -0
  16. data/docs/CreateInvitationRequest.md +3 -1
  17. data/docs/CreateInvitationRequestProjectAccess.md +20 -0
  18. data/docs/DiscoveryApi.md +1 -1
  19. data/docs/GetMeStats200ResponseProjects.md +1 -1
  20. data/docs/GetOrganizationOverview200ResponseAggregate.md +1 -1
  21. data/docs/GetOrganizationOverview200ResponseProjectsInner.md +8 -2
  22. data/docs/GetOrganizationStats200ResponseInvitations.md +1 -1
  23. data/docs/GetOrganizationStats200ResponseMembers.md +1 -1
  24. data/docs/GetOrganizationStats200ResponseProjects.md +1 -1
  25. data/docs/InvitationResource.md +5 -1
  26. data/docs/JobsApi.md +1 -1
  27. data/docs/KeywordListingResource.md +12 -10
  28. data/docs/KeywordListingResourceCarriedPositions.md +24 -0
  29. data/docs/KeywordListingResourceCarriedPositionsSerp.md +20 -0
  30. data/docs/ListProjects200Response.md +1 -1
  31. data/docs/MemberResource.md +5 -1
  32. data/docs/MembersApi.md +78 -0
  33. data/docs/MentionMatchResource.md +44 -0
  34. data/docs/MentionSampleResponse.md +46 -0
  35. data/docs/MentionTypeCounts.md +26 -0
  36. data/docs/OrganizationsApi.md +3 -3
  37. data/docs/PerCompetitorSentiment.md +30 -0
  38. data/docs/PerEngineSentiment.md +28 -0
  39. data/docs/PerEntityMetrics.md +32 -0
  40. data/docs/PositionDistributionBucket.md +20 -0
  41. data/docs/ProjectMentionMixResponse.md +22 -0
  42. data/docs/ProjectMentionSamplesResponse.md +20 -0
  43. data/docs/ProjectRankTrackingClusterBreakdown.md +20 -0
  44. data/docs/ProjectRankTrackingStats.md +96 -0
  45. data/docs/ProjectRankTrackingTimeSeries.md +20 -0
  46. data/docs/ProjectSentimentBreakdown.md +20 -0
  47. data/docs/ProjectedMonthlyChecksResource.md +2 -2
  48. data/docs/ProjectsApi.md +76 -2
  49. data/docs/SearchTrackedQueryMentionMatches200Response.md +20 -0
  50. data/docs/SearchTrackedQuerySerpMatches200Response.md +20 -0
  51. data/docs/SerpMatchResource.md +30 -0
  52. data/docs/SetMemberProjectAccessRequest.md +20 -0
  53. data/docs/SubscriptionResource.md +1 -1
  54. data/docs/TimeSeriesPoint.md +22 -0
  55. data/docs/TrackedQueriesApi.md +175 -3
  56. data/docs/TrackedQueryCountResource.md +1 -1
  57. data/docs/TrackedQueryMoverRow.md +58 -0
  58. data/docs/TrackedQueryMoversResponse.md +22 -0
  59. data/docs/TrackedQueryRankTrackingTimeSeries.md +20 -0
  60. data/docs/TrackedQueryUsageResource.md +1 -1
  61. data/lib/mencoro/api/account_api.rb +3 -3
  62. data/lib/mencoro/api/analytics_api.rb +103 -85
  63. data/lib/mencoro/api/billing_api.rb +3 -3
  64. data/lib/mencoro/api/captures_api.rb +2 -2
  65. data/lib/mencoro/api/clusters_api.rb +76 -1
  66. data/lib/mencoro/api/discovery_api.rb +3 -3
  67. data/lib/mencoro/api/invitations_api.rb +1 -1
  68. data/lib/mencoro/api/jobs_api.rb +3 -3
  69. data/lib/mencoro/api/members_api.rb +95 -1
  70. data/lib/mencoro/api/organization_operations_api.rb +1 -1
  71. data/lib/mencoro/api/organizations_api.rb +7 -7
  72. data/lib/mencoro/api/projects_api.rb +80 -5
  73. data/lib/mencoro/api/tracked_queries_api.rb +220 -8
  74. data/lib/mencoro/api_client.rb +2 -2
  75. data/lib/mencoro/api_error.rb +1 -1
  76. data/lib/mencoro/api_model_base.rb +1 -1
  77. data/lib/mencoro/configuration.rb +1 -1
  78. data/lib/mencoro/models/accepted_job_resource.rb +1 -1
  79. data/lib/mencoro/models/ai_response_report_resource.rb +1 -1
  80. data/lib/mencoro/models/ai_response_resource.rb +1 -1
  81. data/lib/mencoro/models/apply_clustering_job_outcome.rb +1 -1
  82. data/lib/mencoro/models/apply_clustering_job_outcome_clusters_inner.rb +1 -1
  83. data/lib/mencoro/models/apply_clustering_job_outcome_failed_inner.rb +1 -1
  84. data/lib/mencoro/models/apply_clustering_job_outcome_skipped_clusters_inner.rb +1 -1
  85. data/lib/mencoro/models/apply_clustering_job_outcome_successful_inner.rb +1 -1
  86. data/lib/mencoro/models/async_job_resource.rb +17 -7
  87. data/lib/mencoro/models/async_job_resource_error.rb +217 -0
  88. data/lib/mencoro/models/batch_change_tracked_query_check_frequency_request_data.rb +1 -1
  89. data/lib/mencoro/models/batch_change_tracked_query_passes_request_data.rb +1 -1
  90. data/lib/mencoro/models/batch_create_query_clusters_outcome.rb +1 -1
  91. data/lib/mencoro/models/batch_create_query_clusters_outcome_failed_inner.rb +1 -1
  92. data/lib/mencoro/models/batch_create_query_clusters_outcome_successful_inner.rb +1 -1
  93. data/lib/mencoro/models/batch_create_query_clusters_request_data.rb +1 -1
  94. data/lib/mencoro/models/batch_create_tracked_queries_request_data.rb +1 -1
  95. data/lib/mencoro/models/batch_create_tracked_queries_result_resource.rb +1 -1
  96. data/lib/mencoro/models/batch_create_tracked_queries_result_resource_failed_inner.rb +1 -1
  97. data/lib/mencoro/models/batch_create_tracked_queries_result_resource_successful_inner.rb +1 -1
  98. data/lib/mencoro/models/batch_force_check_tracked_queries200_response.rb +1 -1
  99. data/lib/mencoro/models/batch_force_check_tracked_queries200_response_failed_inner.rb +1 -1
  100. data/lib/mencoro/models/batch_pause_tracked_queries200_response.rb +1 -1
  101. data/lib/mencoro/models/batch_pause_tracked_queries200_response_failed_inner.rb +1 -1
  102. data/lib/mencoro/models/batch_pause_tracked_queries200_response_successful_inner.rb +1 -1
  103. data/lib/mencoro/models/batch_resume_tracked_queries200_response.rb +1 -1
  104. data/lib/mencoro/models/batch_targets_request_data.rb +1 -1
  105. data/lib/mencoro/models/batch_write_outcome.rb +1 -1
  106. data/lib/mencoro/models/batch_write_outcome_failed_inner.rb +1 -1
  107. data/lib/mencoro/models/brand_profile_resource.rb +1 -1
  108. data/lib/mencoro/models/bulk_add_clusters_to_tracked_queries200_response.rb +1 -1
  109. data/lib/mencoro/models/bulk_add_clusters_to_tracked_queries_request.rb +1 -1
  110. data/lib/mencoro/models/bulk_remove_clusters_from_tracked_queries200_response.rb +1 -1
  111. data/lib/mencoro/models/bulk_remove_clusters_from_tracked_queries_request.rb +1 -1
  112. data/lib/mencoro/models/change_member_role_request.rb +1 -1
  113. data/lib/mencoro/models/change_tracked_query_check_frequency_request_data.rb +1 -1
  114. data/lib/mencoro/models/change_tracked_query_passes_request_data.rb +1 -1
  115. data/lib/mencoro/models/citation_resource.rb +1 -1
  116. data/lib/mencoro/models/cited_source_row.rb +298 -0
  117. data/lib/mencoro/models/cited_sources_response.rb +192 -0
  118. data/lib/mencoro/models/cluster_breakdown_row.rb +580 -0
  119. data/lib/mencoro/models/cluster_membership_request_data.rb +1 -1
  120. data/lib/mencoro/models/competitor_co_occurrence_response.rb +166 -0
  121. data/lib/mencoro/models/competitor_co_occurrence_row.rb +318 -0
  122. data/lib/mencoro/models/competitor_resource.rb +1 -1
  123. data/lib/mencoro/models/competitor_share_of_voice.rb +174 -0
  124. data/lib/mencoro/models/create_competitor_request.rb +1 -1
  125. data/lib/mencoro/models/create_invitation200_response.rb +1 -1
  126. data/lib/mencoro/models/create_invitation201_response.rb +60 -2
  127. data/lib/mencoro/models/create_invitation_request.rb +15 -5
  128. data/lib/mencoro/models/create_invitation_request_project_access.rb +201 -0
  129. data/lib/mencoro/models/create_organization201_response.rb +1 -1
  130. data/lib/mencoro/models/create_organization_request.rb +1 -1
  131. data/lib/mencoro/models/create_project_request.rb +1 -1
  132. data/lib/mencoro/models/create_project_request_competitors_inner.rb +1 -1
  133. data/lib/mencoro/models/create_query_cluster409_response.rb +1 -1
  134. data/lib/mencoro/models/create_query_cluster_request.rb +1 -1
  135. data/lib/mencoro/models/delete_query_cluster200_response.rb +1 -1
  136. data/lib/mencoro/models/entitlements_resource.rb +1 -1
  137. data/lib/mencoro/models/get_available_filters200_response.rb +1 -1
  138. data/lib/mencoro/models/get_available_filters200_response_clusters_inner.rb +1 -1
  139. data/lib/mencoro/models/get_me_stats200_response.rb +1 -1
  140. data/lib/mencoro/models/get_me_stats200_response_organizations.rb +1 -1
  141. data/lib/mencoro/models/get_me_stats200_response_projects.rb +2 -2
  142. data/lib/mencoro/models/get_membership_stats200_response.rb +1 -1
  143. data/lib/mencoro/models/get_mention_samples400_response.rb +1 -1
  144. data/lib/mencoro/models/get_mention_samples400_response_details_value_inner.rb +1 -1
  145. data/lib/mencoro/models/get_metric_glossary200_response.rb +1 -1
  146. data/lib/mencoro/models/get_metric_glossary200_response_metrics_inner.rb +1 -1
  147. data/lib/mencoro/models/get_organization_overview200_response.rb +1 -1
  148. data/lib/mencoro/models/get_organization_overview200_response_aggregate.rb +2 -2
  149. data/lib/mencoro/models/get_organization_overview200_response_projects_inner.rb +34 -3
  150. data/lib/mencoro/models/get_organization_stats200_response.rb +1 -1
  151. data/lib/mencoro/models/get_organization_stats200_response_invitations.rb +4 -7
  152. data/lib/mencoro/models/get_organization_stats200_response_members.rb +4 -7
  153. data/lib/mencoro/models/get_organization_stats200_response_projects.rb +2 -2
  154. data/lib/mencoro/models/get_share_of_voice_formula200_response.rb +1 -1
  155. data/lib/mencoro/models/get_tracking_coverage200_response.rb +1 -1
  156. data/lib/mencoro/models/get_tracking_coverage200_response_sample_inner.rb +1 -1
  157. data/lib/mencoro/models/invitation_resource.rb +64 -6
  158. data/lib/mencoro/models/keyword_listing_resource.rb +40 -14
  159. data/lib/mencoro/models/keyword_listing_resource_carried_positions.rb +187 -0
  160. data/lib/mencoro/models/keyword_listing_resource_carried_positions_serp.rb +192 -0
  161. data/lib/mencoro/models/keyword_listing_resource_mention_type_counts.rb +1 -1
  162. data/lib/mencoro/models/list_ai_responses200_response.rb +1 -1
  163. data/lib/mencoro/models/list_competitors200_response.rb +1 -1
  164. data/lib/mencoro/models/list_invitations200_response.rb +1 -1
  165. data/lib/mencoro/models/list_keyword_listings200_response.rb +1 -1
  166. data/lib/mencoro/models/list_members200_response.rb +1 -1
  167. data/lib/mencoro/models/list_organizations200_response.rb +1 -1
  168. data/lib/mencoro/models/list_projects200_response.rb +2 -2
  169. data/lib/mencoro/models/list_query_clusters200_response.rb +1 -1
  170. data/lib/mencoro/models/list_search_snapshots200_response.rb +1 -1
  171. data/lib/mencoro/models/list_shopping_snapshots200_response.rb +1 -1
  172. data/lib/mencoro/models/me_resource.rb +1 -1
  173. data/lib/mencoro/models/member_resource.rb +63 -5
  174. data/lib/mencoro/models/mention_match_resource.rb +432 -0
  175. data/lib/mencoro/models/mention_sample_response.rb +450 -0
  176. data/lib/mencoro/models/mention_type_counts.rb +268 -0
  177. data/lib/mencoro/models/operation_effect.rb +1 -1
  178. data/lib/mencoro/models/organization_resource.rb +1 -1
  179. data/lib/mencoro/models/per_competitor_sentiment.rb +304 -0
  180. data/lib/mencoro/models/per_engine_sentiment.rb +278 -0
  181. data/lib/mencoro/models/per_entity_metrics.rb +218 -0
  182. data/lib/mencoro/models/position_distribution_bucket.rb +190 -0
  183. data/lib/mencoro/models/preview_organization_operation200_response.rb +1 -1
  184. data/lib/mencoro/models/preview_organization_operation200_response_organization.rb +1 -1
  185. data/lib/mencoro/models/preview_organization_operation_request.rb +3 -3
  186. data/lib/mencoro/models/project_detail_resource.rb +1 -1
  187. data/lib/mencoro/models/project_detail_resource_competitors_inner.rb +1 -1
  188. data/lib/mencoro/models/project_mention_mix_response.rb +222 -0
  189. data/lib/mencoro/models/project_mention_samples_response.rb +192 -0
  190. data/lib/mencoro/models/project_rank_tracking_cluster_breakdown.rb +176 -0
  191. data/lib/mencoro/models/project_rank_tracking_stats.rb +718 -0
  192. data/lib/mencoro/models/project_rank_tracking_time_series.rb +176 -0
  193. data/lib/mencoro/models/project_resource.rb +1 -1
  194. data/lib/mencoro/models/project_sentiment_breakdown.rb +194 -0
  195. data/lib/mencoro/models/projected_monthly_checks_resource.rb +3 -3
  196. data/lib/mencoro/models/query_cluster_resource.rb +1 -1
  197. data/lib/mencoro/models/report_ai_response_request.rb +1 -1
  198. data/lib/mencoro/models/search_result_resource.rb +1 -1
  199. data/lib/mencoro/models/search_snapshot_resource.rb +1 -1
  200. data/lib/mencoro/models/search_tracked_queries200_response.rb +1 -1
  201. data/lib/mencoro/models/search_tracked_query_mention_matches200_response.rb +158 -0
  202. data/lib/mencoro/models/search_tracked_query_serp_matches200_response.rb +158 -0
  203. data/lib/mencoro/models/serp_match_resource.rb +314 -0
  204. data/lib/mencoro/models/set_member_project_access_request.rb +200 -0
  205. data/lib/mencoro/models/shopping_offer_resource.rb +1 -1
  206. data/lib/mencoro/models/shopping_snapshot_resource.rb +1 -1
  207. data/lib/mencoro/models/start_brand_discovery_job_request.rb +1 -1
  208. data/lib/mencoro/models/start_brand_name_suggestion_job_request.rb +1 -1
  209. data/lib/mencoro/models/start_clustering_job_request_data.rb +1 -1
  210. data/lib/mencoro/models/start_keyword_discovery_job_request.rb +1 -1
  211. data/lib/mencoro/models/start_prompt_discovery_job_request.rb +1 -1
  212. data/lib/mencoro/models/submitted_checks_resource.rb +1 -1
  213. data/lib/mencoro/models/subscription_resource.rb +3 -3
  214. data/lib/mencoro/models/time_series_point.rb +218 -0
  215. data/lib/mencoro/models/tracked_query_count_resource.rb +3 -3
  216. data/lib/mencoro/models/tracked_query_detail_resource.rb +3 -3
  217. data/lib/mencoro/models/tracked_query_mover_row.rb +492 -0
  218. data/lib/mencoro/models/tracked_query_movers_response.rb +202 -0
  219. data/lib/mencoro/models/tracked_query_rank_tracking_time_series.rb +176 -0
  220. data/lib/mencoro/models/tracked_query_resource.rb +3 -3
  221. data/lib/mencoro/models/tracked_query_usage_resource.rb +2 -2
  222. data/lib/mencoro/models/update_organization_request.rb +1 -1
  223. data/lib/mencoro/models/update_project_brand_profile_request.rb +1 -1
  224. data/lib/mencoro/models/update_project_request.rb +1 -1
  225. data/lib/mencoro/version.rb +2 -2
  226. data/lib/mencoro.rb +32 -1
  227. data/mencoro.gemspec +2 -2
  228. data/spec/models/async_job_resource_error_spec.rb +46 -0
  229. data/spec/models/cited_source_row_spec.rb +78 -0
  230. data/spec/models/cited_sources_response_spec.rb +42 -0
  231. data/spec/models/cluster_breakdown_row_spec.rb +228 -0
  232. data/spec/models/competitor_co_occurrence_response_spec.rb +36 -0
  233. data/spec/models/competitor_co_occurrence_row_spec.rb +90 -0
  234. data/spec/models/competitor_share_of_voice_spec.rb +42 -0
  235. data/spec/models/create_invitation_request_project_access_spec.rb +46 -0
  236. data/spec/models/keyword_listing_resource_carried_positions_serp_spec.rb +42 -0
  237. data/spec/models/keyword_listing_resource_carried_positions_spec.rb +54 -0
  238. data/spec/models/mention_match_resource_spec.rb +114 -0
  239. data/spec/models/mention_sample_response_spec.rb +114 -0
  240. data/spec/models/mention_type_counts_spec.rb +60 -0
  241. data/spec/models/per_competitor_sentiment_spec.rb +72 -0
  242. data/spec/models/per_engine_sentiment_spec.rb +66 -0
  243. data/spec/models/per_entity_metrics_spec.rb +78 -0
  244. data/spec/models/position_distribution_bucket_spec.rb +42 -0
  245. data/spec/models/project_mention_mix_response_spec.rb +48 -0
  246. data/spec/models/project_mention_samples_response_spec.rb +42 -0
  247. data/spec/models/project_rank_tracking_cluster_breakdown_spec.rb +42 -0
  248. data/spec/models/project_rank_tracking_stats_spec.rb +270 -0
  249. data/spec/models/project_rank_tracking_time_series_spec.rb +42 -0
  250. data/spec/models/project_sentiment_breakdown_spec.rb +42 -0
  251. data/spec/models/search_tracked_query_mention_matches200_response_spec.rb +42 -0
  252. data/spec/models/search_tracked_query_serp_matches200_response_spec.rb +42 -0
  253. data/spec/models/serp_match_resource_spec.rb +72 -0
  254. data/spec/models/set_member_project_access_request_spec.rb +46 -0
  255. data/spec/models/time_series_point_spec.rb +48 -0
  256. data/spec/models/tracked_query_mover_row_spec.rb +156 -0
  257. data/spec/models/tracked_query_movers_response_spec.rb +48 -0
  258. data/spec/models/tracked_query_rank_tracking_time_series_spec.rb +42 -0
  259. data/spec/spec_helper.rb +1 -1
  260. metadata +235 -108
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e5fc151317a6b4621e289f0fe975c150fade504094c947751105c1cdf29b81fb
4
- data.tar.gz: 8a720dc887d084550fb84fcd3b102ca36ca2f8fd9384a65f84e73f01c0017bed
3
+ metadata.gz: 5e52f30fc45aad6a908e7ded0354336d26accdb0bdb9e4dfd26ecc3e3933768d
4
+ data.tar.gz: b9a8f56554bce8db71a813f34a115c3a840d33c772d0451a26ea81cee8eace83
5
5
  SHA512:
6
- metadata.gz: a6c07c7ac17eb8bbd7ac7560f8aafebca0e80e1f1782a3ff08a01b84e529ef57212825d37b28f41b18c2bc0dd31a4cbcda45232dc978f8fcbe0c5b62683c420e
7
- data.tar.gz: dc808af3a025f836f7ed3fd376e928cd09514608e0a33227b938c900a2846b4da20bcfcedb90332a887c445dc8a532dc6a456bba5891e3c6b65da904f5ffb1ad
6
+ metadata.gz: 9bffcafd60c9b93a0e08c7a8c08719273165674177394b4c80c9ca334bf096686ef4a5b58348ad9707b4ecdfe0462ef99584caefd53af83996aed3b24e0f2a8c
7
+ data.tar.gz: 2bc6e0d13f7bd09222d78a8d4014e95f1188087ddf04244efe79d1f043eb8211c00881a008a620fdda22d93f5988b87e68c06d5e7b6b1a9c02a482216e7c558b
data/README.md CHANGED
@@ -2,12 +2,12 @@
2
2
 
3
3
  Mencoro - the Ruby gem for the Mencoro API
4
4
 
5
- Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
5
+ Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
6
6
 
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 1.0.0
10
- - Package version: 1.0.1
10
+ - Package version: 2.0.1
11
11
  - Generator version: 7.24.0
12
12
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
13
  For more information, please visit [https://mencoro.com/contact/](https://mencoro.com/contact/)
@@ -25,16 +25,16 @@ gem build mencoro.gemspec
25
25
  Then either install the gem locally:
26
26
 
27
27
  ```shell
28
- gem install ./mencoro-1.0.1.gem
28
+ gem install ./mencoro-2.0.1.gem
29
29
  ```
30
30
 
31
- (for development, run `gem install --dev ./mencoro-1.0.1.gem` to install the development dependencies)
31
+ (for development, run `gem install --dev ./mencoro-2.0.1.gem` to install the development dependencies)
32
32
 
33
33
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
34
34
 
35
35
  Finally add this to the Gemfile:
36
36
 
37
- gem 'mencoro', '~> 1.0.1'
37
+ gem 'mencoro', '~> 2.0.1'
38
38
 
39
39
  ### Install from Git
40
40
 
@@ -112,6 +112,7 @@ Class | Method | HTTP request | Description
112
112
  *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
113
113
  *Mencoro::ClustersApi* | [**create_query_cluster**](docs/ClustersApi.md#create_query_cluster) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters | Create a keyword cluster
114
114
  *Mencoro::ClustersApi* | [**delete_query_cluster**](docs/ClustersApi.md#delete_query_cluster) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId} | Delete a keyword cluster
115
+ *Mencoro::ClustersApi* | [**get_query_cluster**](docs/ClustersApi.md#get_query_cluster) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId} | Get one of a project's keyword clusters
115
116
  *Mencoro::ClustersApi* | [**rename_query_cluster**](docs/ClustersApi.md#rename_query_cluster) | **PATCH** /api/v1/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId} | Rename a keyword cluster
116
117
  *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
117
118
  *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
@@ -126,6 +127,7 @@ Class | Method | HTTP request | Description
126
127
  *Mencoro::MembersApi* | [**get_member**](docs/MembersApi.md#get_member) | **GET** /api/v1/organizations/{organizationId}/members/{memberId} | Get one organization membership
127
128
  *Mencoro::MembersApi* | [**list_members**](docs/MembersApi.md#list_members) | **GET** /api/v1/organizations/{organizationId}/members | List an organization's members
128
129
  *Mencoro::MembersApi* | [**reactivate_member**](docs/MembersApi.md#reactivate_member) | **POST** /api/v1/organizations/{organizationId}/members/{memberId}/reactivate | Reactivate a suspended member
130
+ *Mencoro::MembersApi* | [**set_member_project_access**](docs/MembersApi.md#set_member_project_access) | **PUT** /api/v1/organizations/{organizationId}/members/{memberId}/project-access | Set which projects a member reaches
129
131
  *Mencoro::MembersApi* | [**suspend_member**](docs/MembersApi.md#suspend_member) | **POST** /api/v1/organizations/{organizationId}/members/{memberId}/suspend | Suspend a member
130
132
  *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
131
133
  *Mencoro::OrganizationsApi* | [**archive_organization**](docs/OrganizationsApi.md#archive_organization) | **POST** /api/v1/organizations/{organizationId}/archive | Archive an organization
@@ -144,6 +146,7 @@ Class | Method | HTTP request | Description
144
146
  *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
145
147
  *Mencoro::ProjectsApi* | [**delete_competitor**](docs/ProjectsApi.md#delete_competitor) | **DELETE** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/{competitorId} | Remove a competitor from a project
146
148
  *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
149
+ *Mencoro::ProjectsApi* | [**get_competitor**](docs/ProjectsApi.md#get_competitor) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors/{competitorId} | Get one of a project's competitors
147
150
  *Mencoro::ProjectsApi* | [**get_project**](docs/ProjectsApi.md#get_project) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId} | Get a project and its brand monitoring configuration
148
151
  *Mencoro::ProjectsApi* | [**list_competitors**](docs/ProjectsApi.md#list_competitors) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/competitors | List the competitors tracked by a project
149
152
  *Mencoro::ProjectsApi* | [**list_projects**](docs/ProjectsApi.md#list_projects) | **GET** /api/v1/organizations/{organizationId}/projects | List an organization's projects
@@ -172,6 +175,8 @@ Class | Method | HTTP request | Description
172
175
  *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
173
176
  *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
174
177
  *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
178
+ *Mencoro::TrackedQueriesApi* | [**search_tracked_query_mention_matches**](docs/TrackedQueriesApi.md#search_tracked_query_mention_matches) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/mention-matches | List stored mention matches of a tracked query
179
+ *Mencoro::TrackedQueriesApi* | [**search_tracked_query_serp_matches**](docs/TrackedQueriesApi.md#search_tracked_query_serp_matches) | **GET** /api/v1/organizations/{organizationId}/projects/{projectId}/tracked-queries/{trackedQueryId}/serp-matches | List stored serp matches of a tracked query
175
180
 
176
181
 
177
182
  ## Documentation for Models
@@ -185,6 +190,7 @@ Class | Method | HTTP request | Description
185
190
  - [Mencoro::ApplyClusteringJobOutcomeSkippedClustersInner](docs/ApplyClusteringJobOutcomeSkippedClustersInner.md)
186
191
  - [Mencoro::ApplyClusteringJobOutcomeSuccessfulInner](docs/ApplyClusteringJobOutcomeSuccessfulInner.md)
187
192
  - [Mencoro::AsyncJobResource](docs/AsyncJobResource.md)
193
+ - [Mencoro::AsyncJobResourceError](docs/AsyncJobResourceError.md)
188
194
  - [Mencoro::BatchChangeTrackedQueryCheckFrequencyRequestData](docs/BatchChangeTrackedQueryCheckFrequencyRequestData.md)
189
195
  - [Mencoro::BatchChangeTrackedQueryPassesRequestData](docs/BatchChangeTrackedQueryPassesRequestData.md)
190
196
  - [Mencoro::BatchCreateQueryClustersOutcome](docs/BatchCreateQueryClustersOutcome.md)
@@ -213,12 +219,19 @@ Class | Method | HTTP request | Description
213
219
  - [Mencoro::ChangeTrackedQueryCheckFrequencyRequestData](docs/ChangeTrackedQueryCheckFrequencyRequestData.md)
214
220
  - [Mencoro::ChangeTrackedQueryPassesRequestData](docs/ChangeTrackedQueryPassesRequestData.md)
215
221
  - [Mencoro::CitationResource](docs/CitationResource.md)
222
+ - [Mencoro::CitedSourceRow](docs/CitedSourceRow.md)
223
+ - [Mencoro::CitedSourcesResponse](docs/CitedSourcesResponse.md)
224
+ - [Mencoro::ClusterBreakdownRow](docs/ClusterBreakdownRow.md)
216
225
  - [Mencoro::ClusterMembershipRequestData](docs/ClusterMembershipRequestData.md)
226
+ - [Mencoro::CompetitorCoOccurrenceResponse](docs/CompetitorCoOccurrenceResponse.md)
227
+ - [Mencoro::CompetitorCoOccurrenceRow](docs/CompetitorCoOccurrenceRow.md)
217
228
  - [Mencoro::CompetitorResource](docs/CompetitorResource.md)
229
+ - [Mencoro::CompetitorShareOfVoice](docs/CompetitorShareOfVoice.md)
218
230
  - [Mencoro::CreateCompetitorRequest](docs/CreateCompetitorRequest.md)
219
231
  - [Mencoro::CreateInvitation200Response](docs/CreateInvitation200Response.md)
220
232
  - [Mencoro::CreateInvitation201Response](docs/CreateInvitation201Response.md)
221
233
  - [Mencoro::CreateInvitationRequest](docs/CreateInvitationRequest.md)
234
+ - [Mencoro::CreateInvitationRequestProjectAccess](docs/CreateInvitationRequestProjectAccess.md)
222
235
  - [Mencoro::CreateOrganization201Response](docs/CreateOrganization201Response.md)
223
236
  - [Mencoro::CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
224
237
  - [Mencoro::CreateProjectRequest](docs/CreateProjectRequest.md)
@@ -249,6 +262,8 @@ Class | Method | HTTP request | Description
249
262
  - [Mencoro::GetTrackingCoverage200ResponseSampleInner](docs/GetTrackingCoverage200ResponseSampleInner.md)
250
263
  - [Mencoro::InvitationResource](docs/InvitationResource.md)
251
264
  - [Mencoro::KeywordListingResource](docs/KeywordListingResource.md)
265
+ - [Mencoro::KeywordListingResourceCarriedPositions](docs/KeywordListingResourceCarriedPositions.md)
266
+ - [Mencoro::KeywordListingResourceCarriedPositionsSerp](docs/KeywordListingResourceCarriedPositionsSerp.md)
252
267
  - [Mencoro::KeywordListingResourceMentionTypeCounts](docs/KeywordListingResourceMentionTypeCounts.md)
253
268
  - [Mencoro::ListAiResponses200Response](docs/ListAiResponses200Response.md)
254
269
  - [Mencoro::ListCompetitors200Response](docs/ListCompetitors200Response.md)
@@ -262,20 +277,37 @@ Class | Method | HTTP request | Description
262
277
  - [Mencoro::ListShoppingSnapshots200Response](docs/ListShoppingSnapshots200Response.md)
263
278
  - [Mencoro::MeResource](docs/MeResource.md)
264
279
  - [Mencoro::MemberResource](docs/MemberResource.md)
280
+ - [Mencoro::MentionMatchResource](docs/MentionMatchResource.md)
281
+ - [Mencoro::MentionSampleResponse](docs/MentionSampleResponse.md)
282
+ - [Mencoro::MentionTypeCounts](docs/MentionTypeCounts.md)
265
283
  - [Mencoro::OperationEffect](docs/OperationEffect.md)
266
284
  - [Mencoro::OrganizationResource](docs/OrganizationResource.md)
285
+ - [Mencoro::PerCompetitorSentiment](docs/PerCompetitorSentiment.md)
286
+ - [Mencoro::PerEngineSentiment](docs/PerEngineSentiment.md)
287
+ - [Mencoro::PerEntityMetrics](docs/PerEntityMetrics.md)
288
+ - [Mencoro::PositionDistributionBucket](docs/PositionDistributionBucket.md)
267
289
  - [Mencoro::PreviewOrganizationOperation200Response](docs/PreviewOrganizationOperation200Response.md)
268
290
  - [Mencoro::PreviewOrganizationOperation200ResponseOrganization](docs/PreviewOrganizationOperation200ResponseOrganization.md)
269
291
  - [Mencoro::PreviewOrganizationOperationRequest](docs/PreviewOrganizationOperationRequest.md)
270
292
  - [Mencoro::ProjectDetailResource](docs/ProjectDetailResource.md)
271
293
  - [Mencoro::ProjectDetailResourceCompetitorsInner](docs/ProjectDetailResourceCompetitorsInner.md)
294
+ - [Mencoro::ProjectMentionMixResponse](docs/ProjectMentionMixResponse.md)
295
+ - [Mencoro::ProjectMentionSamplesResponse](docs/ProjectMentionSamplesResponse.md)
296
+ - [Mencoro::ProjectRankTrackingClusterBreakdown](docs/ProjectRankTrackingClusterBreakdown.md)
297
+ - [Mencoro::ProjectRankTrackingStats](docs/ProjectRankTrackingStats.md)
298
+ - [Mencoro::ProjectRankTrackingTimeSeries](docs/ProjectRankTrackingTimeSeries.md)
272
299
  - [Mencoro::ProjectResource](docs/ProjectResource.md)
300
+ - [Mencoro::ProjectSentimentBreakdown](docs/ProjectSentimentBreakdown.md)
273
301
  - [Mencoro::ProjectedMonthlyChecksResource](docs/ProjectedMonthlyChecksResource.md)
274
302
  - [Mencoro::QueryClusterResource](docs/QueryClusterResource.md)
275
303
  - [Mencoro::ReportAiResponseRequest](docs/ReportAiResponseRequest.md)
276
304
  - [Mencoro::SearchResultResource](docs/SearchResultResource.md)
277
305
  - [Mencoro::SearchSnapshotResource](docs/SearchSnapshotResource.md)
278
306
  - [Mencoro::SearchTrackedQueries200Response](docs/SearchTrackedQueries200Response.md)
307
+ - [Mencoro::SearchTrackedQueryMentionMatches200Response](docs/SearchTrackedQueryMentionMatches200Response.md)
308
+ - [Mencoro::SearchTrackedQuerySerpMatches200Response](docs/SearchTrackedQuerySerpMatches200Response.md)
309
+ - [Mencoro::SerpMatchResource](docs/SerpMatchResource.md)
310
+ - [Mencoro::SetMemberProjectAccessRequest](docs/SetMemberProjectAccessRequest.md)
279
311
  - [Mencoro::ShoppingOfferResource](docs/ShoppingOfferResource.md)
280
312
  - [Mencoro::ShoppingSnapshotResource](docs/ShoppingSnapshotResource.md)
281
313
  - [Mencoro::StartBrandDiscoveryJobRequest](docs/StartBrandDiscoveryJobRequest.md)
@@ -285,8 +317,12 @@ Class | Method | HTTP request | Description
285
317
  - [Mencoro::StartPromptDiscoveryJobRequest](docs/StartPromptDiscoveryJobRequest.md)
286
318
  - [Mencoro::SubmittedChecksResource](docs/SubmittedChecksResource.md)
287
319
  - [Mencoro::SubscriptionResource](docs/SubscriptionResource.md)
320
+ - [Mencoro::TimeSeriesPoint](docs/TimeSeriesPoint.md)
288
321
  - [Mencoro::TrackedQueryCountResource](docs/TrackedQueryCountResource.md)
289
322
  - [Mencoro::TrackedQueryDetailResource](docs/TrackedQueryDetailResource.md)
323
+ - [Mencoro::TrackedQueryMoverRow](docs/TrackedQueryMoverRow.md)
324
+ - [Mencoro::TrackedQueryMoversResponse](docs/TrackedQueryMoversResponse.md)
325
+ - [Mencoro::TrackedQueryRankTrackingTimeSeries](docs/TrackedQueryRankTrackingTimeSeries.md)
290
326
  - [Mencoro::TrackedQueryResource](docs/TrackedQueryResource.md)
291
327
  - [Mencoro::TrackedQueryUsageResource](docs/TrackedQueryUsageResource.md)
292
328
  - [Mencoro::UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
data/docs/AccountApi.md CHANGED
@@ -80,7 +80,7 @@ This endpoint does not need any parameter.
80
80
 
81
81
  Counts across everything the key can reach
82
82
 
83
- 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.
83
+ 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 the owner can access, 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.
84
84
 
85
85
  ### Examples
86
86