import type { AccountAnalyticsConsent, UpdateAnalyticsConsentInput } from "./account-consent.js"; import type { AiResearchCatalog } from "./ai-research-catalog.js"; import { type ProjectDefaultsPreview, type ReviewedProjectDefaultsPatch } from "./defaults-review.js"; import { type LocalMonitorMethods } from "./local-monitor-methods.js"; import { type PageIndexingMethods } from "./page-indexing-methods.js"; import { type PromptResearchSuggestionMethods } from "./prompt-research-suggestion-methods.js"; import { type PromptTrackerMethods } from "./prompt-tracker-methods.js"; import type { ListRankCheckRunsOptions, RankCheckRunRead, RankCheckRunReadList } from "./rank-check-runs.js"; import type { ProviderBudgets, ProviderBudgetsUpdate, StoredResearchReportByKind, StoredResearchReportKind, StoredResearchReportOptions, StoredResearchReportsResponse } from "./reports-budgets.js"; import type { AgentReport, AgentReportId, AgentReportSummary, AiAnalysisOutcome, AnalyzeBrandVisibilityInput, CompareAiPromptsInput, CreateAgentReportInput, ListAgentReportsOptions, ProjectContext, ProjectContextInput, RunSiteAuditInput, SiteAudit } from "./research-workspace.js"; import { type ClientResourceNamespaces } from "./resources.js"; import { type SearchIndexMethods } from "./search-index-methods.js"; import type { AddCompetitorInput, AlertId, AlertRule, AlertRuleId, AnalyzeBacklinksOptions, ApiKey, ApiKeyId, BacklinksEstimate, BacklinksResponse, BacklinksSnapshotResponse, BisibilityClientConfig, CapabilitiesResponse, CloudImportChunkResponse, CloudImportCompatibility, CloudImportFinalizeResponse, CloudImportJobId, CloudImportPackage, CloudImportSessionCreate, CloudImportSessionCreateResponse, CloudImportUploadChunk, Competitor, CompetitorId, CompetitorListResponse, ConnectProviderInput, CostEstimate, CreateAlertRuleInput, CreateApiKeyInput, CreateKeywordsInput, CreateKeywordsResponse, CreateMyTokenInput, CreateProjectInput, CreateSavedKeywordsInput, CreateSavedKeywordsResponse, CreateSavedViewInput, CreateSignalInput, CreateTeamInviteInput, CreateWebhookInput, CreatedApiKey, CreatedPersonalAccessToken, CreatedTeamInvite, DataResponse, DeleteAlertRuleResponse, DeleteMeInput, DeleteSavedKeywordResponse, DeleteSavedViewResponse, DevicePushToken, DevicePushTokenId, DomainOverviewEstimate, DomainOverviewHistoryResponse, DomainOverviewKeywordsResponse, DomainOverviewPagesResponse, DomainOverviewReport, EstimateBacklinksOptions, EstimateDomainOverviewOptions, EstimateKeywordResearchOptions, ExportRankHistoryCsvOptions, ExportRankHistoryJsonOptions, ExportRankHistoryReportJsonOptions, GetCostEstimateOptions, GetKeywordMetricsInput, HealthResponse, InviteId, IssuedMigrationToken, Keyword, KeywordBulkInput, KeywordBulkResponse, KeywordId, KeywordMatchRequest, KeywordMatchResponse, KeywordMetricsResponse, KeywordResearchEstimate, KeywordResearchResponse, KeywordResearchResult, ListKeywordsOptions, ListRankChecksOptions, ListRankedKeywordSuggestionsOptions, ListResponse, ListSavedViewsOptions, ListSearchPerformanceQueryStatsOptions, ListSignalsOptions, ListTrafficSnapshotsOptions, LivenessResponse, LoadBacklinksSnapshotOptions, LoadDomainOverviewHistoryOptions, LoadDomainOverviewKeywordsOptions, LoadDomainOverviewPagesOptions, LoadDomainOverviewReportOptions, LoadKeywordResearchOptions, LoadMoreBacklinkRowsOptions, LocationSuggestionsResponse, Me, MeDeleted, MembershipId, MigrationTokenId, MigrationTokenListResponse, MintMigrationTokenInput, NotificationPreferences, NotificationPreferencesUpdated, OpenApiDocument, PageTrafficSnapshotsResponse, PaginationOptions, PersonalAccessToken, Project, ProjectDefaults, ProjectDefaultsPatch, ProjectId, ProjectOverview, ProjectOverviewOptions, Provider, ProviderConnection, ProviderDisconnectResponse, ProviderRate, ProviderSettingsInput, ProviderTestResult, RankCheck, RankCheckId, RankCheckRunId, RankHistoryExportResponse, RankHistoryExportRow, RankHistoryReportRecord, RankHistoryReportResponse, RankedKeywordSuggestionsResponse, ReadinessResponse, RegisterDevicePushTokenInput, RemoveCompetitorResponse, RequestOptions, ResearchKeywordsOptions, RevokedMigrationToken, RevokedTeamInvite, RunRankCheckAndWaitOptions, RunRankCheckInput, RunRankCheckOptions, SavedKeyword, SavedKeywordId, SavedView, SavedViewId, SearchLocationsOptions, SearchPerformanceQueryStatsResponse, Signal, SitemapMonitor, SitemapMonitorListResponse, TeamInvite, TeamInviteResendResult, TeamMember, TeamMemberMutationResult, TeamMemberRoleResult, TestProviderConnectionInput, TrafficSyncSummary, TriggeredAlert, TriggeredAlertMuteResult, TriggeredAlertsReadResult, UpdateAlertRuleInput, UpdateKeywordInput, UpdateMeInput, UpdateNotificationPreferencesInput, UpdateProjectInput, UpdateSitemapMonitorInput, UpdateTeamMemberRoleInput, UpdateWebhookInput, UploadCloudImportChunkOptions, Webhook, WebhookId } from "./types.js"; export declare class BisibilityClient { #private; /** Read stored Google indexed state, not a live test; may be partial. Never calls Google. */ readonly getPageIndexingReport: PageIndexingMethods["getPageIndexingReport"]; /** Read stored Google indexed state, not a live test; may be partial. Never calls Google. */ readonly listPageIndexingUrls: PageIndexingMethods["listPageIndexingUrls"]; /** Read stored Google indexed state, not a live test; may be partial. Never calls Google. */ readonly getPageIndexingSettings: PageIndexingMethods["getPageIndexingSettings"]; /** Update settings without calling Google. * Stored results are Google's indexed state, not a live test, and may be partial. */ readonly updatePageIndexingSettings: PageIndexingMethods["updatePageIndexingSettings"]; /** Read stored Google indexed state, not a live test; may be partial. Never calls Google. */ readonly iteratePageIndexingUrls: PageIndexingMethods["iteratePageIndexingUrls"]; /** List sitemaps for Google's indexed state, not a live test; results may be partial. */ readonly listSearchIndexSitemaps: SearchIndexMethods["listSearchIndexSitemaps"]; /** Read one sitemap for Google's indexed state, not a live test; results may be partial. * Pass its full URL. */ readonly getSearchIndexSitemap: SearchIndexMethods["getSearchIndexSitemap"]; /** Ask Google for its indexed state, not a live test; results may be partial. * Uses the shared daily allowance; check each result's error. */ readonly inspectSearchIndexUrls: SearchIndexMethods["inspectSearchIndexUrls"]; readonly listLocalMonitorRuns: LocalMonitorMethods["listLocalMonitorRuns"]; readonly getLocalMonitorRunResults: LocalMonitorMethods["getLocalMonitorRunResults"]; readonly listLocalMonitorPointListings: LocalMonitorMethods["listLocalMonitorPointListings"]; readonly listLocalMonitorPointHistory: LocalMonitorMethods["listLocalMonitorPointHistory"]; readonly exportLocalMonitorRun: LocalMonitorMethods["exportLocalMonitorRun"]; readonly promptResearchSuggestionsPreview: PromptResearchSuggestionMethods["promptResearchSuggestionsPreview"]; readonly promptResearchSuggestionsGenerate: PromptResearchSuggestionMethods["promptResearchSuggestionsGenerate"]; readonly suggestPromptResearchPrompts: PromptResearchSuggestionMethods["suggestPromptResearchPrompts"]; readonly acceptPromptResearchSuggestions: PromptResearchSuggestionMethods["acceptPromptResearchSuggestions"]; readonly listPromptTrackerTopics: PromptTrackerMethods["listPromptTrackerTopics"]; readonly createPromptTrackerTopic: PromptTrackerMethods["createPromptTrackerTopic"]; readonly updatePromptTrackerTopic: PromptTrackerMethods["updatePromptTrackerTopic"]; readonly archivePromptTrackerTopic: PromptTrackerMethods["archivePromptTrackerTopic"]; readonly listPromptTrackerPrompts: PromptTrackerMethods["listPromptTrackerPrompts"]; readonly createPromptTrackerPrompt: PromptTrackerMethods["createPromptTrackerPrompt"]; readonly updatePromptTrackerPrompt: PromptTrackerMethods["updatePromptTrackerPrompt"]; readonly archivePromptTrackerPrompt: PromptTrackerMethods["archivePromptTrackerPrompt"]; readonly listPromptTrackerSchedules: PromptTrackerMethods["listPromptTrackerSchedules"]; readonly createPromptTrackerSchedule: PromptTrackerMethods["createPromptTrackerSchedule"]; readonly updatePromptTrackerSchedule: PromptTrackerMethods["updatePromptTrackerSchedule"]; readonly archivePromptTrackerSchedule: PromptTrackerMethods["archivePromptTrackerSchedule"]; readonly previewPromptTrackerRun: PromptTrackerMethods["previewPromptTrackerRun"]; readonly createPromptTrackerRun: PromptTrackerMethods["createPromptTrackerRun"]; readonly listPromptTrackerRuns: PromptTrackerMethods["listPromptTrackerRuns"]; readonly getPromptTrackerRun: PromptTrackerMethods["getPromptTrackerRun"]; readonly listPromptTrackerSamples: PromptTrackerMethods["listPromptTrackerSamples"]; readonly cancelPromptTrackerRun: PromptTrackerMethods["cancelPromptTrackerRun"]; readonly retryPromptTrackerRun: PromptTrackerMethods["retryPromptTrackerRun"]; readonly getPromptTrackerHistory: PromptTrackerMethods["getPromptTrackerHistory"]; readonly getPromptTrackerTrends: PromptTrackerMethods["getPromptTrackerTrends"]; readonly exportPromptTrackerEvidence: PromptTrackerMethods["exportPromptTrackerEvidence"]; readonly agentReports: ClientResourceNamespaces["agentReports"]; readonly projectContext: ClientResourceNamespaces["projectContext"]; readonly brandVisibility: ClientResourceNamespaces["brandVisibility"]; readonly promptExplorer: ClientResourceNamespaces["promptExplorer"]; readonly siteAudits: ClientResourceNamespaces["siteAudits"]; readonly account: ClientResourceNamespaces["account"]; readonly alertRules: ClientResourceNamespaces["alertRules"]; readonly alerts: ClientResourceNamespaces["alerts"]; readonly analytics: ClientResourceNamespaces["analytics"]; readonly apiKeys: ClientResourceNamespaces["apiKeys"]; readonly backlinks: ClientResourceNamespaces["backlinks"]; readonly baseUrl: string; readonly competitors: ClientResourceNamespaces["competitors"]; readonly domainOverview: ClientResourceNamespaces["domainOverview"]; readonly imports: ClientResourceNamespaces["imports"]; readonly keywords: ClientResourceNamespaces["keywords"]; readonly locations: ClientResourceNamespaces["locations"]; readonly notificationSettings: ClientResourceNamespaces["notificationSettings"]; readonly pricing: ClientResourceNamespaces["pricing"]; readonly projects: ClientResourceNamespaces["projects"]; readonly researchReports: ClientResourceNamespaces["researchReports"]; readonly providers: ClientResourceNamespaces["providers"]; readonly localMonitors: ClientResourceNamespaces["localMonitors"]; readonly rankChecks: ClientResourceNamespaces["rankChecks"]; readonly savedViews: ClientResourceNamespaces["savedViews"]; readonly signals: ClientResourceNamespaces["signals"]; readonly sitemapMonitors: ClientResourceNamespaces["sitemapMonitors"]; readonly system: ClientResourceNamespaces["system"]; readonly team: ClientResourceNamespaces["team"]; readonly webhooks: ClientResourceNamespaces["webhooks"]; constructor(config?: BisibilityClientConfig); /** @deprecated Use `client.system.getHealth()`. */ getHealth(options?: RequestOptions): Promise; /** @deprecated Use `client.system.getLiveness()`. */ getLiveness(options?: RequestOptions): Promise; /** @deprecated Use `client.system.getReadiness()`. */ getReadiness(options?: RequestOptions): Promise; /** @deprecated Use `client.system.getOpenApi()`. */ getOpenApi(options?: RequestOptions): Promise; /** @deprecated Use `client.system.getCapabilities()`. */ getCapabilities(options?: RequestOptions): Promise; /** @deprecated Use `client.system.getLlmsText()`. */ getLlmsText(options?: RequestOptions): Promise; /** @deprecated Use `client.pricing.getRates()`. */ getProviderRates(options?: RequestOptions): Promise>; /** @deprecated Use `client.pricing.estimate()`. */ getCostEstimate(input: GetCostEstimateOptions, options?: RequestOptions): Promise>; /** @deprecated Use `client.locations.search()`. */ searchLocations(input: SearchLocationsOptions, options?: RequestOptions): Promise; /** @deprecated Use `client.account.get()`. */ getMe(options?: RequestOptions): Promise; /** @deprecated Use `client.account.update()`. */ updateMe(input: UpdateMeInput, options?: RequestOptions): Promise; /** * Permanently delete the authenticated account and its owned data. Requires an admin-scope * personal access token, or an app token with `api:write` and a sign-in within 10 minutes. * @deprecated Use `client.account.delete()`. */ deleteMe(input: DeleteMeInput, options?: RequestOptions): Promise; /** @deprecated Use `client.account.pushTokens.list()`. */ listDevicePushTokens(options?: RequestOptions): Promise>; /** @deprecated Use `client.account.pushTokens.register()`. */ registerDevicePushToken(input: RegisterDevicePushTokenInput, options?: RequestOptions): Promise; /** @deprecated Use `client.account.pushTokens.delete()`. */ deleteDevicePushToken(pushTokenId: DevicePushTokenId, options?: RequestOptions): Promise; /** @deprecated Use `client.account.tokens.list()`. */ listMyTokens(options?: RequestOptions): Promise>; /** @deprecated Use `client.account.tokens.create()`. */ createMyToken(input: CreateMyTokenInput, options?: RequestOptions): Promise; /** @deprecated Use `client.account.tokens.revoke()`. */ revokeMyToken(tokenId: PersonalAccessToken["id"] | "current", options?: RequestOptions): Promise; /** @deprecated Use `client.projects.list()`. */ listProjects(options?: RequestOptions): Promise>; /** @deprecated Use `client.projects.create()`. */ createProject(input: CreateProjectInput, options?: RequestOptions): Promise; /** @deprecated Use `client.projects.get()`. */ getProject(projectId: ProjectId, options?: RequestOptions): Promise; /** @deprecated Use `client.projects.update()`. */ updateProject(projectId: ProjectId, input: UpdateProjectInput, options?: RequestOptions): Promise; /** @deprecated Use `client.projects.delete()`. */ deleteProject(projectId: ProjectId, options?: RequestOptions): Promise; /** @deprecated Use `client.projects.getDefaults()`. */ getProjectDefaults(projectId: ProjectId, options?: RequestOptions): Promise; /** @deprecated Use `client.analytics.overview.get()`. */ getProjectOverview(projectId: ProjectId, options?: ProjectOverviewOptions, requestOptions?: RequestOptions): Promise; /** @deprecated Use `client.keywords.match()`. */ matchProjectKeywords(projectId: ProjectId, input: KeywordMatchRequest, requestOptions?: RequestOptions): Promise; /** * Update the project defaults. The schedule fields (`frequency`, `cron_expression`, * `jitter_minutes`, `timezone`) are replaced as a whole, while `serp_depth` (10, 20, 50, or * 100) and `serp_stop_on_match` each keep their stored value when omitted. * @deprecated Use `client.projects.updateDefaults()`. */ updateProjectDefaults(projectId: ProjectId, input: ReviewedProjectDefaultsPatch, options?: RequestOptions): Promise; /** @deprecated Use `client.projects.previewDefaults()` to read a signed draft. */ previewProjectDefaults(projectId: ProjectId, input: ProjectDefaultsPatch, options?: RequestOptions): Promise; /** @deprecated Use `client.apiKeys.list()`. */ listApiKeys(options?: PaginationOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.apiKeys.iterate()`. */ iterateApiKeys(options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.apiKeys.create()`. */ createApiKey(input: CreateApiKeyInput, options?: RequestOptions): Promise; /** @deprecated Use `client.apiKeys.revoke()`. */ revokeApiKey(keyId: ApiKeyId, options?: RequestOptions): Promise; /** @deprecated Use `client.apiKeys.list({ projectId })`. */ listProjectApiKeys(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.apiKeys.iterate({ projectId })`. */ iterateProjectApiKeys(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.apiKeys.create(input, { projectId })`. */ createProjectApiKey(projectId: ProjectId, input: CreateApiKeyInput, options?: RequestOptions): Promise; /** @deprecated Use `client.webhooks.list()`. */ listWebhooks(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.webhooks.iterate()`. */ iterateWebhooks(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.webhooks.create()`. */ createWebhook(projectId: ProjectId, input: CreateWebhookInput, options?: RequestOptions): Promise; /** @deprecated Use `client.webhooks.update()`. */ updateWebhook(projectId: ProjectId, webhookId: WebhookId, input: UpdateWebhookInput, options?: RequestOptions): Promise; /** @deprecated Use `client.webhooks.delete()`. */ deleteWebhook(projectId: ProjectId, webhookId: WebhookId, options?: RequestOptions): Promise; /** @deprecated Use `client.keywords.list()`. */ listKeywords(projectId: ProjectId, options?: ListKeywordsOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.keywords.iterate()`. */ iterateKeywords(projectId: ProjectId, options?: ListKeywordsOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.keywords.add()`. */ addKeywords(projectId: ProjectId, input: CreateKeywordsInput, options?: RequestOptions): Promise; /** @deprecated Use `client.keywords.get()`. */ getKeyword(keywordId: KeywordId, options?: RequestOptions): Promise; /** @deprecated Use `client.keywords.update()`. */ updateKeyword(keywordId: KeywordId, input: UpdateKeywordInput, options?: RequestOptions): Promise; /** @deprecated Use `client.keywords.setTargetUrl()`. */ setKeywordTargetUrl(keywordId: KeywordId, targetUrl: string | null, options?: RequestOptions): Promise; /** @deprecated Use `client.keywords.delete()`. */ deleteKeyword(keywordId: KeywordId, options?: RequestOptions): Promise; /** @deprecated Use `client.keywords.bulkUpdate()`. */ bulkUpdateKeywords(input: KeywordBulkInput, options?: RequestOptions): Promise; /** @deprecated Use `client.keywords.suggestions.list()`. */ listRankedKeywordSuggestions(projectId: ProjectId, options?: ListRankedKeywordSuggestionsOptions, requestOptions?: RequestOptions): Promise; /** * Research keywords from one seed. This operation requires API write scope because a cache * miss can spend the project's provider budget. Use `estimateOnly` for a free dry run, which * answers with a cost-only `KeywordResearchEstimate` instead of a `KeywordResearchResult`. * Narrow the union with `isKeywordResearchEstimate` when `estimateOnly` is not a literal. * @deprecated Use `client.keywords.research()`. */ researchKeywords(projectId: ProjectId, options: EstimateKeywordResearchOptions, requestOptions?: RequestOptions): Promise; researchKeywords(projectId: ProjectId, options: LoadKeywordResearchOptions, requestOptions?: RequestOptions): Promise; researchKeywords(projectId: ProjectId, options: ResearchKeywordsOptions, requestOptions?: RequestOptions): Promise; /** * Analyze backlinks. This operation requires API write scope because a cache miss can spend the * project's provider budget. Use `estimateOnly` (`estimate_only` on the wire) for a free dry * run, which answers with a cost-only `BacklinksEstimate` instead of a `BacklinksSnapshot`. * Narrow the union with `isBacklinksEstimate` when `estimateOnly` is not a literal. * @deprecated Use `client.backlinks.analyze()`. */ analyzeBacklinks(projectId: ProjectId, options: EstimateBacklinksOptions, requestOptions?: RequestOptions): Promise>; analyzeBacklinks(projectId: ProjectId, options: LoadBacklinksSnapshotOptions, requestOptions?: RequestOptions): Promise; analyzeBacklinks(projectId: ProjectId, options: AnalyzeBacklinksOptions, requestOptions?: RequestOptions): Promise; /** * Load more rows into an unexpired backlinks snapshot. This operation requires API write scope * and spends provider budget. Pass the latest response's snapshot_ref as snapshotRef; each * successful append returns a replacement. Missing or stale references return 409 snapshot_expired. * @deprecated Use `client.backlinks.extendSnapshot()`. */ loadMoreBacklinkRows(projectId: ProjectId, options: LoadMoreBacklinkRowsOptions, requestOptions?: RequestOptions): Promise; /** * Analyze a domain, return a free estimate, or load a cached report. A non-estimate request can * spend provider budget and therefore requires `maxCostCents`. * @deprecated Use `client.domainOverview.analyze()`. */ analyzeDomainOverview(projectId: ProjectId, options: EstimateDomainOverviewOptions, requestOptions?: RequestOptions): Promise>; analyzeDomainOverview(projectId: ProjectId, options: LoadDomainOverviewReportOptions, requestOptions?: RequestOptions): Promise>; /** * Load the historical index series for an unexpired Domain Overview snapshot. This operation * can spend provider budget and requires `maxCostCents`. * @deprecated Use `client.domainOverview.history()`. */ loadDomainOverviewHistory(projectId: ProjectId, options: LoadDomainOverviewHistoryOptions, requestOptions?: RequestOptions): Promise; /** * Load a page of ranked keywords for a domain. This operation can spend provider budget and * requires `maxCostCents`. * @deprecated Use `client.domainOverview.keywords()`. */ loadDomainOverviewKeywords(projectId: ProjectId, options: LoadDomainOverviewKeywordsOptions, requestOptions?: RequestOptions): Promise; /** * Load a page of relevant pages for a domain. This operation can spend provider budget and * requires `maxCostCents`. * @deprecated Use `client.domainOverview.pages()`. */ loadDomainOverviewPages(projectId: ProjectId, options: LoadDomainOverviewPagesOptions, requestOptions?: RequestOptions): Promise; /** * Hydrate keyword metrics. This operation requires API write scope because cache misses can * spend the project's provider budget. Use `estimate_only` for a free dry run. * @deprecated Use `client.keywords.metrics.get()`. */ getKeywordMetrics(projectId: ProjectId, input: GetKeywordMetricsInput, options?: RequestOptions): Promise; /** Opt in to the frozen report record and quality contract. */ exportRankHistory(projectId: ProjectId, options: ExportRankHistoryReportJsonOptions, requestOptions?: RequestOptions): Promise; /** @deprecated Use `client.rankChecks.history.export()`. */ exportRankHistory(projectId: ProjectId, options: ExportRankHistoryCsvOptions, requestOptions?: RequestOptions): Promise; /** @deprecated Use `client.rankChecks.history.export()`. */ exportRankHistory(projectId: ProjectId, options?: ExportRankHistoryJsonOptions, requestOptions?: RequestOptions): Promise; iterateRankHistoryExport(projectId: ProjectId, options: ExportRankHistoryReportJsonOptions, requestOptions?: RequestOptions): AsyncGenerator; iterateRankHistoryExport(projectId: ProjectId, options?: ExportRankHistoryJsonOptions, requestOptions?: RequestOptions): AsyncGenerator; /** Read every page while preserving the same frozen report metadata. * @deprecated Use `client.rankChecks.history.exportAll()`. */ exportAllRankHistoryReport(projectId: ProjectId, options: ExportRankHistoryReportJsonOptions, requestOptions?: RequestOptions): Promise; /** Iterate retained runs without starting checks. * @deprecated Use `client.rankChecks.runs.iterate()`. */ iterateRankCheckRuns(projectId: ProjectId, options?: ListRankCheckRunsOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.sitemapMonitors.list()`. */ listSitemapMonitors(projectId: ProjectId, options?: RequestOptions): Promise; /** * Update a project's sitemap monitor. A project has one monitor and its `monitorId` is the * project ID, so pass the same value for both arguments. * @deprecated Use `client.sitemapMonitors.update()`. */ updateSitemapMonitor(projectId: ProjectId, monitorId: ProjectId, input: UpdateSitemapMonitorInput, options?: RequestOptions): Promise; /** @deprecated Use `client.rankChecks.runs.list()`. */ listRankCheckRuns(projectId: ProjectId, options?: ListRankCheckRunsOptions, requestOptions?: RequestOptions): Promise; /** @deprecated Use `client.rankChecks.runs.get()`. */ getRankCheckRun(projectId: ProjectId, runId: RankCheckRunId, options?: RequestOptions): Promise; /** @deprecated Use `client.rankChecks.list()`. */ listRankChecks(keywordId: KeywordId, options?: ListRankChecksOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.rankChecks.iterate()`. */ iterateRankChecks(keywordId: KeywordId, options?: ListRankChecksOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.rankChecks.run()`. */ runRankCheck(keywordId: KeywordId, input?: RunRankCheckInput, options?: RunRankCheckOptions): Promise; /** @deprecated Use `client.rankChecks.runAndWait()`. */ runRankCheckAndWait(keywordId: KeywordId, input?: RunRankCheckInput, options?: RunRankCheckAndWaitOptions): Promise; /** @deprecated Use `client.rankChecks.getResult()`. */ getRankCheckResult(checkId: RankCheckId, options?: RequestOptions): Promise; /** @deprecated Use `client.signals.create()`. */ createSignal(input: CreateSignalInput, options?: RequestOptions): Promise; /** @deprecated Use `client.signals.list()`. */ listSignals(projectId: ProjectId, options?: ListSignalsOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.signals.iterate()`. */ iterateSignals(projectId: ProjectId, options?: ListSignalsOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.analytics.traffic.list()`. */ listTrafficSnapshots(projectId: ProjectId, options: ListTrafficSnapshotsOptions, requestOptions?: RequestOptions): Promise; /** @deprecated Use `client.analytics.searchPerformance.list()`. */ listSearchPerformanceQueryStats(projectId: ProjectId, options: ListSearchPerformanceQueryStatsOptions, requestOptions?: RequestOptions): Promise; /** @deprecated Use `client.analytics.traffic.sync()`. */ syncProjectTraffic(projectId: ProjectId, options?: RequestOptions): Promise; /** @deprecated Use `client.alertRules.list()`. */ listAlertRules(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.alertRules.iterate()`. */ iterateAlertRules(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.alertRules.create()`. */ createAlertRule(projectId: ProjectId, input: CreateAlertRuleInput, options?: RequestOptions): Promise; /** @deprecated Use `client.alertRules.update()`. */ updateAlertRule(ruleId: AlertRuleId, input: UpdateAlertRuleInput, options?: RequestOptions): Promise; /** @deprecated Use `client.alertRules.delete()`. */ deleteAlertRule(ruleId: AlertRuleId, options?: RequestOptions): Promise; /** @deprecated Use `client.alerts.list()`. */ listTriggeredAlerts(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.alerts.iterate()`. */ iterateTriggeredAlerts(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.alerts.mute()`. */ muteTriggeredAlert(projectId: ProjectId, alertId: AlertId, options?: RequestOptions): Promise; /** @deprecated Use `client.alerts.markAllRead({ projectId })`. */ markProjectAlertsRead(projectId: ProjectId, options?: RequestOptions): Promise; /** @deprecated Use `client.team.members.list()`. */ listTeamMembers(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.team.members.iterate()`. */ iterateTeamMembers(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.team.invites.list()`. */ listTeamInvites(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.team.invites.iterate()`. */ iterateTeamInvites(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.team.invites.create()`. */ createTeamInvite(projectId: ProjectId, input: CreateTeamInviteInput, options?: RequestOptions): Promise; /** @deprecated Use `client.team.invites.revoke({ id, projectId })`. */ revokeTeamInvite(projectId: ProjectId, inviteId: InviteId, options?: RequestOptions): Promise; /** @deprecated Use `client.team.invites.revoke(id)`. */ revokeTeamInviteById(inviteId: InviteId, options?: RequestOptions): Promise; /** @deprecated Use `client.team.invites.resend()`. */ resendTeamInvite(projectId: ProjectId, inviteId: InviteId, options?: RequestOptions): Promise; /** @deprecated Use `client.team.members.updateRole()`. */ updateTeamMemberRole(projectId: ProjectId, memberId: MembershipId, input: UpdateTeamMemberRoleInput, options?: RequestOptions): Promise; /** @deprecated Use `client.team.members.remove()`. */ removeTeamMember(projectId: ProjectId, memberId: MembershipId, options?: RequestOptions): Promise; /** Free provider model and locale capabilities. */ getAiResearchCatalog(projectId: ProjectId, options?: RequestOptions): Promise>; /** @deprecated Use `client.projectContext.get()`. */ getProjectContext(projectId: ProjectId, options?: RequestOptions): Promise>; /** Replace all five project guidance fields. * @deprecated Use `client.projectContext.update()`. */ updateProjectContext(projectId: ProjectId, input: ProjectContextInput, options?: RequestOptions): Promise>; /** @deprecated Use `client.agentReports.list()`. */ listAgentReports(projectId: ProjectId, query?: ListAgentReportsOptions, options?: RequestOptions): Promise>; /** @deprecated Use `client.agentReports.create()`. */ createAgentReport(projectId: ProjectId, input: CreateAgentReportInput, options?: RequestOptions): Promise>; /** @deprecated Use `client.agentReports.get()`. */ getAgentReport(projectId: ProjectId, reportId: AgentReportId, options?: RequestOptions): Promise>; /** Paid requests require an explicit maximum cost; estimates do not start provider work. * @deprecated Use `client.brandVisibility.analyze()`. */ analyzeBrandVisibility(projectId: ProjectId, input: AnalyzeBrandVisibilityInput, options?: RequestOptions): Promise>; /** Synthetic prompt comparisons retain their evidence label in the result. * @deprecated Use `client.promptExplorer.compare()`. */ compareAiPrompts(projectId: ProjectId, input: CompareAiPromptsInput, options?: RequestOptions): Promise>; /** @deprecated Use `client.siteAudits.list()`. */ listSiteAudits(projectId: ProjectId, options?: RequestOptions): Promise>; /** @deprecated Use `client.siteAudits.run()`. */ runSiteAudit(projectId: ProjectId, input?: RunSiteAuditInput, options?: RequestOptions): Promise>; /** @deprecated Use `client.siteAudits.get()`. */ getSiteAudit(projectId: ProjectId, reportId: AgentReportId, options?: RequestOptions): Promise>; /** Read saved report summaries without starting provider work. * @deprecated Use `client.researchReports.list()`. */ listStoredResearchReports(projectId: ProjectId, options?: RequestOptions): Promise; /** Read a saved report. fresh_until, rather than saved_at, determines freshness. * @deprecated Use `client.researchReports.get()`. */ getStoredResearchReport(projectId: ProjectId, kind: K, query?: StoredResearchReportOptions, options?: RequestOptions): Promise<{ data: StoredResearchReportByKind[K]; }>; /** Own-key and credit budgets are independent, and the response preserves both. * @deprecated Use `client.providers.budgets.list()`. */ listProviderBudgets(projectId: ProjectId, options?: RequestOptions): Promise>; /** Omitted fields keep their budget; explicit null clears it. * @deprecated Use `client.providers.budgets.update()`. */ updateProviderBudgets(projectId: ProjectId, providerId: string, input: ProviderBudgetsUpdate, options?: RequestOptions): Promise; /** @deprecated Use `client.providers.list()`. */ listProviders(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.providers.iterate()`. */ iterateProviders(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** * Connect a provider. `priority` is an optional integer from 0 to 1000 that the server applies * while saving the connection: `0` promotes the provider and renumbers the fallback chain, and * an omitted priority keeps a reconnected provider's place while a new connection is appended * to the chain. The deprecated `primary: true` input is sent as `priority: 0`. * A new SERP connection starts disabled unless no other SERP connection is enabled. * * Credentials are provider-specific. For Plausible, `credentials.login` is the site domain * configured in Plausible (its site_id, such as `example.com`) and defaults to the project * domain when omitted, while `credentials.api_key` is the Stats API token. * @deprecated Use `client.providers.connect()`. */ connectProvider(projectId: ProjectId, providerId: string, input?: ConnectProviderInput, options?: RequestOptions): Promise; /** * Test provider credentials without saving a connection. A successful result carries * `message: "Connected."`, or `"Connected ยท ."` for analytics providers that * report a detail such as the resolved site. * @deprecated Use `client.providers.test()`. */ testProviderConnection(projectId: ProjectId, providerId: string, input?: TestProviderConnectionInput, options?: RequestOptions): Promise; /** @deprecated Use `client.providers.updateSettings()`. */ updateProviderSettings(projectId: ProjectId, providerId: string, input: ProviderSettingsInput, options?: RequestOptions): Promise; /** @deprecated Use `client.providers.setEnabled()`. */ setProviderEnabled(projectId: ProjectId, providerId: string, enabled: boolean, options?: RequestOptions): Promise; /** @deprecated Use `client.providers.setEnabled(projectId, providerId, true)`. */ enableProvider(projectId: ProjectId, providerId: string, options?: RequestOptions): Promise; /** @deprecated Use `client.providers.setEnabled(projectId, providerId, false)`. */ disableProvider(projectId: ProjectId, providerId: string, options?: RequestOptions): Promise; /** @deprecated Use `client.providers.setPriority()`. */ setProviderPriority(projectId: ProjectId, providerId: string, priority: number, options?: RequestOptions): Promise; /** @deprecated Use `client.providers.setPrimary()`. */ setPrimaryProvider(projectId: ProjectId, providerId: string, primary?: boolean, options?: RequestOptions): Promise; /** @deprecated Use `client.providers.disconnect()`. */ disconnectProvider(projectId: ProjectId, providerId: string, options?: RequestOptions): Promise; /** @deprecated Use `client.savedViews.list()`. */ listSavedViews(projectId: ProjectId, options?: ListSavedViewsOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.savedViews.iterate()`. */ iterateSavedViews(projectId: ProjectId, options?: ListSavedViewsOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.savedViews.create()`. */ createSavedView(projectId: ProjectId, input: CreateSavedViewInput, options?: RequestOptions): Promise; /** @deprecated Use `client.savedViews.delete({ id, projectId })`. */ deleteSavedView(projectId: ProjectId, viewId: SavedViewId, options?: RequestOptions): Promise; /** @deprecated Use `client.savedViews.delete(id)`. */ deleteSavedViewById(viewId: SavedViewId, options?: RequestOptions): Promise; /** @deprecated Use `client.keywords.saved.list()` instead. */ listSavedKeywords(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): Promise>; /** @deprecated Use `client.keywords.saved.iterate()` instead. */ iterateSavedKeywords(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** * Saves keywords for later without putting them under rank tracking. * Keywords already tracked or already saved come back as `skipped`. * @deprecated Use `client.keywords.saved.create()` instead. */ createSavedKeywords(projectId: ProjectId, input: CreateSavedKeywordsInput, options?: RequestOptions): Promise; /** @deprecated Use `client.keywords.saved.delete()` instead. */ deleteSavedKeyword(projectId: ProjectId, savedKeywordId: SavedKeywordId, options?: RequestOptions): Promise; /** @deprecated Use `client.competitors.list()`. */ listCompetitors(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): Promise; /** @deprecated Use `client.competitors.iterate()`. */ iterateCompetitors(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.competitors.add()`. */ addCompetitor(projectId: ProjectId, input: AddCompetitorInput, options?: RequestOptions): Promise; /** @deprecated Use `client.competitors.remove({ id, projectId })`. */ removeCompetitor(projectId: ProjectId, competitorId: CompetitorId, options?: RequestOptions): Promise; /** @deprecated Use `client.competitors.remove(id)`. */ removeCompetitorById(competitorId: CompetitorId, options?: RequestOptions): Promise; /** @deprecated Use `client.notificationSettings.get()`. */ getNotificationPreferences(projectId: ProjectId, options?: RequestOptions): Promise; /** @deprecated Use `client.notificationSettings.update()`. */ updateNotificationPreferences(projectId: ProjectId, input: UpdateNotificationPreferencesInput, options?: RequestOptions): Promise; /** @deprecated Use `client.imports.tokens.list()`. */ listMigrationTokens(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): Promise; /** @deprecated Use `client.imports.tokens.iterate()`. */ iterateMigrationTokens(projectId: ProjectId, options?: PaginationOptions, requestOptions?: RequestOptions): AsyncGenerator; /** @deprecated Use `client.imports.tokens.create()`. */ mintMigrationToken(projectId: ProjectId, input?: MintMigrationTokenInput, options?: RequestOptions): Promise; /** @deprecated Use `client.imports.tokens.revoke({ id, projectId })`. */ revokeMigrationToken(projectId: ProjectId, tokenId: MigrationTokenId, options?: RequestOptions): Promise; /** @deprecated Use `client.imports.tokens.revoke(id)`. */ revokeMigrationTokenById(tokenId: MigrationTokenId, options?: RequestOptions): Promise; /** @deprecated Use `client.imports.compatibility.get()`. */ getCloudImportCompatibility(options?: RequestOptions): Promise; /** @deprecated Use `client.imports.runFromExport()`. */ importCloudExport(input: CloudImportPackage, options?: RequestOptions): Promise; /** @deprecated Use `client.imports.sessions.create()`. */ createCloudImportSession(input: CloudImportSessionCreate, options?: RequestOptions): Promise; /** @deprecated Use `client.imports.sessions.uploadChunk()`. */ uploadCloudImportChunk(sessionId: CloudImportJobId, index: number, input: CloudImportUploadChunk, options?: UploadCloudImportChunkOptions): Promise; /** @deprecated Use `client.imports.sessions.finalize()`. */ finalizeCloudImportSession(sessionId: CloudImportJobId, options?: RequestOptions): Promise; /** @deprecated Use `client.account.analyticsConsent.get()`. */ getAnalyticsConsent(options?: RequestOptions): Promise; /** @deprecated Use `client.account.analyticsConsent.update()`. */ updateAnalyticsConsent(input: UpdateAnalyticsConsentInput, options?: RequestOptions): Promise; private buildUrl; private assertApiVersionCompatible; private ensureApiVersionPreflight; private request; private requestOrUndefined; private jsonFromResponse; private errorFromResponse; } export declare function createBisibilityClient(config?: BisibilityClientConfig): BisibilityClient; //# sourceMappingURL=client.d.ts.map