mencoro 1.0.0
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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +304 -0
- data/Rakefile +10 -0
- data/docs/AcceptedJobResource.md +22 -0
- data/docs/AccountApi.md +141 -0
- data/docs/AiResponseReportResource.md +28 -0
- data/docs/AiResponseResource.md +36 -0
- data/docs/AnalyticsApi.md +1320 -0
- data/docs/ApplyClusteringJobOutcome.md +26 -0
- data/docs/ApplyClusteringJobOutcomeClustersInner.md +22 -0
- data/docs/ApplyClusteringJobOutcomeFailedInner.md +22 -0
- data/docs/ApplyClusteringJobOutcomeSkippedClustersInner.md +20 -0
- data/docs/ApplyClusteringJobOutcomeSuccessfulInner.md +20 -0
- data/docs/AsyncJobResource.md +24 -0
- data/docs/BatchChangeTrackedQueryCheckFrequencyRequestData.md +20 -0
- data/docs/BatchChangeTrackedQueryPassesRequestData.md +20 -0
- data/docs/BatchCreateQueryClustersOutcome.md +20 -0
- data/docs/BatchCreateQueryClustersOutcomeFailedInner.md +22 -0
- data/docs/BatchCreateQueryClustersOutcomeSuccessfulInner.md +20 -0
- data/docs/BatchCreateQueryClustersRequestData.md +18 -0
- data/docs/BatchCreateTrackedQueriesRequestData.md +30 -0
- data/docs/BatchCreateTrackedQueriesResultResource.md +20 -0
- data/docs/BatchCreateTrackedQueriesResultResourceFailedInner.md +26 -0
- data/docs/BatchCreateTrackedQueriesResultResourceSuccessfulInner.md +24 -0
- data/docs/BatchForceCheckTrackedQueries200Response.md +20 -0
- data/docs/BatchForceCheckTrackedQueries200ResponseFailedInner.md +22 -0
- data/docs/BatchPauseTrackedQueries200Response.md +20 -0
- data/docs/BatchPauseTrackedQueries200ResponseFailedInner.md +22 -0
- data/docs/BatchPauseTrackedQueries200ResponseSuccessfulInner.md +18 -0
- data/docs/BatchResumeTrackedQueries200Response.md +20 -0
- data/docs/BatchTargetsRequestData.md +18 -0
- data/docs/BatchWriteOutcome.md +20 -0
- data/docs/BatchWriteOutcomeFailedInner.md +22 -0
- data/docs/BillingApi.md +77 -0
- data/docs/BrandProfileResource.md +24 -0
- data/docs/BulkAddClustersToTrackedQueries200Response.md +20 -0
- data/docs/BulkAddClustersToTrackedQueriesRequest.md +20 -0
- data/docs/BulkRemoveClustersFromTrackedQueries200Response.md +20 -0
- data/docs/BulkRemoveClustersFromTrackedQueriesRequest.md +20 -0
- data/docs/CapturesApi.md +267 -0
- data/docs/ChangeMemberRoleRequest.md +18 -0
- data/docs/ChangeTrackedQueryCheckFrequencyRequestData.md +18 -0
- data/docs/ChangeTrackedQueryPassesRequestData.md +18 -0
- data/docs/CitationResource.md +36 -0
- data/docs/ClusterMembershipRequestData.md +18 -0
- data/docs/ClustersApi.md +465 -0
- data/docs/CompetitorResource.md +24 -0
- data/docs/CreateCompetitorRequest.md +22 -0
- data/docs/CreateInvitation200Response.md +22 -0
- data/docs/CreateInvitation201Response.md +32 -0
- data/docs/CreateInvitationRequest.md +20 -0
- data/docs/CreateOrganization201Response.md +22 -0
- data/docs/CreateOrganizationRequest.md +18 -0
- data/docs/CreateProjectRequest.md +24 -0
- data/docs/CreateProjectRequestCompetitorsInner.md +22 -0
- data/docs/CreateQueryCluster409Response.md +22 -0
- data/docs/CreateQueryClusterRequest.md +18 -0
- data/docs/DeleteQueryCluster200Response.md +22 -0
- data/docs/DiscoveryApi.md +311 -0
- data/docs/EntitlementsResource.md +38 -0
- data/docs/GetAvailableFilters200Response.md +22 -0
- data/docs/GetAvailableFilters200ResponseClustersInner.md +20 -0
- data/docs/GetMeStats200Response.md +20 -0
- data/docs/GetMeStats200ResponseOrganizations.md +18 -0
- data/docs/GetMeStats200ResponseProjects.md +20 -0
- data/docs/GetMembershipStats200Response.md +30 -0
- data/docs/GetMentionSamples400Response.md +24 -0
- data/docs/GetMentionSamples400ResponseDetailsValueInner.md +22 -0
- data/docs/GetMetricGlossary200Response.md +18 -0
- data/docs/GetMetricGlossary200ResponseMetricsInner.md +30 -0
- data/docs/GetOrganizationOverview200Response.md +20 -0
- data/docs/GetOrganizationOverview200ResponseAggregate.md +30 -0
- data/docs/GetOrganizationOverview200ResponseProjectsInner.md +32 -0
- data/docs/GetOrganizationStats200Response.md +22 -0
- data/docs/GetOrganizationStats200ResponseInvitations.md +18 -0
- data/docs/GetOrganizationStats200ResponseMembers.md +18 -0
- data/docs/GetOrganizationStats200ResponseProjects.md +20 -0
- data/docs/GetShareOfVoiceFormula200Response.md +24 -0
- data/docs/GetTrackingCoverage200Response.md +30 -0
- data/docs/GetTrackingCoverage200ResponseSampleInner.md +28 -0
- data/docs/InvitationResource.md +30 -0
- data/docs/InvitationsApi.md +243 -0
- data/docs/JobsApi.md +79 -0
- data/docs/KeywordListingResource.md +88 -0
- data/docs/KeywordListingResourceMentionTypeCounts.md +26 -0
- data/docs/ListAiResponses200Response.md +20 -0
- data/docs/ListCompetitors200Response.md +20 -0
- data/docs/ListInvitations200Response.md +20 -0
- data/docs/ListKeywordListings200Response.md +24 -0
- data/docs/ListMembers200Response.md +20 -0
- data/docs/ListOrganizations200Response.md +20 -0
- data/docs/ListProjects200Response.md +20 -0
- data/docs/ListQueryClusters200Response.md +20 -0
- data/docs/ListSearchSnapshots200Response.md +20 -0
- data/docs/ListShoppingSnapshots200Response.md +20 -0
- data/docs/MeResource.md +34 -0
- data/docs/MemberResource.md +28 -0
- data/docs/MembersApi.md +391 -0
- data/docs/OperationEffect.md +22 -0
- data/docs/OrganizationOperationsApi.md +77 -0
- data/docs/OrganizationResource.md +32 -0
- data/docs/OrganizationsApi.md +807 -0
- data/docs/PreviewOrganizationOperation200Response.md +34 -0
- data/docs/PreviewOrganizationOperation200ResponseOrganization.md +20 -0
- data/docs/PreviewOrganizationOperationRequest.md +24 -0
- data/docs/ProjectDetailResource.md +32 -0
- data/docs/ProjectDetailResourceCompetitorsInner.md +24 -0
- data/docs/ProjectResource.md +50 -0
- data/docs/ProjectedMonthlyChecksResource.md +20 -0
- data/docs/ProjectsApi.md +999 -0
- data/docs/QueryClusterResource.md +22 -0
- data/docs/ReportAiResponseRequest.md +22 -0
- data/docs/SearchResultResource.md +32 -0
- data/docs/SearchSnapshotResource.md +28 -0
- data/docs/SearchTrackedQueries200Response.md +20 -0
- data/docs/ShoppingOfferResource.md +38 -0
- data/docs/ShoppingSnapshotResource.md +28 -0
- data/docs/StartBrandDiscoveryJobRequest.md +20 -0
- data/docs/StartBrandNameSuggestionJobRequest.md +24 -0
- data/docs/StartClusteringJobRequestData.md +22 -0
- data/docs/StartKeywordDiscoveryJobRequest.md +24 -0
- data/docs/StartPromptDiscoveryJobRequest.md +24 -0
- data/docs/SubmittedChecksResource.md +20 -0
- data/docs/SubscriptionResource.md +42 -0
- data/docs/TrackedQueriesApi.md +1549 -0
- data/docs/TrackedQueryCountResource.md +20 -0
- data/docs/TrackedQueryDetailResource.md +38 -0
- data/docs/TrackedQueryResource.md +52 -0
- data/docs/TrackedQueryUsageResource.md +18 -0
- data/docs/UpdateOrganizationRequest.md +22 -0
- data/docs/UpdateProjectBrandProfileRequest.md +20 -0
- data/docs/UpdateProjectRequest.md +18 -0
- data/git_push.sh +57 -0
- data/lib/mencoro/api/account_api.rb +136 -0
- data/lib/mencoro/api/analytics_api.rb +1555 -0
- data/lib/mencoro/api/billing_api.rb +85 -0
- data/lib/mencoro/api/captures_api.rb +338 -0
- data/lib/mencoro/api/clusters_api.rb +548 -0
- data/lib/mencoro/api/discovery_api.rb +360 -0
- data/lib/mencoro/api/invitations_api.rb +302 -0
- data/lib/mencoro/api/jobs_api.rb +91 -0
- data/lib/mencoro/api/members_api.rb +453 -0
- data/lib/mencoro/api/organization_operations_api.rb +90 -0
- data/lib/mencoro/api/organizations_api.rb +835 -0
- data/lib/mencoro/api/projects_api.rb +1158 -0
- data/lib/mencoro/api/tracked_queries_api.rb +1792 -0
- data/lib/mencoro/api_client.rb +441 -0
- data/lib/mencoro/api_error.rb +58 -0
- data/lib/mencoro/api_model_base.rb +88 -0
- data/lib/mencoro/configuration.rb +392 -0
- data/lib/mencoro/models/accepted_job_resource.rb +220 -0
- data/lib/mencoro/models/ai_response_report_resource.rb +311 -0
- data/lib/mencoro/models/ai_response_resource.rb +412 -0
- data/lib/mencoro/models/apply_clustering_job_outcome.rb +199 -0
- data/lib/mencoro/models/apply_clustering_job_outcome_clusters_inner.rb +165 -0
- data/lib/mencoro/models/apply_clustering_job_outcome_failed_inner.rb +165 -0
- data/lib/mencoro/models/apply_clustering_job_outcome_skipped_clusters_inner.rb +156 -0
- data/lib/mencoro/models/apply_clustering_job_outcome_successful_inner.rb +158 -0
- data/lib/mencoro/models/async_job_resource.rb +256 -0
- data/lib/mencoro/models/batch_change_tracked_query_check_frequency_request_data.rb +237 -0
- data/lib/mencoro/models/batch_change_tracked_query_passes_request_data.rb +231 -0
- data/lib/mencoro/models/batch_create_query_clusters_outcome.rb +163 -0
- data/lib/mencoro/models/batch_create_query_clusters_outcome_failed_inner.rb +165 -0
- data/lib/mencoro/models/batch_create_query_clusters_outcome_successful_inner.rb +156 -0
- data/lib/mencoro/models/batch_create_query_clusters_request_data.rb +186 -0
- data/lib/mencoro/models/batch_create_tracked_queries_request_data.rb +399 -0
- data/lib/mencoro/models/batch_create_tracked_queries_result_resource.rb +163 -0
- data/lib/mencoro/models/batch_create_tracked_queries_result_resource_failed_inner.rb +183 -0
- data/lib/mencoro/models/batch_create_tracked_queries_result_resource_successful_inner.rb +174 -0
- data/lib/mencoro/models/batch_force_check_tracked_queries200_response.rb +162 -0
- data/lib/mencoro/models/batch_force_check_tracked_queries200_response_failed_inner.rb +165 -0
- data/lib/mencoro/models/batch_pause_tracked_queries200_response.rb +162 -0
- data/lib/mencoro/models/batch_pause_tracked_queries200_response_failed_inner.rb +165 -0
- data/lib/mencoro/models/batch_pause_tracked_queries200_response_successful_inner.rb +147 -0
- data/lib/mencoro/models/batch_resume_tracked_queries200_response.rb +162 -0
- data/lib/mencoro/models/batch_targets_request_data.rb +186 -0
- data/lib/mencoro/models/batch_write_outcome.rb +163 -0
- data/lib/mencoro/models/batch_write_outcome_failed_inner.rb +166 -0
- data/lib/mencoro/models/brand_profile_resource.rb +235 -0
- data/lib/mencoro/models/bulk_add_clusters_to_tracked_queries200_response.rb +162 -0
- data/lib/mencoro/models/bulk_add_clusters_to_tracked_queries_request.rb +218 -0
- data/lib/mencoro/models/bulk_remove_clusters_from_tracked_queries200_response.rb +162 -0
- data/lib/mencoro/models/bulk_remove_clusters_from_tracked_queries_request.rb +218 -0
- data/lib/mencoro/models/change_member_role_request.rb +181 -0
- data/lib/mencoro/models/change_tracked_query_check_frequency_request_data.rb +190 -0
- data/lib/mencoro/models/change_tracked_query_passes_request_data.rb +184 -0
- data/lib/mencoro/models/citation_resource.rb +306 -0
- data/lib/mencoro/models/cluster_membership_request_data.rb +186 -0
- data/lib/mencoro/models/competitor_resource.rb +250 -0
- data/lib/mencoro/models/create_competitor_request.rb +247 -0
- data/lib/mencoro/models/create_invitation200_response.rb +202 -0
- data/lib/mencoro/models/create_invitation201_response.rb +347 -0
- data/lib/mencoro/models/create_invitation_request.rb +192 -0
- data/lib/mencoro/models/create_organization201_response.rb +166 -0
- data/lib/mencoro/models/create_organization_request.rb +175 -0
- data/lib/mencoro/models/create_project_request.rb +307 -0
- data/lib/mencoro/models/create_project_request_competitors_inner.rb +256 -0
- data/lib/mencoro/models/create_query_cluster409_response.rb +165 -0
- data/lib/mencoro/models/create_query_cluster_request.rb +167 -0
- data/lib/mencoro/models/delete_query_cluster200_response.rb +168 -0
- data/lib/mencoro/models/entitlements_resource.rb +328 -0
- data/lib/mencoro/models/get_available_filters200_response.rb +173 -0
- data/lib/mencoro/models/get_available_filters200_response_clusters_inner.rb +157 -0
- data/lib/mencoro/models/get_me_stats200_response.rb +156 -0
- data/lib/mencoro/models/get_me_stats200_response_organizations.rb +167 -0
- data/lib/mencoro/models/get_me_stats200_response_projects.rb +196 -0
- data/lib/mencoro/models/get_membership_stats200_response.rb +322 -0
- data/lib/mencoro/models/get_mention_samples400_response.rb +231 -0
- data/lib/mencoro/models/get_mention_samples400_response_details_value_inner.rb +168 -0
- data/lib/mencoro/models/get_metric_glossary200_response.rb +149 -0
- data/lib/mencoro/models/get_metric_glossary200_response_metrics_inner.rb +240 -0
- data/lib/mencoro/models/get_organization_overview200_response.rb +158 -0
- data/lib/mencoro/models/get_organization_overview200_response_aggregate.rb +209 -0
- data/lib/mencoro/models/get_organization_overview200_response_projects_inner.rb +218 -0
- data/lib/mencoro/models/get_organization_stats200_response.rb +165 -0
- data/lib/mencoro/models/get_organization_stats200_response_invitations.rb +167 -0
- data/lib/mencoro/models/get_organization_stats200_response_members.rb +167 -0
- data/lib/mencoro/models/get_organization_stats200_response_projects.rb +196 -0
- data/lib/mencoro/models/get_share_of_voice_formula200_response.rb +182 -0
- data/lib/mencoro/models/get_tracking_coverage200_response.rb +209 -0
- data/lib/mencoro/models/get_tracking_coverage200_response_sample_inner.rb +229 -0
- data/lib/mencoro/models/invitation_resource.rb +331 -0
- data/lib/mencoro/models/keyword_listing_resource.rb +798 -0
- data/lib/mencoro/models/keyword_listing_resource_mention_type_counts.rb +184 -0
- data/lib/mencoro/models/list_ai_responses200_response.rb +159 -0
- data/lib/mencoro/models/list_competitors200_response.rb +159 -0
- data/lib/mencoro/models/list_invitations200_response.rb +158 -0
- data/lib/mencoro/models/list_keyword_listings200_response.rb +180 -0
- data/lib/mencoro/models/list_members200_response.rb +158 -0
- data/lib/mencoro/models/list_organizations200_response.rb +158 -0
- data/lib/mencoro/models/list_projects200_response.rb +159 -0
- data/lib/mencoro/models/list_query_clusters200_response.rb +159 -0
- data/lib/mencoro/models/list_search_snapshots200_response.rb +159 -0
- data/lib/mencoro/models/list_shopping_snapshots200_response.rb +159 -0
- data/lib/mencoro/models/me_resource.rb +394 -0
- data/lib/mencoro/models/member_resource.rb +322 -0
- data/lib/mencoro/models/operation_effect.rb +204 -0
- data/lib/mencoro/models/organization_resource.rb +326 -0
- data/lib/mencoro/models/preview_organization_operation200_response.rb +236 -0
- data/lib/mencoro/models/preview_organization_operation200_response_organization.rb +158 -0
- data/lib/mencoro/models/preview_organization_operation_request.rb +213 -0
- data/lib/mencoro/models/project_detail_resource.rb +380 -0
- data/lib/mencoro/models/project_detail_resource_competitors_inner.rb +178 -0
- data/lib/mencoro/models/project_resource.rb +422 -0
- data/lib/mencoro/models/projected_monthly_checks_resource.rb +211 -0
- data/lib/mencoro/models/query_cluster_resource.rb +229 -0
- data/lib/mencoro/models/report_ai_response_request.rb +227 -0
- data/lib/mencoro/models/search_result_resource.rb +284 -0
- data/lib/mencoro/models/search_snapshot_resource.rb +302 -0
- data/lib/mencoro/models/search_tracked_queries200_response.rb +158 -0
- data/lib/mencoro/models/shopping_offer_resource.rb +381 -0
- data/lib/mencoro/models/shopping_snapshot_resource.rb +302 -0
- data/lib/mencoro/models/start_brand_discovery_job_request.rb +185 -0
- data/lib/mencoro/models/start_brand_name_suggestion_job_request.rb +287 -0
- data/lib/mencoro/models/start_clustering_job_request_data.rb +249 -0
- data/lib/mencoro/models/start_keyword_discovery_job_request.rb +266 -0
- data/lib/mencoro/models/start_prompt_discovery_job_request.rb +276 -0
- data/lib/mencoro/models/submitted_checks_resource.rb +195 -0
- data/lib/mencoro/models/subscription_resource.rb +362 -0
- data/lib/mencoro/models/tracked_query_count_resource.rb +193 -0
- data/lib/mencoro/models/tracked_query_detail_resource.rb +440 -0
- data/lib/mencoro/models/tracked_query_resource.rb +492 -0
- data/lib/mencoro/models/tracked_query_usage_resource.rb +175 -0
- data/lib/mencoro/models/update_organization_request.rb +195 -0
- data/lib/mencoro/models/update_project_brand_profile_request.rb +218 -0
- data/lib/mencoro/models/update_project_request.rb +182 -0
- data/lib/mencoro/version.rb +15 -0
- data/lib/mencoro.rb +169 -0
- data/mencoro.gemspec +41 -0
- data/spec/api/account_api_spec.rb +57 -0
- data/spec/api/analytics_api_spec.rb +318 -0
- data/spec/api/billing_api_spec.rb +47 -0
- data/spec/api/captures_api_spec.rb +93 -0
- data/spec/api/clusters_api_spec.rb +126 -0
- data/spec/api/discovery_api_spec.rb +94 -0
- data/spec/api/invitations_api_spec.rb +83 -0
- data/spec/api/jobs_api_spec.rb +48 -0
- data/spec/api/members_api_spec.rb +111 -0
- data/spec/api/organization_operations_api_spec.rb +47 -0
- data/spec/api/organizations_api_spec.rb +181 -0
- data/spec/api/projects_api_spec.rb +229 -0
- data/spec/api/tracked_queries_api_spec.rb +344 -0
- data/spec/models/accepted_job_resource_spec.rb +48 -0
- data/spec/models/ai_response_report_resource_spec.rb +70 -0
- data/spec/models/ai_response_resource_spec.rb +90 -0
- data/spec/models/apply_clustering_job_outcome_clusters_inner_spec.rb +48 -0
- data/spec/models/apply_clustering_job_outcome_failed_inner_spec.rb +48 -0
- data/spec/models/apply_clustering_job_outcome_skipped_clusters_inner_spec.rb +42 -0
- data/spec/models/apply_clustering_job_outcome_spec.rb +60 -0
- data/spec/models/apply_clustering_job_outcome_successful_inner_spec.rb +42 -0
- data/spec/models/async_job_resource_spec.rb +62 -0
- data/spec/models/batch_change_tracked_query_check_frequency_request_data_spec.rb +46 -0
- data/spec/models/batch_change_tracked_query_passes_request_data_spec.rb +42 -0
- data/spec/models/batch_create_query_clusters_outcome_failed_inner_spec.rb +48 -0
- data/spec/models/batch_create_query_clusters_outcome_spec.rb +42 -0
- data/spec/models/batch_create_query_clusters_outcome_successful_inner_spec.rb +42 -0
- data/spec/models/batch_create_query_clusters_request_data_spec.rb +36 -0
- data/spec/models/batch_create_tracked_queries_request_data_spec.rb +80 -0
- data/spec/models/batch_create_tracked_queries_result_resource_failed_inner_spec.rb +60 -0
- data/spec/models/batch_create_tracked_queries_result_resource_spec.rb +42 -0
- data/spec/models/batch_create_tracked_queries_result_resource_successful_inner_spec.rb +54 -0
- data/spec/models/batch_force_check_tracked_queries200_response_failed_inner_spec.rb +48 -0
- data/spec/models/batch_force_check_tracked_queries200_response_spec.rb +42 -0
- data/spec/models/batch_pause_tracked_queries200_response_failed_inner_spec.rb +48 -0
- data/spec/models/batch_pause_tracked_queries200_response_spec.rb +42 -0
- data/spec/models/batch_pause_tracked_queries200_response_successful_inner_spec.rb +36 -0
- data/spec/models/batch_resume_tracked_queries200_response_spec.rb +42 -0
- data/spec/models/batch_targets_request_data_spec.rb +36 -0
- data/spec/models/batch_write_outcome_failed_inner_spec.rb +48 -0
- data/spec/models/batch_write_outcome_spec.rb +42 -0
- data/spec/models/brand_profile_resource_spec.rb +54 -0
- data/spec/models/bulk_add_clusters_to_tracked_queries200_response_spec.rb +42 -0
- data/spec/models/bulk_add_clusters_to_tracked_queries_request_spec.rb +42 -0
- data/spec/models/bulk_remove_clusters_from_tracked_queries200_response_spec.rb +42 -0
- data/spec/models/bulk_remove_clusters_from_tracked_queries_request_spec.rb +42 -0
- data/spec/models/change_member_role_request_spec.rb +40 -0
- data/spec/models/change_tracked_query_check_frequency_request_data_spec.rb +40 -0
- data/spec/models/change_tracked_query_passes_request_data_spec.rb +36 -0
- data/spec/models/citation_resource_spec.rb +90 -0
- data/spec/models/cluster_membership_request_data_spec.rb +36 -0
- data/spec/models/competitor_resource_spec.rb +54 -0
- data/spec/models/create_competitor_request_spec.rb +48 -0
- data/spec/models/create_invitation200_response_spec.rb +52 -0
- data/spec/models/create_invitation201_response_spec.rb +86 -0
- data/spec/models/create_invitation_request_spec.rb +46 -0
- data/spec/models/create_organization201_response_spec.rb +48 -0
- data/spec/models/create_organization_request_spec.rb +36 -0
- data/spec/models/create_project_request_competitors_inner_spec.rb +48 -0
- data/spec/models/create_project_request_spec.rb +54 -0
- data/spec/models/create_query_cluster409_response_spec.rb +48 -0
- data/spec/models/create_query_cluster_request_spec.rb +36 -0
- data/spec/models/delete_query_cluster200_response_spec.rb +48 -0
- data/spec/models/entitlements_resource_spec.rb +104 -0
- data/spec/models/get_available_filters200_response_clusters_inner_spec.rb +42 -0
- data/spec/models/get_available_filters200_response_spec.rb +48 -0
- data/spec/models/get_me_stats200_response_organizations_spec.rb +36 -0
- data/spec/models/get_me_stats200_response_projects_spec.rb +42 -0
- data/spec/models/get_me_stats200_response_spec.rb +42 -0
- data/spec/models/get_membership_stats200_response_spec.rb +72 -0
- data/spec/models/get_mention_samples400_response_details_value_inner_spec.rb +48 -0
- data/spec/models/get_mention_samples400_response_spec.rb +54 -0
- data/spec/models/get_metric_glossary200_response_metrics_inner_spec.rb +76 -0
- data/spec/models/get_metric_glossary200_response_spec.rb +36 -0
- data/spec/models/get_organization_overview200_response_aggregate_spec.rb +72 -0
- data/spec/models/get_organization_overview200_response_projects_inner_spec.rb +78 -0
- data/spec/models/get_organization_overview200_response_spec.rb +42 -0
- data/spec/models/get_organization_stats200_response_invitations_spec.rb +36 -0
- data/spec/models/get_organization_stats200_response_members_spec.rb +36 -0
- data/spec/models/get_organization_stats200_response_projects_spec.rb +42 -0
- data/spec/models/get_organization_stats200_response_spec.rb +48 -0
- data/spec/models/get_share_of_voice_formula200_response_spec.rb +54 -0
- data/spec/models/get_tracking_coverage200_response_sample_inner_spec.rb +70 -0
- data/spec/models/get_tracking_coverage200_response_spec.rb +72 -0
- data/spec/models/invitation_resource_spec.rb +80 -0
- data/spec/models/keyword_listing_resource_mention_type_counts_spec.rb +60 -0
- data/spec/models/keyword_listing_resource_spec.rb +262 -0
- data/spec/models/list_ai_responses200_response_spec.rb +42 -0
- data/spec/models/list_competitors200_response_spec.rb +42 -0
- data/spec/models/list_invitations200_response_spec.rb +42 -0
- data/spec/models/list_keyword_listings200_response_spec.rb +54 -0
- data/spec/models/list_members200_response_spec.rb +42 -0
- data/spec/models/list_organizations200_response_spec.rb +42 -0
- data/spec/models/list_projects200_response_spec.rb +42 -0
- data/spec/models/list_query_clusters200_response_spec.rb +42 -0
- data/spec/models/list_search_snapshots200_response_spec.rb +42 -0
- data/spec/models/list_shopping_snapshots200_response_spec.rb +42 -0
- data/spec/models/me_resource_spec.rb +92 -0
- data/spec/models/member_resource_spec.rb +74 -0
- data/spec/models/operation_effect_spec.rb +48 -0
- data/spec/models/organization_resource_spec.rb +86 -0
- data/spec/models/preview_organization_operation200_response_organization_spec.rb +42 -0
- data/spec/models/preview_organization_operation200_response_spec.rb +84 -0
- data/spec/models/preview_organization_operation_request_spec.rb +58 -0
- data/spec/models/project_detail_resource_competitors_inner_spec.rb +54 -0
- data/spec/models/project_detail_resource_spec.rb +82 -0
- data/spec/models/project_resource_spec.rb +136 -0
- data/spec/models/projected_monthly_checks_resource_spec.rb +42 -0
- data/spec/models/query_cluster_resource_spec.rb +48 -0
- data/spec/models/report_ai_response_request_spec.rb +52 -0
- data/spec/models/search_result_resource_spec.rb +78 -0
- data/spec/models/search_snapshot_resource_spec.rb +66 -0
- data/spec/models/search_tracked_queries200_response_spec.rb +42 -0
- data/spec/models/shopping_offer_resource_spec.rb +96 -0
- data/spec/models/shopping_snapshot_resource_spec.rb +66 -0
- data/spec/models/start_brand_discovery_job_request_spec.rb +42 -0
- data/spec/models/start_brand_name_suggestion_job_request_spec.rb +54 -0
- data/spec/models/start_clustering_job_request_data_spec.rb +52 -0
- data/spec/models/start_keyword_discovery_job_request_spec.rb +54 -0
- data/spec/models/start_prompt_discovery_job_request_spec.rb +54 -0
- data/spec/models/submitted_checks_resource_spec.rb +42 -0
- data/spec/models/subscription_resource_spec.rb +120 -0
- data/spec/models/tracked_query_count_resource_spec.rb +42 -0
- data/spec/models/tracked_query_detail_resource_spec.rb +108 -0
- data/spec/models/tracked_query_resource_spec.rb +150 -0
- data/spec/models/tracked_query_usage_resource_spec.rb +36 -0
- data/spec/models/update_organization_request_spec.rb +48 -0
- data/spec/models/update_project_brand_profile_request_spec.rb +42 -0
- data/spec/models/update_project_request_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- metadata +641 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Mencoro::CreateQueryCluster409Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | | [optional] |
|
|
8
|
+
| **message** | **String** | | [optional] |
|
|
9
|
+
| **request_id** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'mencoro'
|
|
15
|
+
|
|
16
|
+
instance = Mencoro::CreateQueryCluster409Response.new(
|
|
17
|
+
code: null,
|
|
18
|
+
message: null,
|
|
19
|
+
request_id: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Mencoro::CreateQueryClusterRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Stored trimmed and lower-cased. Unique within the project. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'mencoro'
|
|
13
|
+
|
|
14
|
+
instance = Mencoro::CreateQueryClusterRequest.new(
|
|
15
|
+
name: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Mencoro::DeleteQueryCluster200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The cluster that was deleted | [optional] |
|
|
8
|
+
| **name** | **String** | Its name at the moment it was deleted | [optional] |
|
|
9
|
+
| **deleted** | **Boolean** | Always true; present so the body is self-describing | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'mencoro'
|
|
15
|
+
|
|
16
|
+
instance = Mencoro::DeleteQueryCluster200Response.new(
|
|
17
|
+
id: null,
|
|
18
|
+
name: null,
|
|
19
|
+
deleted: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,311 @@
|
|
|
1
|
+
# Mencoro::DiscoveryApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.mencoro.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**start_brand_discovery_job**](DiscoveryApi.md#start_brand_discovery_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/brands | Start a brand discovery job for a project |
|
|
8
|
+
| [**start_brand_name_suggestion_job**](DiscoveryApi.md#start_brand_name_suggestion_job) | **POST** /api/v1/organizations/{organizationId}/brand-name-suggestions | Start a brand-name alias suggestion job |
|
|
9
|
+
| [**start_keyword_discovery_job**](DiscoveryApi.md#start_keyword_discovery_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/keywords | Start a keyword discovery job for a project |
|
|
10
|
+
| [**start_prompt_discovery_job**](DiscoveryApi.md#start_prompt_discovery_job) | **POST** /api/v1/organizations/{organizationId}/projects/{projectId}/discovery/prompts | Start a geo prompt discovery job for a project |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## start_brand_discovery_job
|
|
14
|
+
|
|
15
|
+
> <AcceptedJobResource> start_brand_discovery_job(organization_id, project_id, idempotency_key, opts)
|
|
16
|
+
|
|
17
|
+
Start a brand discovery job for a project
|
|
18
|
+
|
|
19
|
+
Minimum role: manager. Starts background discovery of the brands and competitors around a project and answers 202 with the job to poll; it never returns brands inline. The job PROPOSES names: it creates and updates nothing, so neither the brand profile nor the competitor list changes because this endpoint was called. The organization must be active. Unlike keyword and prompt discovery this operation does not require an entitled subscription, matching the application behaviour it mirrors. Ten starts per minute per organization, counted across every key of every member and shared with the same operation in the Mencoro app; a retry carrying an Idempotency-Key already answered is served from the record and does not count. A project whose brand monitoring profile has not been created yet is still accepted and still billed: the job runs grounded on the project name alone, with no website domains, brand names or competitors to work from, and completes normally. Configure the brand profile first if you want the discovery grounded.
|
|
20
|
+
|
|
21
|
+
### Examples
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'time'
|
|
25
|
+
require 'mencoro'
|
|
26
|
+
# setup authorization
|
|
27
|
+
Mencoro.configure do |config|
|
|
28
|
+
# Configure Bearer authorization: ApiKey
|
|
29
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = Mencoro::DiscoveryApi.new
|
|
33
|
+
organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
34
|
+
project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the organization in the path.
|
|
35
|
+
idempotency_key = 'idempotency_key_example' # String | Repeat it to retry a start whose response was lost; the same key returns the same job instead of starting a second one.
|
|
36
|
+
opts = {
|
|
37
|
+
start_brand_discovery_job_request: Mencoro::StartBrandDiscoveryJobRequest.new # StartBrandDiscoveryJobRequest |
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
begin
|
|
41
|
+
# Start a brand discovery job for a project
|
|
42
|
+
result = api_instance.start_brand_discovery_job(organization_id, project_id, idempotency_key, opts)
|
|
43
|
+
p result
|
|
44
|
+
rescue Mencoro::ApiError => e
|
|
45
|
+
puts "Error when calling DiscoveryApi->start_brand_discovery_job: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### Using the start_brand_discovery_job_with_http_info variant
|
|
50
|
+
|
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
|
52
|
+
|
|
53
|
+
> <Array(<AcceptedJobResource>, Integer, Hash)> start_brand_discovery_job_with_http_info(organization_id, project_id, idempotency_key, opts)
|
|
54
|
+
|
|
55
|
+
```ruby
|
|
56
|
+
begin
|
|
57
|
+
# Start a brand discovery job for a project
|
|
58
|
+
data, status_code, headers = api_instance.start_brand_discovery_job_with_http_info(organization_id, project_id, idempotency_key, opts)
|
|
59
|
+
p status_code # => 2xx
|
|
60
|
+
p headers # => { ... }
|
|
61
|
+
p data # => <AcceptedJobResource>
|
|
62
|
+
rescue Mencoro::ApiError => e
|
|
63
|
+
puts "Error when calling DiscoveryApi->start_brand_discovery_job_with_http_info: #{e}"
|
|
64
|
+
end
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Name | Type | Description | Notes |
|
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
|
71
|
+
| **organization_id** | **String** | | |
|
|
72
|
+
| **project_id** | **String** | Must belong to the organization in the path. | |
|
|
73
|
+
| **idempotency_key** | **String** | Repeat it to retry a start whose response was lost; the same key returns the same job instead of starting a second one. | |
|
|
74
|
+
| **start_brand_discovery_job_request** | [**StartBrandDiscoveryJobRequest**](StartBrandDiscoveryJobRequest.md) | | [optional] |
|
|
75
|
+
|
|
76
|
+
### Return type
|
|
77
|
+
|
|
78
|
+
[**AcceptedJobResource**](AcceptedJobResource.md)
|
|
79
|
+
|
|
80
|
+
### Authorization
|
|
81
|
+
|
|
82
|
+
[ApiKey](../README.md#ApiKey)
|
|
83
|
+
|
|
84
|
+
### HTTP request headers
|
|
85
|
+
|
|
86
|
+
- **Content-Type**: application/json
|
|
87
|
+
- **Accept**: application/json
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
## start_brand_name_suggestion_job
|
|
91
|
+
|
|
92
|
+
> <AcceptedJobResource> start_brand_name_suggestion_job(organization_id, idempotency_key, start_brand_name_suggestion_job_request)
|
|
93
|
+
|
|
94
|
+
Start a brand-name alias suggestion job
|
|
95
|
+
|
|
96
|
+
Minimum role: manager. Starts a background, web-search-grounded job that suggests alias spellings for one entity - a brand, a project or a competitor - described entirely by the body, and answers 202 with the job to poll; it never returns suggestions inline. The entity need not exist: nothing is looked up, nothing is attached and nothing is saved, so the suggestions are the caller's to apply. Names sent in `enteredBrandNames` are excluded from the result. The organization must be active; no subscription is required, matching the application behaviour this mirrors. Ten starts per minute per organization, counted across every key of every member; a retry carrying an Idempotency-Key already answered is served from the record and does not count.
|
|
97
|
+
|
|
98
|
+
### Examples
|
|
99
|
+
|
|
100
|
+
```ruby
|
|
101
|
+
require 'time'
|
|
102
|
+
require 'mencoro'
|
|
103
|
+
# setup authorization
|
|
104
|
+
Mencoro.configure do |config|
|
|
105
|
+
# Configure Bearer authorization: ApiKey
|
|
106
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
api_instance = Mencoro::DiscoveryApi.new
|
|
110
|
+
organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
111
|
+
idempotency_key = 'idempotency_key_example' # String | Repeat it to retry a start whose response was lost; the same key returns the same job instead of starting a second one.
|
|
112
|
+
start_brand_name_suggestion_job_request = Mencoro::StartBrandNameSuggestionJobRequest.new({name: 'Acme', website_domains: ["https: //acme.com"]}) # StartBrandNameSuggestionJobRequest |
|
|
113
|
+
|
|
114
|
+
begin
|
|
115
|
+
# Start a brand-name alias suggestion job
|
|
116
|
+
result = api_instance.start_brand_name_suggestion_job(organization_id, idempotency_key, start_brand_name_suggestion_job_request)
|
|
117
|
+
p result
|
|
118
|
+
rescue Mencoro::ApiError => e
|
|
119
|
+
puts "Error when calling DiscoveryApi->start_brand_name_suggestion_job: #{e}"
|
|
120
|
+
end
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
#### Using the start_brand_name_suggestion_job_with_http_info variant
|
|
124
|
+
|
|
125
|
+
This returns an Array which contains the response data, status code and headers.
|
|
126
|
+
|
|
127
|
+
> <Array(<AcceptedJobResource>, Integer, Hash)> start_brand_name_suggestion_job_with_http_info(organization_id, idempotency_key, start_brand_name_suggestion_job_request)
|
|
128
|
+
|
|
129
|
+
```ruby
|
|
130
|
+
begin
|
|
131
|
+
# Start a brand-name alias suggestion job
|
|
132
|
+
data, status_code, headers = api_instance.start_brand_name_suggestion_job_with_http_info(organization_id, idempotency_key, start_brand_name_suggestion_job_request)
|
|
133
|
+
p status_code # => 2xx
|
|
134
|
+
p headers # => { ... }
|
|
135
|
+
p data # => <AcceptedJobResource>
|
|
136
|
+
rescue Mencoro::ApiError => e
|
|
137
|
+
puts "Error when calling DiscoveryApi->start_brand_name_suggestion_job_with_http_info: #{e}"
|
|
138
|
+
end
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Parameters
|
|
142
|
+
|
|
143
|
+
| Name | Type | Description | Notes |
|
|
144
|
+
| ---- | ---- | ----------- | ----- |
|
|
145
|
+
| **organization_id** | **String** | | |
|
|
146
|
+
| **idempotency_key** | **String** | Repeat it to retry a start whose response was lost; the same key returns the same job instead of starting a second one. | |
|
|
147
|
+
| **start_brand_name_suggestion_job_request** | [**StartBrandNameSuggestionJobRequest**](StartBrandNameSuggestionJobRequest.md) | | |
|
|
148
|
+
|
|
149
|
+
### Return type
|
|
150
|
+
|
|
151
|
+
[**AcceptedJobResource**](AcceptedJobResource.md)
|
|
152
|
+
|
|
153
|
+
### Authorization
|
|
154
|
+
|
|
155
|
+
[ApiKey](../README.md#ApiKey)
|
|
156
|
+
|
|
157
|
+
### HTTP request headers
|
|
158
|
+
|
|
159
|
+
- **Content-Type**: application/json
|
|
160
|
+
- **Accept**: application/json
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
## start_keyword_discovery_job
|
|
164
|
+
|
|
165
|
+
> <AcceptedJobResource> start_keyword_discovery_job(organization_id, project_id, idempotency_key, start_keyword_discovery_job_request)
|
|
166
|
+
|
|
167
|
+
Start a keyword discovery job for a project
|
|
168
|
+
|
|
169
|
+
Minimum role: manager. Starts background keyword discovery from free-text seed input and answers 202 with the job to poll; it never returns keywords inline. The job SUGGESTS keywords - it creates no tracked queries and changes nothing in the project, so a completed job is a list to choose from, not work that has been applied. Queries the project already tracks are excluded from the suggestions automatically; `excludeQueries` adds more on top for this run only. The organization must be active and hold an entitled subscription, because the run spends provider budget. Ten starts per minute per organization, counted across every key of every member; a retry carrying an Idempotency-Key already answered is served from the record and does not count. Run tuning is not exposed: the discovery fan-out uses provider defaults.
|
|
170
|
+
|
|
171
|
+
### Examples
|
|
172
|
+
|
|
173
|
+
```ruby
|
|
174
|
+
require 'time'
|
|
175
|
+
require 'mencoro'
|
|
176
|
+
# setup authorization
|
|
177
|
+
Mencoro.configure do |config|
|
|
178
|
+
# Configure Bearer authorization: ApiKey
|
|
179
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
api_instance = Mencoro::DiscoveryApi.new
|
|
183
|
+
organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
184
|
+
project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the organization in the path.
|
|
185
|
+
idempotency_key = 'idempotency_key_example' # String | Repeat it to retry a start whose response was lost; the same key returns the same job instead of starting a second one.
|
|
186
|
+
start_keyword_discovery_job_request = Mencoro::StartKeywordDiscoveryJobRequest.new({input: 'crm for plumbers, field service software'}) # StartKeywordDiscoveryJobRequest |
|
|
187
|
+
|
|
188
|
+
begin
|
|
189
|
+
# Start a keyword discovery job for a project
|
|
190
|
+
result = api_instance.start_keyword_discovery_job(organization_id, project_id, idempotency_key, start_keyword_discovery_job_request)
|
|
191
|
+
p result
|
|
192
|
+
rescue Mencoro::ApiError => e
|
|
193
|
+
puts "Error when calling DiscoveryApi->start_keyword_discovery_job: #{e}"
|
|
194
|
+
end
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
#### Using the start_keyword_discovery_job_with_http_info variant
|
|
198
|
+
|
|
199
|
+
This returns an Array which contains the response data, status code and headers.
|
|
200
|
+
|
|
201
|
+
> <Array(<AcceptedJobResource>, Integer, Hash)> start_keyword_discovery_job_with_http_info(organization_id, project_id, idempotency_key, start_keyword_discovery_job_request)
|
|
202
|
+
|
|
203
|
+
```ruby
|
|
204
|
+
begin
|
|
205
|
+
# Start a keyword discovery job for a project
|
|
206
|
+
data, status_code, headers = api_instance.start_keyword_discovery_job_with_http_info(organization_id, project_id, idempotency_key, start_keyword_discovery_job_request)
|
|
207
|
+
p status_code # => 2xx
|
|
208
|
+
p headers # => { ... }
|
|
209
|
+
p data # => <AcceptedJobResource>
|
|
210
|
+
rescue Mencoro::ApiError => e
|
|
211
|
+
puts "Error when calling DiscoveryApi->start_keyword_discovery_job_with_http_info: #{e}"
|
|
212
|
+
end
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Parameters
|
|
216
|
+
|
|
217
|
+
| Name | Type | Description | Notes |
|
|
218
|
+
| ---- | ---- | ----------- | ----- |
|
|
219
|
+
| **organization_id** | **String** | | |
|
|
220
|
+
| **project_id** | **String** | Must belong to the organization in the path. | |
|
|
221
|
+
| **idempotency_key** | **String** | Repeat it to retry a start whose response was lost; the same key returns the same job instead of starting a second one. | |
|
|
222
|
+
| **start_keyword_discovery_job_request** | [**StartKeywordDiscoveryJobRequest**](StartKeywordDiscoveryJobRequest.md) | | |
|
|
223
|
+
|
|
224
|
+
### Return type
|
|
225
|
+
|
|
226
|
+
[**AcceptedJobResource**](AcceptedJobResource.md)
|
|
227
|
+
|
|
228
|
+
### Authorization
|
|
229
|
+
|
|
230
|
+
[ApiKey](../README.md#ApiKey)
|
|
231
|
+
|
|
232
|
+
### HTTP request headers
|
|
233
|
+
|
|
234
|
+
- **Content-Type**: application/json
|
|
235
|
+
- **Accept**: application/json
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
## start_prompt_discovery_job
|
|
239
|
+
|
|
240
|
+
> <AcceptedJobResource> start_prompt_discovery_job(organization_id, project_id, idempotency_key, start_prompt_discovery_job_request)
|
|
241
|
+
|
|
242
|
+
Start a geo prompt discovery job for a project
|
|
243
|
+
|
|
244
|
+
Minimum role: manager. Starts background discovery of natural-language prompts - the questions an answer engine gets asked - from free-text seed input, and answers 202 with the job to poll; it never returns prompts inline. The job SUGGESTS prompts: it creates no tracked queries and changes nothing in the project. `country` is required here, unlike keyword discovery, because a prompt is a question asked from somewhere and the provider request has no default for it. Queries the project already tracks are excluded automatically; `excludeQueries` adds more for this run only. The organization must be active and hold an entitled subscription, because the run spends provider budget. Ten starts per minute per organization, counted across every key of every member; a retry carrying an Idempotency-Key already answered is served from the record and does not count. Run tuning is not exposed: the discovery fan-out uses provider defaults.
|
|
245
|
+
|
|
246
|
+
### Examples
|
|
247
|
+
|
|
248
|
+
```ruby
|
|
249
|
+
require 'time'
|
|
250
|
+
require 'mencoro'
|
|
251
|
+
# setup authorization
|
|
252
|
+
Mencoro.configure do |config|
|
|
253
|
+
# Configure Bearer authorization: ApiKey
|
|
254
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
255
|
+
end
|
|
256
|
+
|
|
257
|
+
api_instance = Mencoro::DiscoveryApi.new
|
|
258
|
+
organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
259
|
+
project_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Must belong to the organization in the path.
|
|
260
|
+
idempotency_key = 'idempotency_key_example' # String | Repeat it to retry a start whose response was lost; the same key returns the same job instead of starting a second one.
|
|
261
|
+
start_prompt_discovery_job_request = Mencoro::StartPromptDiscoveryJobRequest.new({input: 'crm for plumbers, field service software', country: 'ES'}) # StartPromptDiscoveryJobRequest |
|
|
262
|
+
|
|
263
|
+
begin
|
|
264
|
+
# Start a geo prompt discovery job for a project
|
|
265
|
+
result = api_instance.start_prompt_discovery_job(organization_id, project_id, idempotency_key, start_prompt_discovery_job_request)
|
|
266
|
+
p result
|
|
267
|
+
rescue Mencoro::ApiError => e
|
|
268
|
+
puts "Error when calling DiscoveryApi->start_prompt_discovery_job: #{e}"
|
|
269
|
+
end
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
#### Using the start_prompt_discovery_job_with_http_info variant
|
|
273
|
+
|
|
274
|
+
This returns an Array which contains the response data, status code and headers.
|
|
275
|
+
|
|
276
|
+
> <Array(<AcceptedJobResource>, Integer, Hash)> start_prompt_discovery_job_with_http_info(organization_id, project_id, idempotency_key, start_prompt_discovery_job_request)
|
|
277
|
+
|
|
278
|
+
```ruby
|
|
279
|
+
begin
|
|
280
|
+
# Start a geo prompt discovery job for a project
|
|
281
|
+
data, status_code, headers = api_instance.start_prompt_discovery_job_with_http_info(organization_id, project_id, idempotency_key, start_prompt_discovery_job_request)
|
|
282
|
+
p status_code # => 2xx
|
|
283
|
+
p headers # => { ... }
|
|
284
|
+
p data # => <AcceptedJobResource>
|
|
285
|
+
rescue Mencoro::ApiError => e
|
|
286
|
+
puts "Error when calling DiscoveryApi->start_prompt_discovery_job_with_http_info: #{e}"
|
|
287
|
+
end
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### Parameters
|
|
291
|
+
|
|
292
|
+
| Name | Type | Description | Notes |
|
|
293
|
+
| ---- | ---- | ----------- | ----- |
|
|
294
|
+
| **organization_id** | **String** | | |
|
|
295
|
+
| **project_id** | **String** | Must belong to the organization in the path. | |
|
|
296
|
+
| **idempotency_key** | **String** | Repeat it to retry a start whose response was lost; the same key returns the same job instead of starting a second one. | |
|
|
297
|
+
| **start_prompt_discovery_job_request** | [**StartPromptDiscoveryJobRequest**](StartPromptDiscoveryJobRequest.md) | | |
|
|
298
|
+
|
|
299
|
+
### Return type
|
|
300
|
+
|
|
301
|
+
[**AcceptedJobResource**](AcceptedJobResource.md)
|
|
302
|
+
|
|
303
|
+
### Authorization
|
|
304
|
+
|
|
305
|
+
[ApiKey](../README.md#ApiKey)
|
|
306
|
+
|
|
307
|
+
### HTTP request headers
|
|
308
|
+
|
|
309
|
+
- **Content-Type**: application/json
|
|
310
|
+
- **Accept**: application/json
|
|
311
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Mencoro::EntitlementsResource
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | \"none\" when the organization has never had a subscription contract. | |
|
|
8
|
+
| **is_entitled** | **Boolean** | Whether the organization may use paid features right now: an active contract, or a cancelled one still inside its paid grace window. | |
|
|
9
|
+
| **check_budget** | **Integer** | Checks the current cycle allows. Null when there is no plan on file, which is not the same as a budget of zero. | [optional] |
|
|
10
|
+
| **checks_consumed** | **Integer** | Checks consumed so far in the current cycle. Null when there is no plan on file. | [optional] |
|
|
11
|
+
| **checks_available** | **Integer** | Checks left in the current cycle. Null when there is no plan on file. | [optional] |
|
|
12
|
+
| **billing_cycle_type** | **String** | How often the allowance renews. Null when there is no plan on file. | [optional] |
|
|
13
|
+
| **billing_cycle_anchor** | **Time** | Start of the current cycle. Null when there is no plan on file. | [optional] |
|
|
14
|
+
| **next_reset_at** | **Time** | When the check budget next resets. Null when there is no plan on file. | [optional] |
|
|
15
|
+
| **cancelled_at** | **Time** | When the subscription was terminally cancelled. Null while it has not been. | [optional] |
|
|
16
|
+
| **scheduled_to_cancel_at** | **Time** | When a scheduled cancellation takes effect, while the subscription is still running. Null when none is scheduled. | [optional] |
|
|
17
|
+
| **grace_period_ends_at** | **Time** | When paid access ends after a cancellation. Null when the subscription has not been cancelled. | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'mencoro'
|
|
23
|
+
|
|
24
|
+
instance = Mencoro::EntitlementsResource.new(
|
|
25
|
+
status: null,
|
|
26
|
+
is_entitled: null,
|
|
27
|
+
check_budget: null,
|
|
28
|
+
checks_consumed: null,
|
|
29
|
+
checks_available: null,
|
|
30
|
+
billing_cycle_type: null,
|
|
31
|
+
billing_cycle_anchor: null,
|
|
32
|
+
next_reset_at: null,
|
|
33
|
+
cancelled_at: null,
|
|
34
|
+
scheduled_to_cancel_at: null,
|
|
35
|
+
grace_period_ends_at: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Mencoro::GetAvailableFilters200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **engines** | **Array<String>** | Engine codes, ready to pass as the engines filter | [optional] |
|
|
8
|
+
| **countries** | **Array<String>** | ISO-3166 alpha-2 codes, ready to pass as the countries filter | [optional] |
|
|
9
|
+
| **clusters** | [**Array<GetAvailableFilters200ResponseClustersInner>**](GetAvailableFilters200ResponseClustersInner.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'mencoro'
|
|
15
|
+
|
|
16
|
+
instance = Mencoro::GetAvailableFilters200Response.new(
|
|
17
|
+
engines: null,
|
|
18
|
+
countries: null,
|
|
19
|
+
clusters: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mencoro::GetAvailableFilters200ResponseClustersInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Pass this in queryClusterIds, never the name | [optional] |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mencoro'
|
|
14
|
+
|
|
15
|
+
instance = Mencoro::GetAvailableFilters200ResponseClustersInner.new(
|
|
16
|
+
id: null,
|
|
17
|
+
name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mencoro::GetMeStats200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **organizations** | [**GetMeStats200ResponseOrganizations**](GetMeStats200ResponseOrganizations.md) | | [optional] |
|
|
8
|
+
| **projects** | [**GetMeStats200ResponseProjects**](GetMeStats200ResponseProjects.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mencoro'
|
|
14
|
+
|
|
15
|
+
instance = Mencoro::GetMeStats200Response.new(
|
|
16
|
+
organizations: null,
|
|
17
|
+
projects: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Mencoro::GetMeStats200ResponseOrganizations
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **total** | **Integer** | Organizations the caller is an active member of, within the key's scope. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'mencoro'
|
|
13
|
+
|
|
14
|
+
instance = Mencoro::GetMeStats200ResponseOrganizations.new(
|
|
15
|
+
total: 3
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mencoro::GetMeStats200ResponseProjects
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **total** | **Integer** | Projects across those organizations, archived ones included. | [optional] |
|
|
8
|
+
| **active** | **Integer** | How many of those are active; the remainder are archived. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mencoro'
|
|
14
|
+
|
|
15
|
+
instance = Mencoro::GetMeStats200ResponseProjects.new(
|
|
16
|
+
total: 25,
|
|
17
|
+
active: 18
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Mencoro::GetMembershipStats200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **active_members_count** | **Integer** | Members in the active state. | [optional] |
|
|
8
|
+
| **suspended_members_count** | **Integer** | Members in the suspended state. | [optional] |
|
|
9
|
+
| **total_members_count** | **Integer** | Every membership record, suspended ones included. | [optional] |
|
|
10
|
+
| **active_projects_count** | **Integer** | Projects in the active state. | [optional] |
|
|
11
|
+
| **total_projects_count** | **Integer** | Every project, archived ones included. | [optional] |
|
|
12
|
+
| **pending_invitations_count** | **Integer** | Invitations still pending and not yet expired. | [optional] |
|
|
13
|
+
| **computed_at** | **String** | When the snapshot was computed. A database timestamp, not an ISO-8601 instant. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'mencoro'
|
|
19
|
+
|
|
20
|
+
instance = Mencoro::GetMembershipStats200Response.new(
|
|
21
|
+
active_members_count: 85,
|
|
22
|
+
suspended_members_count: 3,
|
|
23
|
+
total_members_count: 88,
|
|
24
|
+
active_projects_count: 18,
|
|
25
|
+
total_projects_count: 25,
|
|
26
|
+
pending_invitations_count: 5,
|
|
27
|
+
computed_at: 2026-02-12 10:30:00
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Mencoro::GetMentionSamples400Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Machine-readable reason. `validation_error` when the request was rejected; otherwise the domain error code. | |
|
|
8
|
+
| **message** | **String** | Human-readable reason. A 4xx carries the real message; a 5xx carries a fixed sentence and the detail goes to the logs only. | |
|
|
9
|
+
| **request_id** | **String** | Correlation id, also returned in the X-Request-Id header. | |
|
|
10
|
+
| **details** | **Hash<String, Array<GetMentionSamples400ResponseDetailsValueInner>>** | Present only on a validation failure: one entry per rejected field, each an array of errors. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'mencoro'
|
|
16
|
+
|
|
17
|
+
instance = Mencoro::GetMentionSamples400Response.new(
|
|
18
|
+
code: null,
|
|
19
|
+
message: null,
|
|
20
|
+
request_id: null,
|
|
21
|
+
details: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Mencoro::GetMentionSamples400ResponseDetailsValueInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | | [optional] |
|
|
8
|
+
| **message** | **String** | | [optional] |
|
|
9
|
+
| **parameters** | **Array<String>** | Placeholder values behind the message. Always empty on this API: no rule it enforces carries any. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'mencoro'
|
|
15
|
+
|
|
16
|
+
instance = Mencoro::GetMentionSamples400ResponseDetailsValueInner.new(
|
|
17
|
+
code: null,
|
|
18
|
+
message: null,
|
|
19
|
+
parameters: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Mencoro::GetMetricGlossary200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **metrics** | [**Array<GetMetricGlossary200ResponseMetricsInner>**](GetMetricGlossary200ResponseMetricsInner.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'mencoro'
|
|
13
|
+
|
|
14
|
+
instance = Mencoro::GetMetricGlossary200Response.new(
|
|
15
|
+
metrics: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Mencoro::GetMetricGlossary200ResponseMetricsInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **metric** | **String** | | [optional] |
|
|
8
|
+
| **aliases** | **Array<String>** | | [optional] |
|
|
9
|
+
| **unit** | **String** | | [optional] |
|
|
10
|
+
| **range** | **String** | | [optional] |
|
|
11
|
+
| **direction** | **String** | | [optional] |
|
|
12
|
+
| **operation** | **String** | The operationId that returns this metric | [optional] |
|
|
13
|
+
| **example_questions** | **Array<String>** | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'mencoro'
|
|
19
|
+
|
|
20
|
+
instance = Mencoro::GetMetricGlossary200ResponseMetricsInner.new(
|
|
21
|
+
metric: null,
|
|
22
|
+
aliases: null,
|
|
23
|
+
unit: null,
|
|
24
|
+
range: null,
|
|
25
|
+
direction: null,
|
|
26
|
+
operation: null,
|
|
27
|
+
example_questions: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Mencoro::GetOrganizationOverview200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **projects** | [**Array<GetOrganizationOverview200ResponseProjectsInner>**](GetOrganizationOverview200ResponseProjectsInner.md) | | [optional] |
|
|
8
|
+
| **aggregate** | [**GetOrganizationOverview200ResponseAggregate**](GetOrganizationOverview200ResponseAggregate.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'mencoro'
|
|
14
|
+
|
|
15
|
+
instance = Mencoro::GetOrganizationOverview200Response.new(
|
|
16
|
+
projects: null,
|
|
17
|
+
aggregate: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|