@bisibility/sdk 0.3.1 → 0.5.0

package/dist/types.d.ts

@@ -1,3 +1,27 @@
+import type { PublicIdForPrefix } from "./public-id.js";
+export type AlertId = PublicIdForPrefix<"alert">;
+export type ApiKeyId = PublicIdForPrefix<"key">;
+export type AuditId = PublicIdForPrefix<"audit">;
+export type CloudImportJobId = PublicIdForPrefix<"job">;
+export type CompetitorId = PublicIdForPrefix<"comp">;
+export type ConnectionId = PublicIdForPrefix<"conn">;
+export type IngestHookId = PublicIdForPrefix<"hook">;
+export type InviteId = PublicIdForPrefix<"invite">;
+export type KeywordId = PublicIdForPrefix<"kw">;
+export type MembershipId = PublicIdForPrefix<"member">;
+export type MigrationTokenId = PublicIdForPrefix<"mtok">;
+export type NotificationId = PublicIdForPrefix<"notif">;
+export type PersonalAccessTokenId = PublicIdForPrefix<"pat">;
+export type ProjectId = PublicIdForPrefix<"prj">;
+export type RankCheckId = PublicIdForPrefix<"check">;
+export type SavedKeywordId = PublicIdForPrefix<"skw">;
+export type SavedViewId = PublicIdForPrefix<"view">;
+export type SessionId = PublicIdForPrefix<"ses">;
+export type SignalId = PublicIdForPrefix<"sig">;
+export type TagId = PublicIdForPrefix<"tag">;
+export type UserId = PublicIdForPrefix<"usr">;
+export type WebhookId = PublicIdForPrefix<"webhook">;
+export type AlertRuleId = PublicIdForPrefix<"rule">;
 export type Device = "desktop" | "mobile";
 export type RankCheckFrequency = "paused" | "manual" | "daily" | "weekly" | "monthly" | "custom_cron";
 export type JsonObject = Record<string, unknown>;
@@ -31,7 +55,7 @@ export type ProjectWriteMode = "active" | "migration_hold" | "migrated";
 export interface Project {
     created_at: string;
     domain: string;
-    id: string;
+    id: ProjectId;
     name: string;
     updated_at: string;
     write_mode: ProjectWriteMode;
@@ -50,7 +74,7 @@ export interface ProjectDefaults {
     last_checked_at: string | null;
     location_key: string;
     next_check_at: string | null;
-    project_id: string;
+    project_id: ProjectId;
     serp_depth: number;
     serp_stop_on_match: boolean;
     source: "derived" | "explicit" | "fallback";
@@ -87,7 +111,7 @@ export interface ProjectOverview {
     last_check_at: string | null;
     next_check_at: string | null;
     position_distribution: ProjectOverviewPositionDistribution[];
-    project_id: string;
+    project_id: ProjectId;
     top_10_count: number | null;
     top_10_delta: number | null;
     top_100_count: number | null;
@@ -106,7 +130,7 @@ export interface KeywordMatchMarket {
     location_key: string;
 }
 export interface KeywordMatch {
-    keyword_id: string;
+    keyword_id: KeywordId;
     latest_position: number | null;
     market: KeywordMatchMarket;
     /** Trimmed, lowercase request text used to match this keyword. */
@@ -135,7 +159,6 @@ export interface LocationSuggestion {
     country_code: string;
     display_name: string;
     hl: string;
-    id: string;
     kind: LocationKind;
     language_label: string;
     location_key: string;
@@ -158,26 +181,36 @@ export interface CreateProjectInput {
 }
 export interface ApiKey {
     created_at: string;
-    id: string;
+    expires_at: string | null;
+    id: ApiKeyId;
     last_used_at: string | null;
     name: string;
     prefix: string;
     revoked_at: string | null;
+    scope: ApiKeyScope;
 }
 export interface CreatedApiKey extends ApiKey {
     masked_value: string;
     token: string;
 }
+export type ApiKeyScope = "admin" | "read" | "write";
+export interface CreateApiKeyInput {
+    /** Days until the key expires, or null for no expiry. */
+    expires_in_days?: 30 | 90 | 365 | null;
+    name: string;
+    /** Access tier. Defaults to admin for backward compatibility. */
+    scope?: ApiKeyScope;
+}
 export type MembershipRole = "admin" | "auditor" | "member" | "owner" | "viewer";
 export interface MeProject {
     domain: string;
-    id: string;
+    id: ProjectId;
     name: string;
     role: MembershipRole;
 }
 export interface Me {
     email: string;
-    id: string;
+    id: UserId;
     name: string;
     projects: MeProject[];
 }
@@ -188,7 +221,7 @@ export type PersonalAccessTokenScope = "admin" | "read" | "write";
 export interface PersonalAccessToken {
     created_at: string;
     expires_at: string | null;
-    id: string;
+    id: PersonalAccessTokenId;
     last_used_at: string | null;
     name: string;
     prefix: string;
@@ -210,7 +243,7 @@ export interface Webhook {
     created_at: string;
     description: string | null;
     enabled: boolean;
-    id: string;
+    id: WebhookId;
     last_delivery_at: string | null;
     updated_at: string;
     url: string;
@@ -241,12 +274,12 @@ export interface Keyword {
     country: string;
     created_at: string;
     device: Device;
-    id: string;
+    id: KeywordId;
     intent: string | null;
     latest_position: number | null;
     location: string;
     previous_position: number | null;
-    project_id: string;
+    project_id: ProjectId;
     ranking_url: string | null;
     schedule: KeywordSchedule | null;
     tags: string[];
@@ -306,24 +339,24 @@ export interface UpdateKeywordInput {
 }
 export type KeywordBulkOperation = "add_tags" | "delete" | "remove_tags" | "set_frequency" | "set_target_url";
 export type KeywordBulkInput = {
-    keyword_ids: readonly string[];
+    keyword_ids: readonly KeywordId[];
     operation: "add_tags" | "remove_tags";
     tags: readonly string[];
 } | {
-    keyword_ids: readonly string[];
+    keyword_ids: readonly KeywordId[];
     operation: "delete";
 } | {
-    keyword_ids: readonly string[];
+    keyword_ids: readonly KeywordId[];
     operation: "set_frequency";
     frequency?: RankCheckFrequency;
     schedule?: KeywordScheduleInput;
 } | {
-    keyword_ids: readonly string[];
+    keyword_ids: readonly KeywordId[];
     operation: "set_target_url";
     target_url?: string | null;
 };
 export interface KeywordBulkItemResult {
-    keyword_id: string;
+    keyword_id: KeywordId;
     status: OpenString<"deleted" | "not_found" | "updated">;
 }
 export interface KeywordBulkResponse {
@@ -349,7 +382,7 @@ export interface RankedKeywordSuggestion {
     search_volume: number | null;
 }
 export interface RankedKeywordConnection {
-    id: string;
+    id: ConnectionId;
     label: string;
     provider: "dataforseo";
 }
@@ -363,7 +396,7 @@ export interface RankedKeywordSuggestionsResponse {
     total_count: number | null;
 }
 export interface ListRankedKeywordSuggestionsOptions {
-    connectionId?: string;
+    connectionId?: ConnectionId;
     fresh?: boolean;
     limit?: number;
     offset?: number;
@@ -386,7 +419,7 @@ export interface KeywordMetricsRow extends KeywordMetrics {
     keyword: string;
 }
 export interface KeywordResearchConnection {
-    id: string;
+    id: ConnectionId;
     label: string;
     provider: string;
 }
@@ -493,7 +526,7 @@ export interface KeywordResearchResponse {
     total_count: number;
 }
 export interface ResearchKeywordsOptions {
-    connectionId?: string;
+    connectionId?: ConnectionId;
     estimateOnly?: boolean;
     fresh?: boolean;
     includeClickstream?: boolean;
@@ -503,7 +536,7 @@ export interface ResearchKeywordsOptions {
     seed: string;
 }
 export interface GetKeywordMetricsInput {
-    connection_id?: string;
+    connection_id?: ConnectionId;
     estimate_only?: boolean;
     fresh?: boolean;
     include_clickstream?: boolean;
@@ -528,9 +561,9 @@ export type RankHistoryExportRange = "30" | "90" | "all";
 export type RankHistoryExportGranularity = "daily" | "weekly";
 export interface RankHistoryExportRow {
     checked_at: string;
-    id: string;
+    id: RankCheckId;
     keyword: string;
-    keyword_id: string;
+    keyword_id: KeywordId;
     position: number | null;
     previous_position: number | null;
     ranking_url: string | null;
@@ -538,7 +571,7 @@ export interface RankHistoryExportRow {
 export type RankHistoryExportResponse = ListResponse<RankHistoryExportRow>;
 interface RankHistoryExportOptions {
     granularity?: RankHistoryExportGranularity;
-    keywordIds?: readonly string[];
+    keywordIds?: readonly KeywordId[];
     range?: RankHistoryExportRange;
 }
 export interface ExportRankHistoryJsonOptions extends PaginationOptions, RankHistoryExportOptions {
@@ -550,15 +583,14 @@ export interface ExportRankHistoryCsvOptions extends RankHistoryExportOptions {
 export type SitemapMonitorStatus = "active" | "disabled" | "pending";
 export interface SitemapMonitorSnapshot {
     fetched_at: string;
-    id: string;
     sitemap_url: string;
     url_count: number;
 }
 export interface SitemapMonitor {
     enabled: boolean;
-    id: string;
+    id: ProjectId;
     latest_snapshot: SitemapMonitorSnapshot | null;
-    project_id: string;
+    project_id: ProjectId;
     sitemap_url: string | null;
     status: SitemapMonitorStatus;
 }
@@ -576,8 +608,8 @@ export interface RankCheck {
     checked_at: string;
     cost_cents: number | null;
     error: string | null;
-    id: string;
-    keyword_id: string;
+    id: RankCheckId;
+    keyword_id: KeywordId;
     position: number | null;
     previous_position: number | null;
     provider: string;
@@ -595,19 +627,11 @@ export interface RunRankCheckInput {
 export interface RunRankCheckOptions extends RequestOptions {
     async?: boolean;
 }
-export type AlertConditionType = "change_pct" | "competitor_overtake" | "enters_top_n" | "exits_top_n" | "serp_feature" | "threshold";
+export type AlertConditionType = "change_pct" | "competitor_overtake" | "ctr_drop" | "downtrend" | "enters_top_n" | "exits_top_n" | "position_drop" | "serp_feature" | "threshold" | "url_mismatch";
 export type AlertChannel = "email" | "slack" | "webhook";
 export type AlertTargetType = "all" | "keyword" | "tag";
 export type AlertSeverity = "info" | "urgent" | "warning";
-export interface AlertRuleTarget {
-    created_at?: string;
-    id: string;
-    keyword_id?: string | null;
-    rule_id?: string;
-    tag_id?: string | null;
-    updated_at?: string;
-}
-export interface AlertRule {
+interface AlertRuleBase {
     change_pct?: number | string | null;
     channel?: string;
     channels: AlertChannel[];
@@ -615,37 +639,54 @@ export interface AlertRule {
     condition_type: AlertConditionType;
     competitor_domain?: string | null;
     created_at?: string;
-    created_by_id?: string | null;
     enabled: boolean;
     fires?: string;
-    id: string;
+    id: AlertRuleId;
     name: string;
     period?: string;
-    project_id?: string;
+    recipient_ids: UserId[];
     scope?: string;
     serp_feature?: string | null;
     severity?: AlertSeverity;
     status?: OpenString<"active" | "paused">;
-    target_ids?: string[];
-    target_type: AlertTargetType;
-    targets?: AlertRuleTarget[];
     threshold_position?: number | null;
     top_n?: number | null;
     updated_at?: string;
 }
-export interface AlertRuleInput {
+export type AlertRule = (AlertRuleBase & {
+    target_ids: KeywordId[];
+    target_type: "keyword";
+}) | (AlertRuleBase & {
+    target_ids: TagId[];
+    target_type: "tag";
+}) | (AlertRuleBase & {
+    target_ids: [];
+    target_type: "all";
+});
+interface AlertRuleInputBase {
     change_pct?: number | null;
     channels?: readonly AlertChannel[];
     condition_type: AlertConditionType;
     competitor_domain?: string | null;
+    drop_positions?: number | null;
     enabled?: boolean;
     name: string;
+    recipient_ids?: readonly UserId[];
     serp_feature?: string | null;
-    target_ids?: readonly string[];
-    target_type?: AlertTargetType;
+    severity?: AlertSeverity;
     threshold_position?: number | null;
     top_n?: number | null;
 }
+export type AlertRuleInput = (AlertRuleInputBase & {
+    target_ids?: readonly [];
+    target_type?: "all";
+}) | (AlertRuleInputBase & {
+    target_ids: readonly KeywordId[];
+    target_type: "keyword";
+}) | (AlertRuleInputBase & {
+    target_ids: readonly TagId[];
+    target_type: "tag";
+});
 export type CreateAlertRuleInput = AlertRuleInput;
 export type UpdateAlertRuleInput = AlertRuleInput;
 export interface DeleteAlertRuleResponse {
@@ -656,7 +697,7 @@ export interface TriggeredAlert {
     ctas: string[];
     current: string;
     headline: string;
-    id: string;
+    id: AlertId;
     keyword: string;
     previous: string;
     rule: string;
@@ -676,7 +717,7 @@ export type TeamRoleLabel = "Admin" | "Editor" | "Owner" | "Viewer";
 export interface TeamMember {
     color: OpenString<"accent" | "blue" | "purple">;
     email: string;
-    id: string;
+    id: MembershipId;
     initials: string;
     name: string;
     role: TeamRoleLabel;
@@ -685,7 +726,7 @@ export interface TeamMember {
 export interface TeamInvite {
     email: string;
     expires_label: string;
-    id: string;
+    id: InviteId;
     invited_label: string;
     role: TeamRoleLabel;
     role_value: Exclude<TeamRole, "owner">;
@@ -696,26 +737,26 @@ export interface CreateTeamInviteInput {
 }
 export interface CreatedTeamInvite {
     expires_at: string;
-    id: string;
+    id: InviteId;
     invite_link: string;
 }
 export interface RevokedTeamInvite {
-    id: string;
+    id: InviteId;
 }
 export type AssignableTeamRole = Exclude<TeamRole, "owner">;
 export interface UpdateTeamMemberRoleInput {
     role: AssignableTeamRole;
 }
 export interface TeamMemberRoleResult {
-    id: string;
+    id: MembershipId;
     role: AssignableTeamRole;
 }
 export interface TeamMemberMutationResult {
-    id: string;
+    id: MembershipId;
 }
 export interface TeamInviteResendResult {
     expires_at: string;
-    id: string;
+    id: InviteId;
     invite_link: string;
 }
 export type ProviderId = "dataforseo" | "ga4" | "gsc" | "plausible" | "serpapi";
@@ -799,12 +840,12 @@ export interface ProviderConnection {
     created_at: string;
     credentials_hash?: string | null;
     enabled: boolean;
-    id: string;
+    id: ConnectionId;
     is_primary: boolean;
     kind: ProviderKind;
     last_used_at: string | null;
     priority: number;
-    project_id: string;
+    project_id: ProjectId;
     provider: OpenString<ProviderId>;
     status: ProviderStatus;
     updated_at: string;
@@ -822,39 +863,69 @@ export type SavedViewFilterCountry = "all" | "de" | "gb" | "pl" | "us";
 export type SavedViewFilterDevice = "all" | Device;
 export type SavedViewPositionFilter = "11-50" | "51-100" | "top10" | "top3";
 export type SavedViewSerpFilter = "ai" | "featured" | "image" | "paa" | "sitelinks" | "video";
-export interface SavedViewFilters {
+export interface KeywordSavedViewFilters {
     change: SavedViewFilterChange;
     contains: string;
-    country: SavedViewFilterCountry;
-    device: SavedViewFilterDevice;
+    intents: string[];
+    last_check: "any" | RankCheckStatus;
     position: SavedViewPositionFilter[];
     serp: SavedViewSerpFilter[];
     tags: string[];
+    topics: string[];
+    url_changed: boolean;
     vol_max: number;
     vol_min: number;
     wrong_url: boolean;
 }
-export interface SavedViewConfig {
-    filters: SavedViewFilters;
+export type SavedViewFilters = KeywordSavedViewFilters;
+export interface KeywordSavedViewConfig {
+    filters: KeywordSavedViewFilters;
+    lens: {
+        device: SavedViewFilterDevice;
+        location_id: string | null;
+    };
     search: string;
+    surface: "keywords";
+    version: 1;
+}
+export interface CompetitorSavedViewConfig {
+    filters: {
+        excluded_keyword_ids: KeywordId[];
+        position: "all" | "top10" | "top3";
+        tag: string | null;
+    };
+    scope: {
+        device: Device;
+        engine: "google";
+        location_id: string;
+    };
+    surface: "competitors";
+    version: 1;
 }
+export type SavedViewConfig = CompetitorSavedViewConfig | KeywordSavedViewConfig;
 export interface CreateSavedViewInput {
     config: SavedViewConfig;
     name: string;
+    surface?: SavedViewSurface;
+}
+export type SavedViewSurface = "competitors" | "keywords";
+export interface ListSavedViewsOptions extends PaginationOptions {
+    surface?: SavedViewSurface;
 }
 export interface SavedView {
     config: SavedViewConfig;
     created_at: string;
-    created_by_id: string | null;
-    id: string;
+    created_by_id: UserId | null;
+    id: SavedViewId;
     name: string;
+    surface: SavedViewSurface;
 }
 export interface DeleteSavedViewResponse {
     deleted: boolean;
 }
 export interface Competitor {
     domain: string;
-    id: string;
+    id: CompetitorId;
     initials?: string;
     label: string | null;
 }
@@ -868,14 +939,14 @@ export interface RemoveCompetitorResponse {
 export type CompetitorKind = "Managed" | "You";
 export interface CompetitorColumn {
     domain: string;
-    id?: string;
+    id?: CompetitorId;
     kind: CompetitorKind;
     label: string;
 }
 export interface CompetitorShare {
     color: string;
     domain: string;
-    id?: string;
+    id?: CompetitorId;
     initials: string;
     kind: CompetitorKind;
     label: string;
@@ -885,8 +956,11 @@ export interface CompetitorShare {
 export interface HeadToHeadRow {
     gap: number | null;
     keyword: string;
-    ranks: Record<string, number | null>;
+    ranks: CompetitorRankMap;
 }
+export type CompetitorRankMap = {
+    you?: number | null;
+} & Partial<Record<CompetitorId, number | null>>;
 export interface CompetitorMarket {
     checked_keyword_count: number;
     columns: CompetitorColumn[];
@@ -926,7 +1000,7 @@ export interface NotificationPreferences {
     import_in_app: boolean;
     invite_email: boolean;
     invite_in_app: boolean;
-    project_id: string;
+    project_id: ProjectId;
     slack_available?: boolean;
     webhook_available?: boolean;
 }
@@ -943,10 +1017,8 @@ export interface PageTrafficSnapshot {
     created_at: string;
     date: string;
     engagement_rate: number | null;
-    id: string;
     key_events: number | null;
     path: string;
-    project_id: string;
     provider: string;
     scroll_depth: number | null;
     sessions: number;
@@ -961,14 +1033,14 @@ export interface PageTrafficSnapshotsResponse {
     total_count: number;
 }
 export interface ListSearchPerformanceQueryStatsOptions {
-    connectionId?: string;
+    connectionId?: ConnectionId;
     endDate: Date | string;
     limit?: number;
     query?: string;
     startDate: Date | string;
 }
 export interface AnalyticsConnection {
-    id: string;
+    id: ConnectionId;
     label: string;
     provider: string;
 }
@@ -986,7 +1058,7 @@ export interface SearchPerformanceQueryStatsResponse {
 }
 export type TrafficSyncRunStatus = "succeeded_with_data" | "succeeded_empty" | "deferred_rate_limit" | "failed" | "not_applicable";
 export interface TrafficSyncRun {
-    connection_id: string;
+    connection_id: ConnectionId;
     error?: string;
     error_class?: string;
     provider: string;
@@ -1005,7 +1077,7 @@ export interface TrafficSyncSummary {
     connections: number;
     keyword_snapshots: number;
     page_snapshots: number;
-    project_id: string;
+    project_id: ProjectId;
     runs: TrafficSyncRun[];
     skipped: TrafficSyncSkippedConnection[];
 }
@@ -1016,7 +1088,7 @@ export interface CloudImportJob {
     created_at: string | null;
     error: string | null;
     finished_at: string | null;
-    id: string | null;
+    id: CloudImportJobId | null;
     progress: number;
     started_at: string | null;
     state: CloudImportState;
@@ -1028,7 +1100,7 @@ export interface ActiveMigrationToken {
         name: string;
     };
     expires_at: string;
-    id: string;
+    id: MigrationTokenId;
     scope: MigrationScope;
     single_use: boolean;
 }
@@ -1040,7 +1112,7 @@ export interface MintMigrationTokenInput {
     scope?: MigrationScope;
 }
 export interface RevokedMigrationToken {
-    id: string;
+    id: MigrationTokenId;
     revoked_at: string;
 }
 export interface MigrationTokenListMeta extends ListMeta {
@@ -1049,7 +1121,7 @@ export interface MigrationTokenListMeta extends ListMeta {
 export interface MigrationTokenListResponse extends ListResponse<ActiveMigrationToken> {
     meta: MigrationTokenListMeta;
 }
-export type CloudImportSchemaVersion = 1 | 2 | 3;
+export type CloudImportSchemaVersion = 4;
 export type CloudImportLocation = "Australia" | "Austria" | "Belgium" | "Brazil" | "Canada" | "Denmark" | "Finland" | "France" | "Germany" | "India" | "Ireland" | "Italy" | "Japan" | "Mexico" | "Netherlands" | "New Zealand" | "Norway" | "Poland" | "Portugal" | "Singapore" | "South Africa" | "Spain" | "Sweden" | "Switzerland" | "United Arab Emirates" | "United Kingdom" | "United States";
 export interface CloudImportCompatibility {
     app_version: string;
@@ -1063,121 +1135,92 @@ export interface CloudImportRankingHistory {
     rankingUrl?: string | null;
 }
 export interface CloudImportKeyword {
-    country?: CloudImportLocation;
-    device?: Device;
-    id?: string;
-    keyword?: string;
-    location?: CloudImportLocation;
+    device: Device;
+    id: KeywordId;
+    keyword: string;
+    location: CloudImportLocation;
     rankingHistory?: CloudImportRankingHistory[];
     tags?: string[];
     target_url?: string | null;
-    targetUrl?: string | null;
-    text?: string;
 }
 export interface CloudImportCompetitor {
     domain: string;
+    id: CompetitorId;
     label?: string | null;
 }
 export interface CloudImportSavedView {
     config?: unknown;
+    id: SavedViewId;
     name: string;
     surface?: "competitors" | "keywords";
 }
 export type CloudImportAlertChannel = "email" | "slack" | "webhook";
-export type CloudImportAlertConditionType = "change_pct" | "competitor_overtake" | "enters_top_n" | "exits_top_n" | "serp_feature" | "threshold";
+export type CloudImportAlertConditionType = "change_pct" | "competitor_overtake" | "ctr_drop" | "downtrend" | "enters_top_n" | "exits_top_n" | "position_drop" | "serp_feature" | "threshold" | "url_mismatch";
 export type CloudImportAlertTargetType = "all" | "keyword" | "tag";
-export interface CloudImportAlertRuleTarget {
+export interface CloudImportKeywordAlertTarget {
     device?: Device;
     keyword?: string;
-    keyword_id?: string;
-    keywordId?: string;
+    keyword_id: KeywordId;
     location?: CloudImportLocation;
-    tag?: string;
-    tag_id?: string;
-    tagId?: string;
-    type?: "keyword" | "tag";
+    type: "keyword";
+}
+export interface CloudImportTagAlertTarget {
+    tag: string;
+    type: "tag";
 }
+export type CloudImportAlertRuleTarget = CloudImportKeywordAlertTarget | CloudImportTagAlertTarget;
 export interface CloudImportAlertRule {
     change_pct?: number | null;
-    changePct?: number | null;
     channels?: CloudImportAlertChannel[];
     competitor_domain?: string | null;
-    competitorDomain?: string | null;
     condition_type?: CloudImportAlertConditionType;
-    conditionType?: CloudImportAlertConditionType;
+    drop_positions?: number | null;
     enabled?: boolean;
+    id: AlertRuleId;
     name: string;
     serp_feature?: string | null;
-    serpFeature?: string | null;
     target_type?: CloudImportAlertTargetType;
     targets?: CloudImportAlertRuleTarget[];
-    targetType?: CloudImportAlertTargetType;
     threshold_position?: number | null;
-    thresholdPosition?: number | null;
     top_n?: number | null;
-    topN?: number | null;
 }
 export interface CloudImportNotificationPreference {
     alert_email?: boolean;
     alert_in_app?: boolean;
-    alertEmail?: boolean;
-    alertInApp?: boolean;
     check_email?: boolean;
     check_in_app?: boolean;
-    checkEmail?: boolean;
-    checkInApp?: boolean;
     import_email?: boolean;
     import_in_app?: boolean;
-    importEmail?: boolean;
-    importInApp?: boolean;
     invite_email?: boolean;
     invite_in_app?: boolean;
-    inviteEmail?: boolean;
-    inviteInApp?: boolean;
-}
-export interface CloudImportTopLevelRankCheck {
-    checked_at?: string;
-    checkedAt?: string;
-    keyword?: string;
-    keyword_id?: string;
-    keywordId?: string;
-    position?: number | null;
-    previous_position?: number | null;
-    previousPosition?: number | null;
-    ranking_url?: string | null;
-    rankingUrl?: string | null;
-    text?: string;
+    report_email?: boolean;
 }
 export type CloudImportScope = "current" | "history";
 export interface CloudImportPackage {
-    alert_rules?: CloudImportAlertRule[];
-    alertRules?: CloudImportAlertRule[];
-    competitors?: CloudImportCompetitor[];
-    exportedAt?: string;
-    keywords?: CloudImportKeyword[];
-    notification_preferences?: CloudImportNotificationPreference[];
-    notificationPreferences?: CloudImportNotificationPreference[];
-    projectId?: string;
-    rank_checks?: CloudImportTopLevelRankCheck[];
-    saved_views?: CloudImportSavedView[];
-    savedViews?: CloudImportSavedView[];
+    alert_rules: CloudImportAlertRule[];
+    competitors: CloudImportCompetitor[];
+    exported_at?: string;
+    keywords: CloudImportKeyword[];
+    notification_preferences: CloudImportNotificationPreference[];
+    project_id: ProjectId;
+    saved_views: CloudImportSavedView[];
     scope?: CloudImportScope;
-    version?: number;
-    [key: string]: unknown;
+    version: CloudImportSchemaVersion;
 }
 export type CloudImportCounts = Record<string, number>;
 export interface CloudImportFinalizeResponse {
     counts: CloudImportCounts;
-    job_id: string;
+    job_id: CloudImportJobId;
     state: "done";
 }
 export interface CloudImportSessionCreate {
     chunk_count: number;
+    source_project_id: ProjectId;
     totals?: {
         keywords?: number;
         rank_checks?: number;
     };
-    version: 3;
+    version: CloudImportSchemaVersion;
 }
 export interface CloudImportSessionCreateResponse {
     chunk_limits: {
@@ -1185,7 +1228,7 @@ export interface CloudImportSessionCreateResponse {
         max_history_rows: number;
         max_keywords: number;
     };
-    session_id: string;
+    session_id: CloudImportJobId;
     state: "receiving";
 }
 export interface CloudImportSourceKeyword {
@@ -1195,15 +1238,10 @@ export interface CloudImportSourceKeyword {
 }
 export interface CloudImportSessionSections {
     alert_rules?: CloudImportAlertRule[];
-    alertRules?: CloudImportAlertRule[];
     competitors?: CloudImportCompetitor[];
     notification_preferences?: CloudImportNotificationPreference[];
-    notificationPreferences?: CloudImportNotificationPreference[];
     saved_views?: CloudImportSavedView[];
-    savedViews?: CloudImportSavedView[];
-    source_keyword_ids?: Record<string, CloudImportSourceKeyword>;
-    sourceKeywordIds?: Record<string, CloudImportSourceKeyword>;
-    [key: string]: unknown;
+    source_keyword_ids?: Partial<Record<KeywordId, CloudImportSourceKeyword>>;
 }
 export interface CloudImportKeywordsChunk {
     checksum: string;
@@ -1231,11 +1269,11 @@ export type SignalSeverity = "critical" | "info" | "warning";
 export interface Signal {
     created_at: string;
     happened_at: string;
-    id: string;
-    keyword_id: string | null;
+    id: SignalId;
+    keyword_id: KeywordId | null;
     payload: JsonObject | null;
-    project_id: string;
-    public_id: string;
+    project_id: ProjectId;
+    public_id: SignalId;
     severity: SignalSeverity;
     source: SignalSource;
     type: string;
@@ -1244,7 +1282,7 @@ export interface Signal {
 export interface CreateSignalInput {
     /** ISO-8601 date-time when the signal happened. Defaults to now on the server. */
     happened_at?: string;
-    keyword_id?: string;
+    keyword_id?: KeywordId;
     /** JSON object payload. Ingestion rejects serialized payloads above 8KB. */
     payload?: JsonObject;
     severity?: SignalSeverity;
@@ -1366,10 +1404,10 @@ export interface BisibilityClientConfig {
     /** Number of retries after the initial attempt. Defaults to 2; 0 disables retries. */
     maxRetries?: number;
     /**
-     * Project id or public id sent as the X-Bisibility-Project header on every request.
+     * Project public ID sent as the X-Bisibility-Project header on every request.
      * Targets personal access token requests at a project on routes without one in the path.
      */
-    projectId?: string;
+    projectId?: ProjectId;
     /** Per-attempt timeout in milliseconds. Defaults to 30 seconds; null disables it. */
     timeout?: number | null;
 }