@bisibility/sdk 0.6.1 → 0.7.2

package/dist/client.js

@@ -1,7 +1,9 @@
-import { BisibilityApiError, BisibilityConfigurationError, BisibilityNetworkError, BisibilityResponseError, } from "./errors.js";
+import { BISIBILITY_API_VERSION, BISIBILITY_API_VERSION_HEADER, UNSUPPORTED_API_VERSION_PROBLEM_TYPE, } from "./api-version.js";
+import { BisibilityApiError, BisibilityApiVersionError, BisibilityConfigurationError, BisibilityNetworkError, BisibilityResponseError, isUnsupportedApiVersionProblem, } from "./errors.js";
 import { iterateCursorPagination } from "./pagination.js";
 import { validatePublicIdRequest, validatePublicIdResponse } from "./public-id-contract.js";
 import { isPublicIdOfType } from "./public-id.js";
+import { installResourceNamespaces } from "./resources.js";
 import { SDK_VERSION } from "./version.js";
 const DEFAULT_BASE_URL = "https://bisibility.com/api/v1";
 const DEFAULT_MAX_RETRIES = 2;
@@ -41,6 +43,24 @@ function stringOrUndefined(value) {
 function numberOrUndefined(value) {
     return typeof value === "number" ? value : undefined;
 }
+function apiVersionErrorDetails(problem) {
+    if (!problem?.errors || typeof problem.errors !== "object") {
+        return {
+            declaredApiVersion: BISIBILITY_API_VERSION,
+            serverApiVersions: [],
+        };
+    }
+    const errors = problem.errors;
+    const serverApiVersions = Array.isArray(errors.apiVersions)
+        ? errors.apiVersions.filter((version) => typeof version === "string")
+        : [];
+    return {
+        declaredApiVersion: typeof errors.declaredApiVersion === "string"
+            ? errors.declaredApiVersion
+            : BISIBILITY_API_VERSION,
+        serverApiVersions,
+    };
+}
 function problemFromJson(value) {
     if (!value || typeof value !== "object") {
         return undefined;
@@ -163,7 +183,8 @@ function validateCredential(value) {
     }
 }
 export class BisibilityClient {
-    #apiKey;
+    #apiVersionPreflight;
+    #authorizationToken;
     #defaultHeaders;
     #fetchImpl;
     #maxRetries;
@@ -174,27 +195,55 @@ export class BisibilityClient {
         if (config.projectId !== undefined && !isPublicIdOfType(config.projectId, "prj")) {
             throw new BisibilityConfigurationError("projectId must match prj_[a-z][a-z0-9]{23}.");
         }
+        if (config.apiKey !== undefined && config.accessToken !== undefined) {
+            throw new BisibilityConfigurationError("apiKey and accessToken are mutually exclusive. Pass only one credential.");
+        }
         validateCredential(config.apiKey);
-        this.#apiKey = config.apiKey;
+        this.#authorizationToken = config.accessToken ?? config.apiKey;
         this.baseUrl = normalizeBaseUrl(config.baseUrl);
         this.#defaultHeaders = config.headers;
         this.#fetchImpl = config.fetch;
         this.#maxRetries = validatedMaxRetries(config.maxRetries);
         this.#projectId = config.projectId;
         this.#timeout = validatedTimeout(config.timeout);
+        installResourceNamespaces(this);
     }
+    /** @deprecated Use `client.system.getHealth()`. */
     getHealth(options) {
-        return this.request("GET", "/health", { ...options, auth: false });
+        return this.request("GET", "/health", {
+            ...options,
+            acceptedStatuses: [503],
+            auth: false,
+        });
+    }
+    /** @deprecated Use `client.system.getLiveness()`. */
+    getLiveness(options) {
+        return this.request("GET", "/liveness", { ...options, auth: false });
+    }
+    /** @deprecated Use `client.system.getReadiness()`. */
+    getReadiness(options) {
+        return this.request("GET", "/readiness", {
+            ...options,
+            acceptedStatuses: [503],
+            auth: false,
+        });
     }
+    /** @deprecated Use `client.system.getOpenApi()`. */
     getOpenApi(options) {
         return this.request("GET", "/openapi.json", { ...options, auth: false });
     }
-    getCapabilities(options) {
-        return this.request("GET", "/capabilities", {
+    /** @deprecated Use `client.system.getCapabilities()`. */
+    async getCapabilities(options) {
+        const response = await this.request("GET", "/capabilities", {
             ...options,
             auth: false,
+            skipApiVersionPreflight: true,
         });
+        this.assertApiVersionCompatible(response);
+        this.#apiVersionPreflight ??= Promise.resolve();
+        return response;
     }
+    /** @deprecated Use `client.system.getLlmsText()`. */
     getLlmsText(options) {
         return this.request("GET", "/llms.txt", {
             ...options,
@@ -202,12 +251,14 @@ export class BisibilityClient {
             parseAs: "text",
         });
     }
+    /** @deprecated Use `client.pricing.getRates()`. */
     getProviderRates(options) {
         return this.request("GET", "/provider-rates", {
             ...options,
             auth: false,
         });
     }
+    /** @deprecated Use `client.pricing.estimate()`. */
     getCostEstimate(input, options) {
         return this.request("GET", "/cost-estimate", {
             ...options,
@@ -223,6 +274,7 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.locations.search()`. */
     searchLocations(input, options) {
         return this.request("GET", "/locations/search", {
             ...options,
@@ -233,48 +285,60 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.account.get()`. */
     getMe(options) {
         return this.request("GET", "/me", options);
     }
+    /** @deprecated Use `client.account.update()`. */
     updateMe(input, options) {
         return this.request("PATCH", "/me", { ...options, body: input });
     }
+    /** @deprecated Use `client.account.tokens.list()`. */
     listMyTokens(options) {
         return this.request("GET", "/me/tokens", options);
     }
+    /** @deprecated Use `client.account.tokens.create()`. */
     createMyToken(input, options) {
         return this.request("POST", "/me/tokens", {
             ...options,
             body: input,
         });
     }
+    /** @deprecated Use `client.account.tokens.revoke()`. */
     revokeMyToken(tokenId, options) {
         return this.request("DELETE", `/me/tokens/${encodedPathSegment(tokenId)}`, options);
     }
+    /** @deprecated Use `client.projects.list()`. */
     listProjects(options) {
         return this.request("GET", "/projects", options);
     }
+    /** @deprecated Use `client.projects.create()`. */
     createProject(input, options) {
         return this.request("POST", "/projects", {
             ...options,
             body: input,
         });
     }
+    /** @deprecated Use `client.projects.get()`. */
     getProject(projectId, options) {
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}`, options);
     }
+    /** @deprecated Use `client.projects.update()`. */
     updateProject(projectId, input, options) {
         return this.request("PATCH", `/projects/${encodedPathSegment(projectId)}`, {
             ...options,
             body: input,
         });
     }
+    /** @deprecated Use `client.projects.delete()`. */
     deleteProject(projectId, options) {
         return this.request("DELETE", `/projects/${encodedPathSegment(projectId)}`, options);
     }
+    /** @deprecated Use `client.projects.getDefaults()`. */
     getProjectDefaults(projectId, options) {
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/defaults`, options);
     }
+    /** @deprecated Use `client.analytics.overview.get()`. */
     getProjectOverview(projectId, options, requestOptions) {
         const filters = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/overview`, {
@@ -286,12 +350,15 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.keywords.match()`. */
     matchProjectKeywords(projectId, input, requestOptions) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/keyword-matches`, { ...requestOptions, body: input });
     }
+    /** @deprecated Use `client.projects.updateDefaults()`. */
     updateProjectDefaults(projectId, input, options) {
         return this.request("PATCH", `/projects/${encodedPathSegment(projectId)}/defaults`, { ...options, body: input });
     }
+    /** @deprecated Use `client.apiKeys.list()`. */
     listApiKeys(options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", "/api-keys", {
@@ -302,15 +369,19 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.apiKeys.iterate()`. */
     iterateApiKeys(options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listApiKeys(pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.apiKeys.create()`. */
     createApiKey(input, options) {
         return this.request("POST", "/api-keys", { ...options, body: input });
     }
+    /** @deprecated Use `client.apiKeys.revoke()`. */
     revokeApiKey(keyId, options) {
         return this.request("DELETE", `/api-keys/${encodedPathSegment(keyId)}`, options);
     }
+    /** @deprecated Use `client.apiKeys.list({ projectId })`. */
     listProjectApiKeys(projectId, options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/api-keys`, {
@@ -321,12 +392,15 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.apiKeys.iterate({ projectId })`. */
     iterateProjectApiKeys(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listProjectApiKeys(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.apiKeys.create(input, { projectId })`. */
     createProjectApiKey(projectId, input, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/api-keys`, { ...options, body: input });
     }
+    /** @deprecated Use `client.webhooks.list()`. */
     listWebhooks(projectId, options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/webhooks`, {
@@ -337,21 +411,26 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.webhooks.iterate()`. */
     iterateWebhooks(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listWebhooks(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.webhooks.create()`. */
     createWebhook(projectId, input, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/webhooks`, {
             ...options,
             body: input,
         });
     }
+    /** @deprecated Use `client.webhooks.update()`. */
     updateWebhook(projectId, webhookId, input, options) {
         return this.request("PATCH", `/projects/${encodedPathSegment(projectId)}/webhooks/${encodedPathSegment(webhookId)}`, { ...options, body: input });
     }
+    /** @deprecated Use `client.webhooks.delete()`. */
     deleteWebhook(projectId, webhookId, options) {
         return this.request("DELETE", `/projects/${encodedPathSegment(projectId)}/webhooks/${encodedPathSegment(webhookId)}`, options);
     }
+    /** @deprecated Use `client.keywords.list()`. */
     listKeywords(projectId, options, requestOptions) {
         const filters = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/keywords`, {
@@ -371,30 +450,38 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.keywords.iterate()`. */
     iterateKeywords(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listKeywords(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.keywords.add()`. */
     addKeywords(projectId, input, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/keywords`, { ...options, body: input });
     }
+    /** @deprecated Use `client.keywords.get()`. */
     getKeyword(keywordId, options) {
         return this.request("GET", `/keywords/${encodedPathSegment(keywordId)}`, options);
     }
+    /** @deprecated Use `client.keywords.update()`. */
     updateKeyword(keywordId, input, options) {
         return this.request("PATCH", `/keywords/${encodedPathSegment(keywordId)}`, {
             ...options,
             body: input,
         });
     }
+    /** @deprecated Use `client.keywords.setTargetUrl()`. */
     setKeywordTargetUrl(keywordId, targetUrl, options) {
         return this.updateKeyword(keywordId, { target_url: targetUrl }, options);
     }
+    /** @deprecated Use `client.keywords.delete()`. */
     deleteKeyword(keywordId, options) {
         return this.requestOrUndefined("DELETE", `/keywords/${encodedPathSegment(keywordId)}`, options);
     }
+    /** @deprecated Use `client.keywords.bulkUpdate()`. */
     bulkUpdateKeywords(input, options) {
         return this.request("POST", "/keywords/bulk", { ...options, body: input });
     }
+    /** @deprecated Use `client.keywords.suggestions.list()`. */
     listRankedKeywordSuggestions(projectId, options, requestOptions) {
         const filters = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/ranked-keyword-suggestions`, {
@@ -410,6 +497,7 @@ export class BisibilityClient {
     /**
      * 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.
+     * @deprecated Use `client.keywords.research()`.
      */
     researchKeywords(projectId, options, requestOptions) {
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/keyword-research`, {
@@ -430,6 +518,7 @@ export class BisibilityClient {
      * 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.
+     * @deprecated Use `client.backlinks.analyze()`.
      */
     analyzeBacklinks(projectId, options, requestOptions) {
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/backlinks`, {
@@ -449,6 +538,7 @@ export class BisibilityClient {
     /**
      * Load more rows into an unexpired backlinks snapshot. This operation requires API write scope
      * and spends provider budget.
+     * @deprecated Use `client.backlinks.extendSnapshot()`.
      */
     loadMoreBacklinkRows(projectId, options, requestOptions) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/backlinks/rows`, {
@@ -464,10 +554,12 @@ export class BisibilityClient {
     /**
      * 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, input, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/keyword-metrics`, { ...options, body: input });
     }
+    /** @deprecated Use `client.rankChecks.history.export()`. */
     exportRankHistory(projectId, options = {}, requestOptions) {
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/exports/rank-history`, {
             ...requestOptions,
@@ -482,15 +574,19 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.rankChecks.history.iterate()`. */
     iterateRankHistoryExport(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.exportRankHistory(projectId, { ...options, ...pageOptions, format: "json" }, requestOptions), options);
     }
+    /** @deprecated Use `client.sitemapMonitors.list()`. */
     listSitemapMonitors(projectId, options) {
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/sitemap-monitors`, options);
     }
+    /** @deprecated Use `client.sitemapMonitors.update()`. */
     updateSitemapMonitor(projectId, monitorId, input, options) {
         return this.request("PATCH", `/projects/${encodedPathSegment(projectId)}/sitemap-monitors/${encodedPathSegment(monitorId)}`, { ...options, body: input });
     }
+    /** @deprecated Use `client.rankChecks.list()`. */
     listRankChecks(keywordId, options, requestOptions) {
         const filters = options ?? {};
         return this.request("GET", `/keywords/${encodedPathSegment(keywordId)}/rank-checks`, {
@@ -504,9 +600,11 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.rankChecks.iterate()`. */
     iterateRankChecks(keywordId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listRankChecks(keywordId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.rankChecks.run()`. */
     runRankCheck(keywordId, input, options) {
         const { async: runAsync, ...requestOptions } = options ?? {};
         const body = input && Object.keys(input).length ? input : undefined;
@@ -516,12 +614,15 @@ export class BisibilityClient {
             ...(runAsync ? { query: { async: "true" } } : {}),
         });
     }
+    /** @deprecated Use `client.rankChecks.getResult()`. */
     getRankCheckResult(checkId, options) {
         return this.request("GET", `/rank-checks/${encodedPathSegment(checkId)}`, options);
     }
+    /** @deprecated Use `client.signals.create()`. */
     createSignal(input, options) {
         return this.request("POST", "/signals", { ...options, body: input });
     }
+    /** @deprecated Use `client.signals.list()`. */
     listSignals(projectId, options, requestOptions) {
         const filters = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/signals`, {
@@ -536,9 +637,11 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.signals.iterate()`. */
     iterateSignals(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listSignals(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.analytics.traffic.list()`. */
     listTrafficSnapshots(projectId, options, requestOptions) {
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/analytics/traffic-snapshots`, {
             ...requestOptions,
@@ -551,6 +654,7 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.analytics.searchPerformance.list()`. */
     listSearchPerformanceQueryStats(projectId, options, requestOptions) {
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/analytics/query-stats`, {
             ...requestOptions,
@@ -563,9 +667,11 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.analytics.traffic.sync()`. */
     syncProjectTraffic(projectId, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/analytics/sync`, options);
     }
+    /** @deprecated Use `client.alertRules.list()`. */
     listAlertRules(projectId, options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/alert-rules`, {
@@ -576,21 +682,26 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.alertRules.iterate()`. */
     iterateAlertRules(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listAlertRules(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.alertRules.create()`. */
     createAlertRule(projectId, input, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/alert-rules`, { ...options, body: input });
     }
+    /** @deprecated Use `client.alertRules.update()`. */
     updateAlertRule(ruleId, input, options) {
         return this.request("PATCH", `/alert-rules/${encodedPathSegment(ruleId)}`, {
             ...options,
             body: input,
         });
     }
+    /** @deprecated Use `client.alertRules.delete()`. */
     deleteAlertRule(ruleId, options) {
         return this.request("DELETE", `/alert-rules/${encodedPathSegment(ruleId)}`, options);
     }
+    /** @deprecated Use `client.alerts.list()`. */
     listTriggeredAlerts(projectId, options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/triggered-alerts`, {
@@ -601,15 +712,19 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.alerts.iterate()`. */
     iterateTriggeredAlerts(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listTriggeredAlerts(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.alerts.mute()`. */
     muteTriggeredAlert(projectId, alertId, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/triggered-alerts/${encodedPathSegment(alertId)}/mute`, options);
     }
+    /** @deprecated Use `client.alerts.markAllRead({ projectId })`. */
     markProjectAlertsRead(projectId, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/triggered-alerts/mark-read`, options);
     }
+    /** @deprecated Use `client.team.members.list()`. */
     listTeamMembers(projectId, options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/team/members`, {
@@ -620,9 +735,11 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.team.members.iterate()`. */
     iterateTeamMembers(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listTeamMembers(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.team.invites.list()`. */
     listTeamInvites(projectId, options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/team/invites`, {
@@ -633,27 +750,35 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.team.invites.iterate()`. */
     iterateTeamInvites(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listTeamInvites(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.team.invites.create()`. */
     createTeamInvite(projectId, input, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/team/invites`, { ...options, body: input });
     }
+    /** @deprecated Use `client.team.invites.revoke({ id, projectId })`. */
     revokeTeamInvite(projectId, inviteId, options) {
         return this.request("DELETE", `/projects/${encodedPathSegment(projectId)}/team/invites/${encodedPathSegment(inviteId)}`, options);
     }
+    /** @deprecated Use `client.team.invites.revoke(id)`. */
     revokeTeamInviteById(inviteId, options) {
         return this.request("DELETE", `/team/invites/${encodedPathSegment(inviteId)}`, options);
     }
+    /** @deprecated Use `client.team.invites.resend()`. */
     resendTeamInvite(projectId, inviteId, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/team/invites/${encodedPathSegment(inviteId)}/resend`, options);
     }
+    /** @deprecated Use `client.team.members.updateRole()`. */
     updateTeamMemberRole(projectId, memberId, input, options) {
         return this.request("PATCH", `/projects/${encodedPathSegment(projectId)}/team/members/${encodedPathSegment(memberId)}`, { ...options, body: input });
     }
+    /** @deprecated Use `client.team.members.remove()`. */
     removeTeamMember(projectId, memberId, options) {
         return this.request("DELETE", `/projects/${encodedPathSegment(projectId)}/team/members/${encodedPathSegment(memberId)}`, options);
     }
+    /** @deprecated Use `client.providers.list()`. */
     listProviders(projectId, options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/providers`, {
@@ -664,36 +789,47 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.providers.iterate()`. */
     iterateProviders(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listProviders(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.providers.connect()`. */
     connectProvider(projectId, providerId, input = {}, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/providers/${encodedPathSegment(providerId)}/connect`, { ...options, body: bodyOrUndefined(input) });
     }
+    /** @deprecated Use `client.providers.test()`. */
     testProviderConnection(projectId, providerId, input = {}, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/providers/${encodedPathSegment(providerId)}/test`, { ...options, body: bodyOrUndefined(input) });
     }
+    /** @deprecated Use `client.providers.updateSettings()`. */
     updateProviderSettings(projectId, providerId, input, options) {
         return this.request("PATCH", `/projects/${encodedPathSegment(projectId)}/providers/${encodedPathSegment(providerId)}`, { ...options, body: input });
     }
+    /** @deprecated Use `client.providers.setEnabled()`. */
     setProviderEnabled(projectId, providerId, enabled, options) {
         return this.updateProviderSettings(projectId, providerId, { enabled }, options);
     }
+    /** @deprecated Use `client.providers.setEnabled(projectId, providerId, true)`. */
     enableProvider(projectId, providerId, options) {
         return this.setProviderEnabled(projectId, providerId, true, options);
     }
+    /** @deprecated Use `client.providers.setEnabled(projectId, providerId, false)`. */
     disableProvider(projectId, providerId, options) {
         return this.setProviderEnabled(projectId, providerId, false, options);
     }
+    /** @deprecated Use `client.providers.setPriority()`. */
     setProviderPriority(projectId, providerId, priority, options) {
         return this.updateProviderSettings(projectId, providerId, { priority }, options);
     }
+    /** @deprecated Use `client.providers.setPrimary()`. */
     setPrimaryProvider(projectId, providerId, primary = true, options) {
         return this.updateProviderSettings(projectId, providerId, { primary }, options);
     }
+    /** @deprecated Use `client.providers.disconnect()`. */
     disconnectProvider(projectId, providerId, options) {
         return this.request("DELETE", `/projects/${encodedPathSegment(projectId)}/providers/${encodedPathSegment(providerId)}`, options);
     }
+    /** @deprecated Use `client.savedViews.list()`. */
     listSavedViews(projectId, options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/saved-views`, {
@@ -705,18 +841,50 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.savedViews.iterate()`. */
     iterateSavedViews(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listSavedViews(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.savedViews.create()`. */
     createSavedView(projectId, input, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/saved-views`, { ...options, body: input });
     }
+    /** @deprecated Use `client.savedViews.delete({ id, projectId })`. */
     deleteSavedView(projectId, viewId, options) {
         return this.request("DELETE", `/projects/${encodedPathSegment(projectId)}/saved-views/${encodedPathSegment(viewId)}`, options);
     }
+    /** @deprecated Use `client.savedViews.delete(id)`. */
     deleteSavedViewById(viewId, options) {
         return this.request("DELETE", `/saved-views/${encodedPathSegment(viewId)}`, options);
     }
+    /** @deprecated Use `client.keywords.saved.list()` instead. */
+    listSavedKeywords(projectId, options, requestOptions) {
+        const pagination = options ?? {};
+        return this.request("GET", `/projects/${encodedPathSegment(projectId)}/saved-keywords`, {
+            ...requestOptions,
+            query: {
+                ...(pagination.cursor === undefined ? {} : { cursor: pagination.cursor }),
+                ...(pagination.limit === undefined ? {} : { limit: pagination.limit }),
+            },
+        });
+    }
+    /** @deprecated Use `client.keywords.saved.iterate()` instead. */
+    iterateSavedKeywords(projectId, options = {}, requestOptions) {
+        return iterateCursorPagination((pageOptions) => this.listSavedKeywords(projectId, pageOptions, requestOptions), options);
+    }
+    /**
+     * 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, input, options) {
+        return this.request("POST", `/projects/${encodedPathSegment(projectId)}/saved-keywords`, { ...options, body: input });
+    }
+    /** @deprecated Use `client.keywords.saved.delete()` instead. */
+    deleteSavedKeyword(projectId, savedKeywordId, options) {
+        return this.request("DELETE", `/projects/${encodedPathSegment(projectId)}/saved-keywords/${encodedPathSegment(savedKeywordId)}`, options);
+    }
+    /** @deprecated Use `client.competitors.list()`. */
     listCompetitors(projectId, options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/competitors`, {
@@ -727,24 +895,31 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.competitors.iterate()`. */
     iterateCompetitors(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listCompetitors(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.competitors.add()`. */
     addCompetitor(projectId, input, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/competitors`, { ...options, body: input });
     }
+    /** @deprecated Use `client.competitors.remove({ id, projectId })`. */
     removeCompetitor(projectId, competitorId, options) {
         return this.request("DELETE", `/projects/${encodedPathSegment(projectId)}/competitors/${encodedPathSegment(competitorId)}`, options);
     }
+    /** @deprecated Use `client.competitors.remove(id)`. */
     removeCompetitorById(competitorId, options) {
         return this.request("DELETE", `/competitors/${encodedPathSegment(competitorId)}`, options);
     }
+    /** @deprecated Use `client.notificationSettings.get()`. */
     getNotificationPreferences(projectId, options) {
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/notification-preferences`, options);
     }
+    /** @deprecated Use `client.notificationSettings.update()`. */
     updateNotificationPreferences(projectId, input, options) {
         return this.request("PATCH", `/projects/${encodedPathSegment(projectId)}/notification-preferences`, { ...options, body: input });
     }
+    /** @deprecated Use `client.imports.tokens.list()`. */
     listMigrationTokens(projectId, options, requestOptions) {
         const pagination = options ?? {};
         return this.request("GET", `/projects/${encodedPathSegment(projectId)}/migration-tokens`, {
@@ -755,36 +930,44 @@ export class BisibilityClient {
             },
         });
     }
+    /** @deprecated Use `client.imports.tokens.iterate()`. */
     iterateMigrationTokens(projectId, options = {}, requestOptions) {
         return iterateCursorPagination((pageOptions) => this.listMigrationTokens(projectId, pageOptions, requestOptions), options);
     }
+    /** @deprecated Use `client.imports.tokens.create()`. */
     mintMigrationToken(projectId, input = {}, options) {
         return this.request("POST", `/projects/${encodedPathSegment(projectId)}/migration-tokens`, { ...options, body: bodyOrUndefined(input) });
     }
+    /** @deprecated Use `client.imports.tokens.revoke({ id, projectId })`. */
     revokeMigrationToken(projectId, tokenId, options) {
         return this.request("DELETE", `/projects/${encodedPathSegment(projectId)}/migration-tokens/${encodedPathSegment(tokenId)}`, options);
     }
+    /** @deprecated Use `client.imports.tokens.revoke(id)`. */
     revokeMigrationTokenById(tokenId, options) {
         return this.request("DELETE", `/migration-tokens/${encodedPathSegment(tokenId)}`, options);
     }
+    /** @deprecated Use `client.imports.compatibility.get()`. */
     getCloudImportCompatibility(options) {
         return this.request("GET", "/cloud/import/compatibility", {
             ...options,
             auth: false,
         });
     }
+    /** @deprecated Use `client.imports.runFromExport()`. */
     importCloudExport(input, options) {
         return this.request("POST", "/cloud/import", {
             ...options,
             body: input,
         });
     }
+    /** @deprecated Use `client.imports.sessions.create()`. */
     createCloudImportSession(input, options) {
         return this.request("POST", "/cloud/import/sessions", {
             ...options,
             body: input,
         });
     }
+    /** @deprecated Use `client.imports.sessions.uploadChunk()`. */
     uploadCloudImportChunk(sessionId, index, input, options) {
         const { contentEncoding, headers, ...requestOptions } = options ?? {};
         const mergedHeaders = new Headers(headers);
@@ -793,6 +976,7 @@ export class BisibilityClient {
         }
         return this.request("PUT", `/cloud/import/sessions/${encodedPathSegment(sessionId)}/chunks/${encodedPathSegment(String(index))}`, { ...requestOptions, body: input, headers: mergedHeaders });
     }
+    /** @deprecated Use `client.imports.sessions.finalize()`. */
     finalizeCloudImportSession(sessionId, options) {
         return this.request("POST", `/cloud/import/sessions/${encodedPathSegment(sessionId)}/finalize`, options);
     }
@@ -815,6 +999,70 @@ export class BisibilityClient {
         }
         return absolute ? url.toString() : `${url.pathname}${url.search}`;
     }
+    assertApiVersionCompatible(response) {
+        const advertised = response.apiVersions;
+        if (advertised === undefined) {
+            return;
+        }
+        if (!Array.isArray(advertised) || advertised.some((version) => typeof version !== "string")) {
+            throw new BisibilityResponseError("Bisibility API returned invalid API version capabilities.", {
+                body: JSON.stringify(response),
+                cause: undefined,
+                method: "GET",
+                status: 200,
+                url: this.buildUrl("/capabilities"),
+            });
+        }
+        if (advertised.includes(BISIBILITY_API_VERSION)) {
+            return;
+        }
+        const detail = `The declared API version ${BISIBILITY_API_VERSION} is not served by this server.`;
+        const problem = {
+            detail,
+            errors: {
+                apiVersions: advertised,
+                declaredApiVersion: BISIBILITY_API_VERSION,
+            },
+            status: 409,
+            title: "Unsupported API version",
+            type: UNSUPPORTED_API_VERSION_PROBLEM_TYPE,
+        };
+        throw new BisibilityApiVersionError(detail, {
+            body: JSON.stringify(problem),
+            declaredApiVersion: BISIBILITY_API_VERSION,
+            headers: new Headers(),
+            method: "GET",
+            problem,
+            serverApiVersions: advertised,
+            status: 409,
+            url: this.buildUrl("/capabilities"),
+        });
+    }
+    ensureApiVersionPreflight(signal, timeout) {
+        if (this.#apiVersionPreflight === undefined) {
+            const options = {
+                auth: false,
+                skipApiVersionPreflight: true,
+            };
+            if (signal !== undefined) {
+                options.signal = signal;
+            }
+            if (timeout !== undefined) {
+                options.timeout = timeout;
+            }
+            const pending = this.request("GET", "/capabilities", options).then((response) => {
+                this.assertApiVersionCompatible(response);
+            });
+            const cached = pending.catch((error) => {
+                if (!(error instanceof BisibilityApiVersionError) && this.#apiVersionPreflight === cached) {
+                    this.#apiVersionPreflight = undefined;
+                }
+                throw error;
+            });
+            this.#apiVersionPreflight = cached;
+        }
+        return this.#apiVersionPreflight;
+    }
     async request(method, path, options = {}) {
         const statusRef = { status: 0 };
         const result = await this.requestOrUndefined(method, path, options, statusRef);
@@ -841,8 +1089,8 @@ export class BisibilityClient {
         if (!fetchImpl) {
             throw new BisibilityConfigurationError("No fetch implementation is available. Pass fetch in BisibilityClient config.");
         }
-        if (options.auth !== false && !this.#apiKey) {
-            throw new BisibilityConfigurationError("apiKey is required for this Bisibility API method.");
+        if (options.auth !== false && !this.#authorizationToken) {
+            throw new BisibilityConfigurationError("apiKey or accessToken is required for this Bisibility API method.");
         }
         const headers = mergeHeaders(this.#defaultHeaders, options.headers);
         if (this.#projectId !== undefined && !headers.has("X-Bisibility-Project")) {
@@ -852,13 +1100,17 @@ export class BisibilityClient {
         if (projectHeader !== null && !isPublicIdOfType(projectHeader, "prj")) {
             throw new BisibilityConfigurationError("X-Bisibility-Project must match prj_[a-z][a-z0-9]{23}.");
         }
+        if (!options.skipApiVersionPreflight) {
+            await this.ensureApiVersionPreflight(options.signal, options.timeout);
+        }
         if (options.auth !== false) {
-            headers.set("Authorization", `Bearer ${this.#apiKey}`);
+            headers.set("Authorization", `Bearer ${this.#authorizationToken}`);
         }
         if (options.idempotencyKey) {
             headers.set("Idempotency-Key", options.idempotencyKey);
         }
         headers.set("X-Bisibility-Client", CLIENT_ID);
+        headers.set(BISIBILITY_API_VERSION_HEADER, BISIBILITY_API_VERSION);
         if (!headers.has("User-Agent")) {
             try {
                 headers.set("User-Agent", CLIENT_ID);
@@ -903,7 +1155,7 @@ export class BisibilityClient {
                 await sleepForRetry(retryBackoffMs(attempt), options.signal, method, url);
                 continue;
             }
-            if (!response.ok) {
+            if (!response.ok && !options.acceptedStatuses?.includes(response.status)) {
                 const error = await this.errorFromResponse(response, method, url);
                 if (retryable &&
                     attempt < this.#maxRetries &&
@@ -971,6 +1223,19 @@ export class BisibilityClient {
         }
         const problem = problemFromJson(parsed);
         const message = problem?.detail || body || `Bisibility API request failed with status ${response.status}.`;
+        if (response.status === 409 && isUnsupportedApiVersionProblem(problem)) {
+            const details = apiVersionErrorDetails(problem);
+            return new BisibilityApiVersionError(message, {
+                body,
+                declaredApiVersion: details.declaredApiVersion,
+                headers,
+                method,
+                problem,
+                serverApiVersions: details.serverApiVersions,
+                status: response.status,
+                url,
+            });
+        }
         return new BisibilityApiError(message, {
             body,
             headers,