@llmpulse/sdk 0.0.0-stage → 1.59.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.
- package/.github/workflows/ci.yml +17 -0
- package/.github/workflows/publish.yml +37 -0
- package/.openapi-generator/FILES +443 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/LICENSE +21 -0
- package/README.md +442 -2
- package/dist/apis/AIAgentTrafficApi.d.ts +293 -0
- package/dist/apis/AIAgentTrafficApi.js +354 -0
- package/dist/apis/AIModelInsightsApi.d.ts +305 -0
- package/dist/apis/AIModelInsightsApi.js +340 -0
- package/dist/apis/AccountApi.d.ts +59 -0
- package/dist/apis/AccountApi.js +77 -0
- package/dist/apis/AnnotationsApi.d.ts +201 -0
- package/dist/apis/AnnotationsApi.js +253 -0
- package/dist/apis/AnswersApi.d.ts +197 -0
- package/dist/apis/AnswersApi.js +225 -0
- package/dist/apis/CollectionsTagsApi.d.ts +281 -0
- package/dist/apis/CollectionsTagsApi.js +357 -0
- package/dist/apis/CompetitorsApi.d.ts +237 -0
- package/dist/apis/CompetitorsApi.js +304 -0
- package/dist/apis/GEOAuditsApi.d.ts +666 -0
- package/dist/apis/GEOAuditsApi.js +840 -0
- package/dist/apis/GEOWriterApi.d.ts +247 -0
- package/dist/apis/GEOWriterApi.js +316 -0
- package/dist/apis/HealthApi.d.ts +64 -0
- package/dist/apis/HealthApi.js +80 -0
- package/dist/apis/MentionsCitationsApi.d.ts +580 -0
- package/dist/apis/MentionsCitationsApi.js +646 -0
- package/dist/apis/MetricsApi.d.ts +684 -0
- package/dist/apis/MetricsApi.js +728 -0
- package/dist/apis/OwnedMediaCommunitiesApi.d.ts +348 -0
- package/dist/apis/OwnedMediaCommunitiesApi.js +367 -0
- package/dist/apis/ProjectsApi.d.ts +426 -0
- package/dist/apis/ProjectsApi.js +538 -0
- package/dist/apis/PromptsApi.d.ts +494 -0
- package/dist/apis/PromptsApi.js +548 -0
- package/dist/apis/RecommendationsApi.d.ts +185 -0
- package/dist/apis/RecommendationsApi.js +225 -0
- package/dist/apis/ReputationStudiesApi.d.ts +342 -0
- package/dist/apis/ReputationStudiesApi.js +392 -0
- package/dist/apis/SearchConsoleApi.d.ts +611 -0
- package/dist/apis/SearchConsoleApi.js +657 -0
- package/dist/apis/SentimentsApi.d.ts +165 -0
- package/dist/apis/SentimentsApi.js +193 -0
- package/dist/apis/ShoppingAdsApi.d.ts +486 -0
- package/dist/apis/ShoppingAdsApi.js +510 -0
- package/dist/apis/SourcesCitationIntelligenceApi.d.ts +531 -0
- package/dist/apis/SourcesCitationIntelligenceApi.js +599 -0
- package/dist/apis/StoreIntegrationsApi.d.ts +348 -0
- package/dist/apis/StoreIntegrationsApi.js +435 -0
- package/dist/apis/TeamApi.d.ts +227 -0
- package/dist/apis/TeamApi.js +283 -0
- package/dist/apis/TechnicalGEOReportsApi.d.ts +277 -0
- package/dist/apis/TechnicalGEOReportsApi.js +345 -0
- package/dist/apis/WebhooksApi.d.ts +207 -0
- package/dist/apis/WebhooksApi.js +256 -0
- package/dist/apis/index.d.ts +25 -0
- package/dist/apis/index.js +43 -0
- package/dist/esm/apis/AIAgentTrafficApi.d.ts +293 -0
- package/dist/esm/apis/AIAgentTrafficApi.js +350 -0
- package/dist/esm/apis/AIModelInsightsApi.d.ts +305 -0
- package/dist/esm/apis/AIModelInsightsApi.js +336 -0
- package/dist/esm/apis/AccountApi.d.ts +59 -0
- package/dist/esm/apis/AccountApi.js +73 -0
- package/dist/esm/apis/AnnotationsApi.d.ts +201 -0
- package/dist/esm/apis/AnnotationsApi.js +249 -0
- package/dist/esm/apis/AnswersApi.d.ts +197 -0
- package/dist/esm/apis/AnswersApi.js +221 -0
- package/dist/esm/apis/CollectionsTagsApi.d.ts +281 -0
- package/dist/esm/apis/CollectionsTagsApi.js +353 -0
- package/dist/esm/apis/CompetitorsApi.d.ts +237 -0
- package/dist/esm/apis/CompetitorsApi.js +300 -0
- package/dist/esm/apis/GEOAuditsApi.d.ts +666 -0
- package/dist/esm/apis/GEOAuditsApi.js +836 -0
- package/dist/esm/apis/GEOWriterApi.d.ts +247 -0
- package/dist/esm/apis/GEOWriterApi.js +312 -0
- package/dist/esm/apis/HealthApi.d.ts +64 -0
- package/dist/esm/apis/HealthApi.js +76 -0
- package/dist/esm/apis/MentionsCitationsApi.d.ts +580 -0
- package/dist/esm/apis/MentionsCitationsApi.js +642 -0
- package/dist/esm/apis/MetricsApi.d.ts +684 -0
- package/dist/esm/apis/MetricsApi.js +724 -0
- package/dist/esm/apis/OwnedMediaCommunitiesApi.d.ts +348 -0
- package/dist/esm/apis/OwnedMediaCommunitiesApi.js +363 -0
- package/dist/esm/apis/ProjectsApi.d.ts +426 -0
- package/dist/esm/apis/ProjectsApi.js +534 -0
- package/dist/esm/apis/PromptsApi.d.ts +494 -0
- package/dist/esm/apis/PromptsApi.js +544 -0
- package/dist/esm/apis/RecommendationsApi.d.ts +185 -0
- package/dist/esm/apis/RecommendationsApi.js +221 -0
- package/dist/esm/apis/ReputationStudiesApi.d.ts +342 -0
- package/dist/esm/apis/ReputationStudiesApi.js +388 -0
- package/dist/esm/apis/SearchConsoleApi.d.ts +611 -0
- package/dist/esm/apis/SearchConsoleApi.js +653 -0
- package/dist/esm/apis/SentimentsApi.d.ts +165 -0
- package/dist/esm/apis/SentimentsApi.js +189 -0
- package/dist/esm/apis/ShoppingAdsApi.d.ts +486 -0
- package/dist/esm/apis/ShoppingAdsApi.js +506 -0
- package/dist/esm/apis/SourcesCitationIntelligenceApi.d.ts +531 -0
- package/dist/esm/apis/SourcesCitationIntelligenceApi.js +595 -0
- package/dist/esm/apis/StoreIntegrationsApi.d.ts +348 -0
- package/dist/esm/apis/StoreIntegrationsApi.js +431 -0
- package/dist/esm/apis/TeamApi.d.ts +227 -0
- package/dist/esm/apis/TeamApi.js +279 -0
- package/dist/esm/apis/TechnicalGEOReportsApi.d.ts +277 -0
- package/dist/esm/apis/TechnicalGEOReportsApi.js +341 -0
- package/dist/esm/apis/WebhooksApi.d.ts +207 -0
- package/dist/esm/apis/WebhooksApi.js +252 -0
- package/dist/esm/apis/index.d.ts +25 -0
- package/dist/esm/apis/index.js +27 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/models/AccountCapacity.d.ts +38 -0
- package/dist/esm/models/AccountCapacity.js +43 -0
- package/dist/esm/models/AccountQuota.d.ts +56 -0
- package/dist/esm/models/AccountQuota.js +49 -0
- package/dist/esm/models/Actor.d.ts +64 -0
- package/dist/esm/models/Actor.js +56 -0
- package/dist/esm/models/AgentBot.d.ts +62 -0
- package/dist/esm/models/AgentBot.js +51 -0
- package/dist/esm/models/AgentBotsResponse.d.ts +45 -0
- package/dist/esm/models/AgentBotsResponse.js +46 -0
- package/dist/esm/models/AgentTrafficResponse.d.ts +97 -0
- package/dist/esm/models/AgentTrafficResponse.js +70 -0
- package/dist/esm/models/AiOrdersResponse.d.ts +83 -0
- package/dist/esm/models/AiOrdersResponse.js +78 -0
- package/dist/esm/models/AiOrdersResponseBySourceInner.d.ts +50 -0
- package/dist/esm/models/AiOrdersResponseBySourceInner.js +55 -0
- package/dist/esm/models/AiOrdersResponseSeriesInner.d.ts +44 -0
- package/dist/esm/models/AiOrdersResponseSeriesInner.js +51 -0
- package/dist/esm/models/AiOrdersResponseTotals.d.ts +38 -0
- package/dist/esm/models/AiOrdersResponseTotals.js +47 -0
- package/dist/esm/models/AiOrdersUpdateRequest.d.ts +70 -0
- package/dist/esm/models/AiOrdersUpdateRequest.js +72 -0
- package/dist/esm/models/AiOrdersUpdateRequestDaysInner.d.ts +50 -0
- package/dist/esm/models/AiOrdersUpdateRequestDaysInner.js +55 -0
- package/dist/esm/models/AiOrdersUpdateResponse.d.ts +56 -0
- package/dist/esm/models/AiOrdersUpdateResponse.js +59 -0
- package/dist/esm/models/AnnotationCreateResponse.d.ts +45 -0
- package/dist/esm/models/AnnotationCreateResponse.js +52 -0
- package/dist/esm/models/AnnotationCreateResponseAnnotation.d.ts +62 -0
- package/dist/esm/models/AnnotationCreateResponseAnnotation.js +63 -0
- package/dist/esm/models/AnswerDetails.d.ts +165 -0
- package/dist/esm/models/AnswerDetails.js +86 -0
- package/dist/esm/models/AnswerDetailsLocale.d.ts +38 -0
- package/dist/esm/models/AnswerDetailsLocale.js +43 -0
- package/dist/esm/models/ApiError.d.ts +39 -0
- package/dist/esm/models/ApiError.js +44 -0
- package/dist/esm/models/ApiErrorError.d.ts +79 -0
- package/dist/esm/models/ApiErrorError.js +79 -0
- package/dist/esm/models/AssignPromptTagsRequest.d.ts +56 -0
- package/dist/esm/models/AssignPromptTagsRequest.js +53 -0
- package/dist/esm/models/CatalogProduct.d.ts +74 -0
- package/dist/esm/models/CatalogProduct.js +59 -0
- package/dist/esm/models/CatalogPromptSuggestion.d.ts +87 -0
- package/dist/esm/models/CatalogPromptSuggestion.js +80 -0
- package/dist/esm/models/CatalogPromptSuggestionIdsRequest.d.ts +38 -0
- package/dist/esm/models/CatalogPromptSuggestionIdsRequest.js +47 -0
- package/dist/esm/models/CatalogPromptSuggestionProduct.d.ts +44 -0
- package/dist/esm/models/CatalogPromptSuggestionProduct.js +45 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponse.d.ts +58 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponse.js +61 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponseAcceptedInner.d.ts +44 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponseAcceptedInner.js +51 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponseSkippedInner.d.ts +38 -0
- package/dist/esm/models/CatalogPromptSuggestionsAcceptResponseSkippedInner.js +47 -0
- package/dist/esm/models/CatalogPromptSuggestionsCreateRequest.d.ts +64 -0
- package/dist/esm/models/CatalogPromptSuggestionsCreateRequest.js +64 -0
- package/dist/esm/models/CatalogPromptSuggestionsCreateResponse.d.ts +57 -0
- package/dist/esm/models/CatalogPromptSuggestionsCreateResponse.js +60 -0
- package/dist/esm/models/CatalogPromptSuggestionsRejectResponse.d.ts +44 -0
- package/dist/esm/models/CatalogPromptSuggestionsRejectResponse.js +51 -0
- package/dist/esm/models/CatalogPromptSuggestionsResponse.d.ts +63 -0
- package/dist/esm/models/CatalogPromptSuggestionsResponse.js +64 -0
- package/dist/esm/models/CitationMatchMode.d.ts +26 -0
- package/dist/esm/models/CitationMatchMode.js +44 -0
- package/dist/esm/models/CitationRecord.d.ts +74 -0
- package/dist/esm/models/CitationRecord.js +71 -0
- package/dist/esm/models/CitationsResponse.d.ts +63 -0
- package/dist/esm/models/CitationsResponse.js +64 -0
- package/dist/esm/models/CollectionCreateResponse.d.ts +57 -0
- package/dist/esm/models/CollectionCreateResponse.js +60 -0
- package/dist/esm/models/CollectionCreateResponseCollection.d.ts +44 -0
- package/dist/esm/models/CollectionCreateResponseCollection.js +51 -0
- package/dist/esm/models/CollectionsResponse.d.ts +45 -0
- package/dist/esm/models/CollectionsResponse.js +52 -0
- package/dist/esm/models/Competitor.d.ts +83 -0
- package/dist/esm/models/Competitor.js +63 -0
- package/dist/esm/models/CompetitorCreateResponse.d.ts +57 -0
- package/dist/esm/models/CompetitorCreateResponse.js +60 -0
- package/dist/esm/models/CompetitorCreateResponseCompetitor.d.ts +69 -0
- package/dist/esm/models/CompetitorCreateResponseCompetitor.js +68 -0
- package/dist/esm/models/CompetitorDetails.d.ts +129 -0
- package/dist/esm/models/CompetitorDetails.js +74 -0
- package/dist/esm/models/CompetitorMentionRecord.d.ts +62 -0
- package/dist/esm/models/CompetitorMentionRecord.js +63 -0
- package/dist/esm/models/CompetitorMentionsResponse.d.ts +63 -0
- package/dist/esm/models/CompetitorMentionsResponse.js +64 -0
- package/dist/esm/models/CreateAnnotationRequest.d.ts +62 -0
- package/dist/esm/models/CreateAnnotationRequest.js +55 -0
- package/dist/esm/models/CreateCollectionRequest.d.ts +50 -0
- package/dist/esm/models/CreateCollectionRequest.js +51 -0
- package/dist/esm/models/CreateCompetitorRequest.d.ts +71 -0
- package/dist/esm/models/CreateCompetitorRequest.js +65 -0
- package/dist/esm/models/CreateProjectDraftRequest.d.ts +62 -0
- package/dist/esm/models/CreateProjectDraftRequest.js +57 -0
- package/dist/esm/models/CreateTeamInvitation201Response.d.ts +123 -0
- package/dist/esm/models/CreateTeamInvitation201Response.js +97 -0
- package/dist/esm/models/CreateTeamInvitationRequest.d.ts +86 -0
- package/dist/esm/models/CreateTeamInvitationRequest.js +66 -0
- package/dist/esm/models/CreateTechnicalGeoReportsRequest.d.ts +50 -0
- package/dist/esm/models/CreateTechnicalGeoReportsRequest.js +51 -0
- package/dist/esm/models/CreateWebhook201Response.d.ts +102 -0
- package/dist/esm/models/CreateWebhook201Response.js +74 -0
- package/dist/esm/models/CreateWebhookRequest.d.ts +60 -0
- package/dist/esm/models/CreateWebhookRequest.js +66 -0
- package/dist/esm/models/DeleteWebhook200Response.d.ts +44 -0
- package/dist/esm/models/DeleteWebhook200Response.js +45 -0
- package/dist/esm/models/FinalizeProjectDraftRequest.d.ts +38 -0
- package/dist/esm/models/FinalizeProjectDraftRequest.js +43 -0
- package/dist/esm/models/GeoAlert.d.ts +81 -0
- package/dist/esm/models/GeoAlert.js +58 -0
- package/dist/esm/models/GeoAlertEventsInner.d.ts +68 -0
- package/dist/esm/models/GeoAlertEventsInner.js +60 -0
- package/dist/esm/models/GeoAlertList.d.ts +63 -0
- package/dist/esm/models/GeoAlertList.js +52 -0
- package/dist/esm/models/GeoAudit.d.ts +161 -0
- package/dist/esm/models/GeoAudit.js +103 -0
- package/dist/esm/models/GeoAuditArchived.d.ts +50 -0
- package/dist/esm/models/GeoAuditArchived.js +47 -0
- package/dist/esm/models/GeoAuditComparison.d.ts +86 -0
- package/dist/esm/models/GeoAuditComparison.js +59 -0
- package/dist/esm/models/GeoAuditComparisonChangesInner.d.ts +86 -0
- package/dist/esm/models/GeoAuditComparisonChangesInner.js +66 -0
- package/dist/esm/models/GeoAuditCreateRequest.d.ts +72 -0
- package/dist/esm/models/GeoAuditCreateRequest.js +73 -0
- package/dist/esm/models/GeoAuditCreateResponse.d.ts +45 -0
- package/dist/esm/models/GeoAuditCreateResponse.js +46 -0
- package/dist/esm/models/GeoAuditFinding.d.ts +91 -0
- package/dist/esm/models/GeoAuditFinding.js +74 -0
- package/dist/esm/models/GeoAuditFindingList.d.ts +63 -0
- package/dist/esm/models/GeoAuditFindingList.js +52 -0
- package/dist/esm/models/GeoAuditIssue.d.ts +124 -0
- package/dist/esm/models/GeoAuditIssue.js +83 -0
- package/dist/esm/models/GeoAuditIssueList.d.ts +63 -0
- package/dist/esm/models/GeoAuditIssueList.js +52 -0
- package/dist/esm/models/GeoAuditIssueResponse.d.ts +136 -0
- package/dist/esm/models/GeoAuditIssueResponse.js +87 -0
- package/dist/esm/models/GeoAuditIssueUpdateRequest.d.ts +38 -0
- package/dist/esm/models/GeoAuditIssueUpdateRequest.js +45 -0
- package/dist/esm/models/GeoAuditList.d.ts +63 -0
- package/dist/esm/models/GeoAuditList.js +52 -0
- package/dist/esm/models/GeoAuditResponse.d.ts +173 -0
- package/dist/esm/models/GeoAuditResponse.js +107 -0
- package/dist/esm/models/GeoAuditRun.d.ts +138 -0
- package/dist/esm/models/GeoAuditRun.js +89 -0
- package/dist/esm/models/GeoAuditRunDetail.d.ts +164 -0
- package/dist/esm/models/GeoAuditRunDetail.js +97 -0
- package/dist/esm/models/GeoAuditRunList.d.ts +63 -0
- package/dist/esm/models/GeoAuditRunList.js +52 -0
- package/dist/esm/models/GeoAuditRunResponse.d.ts +150 -0
- package/dist/esm/models/GeoAuditRunResponse.js +93 -0
- package/dist/esm/models/GeoAuditSchedule.d.ts +44 -0
- package/dist/esm/models/GeoAuditSchedule.js +45 -0
- package/dist/esm/models/GeoAuditUpdateRequest.d.ts +80 -0
- package/dist/esm/models/GeoAuditUpdateRequest.js +67 -0
- package/dist/esm/models/GetAccount200Response.d.ts +91 -0
- package/dist/esm/models/GetAccount200Response.js +67 -0
- package/dist/esm/models/GetAccount200ResponseLimits.d.ts +70 -0
- package/dist/esm/models/GetAccount200ResponseLimits.js +55 -0
- package/dist/esm/models/GetAccount200ResponseRateLimits.d.ts +38 -0
- package/dist/esm/models/GetAccount200ResponseRateLimits.js +43 -0
- package/dist/esm/models/GetAccount200ResponseSubscription.d.ts +44 -0
- package/dist/esm/models/GetAccount200ResponseSubscription.js +45 -0
- package/dist/esm/models/IntelligenceTask.d.ts +158 -0
- package/dist/esm/models/IntelligenceTask.js +83 -0
- package/dist/esm/models/IntelligenceTaskCreateRequest.d.ts +99 -0
- package/dist/esm/models/IntelligenceTaskCreateRequest.js +75 -0
- package/dist/esm/models/IntelligenceTaskProduct.d.ts +75 -0
- package/dist/esm/models/IntelligenceTaskProduct.js +58 -0
- package/dist/esm/models/IntelligenceTaskProductImagesInner.d.ts +38 -0
- package/dist/esm/models/IntelligenceTaskProductImagesInner.js +45 -0
- package/dist/esm/models/IntelligenceTaskSummary.d.ts +98 -0
- package/dist/esm/models/IntelligenceTaskSummary.js +87 -0
- package/dist/esm/models/IntelligenceTaskUpdateRequest.d.ts +46 -0
- package/dist/esm/models/IntelligenceTaskUpdateRequest.js +49 -0
- package/dist/esm/models/IntelligenceTaskUpdateResponse.d.ts +164 -0
- package/dist/esm/models/IntelligenceTaskUpdateResponse.js +85 -0
- package/dist/esm/models/IntelligenceTasksResponse.d.ts +63 -0
- package/dist/esm/models/IntelligenceTasksResponse.js +64 -0
- package/dist/esm/models/LaunchRecommendationsRequest.d.ts +48 -0
- package/dist/esm/models/LaunchRecommendationsRequest.js +54 -0
- package/dist/esm/models/ListCompetitors200Response.d.ts +45 -0
- package/dist/esm/models/ListCompetitors200Response.js +46 -0
- package/dist/esm/models/ListProjects200Response.d.ts +39 -0
- package/dist/esm/models/ListProjects200Response.js +44 -0
- package/dist/esm/models/ListTeamInvitations200Response.d.ts +57 -0
- package/dist/esm/models/ListTeamInvitations200Response.js +50 -0
- package/dist/esm/models/ListTeamMembers200Response.d.ts +57 -0
- package/dist/esm/models/ListTeamMembers200Response.js +50 -0
- package/dist/esm/models/ListWebhooks200Response.d.ts +57 -0
- package/dist/esm/models/ListWebhooks200Response.js +50 -0
- package/dist/esm/models/ListWebhooks200ResponseDataInner.d.ts +90 -0
- package/dist/esm/models/ListWebhooks200ResponseDataInner.js +70 -0
- package/dist/esm/models/LlmsTxtTechnicalGeoReport.d.ts +135 -0
- package/dist/esm/models/LlmsTxtTechnicalGeoReport.js +76 -0
- package/dist/esm/models/LlmsTxtTechnicalGeoReportResultData.d.ts +92 -0
- package/dist/esm/models/LlmsTxtTechnicalGeoReportResultData.js +61 -0
- package/dist/esm/models/LocalBusiness.d.ts +110 -0
- package/dist/esm/models/LocalBusiness.js +67 -0
- package/dist/esm/models/LocalBusinessesResponse.d.ts +70 -0
- package/dist/esm/models/LocalBusinessesResponse.js +55 -0
- package/dist/esm/models/LocalBusinessesTotals.d.ts +56 -0
- package/dist/esm/models/LocalBusinessesTotals.js +49 -0
- package/dist/esm/models/LocalesResponse.d.ts +50 -0
- package/dist/esm/models/LocalesResponse.js +55 -0
- package/dist/esm/models/MentionRecord.d.ts +56 -0
- package/dist/esm/models/MentionRecord.js +59 -0
- package/dist/esm/models/MentionsResponse.d.ts +63 -0
- package/dist/esm/models/MentionsResponse.js +64 -0
- package/dist/esm/models/MetricsFiltersEcho.d.ts +110 -0
- package/dist/esm/models/MetricsFiltersEcho.js +67 -0
- package/dist/esm/models/ModelsResponse.d.ts +63 -0
- package/dist/esm/models/ModelsResponse.js +69 -0
- package/dist/esm/models/PaginatedEnvelope.d.ts +56 -0
- package/dist/esm/models/PaginatedEnvelope.js +59 -0
- package/dist/esm/models/Ping200Response.d.ts +51 -0
- package/dist/esm/models/Ping200Response.js +48 -0
- package/dist/esm/models/Project.d.ts +44 -0
- package/dist/esm/models/Project.js +45 -0
- package/dist/esm/models/ProjectCreateRequest.d.ts +161 -0
- package/dist/esm/models/ProjectCreateRequest.js +94 -0
- package/dist/esm/models/ProjectCreateRequestCollectionsInner.d.ts +38 -0
- package/dist/esm/models/ProjectCreateRequestCollectionsInner.js +45 -0
- package/dist/esm/models/ProjectCreateRequestCompetitorsInner.d.ts +44 -0
- package/dist/esm/models/ProjectCreateRequestCompetitorsInner.js +47 -0
- package/dist/esm/models/ProjectCreateRequestOwnedMedia.d.ts +62 -0
- package/dist/esm/models/ProjectCreateRequestOwnedMedia.js +51 -0
- package/dist/esm/models/ProjectCreateResponse.d.ts +92 -0
- package/dist/esm/models/ProjectCreateResponse.js +65 -0
- package/dist/esm/models/ProjectCreateResponseCollectionsInner.d.ts +44 -0
- package/dist/esm/models/ProjectCreateResponseCollectionsInner.js +45 -0
- package/dist/esm/models/ProjectCreateResponseCompetitors.d.ts +38 -0
- package/dist/esm/models/ProjectCreateResponseCompetitors.js +43 -0
- package/dist/esm/models/ProjectCreateResponseEmailSubscription.d.ts +32 -0
- package/dist/esm/models/ProjectCreateResponseEmailSubscription.js +41 -0
- package/dist/esm/models/ProjectCreateResponseLimits.d.ts +44 -0
- package/dist/esm/models/ProjectCreateResponseLimits.js +45 -0
- package/dist/esm/models/ProjectCreateResponsePrompts.d.ts +52 -0
- package/dist/esm/models/ProjectCreateResponsePrompts.js +52 -0
- package/dist/esm/models/ProjectCreateResponseSameDomainProjectsInner.d.ts +50 -0
- package/dist/esm/models/ProjectCreateResponseSameDomainProjectsInner.js +47 -0
- package/dist/esm/models/ProjectDetails.d.ts +167 -0
- package/dist/esm/models/ProjectDetails.js +88 -0
- package/dist/esm/models/ProjectDetailsAllOfDataCoverage.d.ts +63 -0
- package/dist/esm/models/ProjectDetailsAllOfDataCoverage.js +63 -0
- package/dist/esm/models/ProjectDetailsAllOfSearchConsole.d.ts +47 -0
- package/dist/esm/models/ProjectDetailsAllOfSearchConsole.js +51 -0
- package/dist/esm/models/ProjectDetailsAllOfStats.d.ts +51 -0
- package/dist/esm/models/ProjectDetailsAllOfStats.js +48 -0
- package/dist/esm/models/ProjectDetailsAllOfStatsPromptsByBrandKind.d.ts +44 -0
- package/dist/esm/models/ProjectDetailsAllOfStatsPromptsByBrandKind.js +45 -0
- package/dist/esm/models/PromptExecutionRecord.d.ts +117 -0
- package/dist/esm/models/PromptExecutionRecord.js +105 -0
- package/dist/esm/models/PromptExecutionsResponse.d.ts +63 -0
- package/dist/esm/models/PromptExecutionsResponse.js +64 -0
- package/dist/esm/models/PromptRecord.d.ts +93 -0
- package/dist/esm/models/PromptRecord.js +84 -0
- package/dist/esm/models/PromptSummaryResponse.d.ts +100 -0
- package/dist/esm/models/PromptSummaryResponse.js +65 -0
- package/dist/esm/models/PromptSummaryRow.d.ts +171 -0
- package/dist/esm/models/PromptSummaryRow.js +88 -0
- package/dist/esm/models/PromptTagsAssignResponse.d.ts +75 -0
- package/dist/esm/models/PromptTagsAssignResponse.js +72 -0
- package/dist/esm/models/PromptsCreateRequest.d.ts +50 -0
- package/dist/esm/models/PromptsCreateRequest.js +55 -0
- package/dist/esm/models/PromptsCreateResponse.d.ts +69 -0
- package/dist/esm/models/PromptsCreateResponse.js +54 -0
- package/dist/esm/models/PromptsCreateResponseDataInner.d.ts +52 -0
- package/dist/esm/models/PromptsCreateResponseDataInner.js +52 -0
- package/dist/esm/models/PromptsResponse.d.ts +63 -0
- package/dist/esm/models/PromptsResponse.js +64 -0
- package/dist/esm/models/QueryWebAnalyticsRequest.d.ts +38 -0
- package/dist/esm/models/QueryWebAnalyticsRequest.js +47 -0
- package/dist/esm/models/RecommendationSummary.d.ts +119 -0
- package/dist/esm/models/RecommendationSummary.js +106 -0
- package/dist/esm/models/RecommendationSummarySummary.d.ts +44 -0
- package/dist/esm/models/RecommendationSummarySummary.js +45 -0
- package/dist/esm/models/RecommendationsResponse.d.ts +63 -0
- package/dist/esm/models/RecommendationsResponse.js +64 -0
- package/dist/esm/models/RemoveTeamMember200Response.d.ts +44 -0
- package/dist/esm/models/RemoveTeamMember200Response.js +45 -0
- package/dist/esm/models/RevokeTeamInvitation200Response.d.ts +44 -0
- package/dist/esm/models/RevokeTeamInvitation200Response.js +45 -0
- package/dist/esm/models/SampleWebhookPayloads200Response.d.ts +45 -0
- package/dist/esm/models/SampleWebhookPayloads200Response.js +46 -0
- package/dist/esm/models/SampleWebhookPayloads200ResponseDataInner.d.ts +56 -0
- package/dist/esm/models/SampleWebhookPayloads200ResponseDataInner.js +49 -0
- package/dist/esm/models/SearchConsoleFiltersInner.d.ts +67 -0
- package/dist/esm/models/SearchConsoleFiltersInner.js +70 -0
- package/dist/esm/models/SearchConsoleListResponse.d.ts +106 -0
- package/dist/esm/models/SearchConsoleListResponse.js +67 -0
- package/dist/esm/models/SearchConsoleListResponseDataInner.d.ts +56 -0
- package/dist/esm/models/SearchConsoleListResponseDataInner.js +49 -0
- package/dist/esm/models/SearchConsoleMetrics.d.ts +50 -0
- package/dist/esm/models/SearchConsoleMetrics.js +47 -0
- package/dist/esm/models/SearchConsoleProperty.d.ts +38 -0
- package/dist/esm/models/SearchConsoleProperty.js +43 -0
- package/dist/esm/models/SearchConsoleRowsResponse.d.ts +112 -0
- package/dist/esm/models/SearchConsoleRowsResponse.js +69 -0
- package/dist/esm/models/SearchConsoleRowsResponseDataInner.d.ts +86 -0
- package/dist/esm/models/SearchConsoleRowsResponseDataInner.js +59 -0
- package/dist/esm/models/SearchConsoleSummaryResponse.d.ts +89 -0
- package/dist/esm/models/SearchConsoleSummaryResponse.js +62 -0
- package/dist/esm/models/SearchConsoleSummaryResponseBreakdownInner.d.ts +56 -0
- package/dist/esm/models/SearchConsoleSummaryResponseBreakdownInner.js +49 -0
- package/dist/esm/models/SearchConsoleTimeseriesResponse.d.ts +76 -0
- package/dist/esm/models/SearchConsoleTimeseriesResponse.js +57 -0
- package/dist/esm/models/SearchConsoleTimeseriesResponseDataInner.d.ts +56 -0
- package/dist/esm/models/SearchConsoleTimeseriesResponseDataInner.js +49 -0
- package/dist/esm/models/SentimentRecord.d.ts +134 -0
- package/dist/esm/models/SentimentRecord.js +119 -0
- package/dist/esm/models/SentimentsResponse.d.ts +63 -0
- package/dist/esm/models/SentimentsResponse.js +64 -0
- package/dist/esm/models/SovResponse.d.ts +105 -0
- package/dist/esm/models/SovResponse.js +70 -0
- package/dist/esm/models/SovResponseBreakdownInner.d.ts +51 -0
- package/dist/esm/models/SovResponseBreakdownInner.js +48 -0
- package/dist/esm/models/SovResponseCurrentInner.d.ts +51 -0
- package/dist/esm/models/SovResponseCurrentInner.js +48 -0
- package/dist/esm/models/SovResponseOthersInner.d.ts +45 -0
- package/dist/esm/models/SovResponseOthersInner.js +46 -0
- package/dist/esm/models/SovResponseOverTimeInner.d.ts +40 -0
- package/dist/esm/models/SovResponseOverTimeInner.js +45 -0
- package/dist/esm/models/SovResponsePeriodsInner.d.ts +56 -0
- package/dist/esm/models/SovResponsePeriodsInner.js +49 -0
- package/dist/esm/models/SovResponseSample.d.ts +56 -0
- package/dist/esm/models/SovResponseSample.js +49 -0
- package/dist/esm/models/StoreConnectionResponse.d.ts +71 -0
- package/dist/esm/models/StoreConnectionResponse.js +70 -0
- package/dist/esm/models/StoreConnectionResponseAccount.d.ts +32 -0
- package/dist/esm/models/StoreConnectionResponseAccount.js +41 -0
- package/dist/esm/models/StoreConnectionResponseCandidatesInner.d.ts +44 -0
- package/dist/esm/models/StoreConnectionResponseCandidatesInner.js +51 -0
- package/dist/esm/models/StoreConnectionResponseProject.d.ts +56 -0
- package/dist/esm/models/StoreConnectionResponseProject.js +55 -0
- package/dist/esm/models/SummaryResponse.d.ts +88 -0
- package/dist/esm/models/SummaryResponse.js +59 -0
- package/dist/esm/models/SummaryResponseAllOfPositionDistribution.d.ts +56 -0
- package/dist/esm/models/SummaryResponseAllOfPositionDistribution.js +49 -0
- package/dist/esm/models/SummaryResponseAllOfSummaryValueInner.d.ts +77 -0
- package/dist/esm/models/SummaryResponseAllOfSummaryValueInner.js +61 -0
- package/dist/esm/models/TagRef.d.ts +38 -0
- package/dist/esm/models/TagRef.js +47 -0
- package/dist/esm/models/TeamAccountRole.d.ts +38 -0
- package/dist/esm/models/TeamAccountRole.js +47 -0
- package/dist/esm/models/TeamInvitation.d.ts +111 -0
- package/dist/esm/models/TeamInvitation.js +91 -0
- package/dist/esm/models/TeamMember.d.ts +135 -0
- package/dist/esm/models/TeamMember.js +106 -0
- package/dist/esm/models/TechnicalGeoReportContentRevertRequest.d.ts +45 -0
- package/dist/esm/models/TechnicalGeoReportContentRevertRequest.js +55 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateRequest.d.ts +58 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateRequest.js +64 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateRequestEdits.d.ts +38 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateRequestEdits.js +43 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateResponse.d.ts +149 -0
- package/dist/esm/models/TechnicalGeoReportContentUpdateResponse.js +85 -0
- package/dist/esm/models/TimeseriesPoint.d.ts +38 -0
- package/dist/esm/models/TimeseriesPoint.js +43 -0
- package/dist/esm/models/TimeseriesResponse.d.ts +72 -0
- package/dist/esm/models/TimeseriesResponse.js +54 -0
- package/dist/esm/models/TimeseriesSeries.d.ts +46 -0
- package/dist/esm/models/TimeseriesSeries.js +47 -0
- package/dist/esm/models/TopSourcesResponse.d.ts +88 -0
- package/dist/esm/models/TopSourcesResponse.js +61 -0
- package/dist/esm/models/TopSourcesResponseDataInner.d.ts +50 -0
- package/dist/esm/models/TopSourcesResponseDataInner.js +47 -0
- package/dist/esm/models/UpdateAnnotationRequest.d.ts +62 -0
- package/dist/esm/models/UpdateAnnotationRequest.js +53 -0
- package/dist/esm/models/UpdateCollectionRequest.d.ts +44 -0
- package/dist/esm/models/UpdateCollectionRequest.js +47 -0
- package/dist/esm/models/UpdateCompetitorRequest.d.ts +77 -0
- package/dist/esm/models/UpdateCompetitorRequest.js +63 -0
- package/dist/esm/models/UpdateProjectDraftRequest.d.ts +132 -0
- package/dist/esm/models/UpdateProjectDraftRequest.js +82 -0
- package/dist/esm/models/UpdateProjectRequest.d.ts +92 -0
- package/dist/esm/models/UpdateProjectRequest.js +61 -0
- package/dist/esm/models/WebAnalyticsQueryResponse.d.ts +135 -0
- package/dist/esm/models/WebAnalyticsQueryResponse.js +81 -0
- package/dist/esm/models/WebAnalyticsQueryResponseColumnsInner.d.ts +50 -0
- package/dist/esm/models/WebAnalyticsQueryResponseColumnsInner.js +47 -0
- package/dist/esm/models/WebAnalyticsSchemaResponse.d.ts +108 -0
- package/dist/esm/models/WebAnalyticsSchemaResponse.js +72 -0
- package/dist/esm/models/index.d.ts +191 -0
- package/dist/esm/models/index.js +193 -0
- package/dist/esm/runtime.d.ts +185 -0
- package/dist/esm/runtime.js +354 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/AccountCapacity.d.ts +38 -0
- package/dist/models/AccountCapacity.js +50 -0
- package/dist/models/AccountQuota.d.ts +56 -0
- package/dist/models/AccountQuota.js +56 -0
- package/dist/models/Actor.d.ts +64 -0
- package/dist/models/Actor.js +64 -0
- package/dist/models/AgentBot.d.ts +62 -0
- package/dist/models/AgentBot.js +58 -0
- package/dist/models/AgentBotsResponse.d.ts +45 -0
- package/dist/models/AgentBotsResponse.js +53 -0
- package/dist/models/AgentTrafficResponse.d.ts +97 -0
- package/dist/models/AgentTrafficResponse.js +78 -0
- package/dist/models/AiOrdersResponse.d.ts +83 -0
- package/dist/models/AiOrdersResponse.js +85 -0
- package/dist/models/AiOrdersResponseBySourceInner.d.ts +50 -0
- package/dist/models/AiOrdersResponseBySourceInner.js +62 -0
- package/dist/models/AiOrdersResponseSeriesInner.d.ts +44 -0
- package/dist/models/AiOrdersResponseSeriesInner.js +58 -0
- package/dist/models/AiOrdersResponseTotals.d.ts +38 -0
- package/dist/models/AiOrdersResponseTotals.js +54 -0
- package/dist/models/AiOrdersUpdateRequest.d.ts +70 -0
- package/dist/models/AiOrdersUpdateRequest.js +80 -0
- package/dist/models/AiOrdersUpdateRequestDaysInner.d.ts +50 -0
- package/dist/models/AiOrdersUpdateRequestDaysInner.js +62 -0
- package/dist/models/AiOrdersUpdateResponse.d.ts +56 -0
- package/dist/models/AiOrdersUpdateResponse.js +66 -0
- package/dist/models/AnnotationCreateResponse.d.ts +45 -0
- package/dist/models/AnnotationCreateResponse.js +59 -0
- package/dist/models/AnnotationCreateResponseAnnotation.d.ts +62 -0
- package/dist/models/AnnotationCreateResponseAnnotation.js +70 -0
- package/dist/models/AnswerDetails.d.ts +165 -0
- package/dist/models/AnswerDetails.js +93 -0
- package/dist/models/AnswerDetailsLocale.d.ts +38 -0
- package/dist/models/AnswerDetailsLocale.js +50 -0
- package/dist/models/ApiError.d.ts +39 -0
- package/dist/models/ApiError.js +51 -0
- package/dist/models/ApiErrorError.d.ts +79 -0
- package/dist/models/ApiErrorError.js +87 -0
- package/dist/models/AssignPromptTagsRequest.d.ts +56 -0
- package/dist/models/AssignPromptTagsRequest.js +60 -0
- package/dist/models/CatalogProduct.d.ts +74 -0
- package/dist/models/CatalogProduct.js +66 -0
- package/dist/models/CatalogPromptSuggestion.d.ts +87 -0
- package/dist/models/CatalogPromptSuggestion.js +87 -0
- package/dist/models/CatalogPromptSuggestionIdsRequest.d.ts +38 -0
- package/dist/models/CatalogPromptSuggestionIdsRequest.js +54 -0
- package/dist/models/CatalogPromptSuggestionProduct.d.ts +44 -0
- package/dist/models/CatalogPromptSuggestionProduct.js +52 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponse.d.ts +58 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponse.js +68 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponseAcceptedInner.d.ts +44 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponseAcceptedInner.js +58 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponseSkippedInner.d.ts +38 -0
- package/dist/models/CatalogPromptSuggestionsAcceptResponseSkippedInner.js +54 -0
- package/dist/models/CatalogPromptSuggestionsCreateRequest.d.ts +64 -0
- package/dist/models/CatalogPromptSuggestionsCreateRequest.js +72 -0
- package/dist/models/CatalogPromptSuggestionsCreateResponse.d.ts +57 -0
- package/dist/models/CatalogPromptSuggestionsCreateResponse.js +67 -0
- package/dist/models/CatalogPromptSuggestionsRejectResponse.d.ts +44 -0
- package/dist/models/CatalogPromptSuggestionsRejectResponse.js +58 -0
- package/dist/models/CatalogPromptSuggestionsResponse.d.ts +63 -0
- package/dist/models/CatalogPromptSuggestionsResponse.js +71 -0
- package/dist/models/CitationMatchMode.d.ts +26 -0
- package/dist/models/CitationMatchMode.js +52 -0
- package/dist/models/CitationRecord.d.ts +74 -0
- package/dist/models/CitationRecord.js +78 -0
- package/dist/models/CitationsResponse.d.ts +63 -0
- package/dist/models/CitationsResponse.js +71 -0
- package/dist/models/CollectionCreateResponse.d.ts +57 -0
- package/dist/models/CollectionCreateResponse.js +67 -0
- package/dist/models/CollectionCreateResponseCollection.d.ts +44 -0
- package/dist/models/CollectionCreateResponseCollection.js +58 -0
- package/dist/models/CollectionsResponse.d.ts +45 -0
- package/dist/models/CollectionsResponse.js +59 -0
- package/dist/models/Competitor.d.ts +83 -0
- package/dist/models/Competitor.js +71 -0
- package/dist/models/CompetitorCreateResponse.d.ts +57 -0
- package/dist/models/CompetitorCreateResponse.js +67 -0
- package/dist/models/CompetitorCreateResponseCompetitor.d.ts +69 -0
- package/dist/models/CompetitorCreateResponseCompetitor.js +75 -0
- package/dist/models/CompetitorDetails.d.ts +129 -0
- package/dist/models/CompetitorDetails.js +81 -0
- package/dist/models/CompetitorMentionRecord.d.ts +62 -0
- package/dist/models/CompetitorMentionRecord.js +70 -0
- package/dist/models/CompetitorMentionsResponse.d.ts +63 -0
- package/dist/models/CompetitorMentionsResponse.js +71 -0
- package/dist/models/CreateAnnotationRequest.d.ts +62 -0
- package/dist/models/CreateAnnotationRequest.js +62 -0
- package/dist/models/CreateCollectionRequest.d.ts +50 -0
- package/dist/models/CreateCollectionRequest.js +58 -0
- package/dist/models/CreateCompetitorRequest.d.ts +71 -0
- package/dist/models/CreateCompetitorRequest.js +73 -0
- package/dist/models/CreateProjectDraftRequest.d.ts +62 -0
- package/dist/models/CreateProjectDraftRequest.js +64 -0
- package/dist/models/CreateTeamInvitation201Response.d.ts +123 -0
- package/dist/models/CreateTeamInvitation201Response.js +105 -0
- package/dist/models/CreateTeamInvitationRequest.d.ts +86 -0
- package/dist/models/CreateTeamInvitationRequest.js +74 -0
- package/dist/models/CreateTechnicalGeoReportsRequest.d.ts +50 -0
- package/dist/models/CreateTechnicalGeoReportsRequest.js +58 -0
- package/dist/models/CreateWebhook201Response.d.ts +102 -0
- package/dist/models/CreateWebhook201Response.js +82 -0
- package/dist/models/CreateWebhookRequest.d.ts +60 -0
- package/dist/models/CreateWebhookRequest.js +74 -0
- package/dist/models/DeleteWebhook200Response.d.ts +44 -0
- package/dist/models/DeleteWebhook200Response.js +52 -0
- package/dist/models/FinalizeProjectDraftRequest.d.ts +38 -0
- package/dist/models/FinalizeProjectDraftRequest.js +50 -0
- package/dist/models/GeoAlert.d.ts +81 -0
- package/dist/models/GeoAlert.js +65 -0
- package/dist/models/GeoAlertEventsInner.d.ts +68 -0
- package/dist/models/GeoAlertEventsInner.js +68 -0
- package/dist/models/GeoAlertList.d.ts +63 -0
- package/dist/models/GeoAlertList.js +59 -0
- package/dist/models/GeoAudit.d.ts +161 -0
- package/dist/models/GeoAudit.js +111 -0
- package/dist/models/GeoAuditArchived.d.ts +50 -0
- package/dist/models/GeoAuditArchived.js +54 -0
- package/dist/models/GeoAuditComparison.d.ts +86 -0
- package/dist/models/GeoAuditComparison.js +66 -0
- package/dist/models/GeoAuditComparisonChangesInner.d.ts +86 -0
- package/dist/models/GeoAuditComparisonChangesInner.js +74 -0
- package/dist/models/GeoAuditCreateRequest.d.ts +72 -0
- package/dist/models/GeoAuditCreateRequest.js +81 -0
- package/dist/models/GeoAuditCreateResponse.d.ts +45 -0
- package/dist/models/GeoAuditCreateResponse.js +53 -0
- package/dist/models/GeoAuditFinding.d.ts +91 -0
- package/dist/models/GeoAuditFinding.js +82 -0
- package/dist/models/GeoAuditFindingList.d.ts +63 -0
- package/dist/models/GeoAuditFindingList.js +59 -0
- package/dist/models/GeoAuditIssue.d.ts +124 -0
- package/dist/models/GeoAuditIssue.js +91 -0
- package/dist/models/GeoAuditIssueList.d.ts +63 -0
- package/dist/models/GeoAuditIssueList.js +59 -0
- package/dist/models/GeoAuditIssueResponse.d.ts +136 -0
- package/dist/models/GeoAuditIssueResponse.js +95 -0
- package/dist/models/GeoAuditIssueUpdateRequest.d.ts +38 -0
- package/dist/models/GeoAuditIssueUpdateRequest.js +52 -0
- package/dist/models/GeoAuditList.d.ts +63 -0
- package/dist/models/GeoAuditList.js +59 -0
- package/dist/models/GeoAuditResponse.d.ts +173 -0
- package/dist/models/GeoAuditResponse.js +115 -0
- package/dist/models/GeoAuditRun.d.ts +138 -0
- package/dist/models/GeoAuditRun.js +97 -0
- package/dist/models/GeoAuditRunDetail.d.ts +164 -0
- package/dist/models/GeoAuditRunDetail.js +105 -0
- package/dist/models/GeoAuditRunList.d.ts +63 -0
- package/dist/models/GeoAuditRunList.js +59 -0
- package/dist/models/GeoAuditRunResponse.d.ts +150 -0
- package/dist/models/GeoAuditRunResponse.js +101 -0
- package/dist/models/GeoAuditSchedule.d.ts +44 -0
- package/dist/models/GeoAuditSchedule.js +52 -0
- package/dist/models/GeoAuditUpdateRequest.d.ts +80 -0
- package/dist/models/GeoAuditUpdateRequest.js +75 -0
- package/dist/models/GetAccount200Response.d.ts +91 -0
- package/dist/models/GetAccount200Response.js +75 -0
- package/dist/models/GetAccount200ResponseLimits.d.ts +70 -0
- package/dist/models/GetAccount200ResponseLimits.js +62 -0
- package/dist/models/GetAccount200ResponseRateLimits.d.ts +38 -0
- package/dist/models/GetAccount200ResponseRateLimits.js +50 -0
- package/dist/models/GetAccount200ResponseSubscription.d.ts +44 -0
- package/dist/models/GetAccount200ResponseSubscription.js +52 -0
- package/dist/models/IntelligenceTask.d.ts +158 -0
- package/dist/models/IntelligenceTask.js +90 -0
- package/dist/models/IntelligenceTaskCreateRequest.d.ts +99 -0
- package/dist/models/IntelligenceTaskCreateRequest.js +83 -0
- package/dist/models/IntelligenceTaskProduct.d.ts +75 -0
- package/dist/models/IntelligenceTaskProduct.js +65 -0
- package/dist/models/IntelligenceTaskProductImagesInner.d.ts +38 -0
- package/dist/models/IntelligenceTaskProductImagesInner.js +52 -0
- package/dist/models/IntelligenceTaskSummary.d.ts +98 -0
- package/dist/models/IntelligenceTaskSummary.js +94 -0
- package/dist/models/IntelligenceTaskUpdateRequest.d.ts +46 -0
- package/dist/models/IntelligenceTaskUpdateRequest.js +56 -0
- package/dist/models/IntelligenceTaskUpdateResponse.d.ts +164 -0
- package/dist/models/IntelligenceTaskUpdateResponse.js +92 -0
- package/dist/models/IntelligenceTasksResponse.d.ts +63 -0
- package/dist/models/IntelligenceTasksResponse.js +71 -0
- package/dist/models/LaunchRecommendationsRequest.d.ts +48 -0
- package/dist/models/LaunchRecommendationsRequest.js +62 -0
- package/dist/models/ListCompetitors200Response.d.ts +45 -0
- package/dist/models/ListCompetitors200Response.js +53 -0
- package/dist/models/ListProjects200Response.d.ts +39 -0
- package/dist/models/ListProjects200Response.js +51 -0
- package/dist/models/ListTeamInvitations200Response.d.ts +57 -0
- package/dist/models/ListTeamInvitations200Response.js +57 -0
- package/dist/models/ListTeamMembers200Response.d.ts +57 -0
- package/dist/models/ListTeamMembers200Response.js +57 -0
- package/dist/models/ListWebhooks200Response.d.ts +57 -0
- package/dist/models/ListWebhooks200Response.js +57 -0
- package/dist/models/ListWebhooks200ResponseDataInner.d.ts +90 -0
- package/dist/models/ListWebhooks200ResponseDataInner.js +78 -0
- package/dist/models/LlmsTxtTechnicalGeoReport.d.ts +135 -0
- package/dist/models/LlmsTxtTechnicalGeoReport.js +83 -0
- package/dist/models/LlmsTxtTechnicalGeoReportResultData.d.ts +92 -0
- package/dist/models/LlmsTxtTechnicalGeoReportResultData.js +68 -0
- package/dist/models/LocalBusiness.d.ts +110 -0
- package/dist/models/LocalBusiness.js +74 -0
- package/dist/models/LocalBusinessesResponse.d.ts +70 -0
- package/dist/models/LocalBusinessesResponse.js +62 -0
- package/dist/models/LocalBusinessesTotals.d.ts +56 -0
- package/dist/models/LocalBusinessesTotals.js +56 -0
- package/dist/models/LocalesResponse.d.ts +50 -0
- package/dist/models/LocalesResponse.js +62 -0
- package/dist/models/MentionRecord.d.ts +56 -0
- package/dist/models/MentionRecord.js +66 -0
- package/dist/models/MentionsResponse.d.ts +63 -0
- package/dist/models/MentionsResponse.js +71 -0
- package/dist/models/MetricsFiltersEcho.d.ts +110 -0
- package/dist/models/MetricsFiltersEcho.js +74 -0
- package/dist/models/ModelsResponse.d.ts +63 -0
- package/dist/models/ModelsResponse.js +77 -0
- package/dist/models/PaginatedEnvelope.d.ts +56 -0
- package/dist/models/PaginatedEnvelope.js +66 -0
- package/dist/models/Ping200Response.d.ts +51 -0
- package/dist/models/Ping200Response.js +55 -0
- package/dist/models/Project.d.ts +44 -0
- package/dist/models/Project.js +52 -0
- package/dist/models/ProjectCreateRequest.d.ts +161 -0
- package/dist/models/ProjectCreateRequest.js +101 -0
- package/dist/models/ProjectCreateRequestCollectionsInner.d.ts +38 -0
- package/dist/models/ProjectCreateRequestCollectionsInner.js +52 -0
- package/dist/models/ProjectCreateRequestCompetitorsInner.d.ts +44 -0
- package/dist/models/ProjectCreateRequestCompetitorsInner.js +54 -0
- package/dist/models/ProjectCreateRequestOwnedMedia.d.ts +62 -0
- package/dist/models/ProjectCreateRequestOwnedMedia.js +58 -0
- package/dist/models/ProjectCreateResponse.d.ts +92 -0
- package/dist/models/ProjectCreateResponse.js +72 -0
- package/dist/models/ProjectCreateResponseCollectionsInner.d.ts +44 -0
- package/dist/models/ProjectCreateResponseCollectionsInner.js +52 -0
- package/dist/models/ProjectCreateResponseCompetitors.d.ts +38 -0
- package/dist/models/ProjectCreateResponseCompetitors.js +50 -0
- package/dist/models/ProjectCreateResponseEmailSubscription.d.ts +32 -0
- package/dist/models/ProjectCreateResponseEmailSubscription.js +48 -0
- package/dist/models/ProjectCreateResponseLimits.d.ts +44 -0
- package/dist/models/ProjectCreateResponseLimits.js +52 -0
- package/dist/models/ProjectCreateResponsePrompts.d.ts +52 -0
- package/dist/models/ProjectCreateResponsePrompts.js +60 -0
- package/dist/models/ProjectCreateResponseSameDomainProjectsInner.d.ts +50 -0
- package/dist/models/ProjectCreateResponseSameDomainProjectsInner.js +54 -0
- package/dist/models/ProjectDetails.d.ts +167 -0
- package/dist/models/ProjectDetails.js +95 -0
- package/dist/models/ProjectDetailsAllOfDataCoverage.d.ts +63 -0
- package/dist/models/ProjectDetailsAllOfDataCoverage.js +71 -0
- package/dist/models/ProjectDetailsAllOfSearchConsole.d.ts +47 -0
- package/dist/models/ProjectDetailsAllOfSearchConsole.js +59 -0
- package/dist/models/ProjectDetailsAllOfStats.d.ts +51 -0
- package/dist/models/ProjectDetailsAllOfStats.js +55 -0
- package/dist/models/ProjectDetailsAllOfStatsPromptsByBrandKind.d.ts +44 -0
- package/dist/models/ProjectDetailsAllOfStatsPromptsByBrandKind.js +52 -0
- package/dist/models/PromptExecutionRecord.d.ts +117 -0
- package/dist/models/PromptExecutionRecord.js +113 -0
- package/dist/models/PromptExecutionsResponse.d.ts +63 -0
- package/dist/models/PromptExecutionsResponse.js +71 -0
- package/dist/models/PromptRecord.d.ts +93 -0
- package/dist/models/PromptRecord.js +91 -0
- package/dist/models/PromptSummaryResponse.d.ts +100 -0
- package/dist/models/PromptSummaryResponse.js +72 -0
- package/dist/models/PromptSummaryRow.d.ts +171 -0
- package/dist/models/PromptSummaryRow.js +95 -0
- package/dist/models/PromptTagsAssignResponse.d.ts +75 -0
- package/dist/models/PromptTagsAssignResponse.js +79 -0
- package/dist/models/PromptsCreateRequest.d.ts +50 -0
- package/dist/models/PromptsCreateRequest.js +62 -0
- package/dist/models/PromptsCreateResponse.d.ts +69 -0
- package/dist/models/PromptsCreateResponse.js +61 -0
- package/dist/models/PromptsCreateResponseDataInner.d.ts +52 -0
- package/dist/models/PromptsCreateResponseDataInner.js +60 -0
- package/dist/models/PromptsResponse.d.ts +63 -0
- package/dist/models/PromptsResponse.js +71 -0
- package/dist/models/QueryWebAnalyticsRequest.d.ts +38 -0
- package/dist/models/QueryWebAnalyticsRequest.js +54 -0
- package/dist/models/RecommendationSummary.d.ts +119 -0
- package/dist/models/RecommendationSummary.js +114 -0
- package/dist/models/RecommendationSummarySummary.d.ts +44 -0
- package/dist/models/RecommendationSummarySummary.js +52 -0
- package/dist/models/RecommendationsResponse.d.ts +63 -0
- package/dist/models/RecommendationsResponse.js +71 -0
- package/dist/models/RemoveTeamMember200Response.d.ts +44 -0
- package/dist/models/RemoveTeamMember200Response.js +52 -0
- package/dist/models/RevokeTeamInvitation200Response.d.ts +44 -0
- package/dist/models/RevokeTeamInvitation200Response.js +52 -0
- package/dist/models/SampleWebhookPayloads200Response.d.ts +45 -0
- package/dist/models/SampleWebhookPayloads200Response.js +53 -0
- package/dist/models/SampleWebhookPayloads200ResponseDataInner.d.ts +56 -0
- package/dist/models/SampleWebhookPayloads200ResponseDataInner.js +56 -0
- package/dist/models/SearchConsoleFiltersInner.d.ts +67 -0
- package/dist/models/SearchConsoleFiltersInner.js +78 -0
- package/dist/models/SearchConsoleListResponse.d.ts +106 -0
- package/dist/models/SearchConsoleListResponse.js +74 -0
- package/dist/models/SearchConsoleListResponseDataInner.d.ts +56 -0
- package/dist/models/SearchConsoleListResponseDataInner.js +56 -0
- package/dist/models/SearchConsoleMetrics.d.ts +50 -0
- package/dist/models/SearchConsoleMetrics.js +54 -0
- package/dist/models/SearchConsoleProperty.d.ts +38 -0
- package/dist/models/SearchConsoleProperty.js +50 -0
- package/dist/models/SearchConsoleRowsResponse.d.ts +112 -0
- package/dist/models/SearchConsoleRowsResponse.js +76 -0
- package/dist/models/SearchConsoleRowsResponseDataInner.d.ts +86 -0
- package/dist/models/SearchConsoleRowsResponseDataInner.js +66 -0
- package/dist/models/SearchConsoleSummaryResponse.d.ts +89 -0
- package/dist/models/SearchConsoleSummaryResponse.js +69 -0
- package/dist/models/SearchConsoleSummaryResponseBreakdownInner.d.ts +56 -0
- package/dist/models/SearchConsoleSummaryResponseBreakdownInner.js +56 -0
- package/dist/models/SearchConsoleTimeseriesResponse.d.ts +76 -0
- package/dist/models/SearchConsoleTimeseriesResponse.js +64 -0
- package/dist/models/SearchConsoleTimeseriesResponseDataInner.d.ts +56 -0
- package/dist/models/SearchConsoleTimeseriesResponseDataInner.js +56 -0
- package/dist/models/SentimentRecord.d.ts +134 -0
- package/dist/models/SentimentRecord.js +127 -0
- package/dist/models/SentimentsResponse.d.ts +63 -0
- package/dist/models/SentimentsResponse.js +71 -0
- package/dist/models/SovResponse.d.ts +105 -0
- package/dist/models/SovResponse.js +77 -0
- package/dist/models/SovResponseBreakdownInner.d.ts +51 -0
- package/dist/models/SovResponseBreakdownInner.js +55 -0
- package/dist/models/SovResponseCurrentInner.d.ts +51 -0
- package/dist/models/SovResponseCurrentInner.js +55 -0
- package/dist/models/SovResponseOthersInner.d.ts +45 -0
- package/dist/models/SovResponseOthersInner.js +53 -0
- package/dist/models/SovResponseOverTimeInner.d.ts +40 -0
- package/dist/models/SovResponseOverTimeInner.js +52 -0
- package/dist/models/SovResponsePeriodsInner.d.ts +56 -0
- package/dist/models/SovResponsePeriodsInner.js +56 -0
- package/dist/models/SovResponseSample.d.ts +56 -0
- package/dist/models/SovResponseSample.js +56 -0
- package/dist/models/StoreConnectionResponse.d.ts +71 -0
- package/dist/models/StoreConnectionResponse.js +77 -0
- package/dist/models/StoreConnectionResponseAccount.d.ts +32 -0
- package/dist/models/StoreConnectionResponseAccount.js +48 -0
- package/dist/models/StoreConnectionResponseCandidatesInner.d.ts +44 -0
- package/dist/models/StoreConnectionResponseCandidatesInner.js +58 -0
- package/dist/models/StoreConnectionResponseProject.d.ts +56 -0
- package/dist/models/StoreConnectionResponseProject.js +62 -0
- package/dist/models/SummaryResponse.d.ts +88 -0
- package/dist/models/SummaryResponse.js +66 -0
- package/dist/models/SummaryResponseAllOfPositionDistribution.d.ts +56 -0
- package/dist/models/SummaryResponseAllOfPositionDistribution.js +56 -0
- package/dist/models/SummaryResponseAllOfSummaryValueInner.d.ts +77 -0
- package/dist/models/SummaryResponseAllOfSummaryValueInner.js +69 -0
- package/dist/models/TagRef.d.ts +38 -0
- package/dist/models/TagRef.js +54 -0
- package/dist/models/TeamAccountRole.d.ts +38 -0
- package/dist/models/TeamAccountRole.js +54 -0
- package/dist/models/TeamInvitation.d.ts +111 -0
- package/dist/models/TeamInvitation.js +99 -0
- package/dist/models/TeamMember.d.ts +135 -0
- package/dist/models/TeamMember.js +114 -0
- package/dist/models/TechnicalGeoReportContentRevertRequest.d.ts +45 -0
- package/dist/models/TechnicalGeoReportContentRevertRequest.js +63 -0
- package/dist/models/TechnicalGeoReportContentUpdateRequest.d.ts +58 -0
- package/dist/models/TechnicalGeoReportContentUpdateRequest.js +72 -0
- package/dist/models/TechnicalGeoReportContentUpdateRequestEdits.d.ts +38 -0
- package/dist/models/TechnicalGeoReportContentUpdateRequestEdits.js +50 -0
- package/dist/models/TechnicalGeoReportContentUpdateResponse.d.ts +149 -0
- package/dist/models/TechnicalGeoReportContentUpdateResponse.js +93 -0
- package/dist/models/TimeseriesPoint.d.ts +38 -0
- package/dist/models/TimeseriesPoint.js +50 -0
- package/dist/models/TimeseriesResponse.d.ts +72 -0
- package/dist/models/TimeseriesResponse.js +61 -0
- package/dist/models/TimeseriesSeries.d.ts +46 -0
- package/dist/models/TimeseriesSeries.js +54 -0
- package/dist/models/TopSourcesResponse.d.ts +88 -0
- package/dist/models/TopSourcesResponse.js +68 -0
- package/dist/models/TopSourcesResponseDataInner.d.ts +50 -0
- package/dist/models/TopSourcesResponseDataInner.js +54 -0
- package/dist/models/UpdateAnnotationRequest.d.ts +62 -0
- package/dist/models/UpdateAnnotationRequest.js +60 -0
- package/dist/models/UpdateCollectionRequest.d.ts +44 -0
- package/dist/models/UpdateCollectionRequest.js +54 -0
- package/dist/models/UpdateCompetitorRequest.d.ts +77 -0
- package/dist/models/UpdateCompetitorRequest.js +71 -0
- package/dist/models/UpdateProjectDraftRequest.d.ts +132 -0
- package/dist/models/UpdateProjectDraftRequest.js +90 -0
- package/dist/models/UpdateProjectRequest.d.ts +92 -0
- package/dist/models/UpdateProjectRequest.js +68 -0
- package/dist/models/WebAnalyticsQueryResponse.d.ts +135 -0
- package/dist/models/WebAnalyticsQueryResponse.js +89 -0
- package/dist/models/WebAnalyticsQueryResponseColumnsInner.d.ts +50 -0
- package/dist/models/WebAnalyticsQueryResponseColumnsInner.js +54 -0
- package/dist/models/WebAnalyticsSchemaResponse.d.ts +108 -0
- package/dist/models/WebAnalyticsSchemaResponse.js +80 -0
- package/dist/models/index.d.ts +191 -0
- package/dist/models/index.js +209 -0
- package/dist/runtime.d.ts +185 -0
- package/dist/runtime.js +371 -0
- package/docs/AIAgentTrafficApi.md +420 -0
- package/docs/AIModelInsightsApi.md +319 -0
- package/docs/AccountApi.md +73 -0
- package/docs/AccountCapacity.md +37 -0
- package/docs/AccountQuota.md +43 -0
- package/docs/Actor.md +42 -0
- package/docs/AgentBot.md +44 -0
- package/docs/AgentBotsResponse.md +38 -0
- package/docs/AgentTrafficResponse.md +48 -0
- package/docs/AiOrdersResponse.md +50 -0
- package/docs/AiOrdersResponseBySourceInner.md +40 -0
- package/docs/AiOrdersResponseSeriesInner.md +38 -0
- package/docs/AiOrdersResponseTotals.md +36 -0
- package/docs/AiOrdersUpdateRequest.md +44 -0
- package/docs/AiOrdersUpdateRequestDaysInner.md +40 -0
- package/docs/AiOrdersUpdateResponse.md +42 -0
- package/docs/AnnotationCreateResponse.md +38 -0
- package/docs/AnnotationCreateResponseAnnotation.md +44 -0
- package/docs/AnnotationsApi.md +325 -0
- package/docs/AnswerDetails.md +78 -0
- package/docs/AnswerDetailsLocale.md +36 -0
- package/docs/AnswersApi.md +202 -0
- package/docs/ApiError.md +36 -0
- package/docs/ApiErrorError.md +38 -0
- package/docs/AssignPromptTagsRequest.md +42 -0
- package/docs/CatalogProduct.md +48 -0
- package/docs/CatalogPromptSuggestion.md +52 -0
- package/docs/CatalogPromptSuggestionIdsRequest.md +36 -0
- package/docs/CatalogPromptSuggestionProduct.md +39 -0
- package/docs/CatalogPromptSuggestionsAcceptResponse.md +42 -0
- package/docs/CatalogPromptSuggestionsAcceptResponseAcceptedInner.md +38 -0
- package/docs/CatalogPromptSuggestionsAcceptResponseSkippedInner.md +36 -0
- package/docs/CatalogPromptSuggestionsCreateRequest.md +42 -0
- package/docs/CatalogPromptSuggestionsCreateResponse.md +42 -0
- package/docs/CatalogPromptSuggestionsRejectResponse.md +38 -0
- package/docs/CatalogPromptSuggestionsResponse.md +44 -0
- package/docs/CitationMatchMode.md +33 -0
- package/docs/CitationRecord.md +48 -0
- package/docs/CitationsResponse.md +44 -0
- package/docs/CollectionCreateResponse.md +42 -0
- package/docs/CollectionCreateResponseCollection.md +38 -0
- package/docs/CollectionsResponse.md +38 -0
- package/docs/CollectionsTagsApi.md +457 -0
- package/docs/Competitor.md +48 -0
- package/docs/CompetitorCreateResponse.md +42 -0
- package/docs/CompetitorCreateResponseCompetitor.md +46 -0
- package/docs/CompetitorDetails.md +66 -0
- package/docs/CompetitorMentionRecord.md +44 -0
- package/docs/CompetitorMentionsResponse.md +44 -0
- package/docs/CompetitorsApi.md +386 -0
- package/docs/CreateAnnotationRequest.md +44 -0
- package/docs/CreateCollectionRequest.md +40 -0
- package/docs/CreateCompetitorRequest.md +44 -0
- package/docs/CreateProjectDraftRequest.md +44 -0
- package/docs/CreateTeamInvitation201Response.md +60 -0
- package/docs/CreateTeamInvitationRequest.md +48 -0
- package/docs/CreateTechnicalGeoReportsRequest.md +40 -0
- package/docs/CreateWebhook201Response.md +52 -0
- package/docs/CreateWebhookRequest.md +38 -0
- package/docs/DeleteWebhook200Response.md +38 -0
- package/docs/FinalizeProjectDraftRequest.md +36 -0
- package/docs/GEOAuditsApi.md +1045 -0
- package/docs/GEOWriterApi.md +394 -0
- package/docs/GeoAlert.md +50 -0
- package/docs/GeoAlertEventsInner.md +42 -0
- package/docs/GeoAlertList.md +44 -0
- package/docs/GeoAudit.md +66 -0
- package/docs/GeoAuditArchived.md +40 -0
- package/docs/GeoAuditComparison.md +50 -0
- package/docs/GeoAuditComparisonChangesInner.md +48 -0
- package/docs/GeoAuditCreateRequest.md +40 -0
- package/docs/GeoAuditCreateResponse.md +38 -0
- package/docs/GeoAuditFinding.md +46 -0
- package/docs/GeoAuditFindingList.md +44 -0
- package/docs/GeoAuditIssue.md +58 -0
- package/docs/GeoAuditIssueList.md +44 -0
- package/docs/GeoAuditIssueResponse.md +62 -0
- package/docs/GeoAuditIssueUpdateRequest.md +36 -0
- package/docs/GeoAuditList.md +44 -0
- package/docs/GeoAuditResponse.md +70 -0
- package/docs/GeoAuditRun.md +63 -0
- package/docs/GeoAuditRunDetail.md +70 -0
- package/docs/GeoAuditRunList.md +44 -0
- package/docs/GeoAuditRunResponse.md +66 -0
- package/docs/GeoAuditSchedule.md +39 -0
- package/docs/GeoAuditUpdateRequest.md +44 -0
- package/docs/GetAccount200Response.md +50 -0
- package/docs/GetAccount200ResponseLimits.md +46 -0
- package/docs/GetAccount200ResponseRateLimits.md +36 -0
- package/docs/GetAccount200ResponseSubscription.md +39 -0
- package/docs/HealthApi.md +81 -0
- package/docs/IntelligenceTask.md +76 -0
- package/docs/IntelligenceTaskCreateRequest.md +52 -0
- package/docs/IntelligenceTaskProduct.md +49 -0
- package/docs/IntelligenceTaskProductImagesInner.md +36 -0
- package/docs/IntelligenceTaskSummary.md +56 -0
- package/docs/IntelligenceTaskUpdateRequest.md +38 -0
- package/docs/IntelligenceTaskUpdateResponse.md +78 -0
- package/docs/IntelligenceTasksResponse.md +44 -0
- package/docs/LaunchRecommendationsRequest.md +36 -0
- package/docs/ListCompetitors200Response.md +38 -0
- package/docs/ListProjects200Response.md +36 -0
- package/docs/ListTeamInvitations200Response.md +42 -0
- package/docs/ListTeamMembers200Response.md +42 -0
- package/docs/ListWebhooks200Response.md +42 -0
- package/docs/ListWebhooks200ResponseDataInner.md +48 -0
- package/docs/LlmsTxtTechnicalGeoReport.md +69 -0
- package/docs/LlmsTxtTechnicalGeoReportResultData.md +55 -0
- package/docs/LocalBusiness.md +60 -0
- package/docs/LocalBusinessesResponse.md +46 -0
- package/docs/LocalBusinessesTotals.md +42 -0
- package/docs/LocalesResponse.md +40 -0
- package/docs/MentionRecord.md +42 -0
- package/docs/MentionsCitationsApi.md +604 -0
- package/docs/MentionsResponse.md +44 -0
- package/docs/MetricsApi.md +584 -0
- package/docs/MetricsFiltersEcho.md +61 -0
- package/docs/ModelsResponse.md +38 -0
- package/docs/OwnedMediaCommunitiesApi.md +256 -0
- package/docs/PaginatedEnvelope.md +43 -0
- package/docs/Ping200Response.md +40 -0
- package/docs/Project.md +38 -0
- package/docs/ProjectCreateRequest.md +76 -0
- package/docs/ProjectCreateRequestCollectionsInner.md +36 -0
- package/docs/ProjectCreateRequestCompetitorsInner.md +38 -0
- package/docs/ProjectCreateRequestOwnedMedia.md +45 -0
- package/docs/ProjectCreateResponse.md +52 -0
- package/docs/ProjectCreateResponseCollectionsInner.md +38 -0
- package/docs/ProjectCreateResponseCompetitors.md +36 -0
- package/docs/ProjectCreateResponseEmailSubscription.md +34 -0
- package/docs/ProjectCreateResponseLimits.md +38 -0
- package/docs/ProjectCreateResponsePrompts.md +38 -0
- package/docs/ProjectCreateResponseSameDomainProjectsInner.md +40 -0
- package/docs/ProjectDetails.md +78 -0
- package/docs/ProjectDetailsAllOfDataCoverage.md +39 -0
- package/docs/ProjectDetailsAllOfSearchConsole.md +37 -0
- package/docs/ProjectDetailsAllOfStats.md +40 -0
- package/docs/ProjectDetailsAllOfStatsPromptsByBrandKind.md +39 -0
- package/docs/ProjectsApi.md +752 -0
- package/docs/PromptExecutionRecord.md +56 -0
- package/docs/PromptExecutionsResponse.md +44 -0
- package/docs/PromptRecord.md +54 -0
- package/docs/PromptSummaryResponse.md +56 -0
- package/docs/PromptSummaryRow.md +80 -0
- package/docs/PromptTagsAssignResponse.md +48 -0
- package/docs/PromptsApi.md +495 -0
- package/docs/PromptsCreateRequest.md +40 -0
- package/docs/PromptsCreateResponse.md +46 -0
- package/docs/PromptsCreateResponseDataInner.md +38 -0
- package/docs/PromptsResponse.md +44 -0
- package/docs/QueryWebAnalyticsRequest.md +36 -0
- package/docs/RecommendationSummary.md +56 -0
- package/docs/RecommendationSummarySummary.md +39 -0
- package/docs/RecommendationsApi.md +244 -0
- package/docs/RecommendationsResponse.md +44 -0
- package/docs/RemoveTeamMember200Response.md +38 -0
- package/docs/ReputationStudiesApi.md +436 -0
- package/docs/RevokeTeamInvitation200Response.md +38 -0
- package/docs/SampleWebhookPayloads200Response.md +38 -0
- package/docs/SampleWebhookPayloads200ResponseDataInner.md +42 -0
- package/docs/SearchConsoleApi.md +558 -0
- package/docs/SearchConsoleFiltersInner.md +38 -0
- package/docs/SearchConsoleListResponse.md +58 -0
- package/docs/SearchConsoleListResponseDataInner.md +42 -0
- package/docs/SearchConsoleMetrics.md +40 -0
- package/docs/SearchConsoleProperty.md +36 -0
- package/docs/SearchConsoleRowsResponse.md +60 -0
- package/docs/SearchConsoleRowsResponseDataInner.md +52 -0
- package/docs/SearchConsoleSummaryResponse.md +52 -0
- package/docs/SearchConsoleSummaryResponseBreakdownInner.md +42 -0
- package/docs/SearchConsoleTimeseriesResponse.md +48 -0
- package/docs/SearchConsoleTimeseriesResponseDataInner.md +42 -0
- package/docs/SentimentRecord.md +58 -0
- package/docs/SentimentsApi.md +191 -0
- package/docs/SentimentsResponse.md +44 -0
- package/docs/ShoppingAdsApi.md +386 -0
- package/docs/SourcesCitationIntelligenceApi.md +570 -0
- package/docs/SovResponse.md +56 -0
- package/docs/SovResponseBreakdownInner.md +40 -0
- package/docs/SovResponseCurrentInner.md +40 -0
- package/docs/SovResponseOthersInner.md +38 -0
- package/docs/SovResponseOverTimeInner.md +36 -0
- package/docs/SovResponsePeriodsInner.md +42 -0
- package/docs/SovResponseSample.md +43 -0
- package/docs/StoreConnectionResponse.md +46 -0
- package/docs/StoreConnectionResponseAccount.md +34 -0
- package/docs/StoreConnectionResponseCandidatesInner.md +38 -0
- package/docs/StoreConnectionResponseProject.md +43 -0
- package/docs/StoreIntegrationsApi.md +556 -0
- package/docs/SummaryResponse.md +50 -0
- package/docs/SummaryResponseAllOfPositionDistribution.md +42 -0
- package/docs/SummaryResponseAllOfSummaryValueInner.md +46 -0
- package/docs/TagRef.md +36 -0
- package/docs/TeamAccountRole.md +37 -0
- package/docs/TeamApi.md +388 -0
- package/docs/TeamInvitation.md +56 -0
- package/docs/TeamMember.md +62 -0
- package/docs/TechnicalGEOReportsApi.md +406 -0
- package/docs/TechnicalGeoReportContentRevertRequest.md +36 -0
- package/docs/TechnicalGeoReportContentUpdateRequest.md +40 -0
- package/docs/TechnicalGeoReportContentUpdateRequestEdits.md +37 -0
- package/docs/TechnicalGeoReportContentUpdateResponse.md +70 -0
- package/docs/TimeseriesPoint.md +36 -0
- package/docs/TimeseriesResponse.md +46 -0
- package/docs/TimeseriesSeries.md +38 -0
- package/docs/TopSourcesResponse.md +52 -0
- package/docs/TopSourcesResponseDataInner.md +40 -0
- package/docs/UpdateAnnotationRequest.md +44 -0
- package/docs/UpdateCollectionRequest.md +38 -0
- package/docs/UpdateCompetitorRequest.md +46 -0
- package/docs/UpdateProjectDraftRequest.md +64 -0
- package/docs/UpdateProjectRequest.md +54 -0
- package/docs/WebAnalyticsQueryResponse.md +62 -0
- package/docs/WebAnalyticsQueryResponseColumnsInner.md +40 -0
- package/docs/WebAnalyticsSchemaResponse.md +54 -0
- package/docs/WebhooksApi.md +318 -0
- package/package.json +20 -4
- package/src/apis/AIAgentTrafficApi.ts +615 -0
- package/src/apis/AIModelInsightsApi.ts +585 -0
- package/src/apis/AccountApi.ts +110 -0
- package/src/apis/AnnotationsApi.ts +447 -0
- package/src/apis/AnswersApi.ts +376 -0
- package/src/apis/CollectionsTagsApi.ts +624 -0
- package/src/apis/CompetitorsApi.ts +537 -0
- package/src/apis/GEOAuditsApi.ts +1539 -0
- package/src/apis/GEOWriterApi.ts +557 -0
- package/src/apis/HealthApi.ts +120 -0
- package/src/apis/MentionsCitationsApi.ts +1108 -0
- package/src/apis/MetricsApi.ts +1236 -0
- package/src/apis/OwnedMediaCommunitiesApi.ts +597 -0
- package/src/apis/ProjectsApi.ts +956 -0
- package/src/apis/PromptsApi.ts +931 -0
- package/src/apis/RecommendationsApi.ts +378 -0
- package/src/apis/ReputationStudiesApi.ts +668 -0
- package/src/apis/SearchConsoleApi.ts +1106 -0
- package/src/apis/SentimentsApi.ts +324 -0
- package/src/apis/ShoppingAdsApi.ts +856 -0
- package/src/apis/SourcesCitationIntelligenceApi.ts +1016 -0
- package/src/apis/StoreIntegrationsApi.ts +771 -0
- package/src/apis/TeamApi.ts +489 -0
- package/src/apis/TechnicalGEOReportsApi.ts +605 -0
- package/src/apis/WebhooksApi.ts +436 -0
- package/src/apis/index.ts +27 -0
- package/src/index.ts +5 -0
- package/src/models/AccountCapacity.ts +73 -0
- package/src/models/AccountQuota.ts +97 -0
- package/src/models/Actor.ts +108 -0
- package/src/models/AgentBot.ts +105 -0
- package/src/models/AgentBotsResponse.ts +89 -0
- package/src/models/AgentTrafficResponse.ts +142 -0
- package/src/models/AiOrdersResponse.ts +160 -0
- package/src/models/AiOrdersResponseBySourceInner.ts +93 -0
- package/src/models/AiOrdersResponseSeriesInner.ts +84 -0
- package/src/models/AiOrdersResponseTotals.ts +75 -0
- package/src/models/AiOrdersUpdateRequest.ts +131 -0
- package/src/models/AiOrdersUpdateRequestDaysInner.ts +93 -0
- package/src/models/AiOrdersUpdateResponse.ts +102 -0
- package/src/models/AnnotationCreateResponse.ts +92 -0
- package/src/models/AnnotationCreateResponseAnnotation.ts +111 -0
- package/src/models/AnswerDetails.ts +249 -0
- package/src/models/AnswerDetailsLocale.ts +73 -0
- package/src/models/ApiError.ts +81 -0
- package/src/models/ApiErrorError.ts +119 -0
- package/src/models/AssignPromptTagsRequest.ts +99 -0
- package/src/models/CatalogProduct.ts +123 -0
- package/src/models/CatalogPromptSuggestion.ts +155 -0
- package/src/models/CatalogPromptSuggestionIdsRequest.ts +75 -0
- package/src/models/CatalogPromptSuggestionProduct.ts +81 -0
- package/src/models/CatalogPromptSuggestionsAcceptResponse.ts +117 -0
- package/src/models/CatalogPromptSuggestionsAcceptResponseAcceptedInner.ts +84 -0
- package/src/models/CatalogPromptSuggestionsAcceptResponseSkippedInner.ts +75 -0
- package/src/models/CatalogPromptSuggestionsCreateRequest.ts +120 -0
- package/src/models/CatalogPromptSuggestionsCreateResponse.ts +110 -0
- package/src/models/CatalogPromptSuggestionsRejectResponse.ts +84 -0
- package/src/models/CatalogPromptSuggestionsResponse.ts +119 -0
- package/src/models/CitationMatchMode.ts +54 -0
- package/src/models/CitationRecord.ts +129 -0
- package/src/models/CitationsResponse.ts +119 -0
- package/src/models/CollectionCreateResponse.ts +110 -0
- package/src/models/CollectionCreateResponseCollection.ts +84 -0
- package/src/models/CollectionsResponse.ts +92 -0
- package/src/models/Competitor.ts +140 -0
- package/src/models/CompetitorCreateResponse.ts +110 -0
- package/src/models/CompetitorCreateResponseCompetitor.ts +130 -0
- package/src/models/CompetitorDetails.ts +203 -0
- package/src/models/CompetitorMentionRecord.ts +111 -0
- package/src/models/CompetitorMentionsResponse.ts +119 -0
- package/src/models/CreateAnnotationRequest.ts +107 -0
- package/src/models/CreateCollectionRequest.ts +91 -0
- package/src/models/CreateCompetitorRequest.ts +120 -0
- package/src/models/CreateProjectDraftRequest.ts +108 -0
- package/src/models/CreateTeamInvitation201Response.ts +200 -0
- package/src/models/CreateTeamInvitationRequest.ts +135 -0
- package/src/models/CreateTechnicalGeoReportsRequest.ts +91 -0
- package/src/models/CreateWebhook201Response.ts +156 -0
- package/src/models/CreateWebhookRequest.ts +103 -0
- package/src/models/DeleteWebhook200Response.ts +81 -0
- package/src/models/FinalizeProjectDraftRequest.ts +73 -0
- package/src/models/GeoAlert.ts +137 -0
- package/src/models/GeoAlertEventsInner.ts +112 -0
- package/src/models/GeoAlertList.ts +113 -0
- package/src/models/GeoAudit.ts +244 -0
- package/src/models/GeoAuditArchived.ts +89 -0
- package/src/models/GeoAuditComparison.ts +144 -0
- package/src/models/GeoAuditComparisonChangesInner.ts +136 -0
- package/src/models/GeoAuditCreateRequest.ts +118 -0
- package/src/models/GeoAuditCreateResponse.ts +89 -0
- package/src/models/GeoAuditFinding.ts +140 -0
- package/src/models/GeoAuditFindingList.ts +113 -0
- package/src/models/GeoAuditIssue.ts +185 -0
- package/src/models/GeoAuditIssueList.ts +113 -0
- package/src/models/GeoAuditIssueResponse.ts +201 -0
- package/src/models/GeoAuditIssueUpdateRequest.ts +74 -0
- package/src/models/GeoAuditList.ts +113 -0
- package/src/models/GeoAuditResponse.ts +260 -0
- package/src/models/GeoAuditRun.ts +203 -0
- package/src/models/GeoAuditRunDetail.ts +235 -0
- package/src/models/GeoAuditRunList.ts +113 -0
- package/src/models/GeoAuditRunResponse.ts +219 -0
- package/src/models/GeoAuditSchedule.ts +81 -0
- package/src/models/GeoAuditUpdateRequest.ts +127 -0
- package/src/models/GetAccount200Response.ts +162 -0
- package/src/models/GetAccount200ResponseLimits.ts +128 -0
- package/src/models/GetAccount200ResponseRateLimits.ts +73 -0
- package/src/models/GetAccount200ResponseSubscription.ts +81 -0
- package/src/models/IntelligenceTask.ts +233 -0
- package/src/models/IntelligenceTaskCreateRequest.ts +162 -0
- package/src/models/IntelligenceTaskProduct.ts +130 -0
- package/src/models/IntelligenceTaskProductImagesInner.ts +74 -0
- package/src/models/IntelligenceTaskSummary.ts +165 -0
- package/src/models/IntelligenceTaskUpdateRequest.ts +83 -0
- package/src/models/IntelligenceTaskUpdateResponse.ts +241 -0
- package/src/models/IntelligenceTasksResponse.ts +119 -0
- package/src/models/LaunchRecommendationsRequest.ts +87 -0
- package/src/models/ListCompetitors200Response.ts +89 -0
- package/src/models/ListProjects200Response.ts +81 -0
- package/src/models/ListTeamInvitations200Response.ts +105 -0
- package/src/models/ListTeamMembers200Response.ts +105 -0
- package/src/models/ListWebhooks200Response.ts +105 -0
- package/src/models/ListWebhooks200ResponseDataInner.ts +140 -0
- package/src/models/LlmsTxtTechnicalGeoReport.ts +209 -0
- package/src/models/LlmsTxtTechnicalGeoReportResultData.ts +145 -0
- package/src/models/LocalBusiness.ts +169 -0
- package/src/models/LocalBusinessesResponse.ts +128 -0
- package/src/models/LocalBusinessesTotals.ts +97 -0
- package/src/models/LocalesResponse.ts +93 -0
- package/src/models/MentionRecord.ts +102 -0
- package/src/models/MentionsResponse.ts +119 -0
- package/src/models/MetricsFiltersEcho.ts +169 -0
- package/src/models/ModelsResponse.ts +106 -0
- package/src/models/PaginatedEnvelope.ts +102 -0
- package/src/models/Ping200Response.ts +97 -0
- package/src/models/Project.ts +81 -0
- package/src/models/ProjectCreateRequest.ts +259 -0
- package/src/models/ProjectCreateRequestCollectionsInner.ts +74 -0
- package/src/models/ProjectCreateRequestCompetitorsInner.ts +82 -0
- package/src/models/ProjectCreateRequestOwnedMedia.ts +105 -0
- package/src/models/ProjectCreateResponse.ts +180 -0
- package/src/models/ProjectCreateResponseCollectionsInner.ts +81 -0
- package/src/models/ProjectCreateResponseCompetitors.ts +73 -0
- package/src/models/ProjectCreateResponseEmailSubscription.ts +65 -0
- package/src/models/ProjectCreateResponseLimits.ts +81 -0
- package/src/models/ProjectCreateResponsePrompts.ts +92 -0
- package/src/models/ProjectCreateResponseSameDomainProjectsInner.ts +89 -0
- package/src/models/ProjectDetails.ts +263 -0
- package/src/models/ProjectDetailsAllOfDataCoverage.ts +103 -0
- package/src/models/ProjectDetailsAllOfSearchConsole.ts +85 -0
- package/src/models/ProjectDetailsAllOfStats.ts +97 -0
- package/src/models/ProjectDetailsAllOfStatsPromptsByBrandKind.ts +81 -0
- package/src/models/PromptExecutionRecord.ts +187 -0
- package/src/models/PromptExecutionsResponse.ts +119 -0
- package/src/models/PromptRecord.ts +164 -0
- package/src/models/PromptSummaryResponse.ts +168 -0
- package/src/models/PromptSummaryRow.ts +257 -0
- package/src/models/PromptTagsAssignResponse.ts +137 -0
- package/src/models/PromptsCreateRequest.ts +93 -0
- package/src/models/PromptsCreateResponse.ts +121 -0
- package/src/models/PromptsCreateResponseDataInner.ts +92 -0
- package/src/models/PromptsResponse.ts +119 -0
- package/src/models/QueryWebAnalyticsRequest.ts +75 -0
- package/src/models/RecommendationSummary.ts +197 -0
- package/src/models/RecommendationSummarySummary.ts +81 -0
- package/src/models/RecommendationsResponse.ts +119 -0
- package/src/models/RemoveTeamMember200Response.ts +81 -0
- package/src/models/RevokeTeamInvitation200Response.ts +81 -0
- package/src/models/SampleWebhookPayloads200Response.ts +89 -0
- package/src/models/SampleWebhookPayloads200ResponseDataInner.ts +97 -0
- package/src/models/SearchConsoleFiltersInner.ts +110 -0
- package/src/models/SearchConsoleListResponse.ts +176 -0
- package/src/models/SearchConsoleListResponseDataInner.ts +97 -0
- package/src/models/SearchConsoleMetrics.ts +89 -0
- package/src/models/SearchConsoleProperty.ts +73 -0
- package/src/models/SearchConsoleRowsResponse.ts +184 -0
- package/src/models/SearchConsoleRowsResponseDataInner.ts +137 -0
- package/src/models/SearchConsoleSummaryResponse.ts +159 -0
- package/src/models/SearchConsoleSummaryResponseBreakdownInner.ts +97 -0
- package/src/models/SearchConsoleTimeseriesResponse.ts +136 -0
- package/src/models/SearchConsoleTimeseriesResponseDataInner.ts +97 -0
- package/src/models/SentimentRecord.ts +208 -0
- package/src/models/SentimentsResponse.ts +119 -0
- package/src/models/SovResponse.ts +203 -0
- package/src/models/SovResponseBreakdownInner.ts +97 -0
- package/src/models/SovResponseCurrentInner.ts +97 -0
- package/src/models/SovResponseOthersInner.ts +89 -0
- package/src/models/SovResponseOverTimeInner.ts +88 -0
- package/src/models/SovResponsePeriodsInner.ts +97 -0
- package/src/models/SovResponseSample.ts +97 -0
- package/src/models/StoreConnectionResponse.ts +142 -0
- package/src/models/StoreConnectionResponseAccount.ts +65 -0
- package/src/models/StoreConnectionResponseCandidatesInner.ts +84 -0
- package/src/models/StoreConnectionResponseProject.ts +100 -0
- package/src/models/SummaryResponse.ts +158 -0
- package/src/models/SummaryResponseAllOfPositionDistribution.ts +97 -0
- package/src/models/SummaryResponseAllOfSummaryValueInner.ts +132 -0
- package/src/models/TagRef.ts +75 -0
- package/src/models/TeamAccountRole.ts +75 -0
- package/src/models/TeamInvitation.ts +183 -0
- package/src/models/TeamMember.ts +216 -0
- package/src/models/TechnicalGeoReportContentRevertRequest.ts +87 -0
- package/src/models/TechnicalGeoReportContentUpdateRequest.ts +113 -0
- package/src/models/TechnicalGeoReportContentUpdateRequestEdits.ts +73 -0
- package/src/models/TechnicalGeoReportContentUpdateResponse.ts +228 -0
- package/src/models/TimeseriesPoint.ts +73 -0
- package/src/models/TimeseriesResponse.ts +128 -0
- package/src/models/TimeseriesSeries.ts +96 -0
- package/src/models/TopSourcesResponse.ts +152 -0
- package/src/models/TopSourcesResponseDataInner.ts +89 -0
- package/src/models/UpdateAnnotationRequest.ts +106 -0
- package/src/models/UpdateCollectionRequest.ts +82 -0
- package/src/models/UpdateCompetitorRequest.ts +126 -0
- package/src/models/UpdateProjectDraftRequest.ts +199 -0
- package/src/models/UpdateProjectRequest.ts +145 -0
- package/src/models/WebAnalyticsQueryResponse.ts +200 -0
- package/src/models/WebAnalyticsQueryResponseColumnsInner.ts +89 -0
- package/src/models/WebAnalyticsSchemaResponse.ts +160 -0
- package/src/models/index.ts +193 -0
- package/src/runtime.ts +454 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +16 -0
|
@@ -0,0 +1,1108 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LLM Pulse API
|
|
5
|
+
* REST API client for LLM Pulse AI visibility analytics.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.59.0
|
|
8
|
+
* Contact: info@llmpulse.ai
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import * as runtime from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
type CitationsResponse,
|
|
18
|
+
CitationsResponseFromJSON,
|
|
19
|
+
CitationsResponseToJSON,
|
|
20
|
+
} from '../models/CitationsResponse';
|
|
21
|
+
import {
|
|
22
|
+
type CompetitorMentionsResponse,
|
|
23
|
+
CompetitorMentionsResponseFromJSON,
|
|
24
|
+
CompetitorMentionsResponseToJSON,
|
|
25
|
+
} from '../models/CompetitorMentionsResponse';
|
|
26
|
+
import {
|
|
27
|
+
type MentionsResponse,
|
|
28
|
+
MentionsResponseFromJSON,
|
|
29
|
+
MentionsResponseToJSON,
|
|
30
|
+
} from '../models/MentionsResponse';
|
|
31
|
+
|
|
32
|
+
export interface ListAllCitationsRequest {
|
|
33
|
+
projectId: number;
|
|
34
|
+
competitors?: string;
|
|
35
|
+
page?: number;
|
|
36
|
+
perPage?: number;
|
|
37
|
+
model?: ListAllCitationsModelEnum;
|
|
38
|
+
collectionId?: string;
|
|
39
|
+
prompt?: number;
|
|
40
|
+
from?: Date;
|
|
41
|
+
to?: Date;
|
|
42
|
+
output?: ListAllCitationsOutputEnum;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export interface ListAllMentionsRequest {
|
|
46
|
+
projectId: number;
|
|
47
|
+
competitors?: string;
|
|
48
|
+
page?: number;
|
|
49
|
+
perPage?: number;
|
|
50
|
+
model?: ListAllMentionsModelEnum;
|
|
51
|
+
collectionId?: string;
|
|
52
|
+
prompt?: number;
|
|
53
|
+
from?: Date;
|
|
54
|
+
to?: Date;
|
|
55
|
+
output?: ListAllMentionsOutputEnum;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export interface ListCitationsRequest {
|
|
59
|
+
projectId: number;
|
|
60
|
+
page?: number;
|
|
61
|
+
perPage?: number;
|
|
62
|
+
model?: ListCitationsModelEnum;
|
|
63
|
+
collectionId?: string;
|
|
64
|
+
countryCode?: string;
|
|
65
|
+
languageCode?: string;
|
|
66
|
+
prompt?: number;
|
|
67
|
+
from?: Date;
|
|
68
|
+
to?: Date;
|
|
69
|
+
output?: ListCitationsOutputEnum;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export interface ListCompetitorCitationsRequest {
|
|
73
|
+
projectId: number;
|
|
74
|
+
competitors?: string;
|
|
75
|
+
page?: number;
|
|
76
|
+
perPage?: number;
|
|
77
|
+
model?: ListCompetitorCitationsModelEnum;
|
|
78
|
+
collectionId?: string;
|
|
79
|
+
prompt?: number;
|
|
80
|
+
from?: Date;
|
|
81
|
+
to?: Date;
|
|
82
|
+
output?: ListCompetitorCitationsOutputEnum;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export interface ListCompetitorMentionsRequest {
|
|
86
|
+
projectId: number;
|
|
87
|
+
competitors?: string;
|
|
88
|
+
page?: number;
|
|
89
|
+
perPage?: number;
|
|
90
|
+
model?: ListCompetitorMentionsModelEnum;
|
|
91
|
+
collectionId?: string;
|
|
92
|
+
prompt?: number;
|
|
93
|
+
from?: Date;
|
|
94
|
+
to?: Date;
|
|
95
|
+
output?: ListCompetitorMentionsOutputEnum;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
export interface ListMentionsRequest {
|
|
99
|
+
projectId: number;
|
|
100
|
+
page?: number;
|
|
101
|
+
perPage?: number;
|
|
102
|
+
model?: ListMentionsModelEnum;
|
|
103
|
+
collectionId?: string;
|
|
104
|
+
countryCode?: string;
|
|
105
|
+
languageCode?: string;
|
|
106
|
+
prompt?: number;
|
|
107
|
+
from?: Date;
|
|
108
|
+
to?: Date;
|
|
109
|
+
output?: ListMentionsOutputEnum;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* MentionsCitationsApi - interface
|
|
114
|
+
*
|
|
115
|
+
* @export
|
|
116
|
+
* @interface MentionsCitationsApiInterface
|
|
117
|
+
*/
|
|
118
|
+
export interface MentionsCitationsApiInterface {
|
|
119
|
+
/**
|
|
120
|
+
* Creates request options for listAllCitations without sending the request
|
|
121
|
+
* @param {number} projectId Project ID
|
|
122
|
+
* @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
|
|
123
|
+
* @param {number} [page]
|
|
124
|
+
* @param {number} [perPage]
|
|
125
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
126
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
127
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
128
|
+
* @param {Date} [from]
|
|
129
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
130
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
* @memberof MentionsCitationsApiInterface
|
|
133
|
+
*/
|
|
134
|
+
listAllCitationsRequestOpts(requestParameters: ListAllCitationsRequest): Promise<runtime.RequestOpts>;
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Unified citations stream with an `actor_type` field on each record. Includes visible citations and background source references; background references use position 0, meaning no visible rank.
|
|
138
|
+
* @summary List all citations (brand + competitor)
|
|
139
|
+
* @param {number} projectId Project ID
|
|
140
|
+
* @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
|
|
141
|
+
* @param {number} [page]
|
|
142
|
+
* @param {number} [perPage]
|
|
143
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
144
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
145
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
146
|
+
* @param {Date} [from]
|
|
147
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
148
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
149
|
+
* @param {*} [options] Override http request option.
|
|
150
|
+
* @throws {RequiredError}
|
|
151
|
+
* @memberof MentionsCitationsApiInterface
|
|
152
|
+
*/
|
|
153
|
+
listAllCitationsRaw(requestParameters: ListAllCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* Unified citations stream with an `actor_type` field on each record. Includes visible citations and background source references; background references use position 0, meaning no visible rank.
|
|
157
|
+
* List all citations (brand + competitor)
|
|
158
|
+
*/
|
|
159
|
+
listAllCitations(requestParameters: ListAllCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Creates request options for listAllMentions without sending the request
|
|
163
|
+
* @param {number} projectId Project ID
|
|
164
|
+
* @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
|
|
165
|
+
* @param {number} [page]
|
|
166
|
+
* @param {number} [perPage]
|
|
167
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
168
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
169
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
170
|
+
* @param {Date} [from]
|
|
171
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
172
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
173
|
+
* @throws {RequiredError}
|
|
174
|
+
* @memberof MentionsCitationsApiInterface
|
|
175
|
+
*/
|
|
176
|
+
listAllMentionsRequestOpts(requestParameters: ListAllMentionsRequest): Promise<runtime.RequestOpts>;
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Unified mentions stream. Each record has an `actor_type` field (`project` or `competitor`) so the same payload covers both.
|
|
180
|
+
* @summary List all mentions (brand + competitor)
|
|
181
|
+
* @param {number} projectId Project ID
|
|
182
|
+
* @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
|
|
183
|
+
* @param {number} [page]
|
|
184
|
+
* @param {number} [perPage]
|
|
185
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
186
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
187
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
188
|
+
* @param {Date} [from]
|
|
189
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
190
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
191
|
+
* @param {*} [options] Override http request option.
|
|
192
|
+
* @throws {RequiredError}
|
|
193
|
+
* @memberof MentionsCitationsApiInterface
|
|
194
|
+
*/
|
|
195
|
+
listAllMentionsRaw(requestParameters: ListAllMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Unified mentions stream. Each record has an `actor_type` field (`project` or `competitor`) so the same payload covers both.
|
|
199
|
+
* List all mentions (brand + competitor)
|
|
200
|
+
*/
|
|
201
|
+
listAllMentions(requestParameters: ListAllMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* Creates request options for listCitations without sending the request
|
|
205
|
+
* @param {number} projectId Project ID
|
|
206
|
+
* @param {number} [page]
|
|
207
|
+
* @param {number} [perPage]
|
|
208
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
209
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
210
|
+
* @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
|
|
211
|
+
* @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
|
|
212
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
213
|
+
* @param {Date} [from]
|
|
214
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
215
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
216
|
+
* @throws {RequiredError}
|
|
217
|
+
* @memberof MentionsCitationsApiInterface
|
|
218
|
+
*/
|
|
219
|
+
listCitationsRequestOpts(requestParameters: ListCitationsRequest): Promise<runtime.RequestOpts>;
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
|
|
223
|
+
* @summary List brand citations
|
|
224
|
+
* @param {number} projectId Project ID
|
|
225
|
+
* @param {number} [page]
|
|
226
|
+
* @param {number} [perPage]
|
|
227
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
228
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
229
|
+
* @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
|
|
230
|
+
* @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
|
|
231
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
232
|
+
* @param {Date} [from]
|
|
233
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
234
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
235
|
+
* @param {*} [options] Override http request option.
|
|
236
|
+
* @throws {RequiredError}
|
|
237
|
+
* @memberof MentionsCitationsApiInterface
|
|
238
|
+
*/
|
|
239
|
+
listCitationsRaw(requestParameters: ListCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CitationsResponse>>;
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
|
|
243
|
+
* List brand citations
|
|
244
|
+
*/
|
|
245
|
+
listCitations(requestParameters: ListCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CitationsResponse>;
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* Creates request options for listCompetitorCitations without sending the request
|
|
249
|
+
* @param {number} projectId Project ID
|
|
250
|
+
* @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
|
|
251
|
+
* @param {number} [page]
|
|
252
|
+
* @param {number} [perPage]
|
|
253
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
254
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
255
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
256
|
+
* @param {Date} [from]
|
|
257
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
258
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
259
|
+
* @throws {RequiredError}
|
|
260
|
+
* @memberof MentionsCitationsApiInterface
|
|
261
|
+
*/
|
|
262
|
+
listCompetitorCitationsRequestOpts(requestParameters: ListCompetitorCitationsRequest): Promise<runtime.RequestOpts>;
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
|
|
266
|
+
* @summary List competitor citations
|
|
267
|
+
* @param {number} projectId Project ID
|
|
268
|
+
* @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
|
|
269
|
+
* @param {number} [page]
|
|
270
|
+
* @param {number} [perPage]
|
|
271
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
272
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
273
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
274
|
+
* @param {Date} [from]
|
|
275
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
276
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
277
|
+
* @param {*} [options] Override http request option.
|
|
278
|
+
* @throws {RequiredError}
|
|
279
|
+
* @memberof MentionsCitationsApiInterface
|
|
280
|
+
*/
|
|
281
|
+
listCompetitorCitationsRaw(requestParameters: ListCompetitorCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
|
|
285
|
+
* List competitor citations
|
|
286
|
+
*/
|
|
287
|
+
listCompetitorCitations(requestParameters: ListCompetitorCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* Creates request options for listCompetitorMentions without sending the request
|
|
291
|
+
* @param {number} projectId Project ID
|
|
292
|
+
* @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
|
|
293
|
+
* @param {number} [page]
|
|
294
|
+
* @param {number} [perPage]
|
|
295
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
296
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
297
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
298
|
+
* @param {Date} [from]
|
|
299
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
300
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
301
|
+
* @throws {RequiredError}
|
|
302
|
+
* @memberof MentionsCitationsApiInterface
|
|
303
|
+
*/
|
|
304
|
+
listCompetitorMentionsRequestOpts(requestParameters: ListCompetitorMentionsRequest): Promise<runtime.RequestOpts>;
|
|
305
|
+
|
|
306
|
+
/**
|
|
307
|
+
*
|
|
308
|
+
* @summary List competitor mentions
|
|
309
|
+
* @param {number} projectId Project ID
|
|
310
|
+
* @param {string} [competitors] Comma-separated competitor IDs (unknown IDs return ERR_INVALID_PARAM)
|
|
311
|
+
* @param {number} [page]
|
|
312
|
+
* @param {number} [perPage]
|
|
313
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
314
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
315
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
316
|
+
* @param {Date} [from]
|
|
317
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
318
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
319
|
+
* @param {*} [options] Override http request option.
|
|
320
|
+
* @throws {RequiredError}
|
|
321
|
+
* @memberof MentionsCitationsApiInterface
|
|
322
|
+
*/
|
|
323
|
+
listCompetitorMentionsRaw(requestParameters: ListCompetitorMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompetitorMentionsResponse>>;
|
|
324
|
+
|
|
325
|
+
/**
|
|
326
|
+
* List competitor mentions
|
|
327
|
+
*/
|
|
328
|
+
listCompetitorMentions(requestParameters: ListCompetitorMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorMentionsResponse>;
|
|
329
|
+
|
|
330
|
+
/**
|
|
331
|
+
* Creates request options for listMentions without sending the request
|
|
332
|
+
* @param {number} projectId Project ID
|
|
333
|
+
* @param {number} [page]
|
|
334
|
+
* @param {number} [perPage]
|
|
335
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
336
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
337
|
+
* @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
|
|
338
|
+
* @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
|
|
339
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
340
|
+
* @param {Date} [from]
|
|
341
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
342
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
343
|
+
* @throws {RequiredError}
|
|
344
|
+
* @memberof MentionsCitationsApiInterface
|
|
345
|
+
*/
|
|
346
|
+
listMentionsRequestOpts(requestParameters: ListMentionsRequest): Promise<runtime.RequestOpts>;
|
|
347
|
+
|
|
348
|
+
/**
|
|
349
|
+
*
|
|
350
|
+
* @summary List brand mentions
|
|
351
|
+
* @param {number} projectId Project ID
|
|
352
|
+
* @param {number} [page]
|
|
353
|
+
* @param {number} [perPage]
|
|
354
|
+
* @param {'chatgpt' | 'perplexity' | 'ai_mode' | 'ai_overview' | 'gemini' | 'copilot' | 'amazon_rufus' | 'claude' | 'grok' | 'deepseek' | 'naver_ai' | 'baidu_ai' | 'meta_ai'} [model] Filter by AI model. Models the API key\'s user has not enabled are silently dropped.
|
|
355
|
+
* @param {string} [collectionId] One collection/tag ID or a comma-separated list of IDs. A query value is always a string on the wire, so it is typed as one: the previous integer-or-string union made generators emit a wrapper type they could not serialize.
|
|
356
|
+
* @param {string} [countryCode] One ISO country code or a comma-separated list (e.g. US,GB,DE)
|
|
357
|
+
* @param {string} [languageCode] One ISO language code or a comma-separated list (e.g. en,es,de)
|
|
358
|
+
* @param {number} [prompt] Filter by prompt ID
|
|
359
|
+
* @param {Date} [from]
|
|
360
|
+
* @param {Date} [to] End of the window. A date-only value such as 2026-09-01 covers that whole day. Pass a full timestamp to end the window earlier.
|
|
361
|
+
* @param {'flat' | 'csv'} [output] Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. \'flat\' returns the same metadata plus \'columns\' and \'rows\'; \'csv\' returns those rows as text/csv. Errors are always returned as JSON.
|
|
362
|
+
* @param {*} [options] Override http request option.
|
|
363
|
+
* @throws {RequiredError}
|
|
364
|
+
* @memberof MentionsCitationsApiInterface
|
|
365
|
+
*/
|
|
366
|
+
listMentionsRaw(requestParameters: ListMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MentionsResponse>>;
|
|
367
|
+
|
|
368
|
+
/**
|
|
369
|
+
* List brand mentions
|
|
370
|
+
*/
|
|
371
|
+
listMentions(requestParameters: ListMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MentionsResponse>;
|
|
372
|
+
|
|
373
|
+
}
|
|
374
|
+
|
|
375
|
+
/**
|
|
376
|
+
*
|
|
377
|
+
*/
|
|
378
|
+
export class MentionsCitationsApi extends runtime.BaseAPI implements MentionsCitationsApiInterface {
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* Creates request options for listAllCitations without sending the request
|
|
382
|
+
*/
|
|
383
|
+
async listAllCitationsRequestOpts(requestParameters: ListAllCitationsRequest): Promise<runtime.RequestOpts> {
|
|
384
|
+
if (requestParameters['projectId'] == null) {
|
|
385
|
+
throw new runtime.RequiredError(
|
|
386
|
+
'projectId',
|
|
387
|
+
'Required parameter "projectId" was null or undefined when calling listAllCitations().'
|
|
388
|
+
);
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
const queryParameters: any = {};
|
|
392
|
+
|
|
393
|
+
if (requestParameters['projectId'] != null) {
|
|
394
|
+
queryParameters['project_id'] = requestParameters['projectId'];
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
if (requestParameters['competitors'] != null) {
|
|
398
|
+
queryParameters['competitors'] = requestParameters['competitors'];
|
|
399
|
+
}
|
|
400
|
+
|
|
401
|
+
if (requestParameters['page'] != null) {
|
|
402
|
+
queryParameters['page'] = requestParameters['page'];
|
|
403
|
+
}
|
|
404
|
+
|
|
405
|
+
if (requestParameters['perPage'] != null) {
|
|
406
|
+
queryParameters['per_page'] = requestParameters['perPage'];
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
if (requestParameters['model'] != null) {
|
|
410
|
+
queryParameters['model'] = requestParameters['model'];
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
if (requestParameters['collectionId'] != null) {
|
|
414
|
+
queryParameters['collection_id'] = requestParameters['collectionId'];
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
if (requestParameters['prompt'] != null) {
|
|
418
|
+
queryParameters['prompt'] = requestParameters['prompt'];
|
|
419
|
+
}
|
|
420
|
+
|
|
421
|
+
if (requestParameters['from'] != null) {
|
|
422
|
+
queryParameters['from'] = (requestParameters['from'] as any).toISOString();
|
|
423
|
+
}
|
|
424
|
+
|
|
425
|
+
if (requestParameters['to'] != null) {
|
|
426
|
+
queryParameters['to'] = (requestParameters['to'] as any).toISOString();
|
|
427
|
+
}
|
|
428
|
+
|
|
429
|
+
if (requestParameters['output'] != null) {
|
|
430
|
+
queryParameters['output'] = requestParameters['output'];
|
|
431
|
+
}
|
|
432
|
+
|
|
433
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
434
|
+
|
|
435
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
436
|
+
const token = this.configuration.accessToken;
|
|
437
|
+
const tokenString = await token("BearerAuth", []);
|
|
438
|
+
|
|
439
|
+
if (tokenString) {
|
|
440
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
441
|
+
}
|
|
442
|
+
}
|
|
443
|
+
|
|
444
|
+
let urlPath = `/dimensions/all_citations`;
|
|
445
|
+
|
|
446
|
+
return {
|
|
447
|
+
path: urlPath,
|
|
448
|
+
method: 'GET',
|
|
449
|
+
headers: headerParameters,
|
|
450
|
+
query: queryParameters,
|
|
451
|
+
};
|
|
452
|
+
}
|
|
453
|
+
|
|
454
|
+
/**
|
|
455
|
+
* Unified citations stream with an `actor_type` field on each record. Includes visible citations and background source references; background references use position 0, meaning no visible rank.
|
|
456
|
+
* List all citations (brand + competitor)
|
|
457
|
+
*/
|
|
458
|
+
async listAllCitationsRaw(requestParameters: ListAllCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
459
|
+
const requestOptions = await this.listAllCitationsRequestOpts(requestParameters);
|
|
460
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
461
|
+
|
|
462
|
+
return new runtime.VoidApiResponse(response);
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
/**
|
|
466
|
+
* Unified citations stream with an `actor_type` field on each record. Includes visible citations and background source references; background references use position 0, meaning no visible rank.
|
|
467
|
+
* List all citations (brand + competitor)
|
|
468
|
+
*/
|
|
469
|
+
async listAllCitations(requestParameters: ListAllCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
470
|
+
await this.listAllCitationsRaw(requestParameters, initOverrides);
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
/**
|
|
474
|
+
* Creates request options for listAllMentions without sending the request
|
|
475
|
+
*/
|
|
476
|
+
async listAllMentionsRequestOpts(requestParameters: ListAllMentionsRequest): Promise<runtime.RequestOpts> {
|
|
477
|
+
if (requestParameters['projectId'] == null) {
|
|
478
|
+
throw new runtime.RequiredError(
|
|
479
|
+
'projectId',
|
|
480
|
+
'Required parameter "projectId" was null or undefined when calling listAllMentions().'
|
|
481
|
+
);
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
const queryParameters: any = {};
|
|
485
|
+
|
|
486
|
+
if (requestParameters['projectId'] != null) {
|
|
487
|
+
queryParameters['project_id'] = requestParameters['projectId'];
|
|
488
|
+
}
|
|
489
|
+
|
|
490
|
+
if (requestParameters['competitors'] != null) {
|
|
491
|
+
queryParameters['competitors'] = requestParameters['competitors'];
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
if (requestParameters['page'] != null) {
|
|
495
|
+
queryParameters['page'] = requestParameters['page'];
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
if (requestParameters['perPage'] != null) {
|
|
499
|
+
queryParameters['per_page'] = requestParameters['perPage'];
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
if (requestParameters['model'] != null) {
|
|
503
|
+
queryParameters['model'] = requestParameters['model'];
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
if (requestParameters['collectionId'] != null) {
|
|
507
|
+
queryParameters['collection_id'] = requestParameters['collectionId'];
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
if (requestParameters['prompt'] != null) {
|
|
511
|
+
queryParameters['prompt'] = requestParameters['prompt'];
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
if (requestParameters['from'] != null) {
|
|
515
|
+
queryParameters['from'] = (requestParameters['from'] as any).toISOString();
|
|
516
|
+
}
|
|
517
|
+
|
|
518
|
+
if (requestParameters['to'] != null) {
|
|
519
|
+
queryParameters['to'] = (requestParameters['to'] as any).toISOString();
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
if (requestParameters['output'] != null) {
|
|
523
|
+
queryParameters['output'] = requestParameters['output'];
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
527
|
+
|
|
528
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
529
|
+
const token = this.configuration.accessToken;
|
|
530
|
+
const tokenString = await token("BearerAuth", []);
|
|
531
|
+
|
|
532
|
+
if (tokenString) {
|
|
533
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
|
|
537
|
+
let urlPath = `/dimensions/all_mentions`;
|
|
538
|
+
|
|
539
|
+
return {
|
|
540
|
+
path: urlPath,
|
|
541
|
+
method: 'GET',
|
|
542
|
+
headers: headerParameters,
|
|
543
|
+
query: queryParameters,
|
|
544
|
+
};
|
|
545
|
+
}
|
|
546
|
+
|
|
547
|
+
/**
|
|
548
|
+
* Unified mentions stream. Each record has an `actor_type` field (`project` or `competitor`) so the same payload covers both.
|
|
549
|
+
* List all mentions (brand + competitor)
|
|
550
|
+
*/
|
|
551
|
+
async listAllMentionsRaw(requestParameters: ListAllMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
552
|
+
const requestOptions = await this.listAllMentionsRequestOpts(requestParameters);
|
|
553
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
554
|
+
|
|
555
|
+
return new runtime.VoidApiResponse(response);
|
|
556
|
+
}
|
|
557
|
+
|
|
558
|
+
/**
|
|
559
|
+
* Unified mentions stream. Each record has an `actor_type` field (`project` or `competitor`) so the same payload covers both.
|
|
560
|
+
* List all mentions (brand + competitor)
|
|
561
|
+
*/
|
|
562
|
+
async listAllMentions(requestParameters: ListAllMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
563
|
+
await this.listAllMentionsRaw(requestParameters, initOverrides);
|
|
564
|
+
}
|
|
565
|
+
|
|
566
|
+
/**
|
|
567
|
+
* Creates request options for listCitations without sending the request
|
|
568
|
+
*/
|
|
569
|
+
async listCitationsRequestOpts(requestParameters: ListCitationsRequest): Promise<runtime.RequestOpts> {
|
|
570
|
+
if (requestParameters['projectId'] == null) {
|
|
571
|
+
throw new runtime.RequiredError(
|
|
572
|
+
'projectId',
|
|
573
|
+
'Required parameter "projectId" was null or undefined when calling listCitations().'
|
|
574
|
+
);
|
|
575
|
+
}
|
|
576
|
+
|
|
577
|
+
const queryParameters: any = {};
|
|
578
|
+
|
|
579
|
+
if (requestParameters['projectId'] != null) {
|
|
580
|
+
queryParameters['project_id'] = requestParameters['projectId'];
|
|
581
|
+
}
|
|
582
|
+
|
|
583
|
+
if (requestParameters['page'] != null) {
|
|
584
|
+
queryParameters['page'] = requestParameters['page'];
|
|
585
|
+
}
|
|
586
|
+
|
|
587
|
+
if (requestParameters['perPage'] != null) {
|
|
588
|
+
queryParameters['per_page'] = requestParameters['perPage'];
|
|
589
|
+
}
|
|
590
|
+
|
|
591
|
+
if (requestParameters['model'] != null) {
|
|
592
|
+
queryParameters['model'] = requestParameters['model'];
|
|
593
|
+
}
|
|
594
|
+
|
|
595
|
+
if (requestParameters['collectionId'] != null) {
|
|
596
|
+
queryParameters['collection_id'] = requestParameters['collectionId'];
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
if (requestParameters['countryCode'] != null) {
|
|
600
|
+
queryParameters['country_code'] = requestParameters['countryCode'];
|
|
601
|
+
}
|
|
602
|
+
|
|
603
|
+
if (requestParameters['languageCode'] != null) {
|
|
604
|
+
queryParameters['language_code'] = requestParameters['languageCode'];
|
|
605
|
+
}
|
|
606
|
+
|
|
607
|
+
if (requestParameters['prompt'] != null) {
|
|
608
|
+
queryParameters['prompt'] = requestParameters['prompt'];
|
|
609
|
+
}
|
|
610
|
+
|
|
611
|
+
if (requestParameters['from'] != null) {
|
|
612
|
+
queryParameters['from'] = (requestParameters['from'] as any).toISOString();
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
if (requestParameters['to'] != null) {
|
|
616
|
+
queryParameters['to'] = (requestParameters['to'] as any).toISOString();
|
|
617
|
+
}
|
|
618
|
+
|
|
619
|
+
if (requestParameters['output'] != null) {
|
|
620
|
+
queryParameters['output'] = requestParameters['output'];
|
|
621
|
+
}
|
|
622
|
+
|
|
623
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
624
|
+
|
|
625
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
626
|
+
const token = this.configuration.accessToken;
|
|
627
|
+
const tokenString = await token("BearerAuth", []);
|
|
628
|
+
|
|
629
|
+
if (tokenString) {
|
|
630
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
631
|
+
}
|
|
632
|
+
}
|
|
633
|
+
|
|
634
|
+
let urlPath = `/dimensions/citations`;
|
|
635
|
+
|
|
636
|
+
return {
|
|
637
|
+
path: urlPath,
|
|
638
|
+
method: 'GET',
|
|
639
|
+
headers: headerParameters,
|
|
640
|
+
query: queryParameters,
|
|
641
|
+
};
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
/**
|
|
645
|
+
* Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
|
|
646
|
+
* List brand citations
|
|
647
|
+
*/
|
|
648
|
+
async listCitationsRaw(requestParameters: ListCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CitationsResponse>> {
|
|
649
|
+
const requestOptions = await this.listCitationsRequestOpts(requestParameters);
|
|
650
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
651
|
+
|
|
652
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CitationsResponseFromJSON(jsonValue));
|
|
653
|
+
}
|
|
654
|
+
|
|
655
|
+
/**
|
|
656
|
+
* Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
|
|
657
|
+
* List brand citations
|
|
658
|
+
*/
|
|
659
|
+
async listCitations(requestParameters: ListCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CitationsResponse> {
|
|
660
|
+
const response = await this.listCitationsRaw(requestParameters, initOverrides);
|
|
661
|
+
return await response.value();
|
|
662
|
+
}
|
|
663
|
+
|
|
664
|
+
/**
|
|
665
|
+
* Creates request options for listCompetitorCitations without sending the request
|
|
666
|
+
*/
|
|
667
|
+
async listCompetitorCitationsRequestOpts(requestParameters: ListCompetitorCitationsRequest): Promise<runtime.RequestOpts> {
|
|
668
|
+
if (requestParameters['projectId'] == null) {
|
|
669
|
+
throw new runtime.RequiredError(
|
|
670
|
+
'projectId',
|
|
671
|
+
'Required parameter "projectId" was null or undefined when calling listCompetitorCitations().'
|
|
672
|
+
);
|
|
673
|
+
}
|
|
674
|
+
|
|
675
|
+
const queryParameters: any = {};
|
|
676
|
+
|
|
677
|
+
if (requestParameters['projectId'] != null) {
|
|
678
|
+
queryParameters['project_id'] = requestParameters['projectId'];
|
|
679
|
+
}
|
|
680
|
+
|
|
681
|
+
if (requestParameters['competitors'] != null) {
|
|
682
|
+
queryParameters['competitors'] = requestParameters['competitors'];
|
|
683
|
+
}
|
|
684
|
+
|
|
685
|
+
if (requestParameters['page'] != null) {
|
|
686
|
+
queryParameters['page'] = requestParameters['page'];
|
|
687
|
+
}
|
|
688
|
+
|
|
689
|
+
if (requestParameters['perPage'] != null) {
|
|
690
|
+
queryParameters['per_page'] = requestParameters['perPage'];
|
|
691
|
+
}
|
|
692
|
+
|
|
693
|
+
if (requestParameters['model'] != null) {
|
|
694
|
+
queryParameters['model'] = requestParameters['model'];
|
|
695
|
+
}
|
|
696
|
+
|
|
697
|
+
if (requestParameters['collectionId'] != null) {
|
|
698
|
+
queryParameters['collection_id'] = requestParameters['collectionId'];
|
|
699
|
+
}
|
|
700
|
+
|
|
701
|
+
if (requestParameters['prompt'] != null) {
|
|
702
|
+
queryParameters['prompt'] = requestParameters['prompt'];
|
|
703
|
+
}
|
|
704
|
+
|
|
705
|
+
if (requestParameters['from'] != null) {
|
|
706
|
+
queryParameters['from'] = (requestParameters['from'] as any).toISOString();
|
|
707
|
+
}
|
|
708
|
+
|
|
709
|
+
if (requestParameters['to'] != null) {
|
|
710
|
+
queryParameters['to'] = (requestParameters['to'] as any).toISOString();
|
|
711
|
+
}
|
|
712
|
+
|
|
713
|
+
if (requestParameters['output'] != null) {
|
|
714
|
+
queryParameters['output'] = requestParameters['output'];
|
|
715
|
+
}
|
|
716
|
+
|
|
717
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
718
|
+
|
|
719
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
720
|
+
const token = this.configuration.accessToken;
|
|
721
|
+
const tokenString = await token("BearerAuth", []);
|
|
722
|
+
|
|
723
|
+
if (tokenString) {
|
|
724
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
725
|
+
}
|
|
726
|
+
}
|
|
727
|
+
|
|
728
|
+
let urlPath = `/dimensions/competitor_citations`;
|
|
729
|
+
|
|
730
|
+
return {
|
|
731
|
+
path: urlPath,
|
|
732
|
+
method: 'GET',
|
|
733
|
+
headers: headerParameters,
|
|
734
|
+
query: queryParameters,
|
|
735
|
+
};
|
|
736
|
+
}
|
|
737
|
+
|
|
738
|
+
/**
|
|
739
|
+
* Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
|
|
740
|
+
* List competitor citations
|
|
741
|
+
*/
|
|
742
|
+
async listCompetitorCitationsRaw(requestParameters: ListCompetitorCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
|
|
743
|
+
const requestOptions = await this.listCompetitorCitationsRequestOpts(requestParameters);
|
|
744
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
745
|
+
|
|
746
|
+
return new runtime.VoidApiResponse(response);
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
/**
|
|
750
|
+
* Includes visible citations and background source references. Background references use position 0, meaning no visible rank.
|
|
751
|
+
* List competitor citations
|
|
752
|
+
*/
|
|
753
|
+
async listCompetitorCitations(requestParameters: ListCompetitorCitationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
|
|
754
|
+
await this.listCompetitorCitationsRaw(requestParameters, initOverrides);
|
|
755
|
+
}
|
|
756
|
+
|
|
757
|
+
/**
|
|
758
|
+
* Creates request options for listCompetitorMentions without sending the request
|
|
759
|
+
*/
|
|
760
|
+
async listCompetitorMentionsRequestOpts(requestParameters: ListCompetitorMentionsRequest): Promise<runtime.RequestOpts> {
|
|
761
|
+
if (requestParameters['projectId'] == null) {
|
|
762
|
+
throw new runtime.RequiredError(
|
|
763
|
+
'projectId',
|
|
764
|
+
'Required parameter "projectId" was null or undefined when calling listCompetitorMentions().'
|
|
765
|
+
);
|
|
766
|
+
}
|
|
767
|
+
|
|
768
|
+
const queryParameters: any = {};
|
|
769
|
+
|
|
770
|
+
if (requestParameters['projectId'] != null) {
|
|
771
|
+
queryParameters['project_id'] = requestParameters['projectId'];
|
|
772
|
+
}
|
|
773
|
+
|
|
774
|
+
if (requestParameters['competitors'] != null) {
|
|
775
|
+
queryParameters['competitors'] = requestParameters['competitors'];
|
|
776
|
+
}
|
|
777
|
+
|
|
778
|
+
if (requestParameters['page'] != null) {
|
|
779
|
+
queryParameters['page'] = requestParameters['page'];
|
|
780
|
+
}
|
|
781
|
+
|
|
782
|
+
if (requestParameters['perPage'] != null) {
|
|
783
|
+
queryParameters['per_page'] = requestParameters['perPage'];
|
|
784
|
+
}
|
|
785
|
+
|
|
786
|
+
if (requestParameters['model'] != null) {
|
|
787
|
+
queryParameters['model'] = requestParameters['model'];
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
if (requestParameters['collectionId'] != null) {
|
|
791
|
+
queryParameters['collection_id'] = requestParameters['collectionId'];
|
|
792
|
+
}
|
|
793
|
+
|
|
794
|
+
if (requestParameters['prompt'] != null) {
|
|
795
|
+
queryParameters['prompt'] = requestParameters['prompt'];
|
|
796
|
+
}
|
|
797
|
+
|
|
798
|
+
if (requestParameters['from'] != null) {
|
|
799
|
+
queryParameters['from'] = (requestParameters['from'] as any).toISOString();
|
|
800
|
+
}
|
|
801
|
+
|
|
802
|
+
if (requestParameters['to'] != null) {
|
|
803
|
+
queryParameters['to'] = (requestParameters['to'] as any).toISOString();
|
|
804
|
+
}
|
|
805
|
+
|
|
806
|
+
if (requestParameters['output'] != null) {
|
|
807
|
+
queryParameters['output'] = requestParameters['output'];
|
|
808
|
+
}
|
|
809
|
+
|
|
810
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
811
|
+
|
|
812
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
813
|
+
const token = this.configuration.accessToken;
|
|
814
|
+
const tokenString = await token("BearerAuth", []);
|
|
815
|
+
|
|
816
|
+
if (tokenString) {
|
|
817
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
818
|
+
}
|
|
819
|
+
}
|
|
820
|
+
|
|
821
|
+
let urlPath = `/dimensions/competitor_mentions`;
|
|
822
|
+
|
|
823
|
+
return {
|
|
824
|
+
path: urlPath,
|
|
825
|
+
method: 'GET',
|
|
826
|
+
headers: headerParameters,
|
|
827
|
+
query: queryParameters,
|
|
828
|
+
};
|
|
829
|
+
}
|
|
830
|
+
|
|
831
|
+
/**
|
|
832
|
+
* List competitor mentions
|
|
833
|
+
*/
|
|
834
|
+
async listCompetitorMentionsRaw(requestParameters: ListCompetitorMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompetitorMentionsResponse>> {
|
|
835
|
+
const requestOptions = await this.listCompetitorMentionsRequestOpts(requestParameters);
|
|
836
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
837
|
+
|
|
838
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CompetitorMentionsResponseFromJSON(jsonValue));
|
|
839
|
+
}
|
|
840
|
+
|
|
841
|
+
/**
|
|
842
|
+
* List competitor mentions
|
|
843
|
+
*/
|
|
844
|
+
async listCompetitorMentions(requestParameters: ListCompetitorMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompetitorMentionsResponse> {
|
|
845
|
+
const response = await this.listCompetitorMentionsRaw(requestParameters, initOverrides);
|
|
846
|
+
return await response.value();
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
/**
|
|
850
|
+
* Creates request options for listMentions without sending the request
|
|
851
|
+
*/
|
|
852
|
+
async listMentionsRequestOpts(requestParameters: ListMentionsRequest): Promise<runtime.RequestOpts> {
|
|
853
|
+
if (requestParameters['projectId'] == null) {
|
|
854
|
+
throw new runtime.RequiredError(
|
|
855
|
+
'projectId',
|
|
856
|
+
'Required parameter "projectId" was null or undefined when calling listMentions().'
|
|
857
|
+
);
|
|
858
|
+
}
|
|
859
|
+
|
|
860
|
+
const queryParameters: any = {};
|
|
861
|
+
|
|
862
|
+
if (requestParameters['projectId'] != null) {
|
|
863
|
+
queryParameters['project_id'] = requestParameters['projectId'];
|
|
864
|
+
}
|
|
865
|
+
|
|
866
|
+
if (requestParameters['page'] != null) {
|
|
867
|
+
queryParameters['page'] = requestParameters['page'];
|
|
868
|
+
}
|
|
869
|
+
|
|
870
|
+
if (requestParameters['perPage'] != null) {
|
|
871
|
+
queryParameters['per_page'] = requestParameters['perPage'];
|
|
872
|
+
}
|
|
873
|
+
|
|
874
|
+
if (requestParameters['model'] != null) {
|
|
875
|
+
queryParameters['model'] = requestParameters['model'];
|
|
876
|
+
}
|
|
877
|
+
|
|
878
|
+
if (requestParameters['collectionId'] != null) {
|
|
879
|
+
queryParameters['collection_id'] = requestParameters['collectionId'];
|
|
880
|
+
}
|
|
881
|
+
|
|
882
|
+
if (requestParameters['countryCode'] != null) {
|
|
883
|
+
queryParameters['country_code'] = requestParameters['countryCode'];
|
|
884
|
+
}
|
|
885
|
+
|
|
886
|
+
if (requestParameters['languageCode'] != null) {
|
|
887
|
+
queryParameters['language_code'] = requestParameters['languageCode'];
|
|
888
|
+
}
|
|
889
|
+
|
|
890
|
+
if (requestParameters['prompt'] != null) {
|
|
891
|
+
queryParameters['prompt'] = requestParameters['prompt'];
|
|
892
|
+
}
|
|
893
|
+
|
|
894
|
+
if (requestParameters['from'] != null) {
|
|
895
|
+
queryParameters['from'] = (requestParameters['from'] as any).toISOString();
|
|
896
|
+
}
|
|
897
|
+
|
|
898
|
+
if (requestParameters['to'] != null) {
|
|
899
|
+
queryParameters['to'] = (requestParameters['to'] as any).toISOString();
|
|
900
|
+
}
|
|
901
|
+
|
|
902
|
+
if (requestParameters['output'] != null) {
|
|
903
|
+
queryParameters['output'] = requestParameters['output'];
|
|
904
|
+
}
|
|
905
|
+
|
|
906
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
907
|
+
|
|
908
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
909
|
+
const token = this.configuration.accessToken;
|
|
910
|
+
const tokenString = await token("BearerAuth", []);
|
|
911
|
+
|
|
912
|
+
if (tokenString) {
|
|
913
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
914
|
+
}
|
|
915
|
+
}
|
|
916
|
+
|
|
917
|
+
let urlPath = `/dimensions/mentions`;
|
|
918
|
+
|
|
919
|
+
return {
|
|
920
|
+
path: urlPath,
|
|
921
|
+
method: 'GET',
|
|
922
|
+
headers: headerParameters,
|
|
923
|
+
query: queryParameters,
|
|
924
|
+
};
|
|
925
|
+
}
|
|
926
|
+
|
|
927
|
+
/**
|
|
928
|
+
* List brand mentions
|
|
929
|
+
*/
|
|
930
|
+
async listMentionsRaw(requestParameters: ListMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MentionsResponse>> {
|
|
931
|
+
const requestOptions = await this.listMentionsRequestOpts(requestParameters);
|
|
932
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
933
|
+
|
|
934
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => MentionsResponseFromJSON(jsonValue));
|
|
935
|
+
}
|
|
936
|
+
|
|
937
|
+
/**
|
|
938
|
+
* List brand mentions
|
|
939
|
+
*/
|
|
940
|
+
async listMentions(requestParameters: ListMentionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MentionsResponse> {
|
|
941
|
+
const response = await this.listMentionsRaw(requestParameters, initOverrides);
|
|
942
|
+
return await response.value();
|
|
943
|
+
}
|
|
944
|
+
|
|
945
|
+
}
|
|
946
|
+
|
|
947
|
+
/**
|
|
948
|
+
* @export
|
|
949
|
+
*/
|
|
950
|
+
export const ListAllCitationsModelEnum = {
|
|
951
|
+
Chatgpt: 'chatgpt',
|
|
952
|
+
Perplexity: 'perplexity',
|
|
953
|
+
AiMode: 'ai_mode',
|
|
954
|
+
AiOverview: 'ai_overview',
|
|
955
|
+
Gemini: 'gemini',
|
|
956
|
+
Copilot: 'copilot',
|
|
957
|
+
AmazonRufus: 'amazon_rufus',
|
|
958
|
+
Claude: 'claude',
|
|
959
|
+
Grok: 'grok',
|
|
960
|
+
Deepseek: 'deepseek',
|
|
961
|
+
NaverAi: 'naver_ai',
|
|
962
|
+
BaiduAi: 'baidu_ai',
|
|
963
|
+
MetaAi: 'meta_ai'
|
|
964
|
+
} as const;
|
|
965
|
+
export type ListAllCitationsModelEnum = typeof ListAllCitationsModelEnum[keyof typeof ListAllCitationsModelEnum];
|
|
966
|
+
/**
|
|
967
|
+
* @export
|
|
968
|
+
*/
|
|
969
|
+
export const ListAllCitationsOutputEnum = {
|
|
970
|
+
Flat: 'flat',
|
|
971
|
+
Csv: 'csv'
|
|
972
|
+
} as const;
|
|
973
|
+
export type ListAllCitationsOutputEnum = typeof ListAllCitationsOutputEnum[keyof typeof ListAllCitationsOutputEnum];
|
|
974
|
+
/**
|
|
975
|
+
* @export
|
|
976
|
+
*/
|
|
977
|
+
export const ListAllMentionsModelEnum = {
|
|
978
|
+
Chatgpt: 'chatgpt',
|
|
979
|
+
Perplexity: 'perplexity',
|
|
980
|
+
AiMode: 'ai_mode',
|
|
981
|
+
AiOverview: 'ai_overview',
|
|
982
|
+
Gemini: 'gemini',
|
|
983
|
+
Copilot: 'copilot',
|
|
984
|
+
AmazonRufus: 'amazon_rufus',
|
|
985
|
+
Claude: 'claude',
|
|
986
|
+
Grok: 'grok',
|
|
987
|
+
Deepseek: 'deepseek',
|
|
988
|
+
NaverAi: 'naver_ai',
|
|
989
|
+
BaiduAi: 'baidu_ai',
|
|
990
|
+
MetaAi: 'meta_ai'
|
|
991
|
+
} as const;
|
|
992
|
+
export type ListAllMentionsModelEnum = typeof ListAllMentionsModelEnum[keyof typeof ListAllMentionsModelEnum];
|
|
993
|
+
/**
|
|
994
|
+
* @export
|
|
995
|
+
*/
|
|
996
|
+
export const ListAllMentionsOutputEnum = {
|
|
997
|
+
Flat: 'flat',
|
|
998
|
+
Csv: 'csv'
|
|
999
|
+
} as const;
|
|
1000
|
+
export type ListAllMentionsOutputEnum = typeof ListAllMentionsOutputEnum[keyof typeof ListAllMentionsOutputEnum];
|
|
1001
|
+
/**
|
|
1002
|
+
* @export
|
|
1003
|
+
*/
|
|
1004
|
+
export const ListCitationsModelEnum = {
|
|
1005
|
+
Chatgpt: 'chatgpt',
|
|
1006
|
+
Perplexity: 'perplexity',
|
|
1007
|
+
AiMode: 'ai_mode',
|
|
1008
|
+
AiOverview: 'ai_overview',
|
|
1009
|
+
Gemini: 'gemini',
|
|
1010
|
+
Copilot: 'copilot',
|
|
1011
|
+
AmazonRufus: 'amazon_rufus',
|
|
1012
|
+
Claude: 'claude',
|
|
1013
|
+
Grok: 'grok',
|
|
1014
|
+
Deepseek: 'deepseek',
|
|
1015
|
+
NaverAi: 'naver_ai',
|
|
1016
|
+
BaiduAi: 'baidu_ai',
|
|
1017
|
+
MetaAi: 'meta_ai'
|
|
1018
|
+
} as const;
|
|
1019
|
+
export type ListCitationsModelEnum = typeof ListCitationsModelEnum[keyof typeof ListCitationsModelEnum];
|
|
1020
|
+
/**
|
|
1021
|
+
* @export
|
|
1022
|
+
*/
|
|
1023
|
+
export const ListCitationsOutputEnum = {
|
|
1024
|
+
Flat: 'flat',
|
|
1025
|
+
Csv: 'csv'
|
|
1026
|
+
} as const;
|
|
1027
|
+
export type ListCitationsOutputEnum = typeof ListCitationsOutputEnum[keyof typeof ListCitationsOutputEnum];
|
|
1028
|
+
/**
|
|
1029
|
+
* @export
|
|
1030
|
+
*/
|
|
1031
|
+
export const ListCompetitorCitationsModelEnum = {
|
|
1032
|
+
Chatgpt: 'chatgpt',
|
|
1033
|
+
Perplexity: 'perplexity',
|
|
1034
|
+
AiMode: 'ai_mode',
|
|
1035
|
+
AiOverview: 'ai_overview',
|
|
1036
|
+
Gemini: 'gemini',
|
|
1037
|
+
Copilot: 'copilot',
|
|
1038
|
+
AmazonRufus: 'amazon_rufus',
|
|
1039
|
+
Claude: 'claude',
|
|
1040
|
+
Grok: 'grok',
|
|
1041
|
+
Deepseek: 'deepseek',
|
|
1042
|
+
NaverAi: 'naver_ai',
|
|
1043
|
+
BaiduAi: 'baidu_ai',
|
|
1044
|
+
MetaAi: 'meta_ai'
|
|
1045
|
+
} as const;
|
|
1046
|
+
export type ListCompetitorCitationsModelEnum = typeof ListCompetitorCitationsModelEnum[keyof typeof ListCompetitorCitationsModelEnum];
|
|
1047
|
+
/**
|
|
1048
|
+
* @export
|
|
1049
|
+
*/
|
|
1050
|
+
export const ListCompetitorCitationsOutputEnum = {
|
|
1051
|
+
Flat: 'flat',
|
|
1052
|
+
Csv: 'csv'
|
|
1053
|
+
} as const;
|
|
1054
|
+
export type ListCompetitorCitationsOutputEnum = typeof ListCompetitorCitationsOutputEnum[keyof typeof ListCompetitorCitationsOutputEnum];
|
|
1055
|
+
/**
|
|
1056
|
+
* @export
|
|
1057
|
+
*/
|
|
1058
|
+
export const ListCompetitorMentionsModelEnum = {
|
|
1059
|
+
Chatgpt: 'chatgpt',
|
|
1060
|
+
Perplexity: 'perplexity',
|
|
1061
|
+
AiMode: 'ai_mode',
|
|
1062
|
+
AiOverview: 'ai_overview',
|
|
1063
|
+
Gemini: 'gemini',
|
|
1064
|
+
Copilot: 'copilot',
|
|
1065
|
+
AmazonRufus: 'amazon_rufus',
|
|
1066
|
+
Claude: 'claude',
|
|
1067
|
+
Grok: 'grok',
|
|
1068
|
+
Deepseek: 'deepseek',
|
|
1069
|
+
NaverAi: 'naver_ai',
|
|
1070
|
+
BaiduAi: 'baidu_ai',
|
|
1071
|
+
MetaAi: 'meta_ai'
|
|
1072
|
+
} as const;
|
|
1073
|
+
export type ListCompetitorMentionsModelEnum = typeof ListCompetitorMentionsModelEnum[keyof typeof ListCompetitorMentionsModelEnum];
|
|
1074
|
+
/**
|
|
1075
|
+
* @export
|
|
1076
|
+
*/
|
|
1077
|
+
export const ListCompetitorMentionsOutputEnum = {
|
|
1078
|
+
Flat: 'flat',
|
|
1079
|
+
Csv: 'csv'
|
|
1080
|
+
} as const;
|
|
1081
|
+
export type ListCompetitorMentionsOutputEnum = typeof ListCompetitorMentionsOutputEnum[keyof typeof ListCompetitorMentionsOutputEnum];
|
|
1082
|
+
/**
|
|
1083
|
+
* @export
|
|
1084
|
+
*/
|
|
1085
|
+
export const ListMentionsModelEnum = {
|
|
1086
|
+
Chatgpt: 'chatgpt',
|
|
1087
|
+
Perplexity: 'perplexity',
|
|
1088
|
+
AiMode: 'ai_mode',
|
|
1089
|
+
AiOverview: 'ai_overview',
|
|
1090
|
+
Gemini: 'gemini',
|
|
1091
|
+
Copilot: 'copilot',
|
|
1092
|
+
AmazonRufus: 'amazon_rufus',
|
|
1093
|
+
Claude: 'claude',
|
|
1094
|
+
Grok: 'grok',
|
|
1095
|
+
Deepseek: 'deepseek',
|
|
1096
|
+
NaverAi: 'naver_ai',
|
|
1097
|
+
BaiduAi: 'baidu_ai',
|
|
1098
|
+
MetaAi: 'meta_ai'
|
|
1099
|
+
} as const;
|
|
1100
|
+
export type ListMentionsModelEnum = typeof ListMentionsModelEnum[keyof typeof ListMentionsModelEnum];
|
|
1101
|
+
/**
|
|
1102
|
+
* @export
|
|
1103
|
+
*/
|
|
1104
|
+
export const ListMentionsOutputEnum = {
|
|
1105
|
+
Flat: 'flat',
|
|
1106
|
+
Csv: 'csv'
|
|
1107
|
+
} as const;
|
|
1108
|
+
export type ListMentionsOutputEnum = typeof ListMentionsOutputEnum[keyof typeof ListMentionsOutputEnum];
|