@fern-api/fdr-sdk 1.2.73-d4652c951f → 1.2.74-04dd3d68b3

package/dist/types/orpc-client/dashboard-agent/contract.d.ts

@@ -0,0 +1,1419 @@
+import * as z from "zod";
+export declare const DashboardAnalyticsCommonInputSchema: z.ZodObject<{
+    orgId: z.ZodString;
+    domain: z.ZodString;
+    dateRange: z.ZodOptional<z.ZodString>;
+    includeInternal: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    orgId: string;
+    domain: string;
+    dateRange?: string | undefined;
+    includeInternal?: boolean | undefined;
+}, {
+    orgId: string;
+    domain: string;
+    dateRange?: string | undefined;
+    includeInternal?: boolean | undefined;
+}>;
+export type DashboardAnalyticsCommonInput = z.infer<typeof DashboardAnalyticsCommonInputSchema>;
+export declare const DashboardFeedbackInputSchema: z.ZodObject<{
+    orgId: z.ZodString;
+    domain: z.ZodString;
+    dateRange: z.ZodOptional<z.ZodString>;
+    feedbackType: z.ZodOptional<z.ZodEnum<["page", "code_block", "all"]>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    orgId: string;
+    domain: string;
+    limit?: number | undefined;
+    dateRange?: string | undefined;
+    feedbackType?: "page" | "code_block" | "all" | undefined;
+}, {
+    orgId: string;
+    domain: string;
+    limit?: number | undefined;
+    dateRange?: string | undefined;
+    feedbackType?: "page" | "code_block" | "all" | undefined;
+}>;
+export type DashboardFeedbackInput = z.infer<typeof DashboardFeedbackInputSchema>;
+export declare const DashboardListOrgDocDomainsInputSchema: z.ZodObject<{
+    orgId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    orgId: string;
+}, {
+    orgId: string;
+}>;
+export type DashboardListOrgDocDomainsInput = z.infer<typeof DashboardListOrgDocDomainsInputSchema>;
+export declare const DashboardListOrgMembersInputSchema: z.ZodObject<{
+    orgId: z.ZodString;
+    includeFernEmployees: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    orgId: string;
+    includeFernEmployees?: boolean | undefined;
+}, {
+    orgId: string;
+    includeFernEmployees?: boolean | undefined;
+}>;
+export type DashboardListOrgMembersInput = z.infer<typeof DashboardListOrgMembersInputSchema>;
+export declare const DashboardGetSiteConfigInputSchema: z.ZodObject<{
+    orgId: z.ZodString;
+    domain: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    orgId: string;
+    domain: string;
+}, {
+    orgId: string;
+    domain: string;
+}>;
+export type DashboardGetSiteConfigInput = z.infer<typeof DashboardGetSiteConfigInputSchema>;
+/** Metrics backed by concrete `posthog.events` aggregates (no invented columns). */
+export declare const AnalyticsMetricSchema: z.ZodEnum<["pageviews", "visitors", "sessions", "404s"]>;
+export type AnalyticsMetric = z.infer<typeof AnalyticsMetricSchema>;
+/** Groupable columns. `referrer` is only valid for the pageview-family metrics. */
+export declare const AnalyticsDimensionSchema: z.ZodEnum<["path", "referrer"]>;
+export type AnalyticsDimension = z.infer<typeof AnalyticsDimensionSchema>;
+export declare const AnalyticsGranularitySchema: z.ZodEnum<["day", "week", "month"]>;
+export type AnalyticsGranularity = z.infer<typeof AnalyticsGranularitySchema>;
+export declare const AnalyticsFilterFieldSchema: z.ZodEnum<["path", "referrer"]>;
+export declare const AnalyticsFilterOpSchema: z.ZodEnum<["eq", "prefix", "contains"]>;
+/** A single filter clause; `value` is always bound as a query parameter. */
+export declare const AnalyticsFilterSchema: z.ZodObject<{
+    field: z.ZodEnum<["path", "referrer"]>;
+    op: z.ZodEnum<["eq", "prefix", "contains"]>;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    field: "path" | "referrer";
+    op: "prefix" | "eq" | "contains";
+}, {
+    value: string;
+    field: "path" | "referrer";
+    op: "prefix" | "eq" | "contains";
+}>;
+export type AnalyticsFilter = z.infer<typeof AnalyticsFilterSchema>;
+export declare const AnalyticsOrderBySchema: z.ZodObject<{
+    field: z.ZodEnum<["count", "visitors"]>;
+    dir: z.ZodEnum<["asc", "desc"]>;
+}, "strip", z.ZodTypeAny, {
+    field: "visitors" | "count";
+    dir: "asc" | "desc";
+}, {
+    field: "visitors" | "count";
+    dir: "asc" | "desc";
+}>;
+/** Either a semantic range string (e.g. `last_n_days:30`) or explicit ISO bounds. */
+export declare const AnalyticsDateRangeSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    startDate: string;
+    endDate: string;
+}, {
+    startDate: string;
+    endDate: string;
+}>]>;
+export declare const QueryAnalyticsInputSchema: z.ZodObject<{
+    orgId: z.ZodString;
+    domain: z.ZodString;
+    metric: z.ZodEnum<["pageviews", "visitors", "sessions", "404s"]>;
+    dimensions: z.ZodOptional<z.ZodArray<z.ZodEnum<["path", "referrer"]>, "many">>;
+    filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        field: z.ZodEnum<["path", "referrer"]>;
+        op: z.ZodEnum<["eq", "prefix", "contains"]>;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        field: "path" | "referrer";
+        op: "prefix" | "eq" | "contains";
+    }, {
+        value: string;
+        field: "path" | "referrer";
+        op: "prefix" | "eq" | "contains";
+    }>, "many">>;
+    dateRange: z.ZodUnion<[z.ZodString, z.ZodObject<{
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        startDate: string;
+        endDate: string;
+    }, {
+        startDate: string;
+        endDate: string;
+    }>]>;
+    granularity: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
+    orderBy: z.ZodOptional<z.ZodObject<{
+        field: z.ZodEnum<["count", "visitors"]>;
+        dir: z.ZodEnum<["asc", "desc"]>;
+    }, "strip", z.ZodTypeAny, {
+        field: "visitors" | "count";
+        dir: "asc" | "desc";
+    }, {
+        field: "visitors" | "count";
+        dir: "asc" | "desc";
+    }>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    orgId: string;
+    domain: string;
+    dateRange: string | {
+        startDate: string;
+        endDate: string;
+    };
+    metric: "pageviews" | "visitors" | "sessions" | "404s";
+    limit?: number | undefined;
+    dimensions?: ("path" | "referrer")[] | undefined;
+    filters?: {
+        value: string;
+        field: "path" | "referrer";
+        op: "prefix" | "eq" | "contains";
+    }[] | undefined;
+    granularity?: "day" | "week" | "month" | undefined;
+    orderBy?: {
+        field: "visitors" | "count";
+        dir: "asc" | "desc";
+    } | undefined;
+}, {
+    orgId: string;
+    domain: string;
+    dateRange: string | {
+        startDate: string;
+        endDate: string;
+    };
+    metric: "pageviews" | "visitors" | "sessions" | "404s";
+    limit?: number | undefined;
+    dimensions?: ("path" | "referrer")[] | undefined;
+    filters?: {
+        value: string;
+        field: "path" | "referrer";
+        op: "prefix" | "eq" | "contains";
+    }[] | undefined;
+    granularity?: "day" | "week" | "month" | undefined;
+    orderBy?: {
+        field: "visitors" | "count";
+        dir: "asc" | "desc";
+    } | undefined;
+}>;
+export type QueryAnalyticsInput = z.infer<typeof QueryAnalyticsInputSchema>;
+export declare const ResolvedDateRangeSchema: z.ZodObject<{
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    startDate: string;
+    endDate: string;
+}, {
+    startDate: string;
+    endDate: string;
+}>;
+export type ResolvedDateRange = z.infer<typeof ResolvedDateRangeSchema>;
+export declare const TrafficSummaryResponseSchema: z.ZodObject<{
+    resolvedDateRange: z.ZodObject<{
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        startDate: string;
+        endDate: string;
+    }, {
+        startDate: string;
+        endDate: string;
+    }>;
+    metrics: z.ZodObject<{
+        visitors: z.ZodNumber;
+        pageViews: z.ZodNumber;
+        sessions: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        visitors: number;
+        sessions: number;
+        pageViews: number;
+    }, {
+        visitors: number;
+        sessions: number;
+        pageViews: number;
+    }>;
+    baseSiteUrl: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    metrics: {
+        visitors: number;
+        sessions: number;
+        pageViews: number;
+    };
+    baseSiteUrl: string;
+}, {
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    metrics: {
+        visitors: number;
+        sessions: number;
+        pageViews: number;
+    };
+    baseSiteUrl: string;
+}>;
+export type TrafficSummaryResponse = z.infer<typeof TrafficSummaryResponseSchema>;
+export declare const TopPagesResponseSchema: z.ZodObject<{
+    resolvedDateRange: z.ZodObject<{
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        startDate: string;
+        endDate: string;
+    }, {
+        startDate: string;
+        endDate: string;
+    }>;
+    topPages: z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        visitors: z.ZodNumber;
+        views: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+        visitors: number;
+        views: number;
+    }, {
+        path: string;
+        visitors: number;
+        views: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    topPages: {
+        path: string;
+        visitors: number;
+        views: number;
+    }[];
+}, {
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    topPages: {
+        path: string;
+        visitors: number;
+        views: number;
+    }[];
+}>;
+export type TopPagesResponse = z.infer<typeof TopPagesResponseSchema>;
+export declare const Pages404ResponseSchema: z.ZodObject<{
+    resolvedDateRange: z.ZodObject<{
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        startDate: string;
+        endDate: string;
+    }, {
+        startDate: string;
+        endDate: string;
+    }>;
+    pages404: z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        count: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+        count: number;
+    }, {
+        path: string;
+        count: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    pages404: {
+        path: string;
+        count: number;
+    }[];
+}, {
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    pages404: {
+        path: string;
+        count: number;
+    }[];
+}>;
+export type Pages404Response = z.infer<typeof Pages404ResponseSchema>;
+export declare const ReferringDomainsResponseSchema: z.ZodObject<{
+    resolvedDateRange: z.ZodObject<{
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        startDate: string;
+        endDate: string;
+    }, {
+        startDate: string;
+        endDate: string;
+    }>;
+    referringDomains: z.ZodArray<z.ZodObject<{
+        domain: z.ZodString;
+        visitors: z.ZodNumber;
+        views: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        domain: string;
+        visitors: number;
+        views: number;
+    }, {
+        domain: string;
+        visitors: number;
+        views: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    referringDomains: {
+        domain: string;
+        visitors: number;
+        views: number;
+    }[];
+}, {
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    referringDomains: {
+        domain: string;
+        visitors: number;
+        views: number;
+    }[];
+}>;
+export type ReferringDomainsResponse = z.infer<typeof ReferringDomainsResponseSchema>;
+export declare const LlmBotTrafficResponseSchema: z.ZodObject<{
+    resolvedDateRange: z.ZodObject<{
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        startDate: string;
+        endDate: string;
+    }, {
+        startDate: string;
+        endDate: string;
+    }>;
+    providers: z.ZodArray<z.ZodObject<{
+        provider: z.ZodString;
+        count: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        count: number;
+        provider: string;
+    }, {
+        count: number;
+        provider: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    providers: {
+        count: number;
+        provider: string;
+    }[];
+}, {
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    providers: {
+        count: number;
+        provider: string;
+    }[];
+}>;
+export type LlmBotTrafficResponse = z.infer<typeof LlmBotTrafficResponseSchema>;
+export declare const RecentFeedbackResponseSchema: z.ZodObject<{
+    resolvedDateRange: z.ZodObject<{
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        startDate: string;
+        endDate: string;
+    }, {
+        startDate: string;
+        endDate: string;
+    }>;
+    helpfulCount: z.ZodNumber;
+    unhelpfulCount: z.ZodNumber;
+    entries: z.ZodArray<z.ZodObject<{
+        date: z.ZodString;
+        location: z.ZodString;
+        wasHelpful: z.ZodBoolean;
+        userFeedback: z.ZodString;
+        feedbackType: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        date: string;
+        location: string;
+        wasHelpful: boolean;
+        userFeedback: string;
+        feedbackType?: string | undefined;
+    }, {
+        date: string;
+        location: string;
+        wasHelpful: boolean;
+        userFeedback: string;
+        feedbackType?: string | undefined;
+    }>, "many">;
+    hasMore: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    entries: {
+        date: string;
+        location: string;
+        wasHelpful: boolean;
+        userFeedback: string;
+        feedbackType?: string | undefined;
+    }[];
+    hasMore: boolean;
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    helpfulCount: number;
+    unhelpfulCount: number;
+}, {
+    entries: {
+        date: string;
+        location: string;
+        wasHelpful: boolean;
+        userFeedback: string;
+        feedbackType?: string | undefined;
+    }[];
+    hasMore: boolean;
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    helpfulCount: number;
+    unhelpfulCount: number;
+}>;
+export type RecentFeedbackResponse = z.infer<typeof RecentFeedbackResponseSchema>;
+export declare const OrgDocDomainsResponseSchema: z.ZodObject<{
+    domains: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    domains: string[];
+}, {
+    domains: string[];
+}>;
+export type OrgDocDomainsResponse = z.infer<typeof OrgDocDomainsResponseSchema>;
+export declare const QueryAnalyticsResponseSchema: z.ZodObject<{
+    resolvedDateRange: z.ZodObject<{
+        startDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        startDate: string;
+        endDate: string;
+    }, {
+        startDate: string;
+        endDate: string;
+    }>;
+    metric: z.ZodEnum<["pageviews", "visitors", "sessions", "404s"]>;
+    dimensions: z.ZodArray<z.ZodEnum<["path", "referrer"]>, "many">;
+    granularity: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
+    rows: z.ZodArray<z.ZodObject<{
+        dimensions: z.ZodRecord<z.ZodString, z.ZodString>;
+        bucket: z.ZodOptional<z.ZodString>;
+        count: z.ZodNumber;
+        visitors: z.ZodOptional<z.ZodNumber>;
+        sessions: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        count: number;
+        dimensions: Record<string, string>;
+        visitors?: number | undefined;
+        sessions?: number | undefined;
+        bucket?: string | undefined;
+    }, {
+        count: number;
+        dimensions: Record<string, string>;
+        visitors?: number | undefined;
+        sessions?: number | undefined;
+        bucket?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    metric: "pageviews" | "visitors" | "sessions" | "404s";
+    dimensions: ("path" | "referrer")[];
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    rows: {
+        count: number;
+        dimensions: Record<string, string>;
+        visitors?: number | undefined;
+        sessions?: number | undefined;
+        bucket?: string | undefined;
+    }[];
+    granularity?: "day" | "week" | "month" | undefined;
+}, {
+    metric: "pageviews" | "visitors" | "sessions" | "404s";
+    dimensions: ("path" | "referrer")[];
+    resolvedDateRange: {
+        startDate: string;
+        endDate: string;
+    };
+    rows: {
+        count: number;
+        dimensions: Record<string, string>;
+        visitors?: number | undefined;
+        sessions?: number | undefined;
+        bucket?: string | undefined;
+    }[];
+    granularity?: "day" | "week" | "month" | undefined;
+}>;
+export type QueryAnalyticsResponse = z.infer<typeof QueryAnalyticsResponseSchema>;
+export declare const OrgMembersResponseSchema: z.ZodObject<{
+    members: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        email: z.ZodString;
+        roles: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        email: string;
+        roles: string[];
+    }, {
+        name: string;
+        email: string;
+        roles: string[];
+    }>, "many">;
+    count: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    count: number;
+    members: {
+        name: string;
+        email: string;
+        roles: string[];
+    }[];
+}, {
+    count: number;
+    members: {
+        name: string;
+        email: string;
+        roles: string[];
+    }[];
+}>;
+export type OrgMembersResponse = z.infer<typeof OrgMembersResponseSchema>;
+export declare const SiteGitRepositorySchema: z.ZodObject<{
+    gitUrl: z.ZodString;
+    provider: z.ZodEnum<["github", "gitlab", "other"]>;
+    /** `owner/repo` when the git url points at GitHub, else null. */
+    githubRepository: z.ZodNullable<z.ZodString>;
+    branch: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    gitUrl: string;
+    provider: "github" | "gitlab" | "other";
+    githubRepository: string | null;
+    branch: string | null;
+}, {
+    gitUrl: string;
+    provider: "github" | "gitlab" | "other";
+    githubRepository: string | null;
+    branch: string | null;
+}>;
+export type SiteGitRepository = z.infer<typeof SiteGitRepositorySchema>;
+export declare const SiteConfigResponseSchema: z.ZodObject<{
+    domain: z.ZodString;
+    basepath: z.ZodNullable<z.ZodString>;
+    status: z.ZodNullable<z.ZodString>;
+    isPreview: z.ZodBoolean;
+    /** The git repository connected to this docs site, when one exists. */
+    gitRepository: z.ZodNullable<z.ZodObject<{
+        gitUrl: z.ZodString;
+        provider: z.ZodEnum<["github", "gitlab", "other"]>;
+        /** `owner/repo` when the git url points at GitHub, else null. */
+        githubRepository: z.ZodNullable<z.ZodString>;
+        branch: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        gitUrl: string;
+        provider: "github" | "gitlab" | "other";
+        githubRepository: string | null;
+        branch: string | null;
+    }, {
+        gitUrl: string;
+        provider: "github" | "gitlab" | "other";
+        githubRepository: string | null;
+        branch: string | null;
+    }>>;
+    /** True when the queried domain is a customer-owned custom domain (not *.docs.buildwithfern.com). */
+    isCustomDomain: z.ZodBoolean;
+    /** Fern CLI version that published the current deployment, when known. */
+    fernCliVersion: z.ZodNullable<z.ZodString>;
+    /** Connected Postman collection id, when one exists. */
+    postmanCollectionId: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    status: string | null;
+    domain: string;
+    basepath: string | null;
+    postmanCollectionId: string | null;
+    isPreview: boolean;
+    gitRepository: {
+        gitUrl: string;
+        provider: "github" | "gitlab" | "other";
+        githubRepository: string | null;
+        branch: string | null;
+    } | null;
+    isCustomDomain: boolean;
+    fernCliVersion: string | null;
+}, {
+    status: string | null;
+    domain: string;
+    basepath: string | null;
+    postmanCollectionId: string | null;
+    isPreview: boolean;
+    gitRepository: {
+        gitUrl: string;
+        provider: "github" | "gitlab" | "other";
+        githubRepository: string | null;
+        branch: string | null;
+    } | null;
+    isCustomDomain: boolean;
+    fernCliVersion: string | null;
+}>;
+export type SiteConfigResponse = z.infer<typeof SiteConfigResponseSchema>;
+export declare const SitePasswordProtectionSchema: z.ZodObject<{
+    enabled: z.ZodBoolean;
+    /** Number of configured passwords. Passwords themselves are never returned. */
+    passwordCount: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    enabled: boolean;
+    passwordCount: number;
+}, {
+    enabled: boolean;
+    passwordCount: number;
+}>;
+export type SitePasswordProtection = z.infer<typeof SitePasswordProtectionSchema>;
+export declare const SiteSettingsResponseSchema: z.ZodObject<{
+    domain: z.ZodString;
+    basepath: z.ZodNullable<z.ZodString>;
+    /** Default basepath route for multi-basepath domains, when configured. */
+    defaultBasepath: z.ZodNullable<z.ZodString>;
+    /** Basepaths routed on this domain, when configured. */
+    basepaths: z.ZodNullable<z.ZodArray<z.ZodString, "many">>;
+    searchBehavior: z.ZodNullable<z.ZodEnum<["hierarchical", "unified"]>>;
+    passwordProtection: z.ZodObject<{
+        enabled: z.ZodBoolean;
+        /** Number of configured passwords. Passwords themselves are never returned. */
+        passwordCount: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        passwordCount: number;
+    }, {
+        enabled: boolean;
+        passwordCount: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    domain: string;
+    basepath: string | null;
+    defaultBasepath: string | null;
+    basepaths: string[] | null;
+    searchBehavior: "hierarchical" | "unified" | null;
+    passwordProtection: {
+        enabled: boolean;
+        passwordCount: number;
+    };
+}, {
+    domain: string;
+    basepath: string | null;
+    defaultBasepath: string | null;
+    basepaths: string[] | null;
+    searchBehavior: "hierarchical" | "unified" | null;
+    passwordProtection: {
+        enabled: boolean;
+        passwordCount: number;
+    };
+}>;
+export type SiteSettingsResponse = z.infer<typeof SiteSettingsResponseSchema>;
+export declare const dashboardAgentContract: {
+    getTrafficSummary: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+        domain: z.ZodString;
+        dateRange: z.ZodOptional<z.ZodString>;
+        includeInternal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+        domain: string;
+        dateRange?: string | undefined;
+        includeInternal?: boolean | undefined;
+    }, {
+        orgId: string;
+        domain: string;
+        dateRange?: string | undefined;
+        includeInternal?: boolean | undefined;
+    }>, z.ZodObject<{
+        resolvedDateRange: z.ZodObject<{
+            startDate: z.ZodString;
+            endDate: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            startDate: string;
+            endDate: string;
+        }, {
+            startDate: string;
+            endDate: string;
+        }>;
+        metrics: z.ZodObject<{
+            visitors: z.ZodNumber;
+            pageViews: z.ZodNumber;
+            sessions: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            visitors: number;
+            sessions: number;
+            pageViews: number;
+        }, {
+            visitors: number;
+            sessions: number;
+            pageViews: number;
+        }>;
+        baseSiteUrl: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        metrics: {
+            visitors: number;
+            sessions: number;
+            pageViews: number;
+        };
+        baseSiteUrl: string;
+    }, {
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        metrics: {
+            visitors: number;
+            sessions: number;
+            pageViews: number;
+        };
+        baseSiteUrl: string;
+    }>, Record<never, never>, Record<never, never>>;
+    getTopPages: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+        domain: z.ZodString;
+        dateRange: z.ZodOptional<z.ZodString>;
+        includeInternal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+        domain: string;
+        dateRange?: string | undefined;
+        includeInternal?: boolean | undefined;
+    }, {
+        orgId: string;
+        domain: string;
+        dateRange?: string | undefined;
+        includeInternal?: boolean | undefined;
+    }>, z.ZodObject<{
+        resolvedDateRange: z.ZodObject<{
+            startDate: z.ZodString;
+            endDate: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            startDate: string;
+            endDate: string;
+        }, {
+            startDate: string;
+            endDate: string;
+        }>;
+        topPages: z.ZodArray<z.ZodObject<{
+            path: z.ZodString;
+            visitors: z.ZodNumber;
+            views: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            path: string;
+            visitors: number;
+            views: number;
+        }, {
+            path: string;
+            visitors: number;
+            views: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        topPages: {
+            path: string;
+            visitors: number;
+            views: number;
+        }[];
+    }, {
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        topPages: {
+            path: string;
+            visitors: number;
+            views: number;
+        }[];
+    }>, Record<never, never>, Record<never, never>>;
+    get404Pages: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+        domain: z.ZodString;
+        dateRange: z.ZodOptional<z.ZodString>;
+        includeInternal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+        domain: string;
+        dateRange?: string | undefined;
+        includeInternal?: boolean | undefined;
+    }, {
+        orgId: string;
+        domain: string;
+        dateRange?: string | undefined;
+        includeInternal?: boolean | undefined;
+    }>, z.ZodObject<{
+        resolvedDateRange: z.ZodObject<{
+            startDate: z.ZodString;
+            endDate: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            startDate: string;
+            endDate: string;
+        }, {
+            startDate: string;
+            endDate: string;
+        }>;
+        pages404: z.ZodArray<z.ZodObject<{
+            path: z.ZodString;
+            count: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            path: string;
+            count: number;
+        }, {
+            path: string;
+            count: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        pages404: {
+            path: string;
+            count: number;
+        }[];
+    }, {
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        pages404: {
+            path: string;
+            count: number;
+        }[];
+    }>, Record<never, never>, Record<never, never>>;
+    getReferringDomains: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+        domain: z.ZodString;
+        dateRange: z.ZodOptional<z.ZodString>;
+        includeInternal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+        domain: string;
+        dateRange?: string | undefined;
+        includeInternal?: boolean | undefined;
+    }, {
+        orgId: string;
+        domain: string;
+        dateRange?: string | undefined;
+        includeInternal?: boolean | undefined;
+    }>, z.ZodObject<{
+        resolvedDateRange: z.ZodObject<{
+            startDate: z.ZodString;
+            endDate: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            startDate: string;
+            endDate: string;
+        }, {
+            startDate: string;
+            endDate: string;
+        }>;
+        referringDomains: z.ZodArray<z.ZodObject<{
+            domain: z.ZodString;
+            visitors: z.ZodNumber;
+            views: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            domain: string;
+            visitors: number;
+            views: number;
+        }, {
+            domain: string;
+            visitors: number;
+            views: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        referringDomains: {
+            domain: string;
+            visitors: number;
+            views: number;
+        }[];
+    }, {
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        referringDomains: {
+            domain: string;
+            visitors: number;
+            views: number;
+        }[];
+    }>, Record<never, never>, Record<never, never>>;
+    getLlmBotTraffic: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+        domain: z.ZodString;
+        dateRange: z.ZodOptional<z.ZodString>;
+        includeInternal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+        domain: string;
+        dateRange?: string | undefined;
+        includeInternal?: boolean | undefined;
+    }, {
+        orgId: string;
+        domain: string;
+        dateRange?: string | undefined;
+        includeInternal?: boolean | undefined;
+    }>, z.ZodObject<{
+        resolvedDateRange: z.ZodObject<{
+            startDate: z.ZodString;
+            endDate: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            startDate: string;
+            endDate: string;
+        }, {
+            startDate: string;
+            endDate: string;
+        }>;
+        providers: z.ZodArray<z.ZodObject<{
+            provider: z.ZodString;
+            count: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            count: number;
+            provider: string;
+        }, {
+            count: number;
+            provider: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        providers: {
+            count: number;
+            provider: string;
+        }[];
+    }, {
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        providers: {
+            count: number;
+            provider: string;
+        }[];
+    }>, Record<never, never>, Record<never, never>>;
+    getRecentFeedback: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+        domain: z.ZodString;
+        dateRange: z.ZodOptional<z.ZodString>;
+        feedbackType: z.ZodOptional<z.ZodEnum<["page", "code_block", "all"]>>;
+        limit: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+        domain: string;
+        limit?: number | undefined;
+        dateRange?: string | undefined;
+        feedbackType?: "page" | "code_block" | "all" | undefined;
+    }, {
+        orgId: string;
+        domain: string;
+        limit?: number | undefined;
+        dateRange?: string | undefined;
+        feedbackType?: "page" | "code_block" | "all" | undefined;
+    }>, z.ZodObject<{
+        resolvedDateRange: z.ZodObject<{
+            startDate: z.ZodString;
+            endDate: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            startDate: string;
+            endDate: string;
+        }, {
+            startDate: string;
+            endDate: string;
+        }>;
+        helpfulCount: z.ZodNumber;
+        unhelpfulCount: z.ZodNumber;
+        entries: z.ZodArray<z.ZodObject<{
+            date: z.ZodString;
+            location: z.ZodString;
+            wasHelpful: z.ZodBoolean;
+            userFeedback: z.ZodString;
+            feedbackType: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            date: string;
+            location: string;
+            wasHelpful: boolean;
+            userFeedback: string;
+            feedbackType?: string | undefined;
+        }, {
+            date: string;
+            location: string;
+            wasHelpful: boolean;
+            userFeedback: string;
+            feedbackType?: string | undefined;
+        }>, "many">;
+        hasMore: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        entries: {
+            date: string;
+            location: string;
+            wasHelpful: boolean;
+            userFeedback: string;
+            feedbackType?: string | undefined;
+        }[];
+        hasMore: boolean;
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        helpfulCount: number;
+        unhelpfulCount: number;
+    }, {
+        entries: {
+            date: string;
+            location: string;
+            wasHelpful: boolean;
+            userFeedback: string;
+            feedbackType?: string | undefined;
+        }[];
+        hasMore: boolean;
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        helpfulCount: number;
+        unhelpfulCount: number;
+    }>, Record<never, never>, Record<never, never>>;
+    queryAnalytics: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+        domain: z.ZodString;
+        metric: z.ZodEnum<["pageviews", "visitors", "sessions", "404s"]>;
+        dimensions: z.ZodOptional<z.ZodArray<z.ZodEnum<["path", "referrer"]>, "many">>;
+        filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            field: z.ZodEnum<["path", "referrer"]>;
+            op: z.ZodEnum<["eq", "prefix", "contains"]>;
+            value: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            field: "path" | "referrer";
+            op: "prefix" | "eq" | "contains";
+        }, {
+            value: string;
+            field: "path" | "referrer";
+            op: "prefix" | "eq" | "contains";
+        }>, "many">>;
+        dateRange: z.ZodUnion<[z.ZodString, z.ZodObject<{
+            startDate: z.ZodString;
+            endDate: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            startDate: string;
+            endDate: string;
+        }, {
+            startDate: string;
+            endDate: string;
+        }>]>;
+        granularity: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
+        orderBy: z.ZodOptional<z.ZodObject<{
+            field: z.ZodEnum<["count", "visitors"]>;
+            dir: z.ZodEnum<["asc", "desc"]>;
+        }, "strip", z.ZodTypeAny, {
+            field: "visitors" | "count";
+            dir: "asc" | "desc";
+        }, {
+            field: "visitors" | "count";
+            dir: "asc" | "desc";
+        }>>;
+        limit: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+        domain: string;
+        dateRange: string | {
+            startDate: string;
+            endDate: string;
+        };
+        metric: "pageviews" | "visitors" | "sessions" | "404s";
+        limit?: number | undefined;
+        dimensions?: ("path" | "referrer")[] | undefined;
+        filters?: {
+            value: string;
+            field: "path" | "referrer";
+            op: "prefix" | "eq" | "contains";
+        }[] | undefined;
+        granularity?: "day" | "week" | "month" | undefined;
+        orderBy?: {
+            field: "visitors" | "count";
+            dir: "asc" | "desc";
+        } | undefined;
+    }, {
+        orgId: string;
+        domain: string;
+        dateRange: string | {
+            startDate: string;
+            endDate: string;
+        };
+        metric: "pageviews" | "visitors" | "sessions" | "404s";
+        limit?: number | undefined;
+        dimensions?: ("path" | "referrer")[] | undefined;
+        filters?: {
+            value: string;
+            field: "path" | "referrer";
+            op: "prefix" | "eq" | "contains";
+        }[] | undefined;
+        granularity?: "day" | "week" | "month" | undefined;
+        orderBy?: {
+            field: "visitors" | "count";
+            dir: "asc" | "desc";
+        } | undefined;
+    }>, z.ZodObject<{
+        resolvedDateRange: z.ZodObject<{
+            startDate: z.ZodString;
+            endDate: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            startDate: string;
+            endDate: string;
+        }, {
+            startDate: string;
+            endDate: string;
+        }>;
+        metric: z.ZodEnum<["pageviews", "visitors", "sessions", "404s"]>;
+        dimensions: z.ZodArray<z.ZodEnum<["path", "referrer"]>, "many">;
+        granularity: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
+        rows: z.ZodArray<z.ZodObject<{
+            dimensions: z.ZodRecord<z.ZodString, z.ZodString>;
+            bucket: z.ZodOptional<z.ZodString>;
+            count: z.ZodNumber;
+            visitors: z.ZodOptional<z.ZodNumber>;
+            sessions: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            count: number;
+            dimensions: Record<string, string>;
+            visitors?: number | undefined;
+            sessions?: number | undefined;
+            bucket?: string | undefined;
+        }, {
+            count: number;
+            dimensions: Record<string, string>;
+            visitors?: number | undefined;
+            sessions?: number | undefined;
+            bucket?: string | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        metric: "pageviews" | "visitors" | "sessions" | "404s";
+        dimensions: ("path" | "referrer")[];
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        rows: {
+            count: number;
+            dimensions: Record<string, string>;
+            visitors?: number | undefined;
+            sessions?: number | undefined;
+            bucket?: string | undefined;
+        }[];
+        granularity?: "day" | "week" | "month" | undefined;
+    }, {
+        metric: "pageviews" | "visitors" | "sessions" | "404s";
+        dimensions: ("path" | "referrer")[];
+        resolvedDateRange: {
+            startDate: string;
+            endDate: string;
+        };
+        rows: {
+            count: number;
+            dimensions: Record<string, string>;
+            visitors?: number | undefined;
+            sessions?: number | undefined;
+            bucket?: string | undefined;
+        }[];
+        granularity?: "day" | "week" | "month" | undefined;
+    }>, Record<never, never>, Record<never, never>>;
+    listOrgDocDomains: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+    }, {
+        orgId: string;
+    }>, z.ZodObject<{
+        domains: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        domains: string[];
+    }, {
+        domains: string[];
+    }>, Record<never, never>, Record<never, never>>;
+    listOrgMembers: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+        includeFernEmployees: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+        includeFernEmployees?: boolean | undefined;
+    }, {
+        orgId: string;
+        includeFernEmployees?: boolean | undefined;
+    }>, z.ZodObject<{
+        members: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            email: z.ZodString;
+            roles: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            email: string;
+            roles: string[];
+        }, {
+            name: string;
+            email: string;
+            roles: string[];
+        }>, "many">;
+        count: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        count: number;
+        members: {
+            name: string;
+            email: string;
+            roles: string[];
+        }[];
+    }, {
+        count: number;
+        members: {
+            name: string;
+            email: string;
+            roles: string[];
+        }[];
+    }>, Record<never, never>, Record<never, never>>;
+    getSiteConfig: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+        domain: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+        domain: string;
+    }, {
+        orgId: string;
+        domain: string;
+    }>, z.ZodObject<{
+        domain: z.ZodString;
+        basepath: z.ZodNullable<z.ZodString>;
+        status: z.ZodNullable<z.ZodString>;
+        isPreview: z.ZodBoolean;
+        /** The git repository connected to this docs site, when one exists. */
+        gitRepository: z.ZodNullable<z.ZodObject<{
+            gitUrl: z.ZodString;
+            provider: z.ZodEnum<["github", "gitlab", "other"]>;
+            /** `owner/repo` when the git url points at GitHub, else null. */
+            githubRepository: z.ZodNullable<z.ZodString>;
+            branch: z.ZodNullable<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            gitUrl: string;
+            provider: "github" | "gitlab" | "other";
+            githubRepository: string | null;
+            branch: string | null;
+        }, {
+            gitUrl: string;
+            provider: "github" | "gitlab" | "other";
+            githubRepository: string | null;
+            branch: string | null;
+        }>>;
+        /** True when the queried domain is a customer-owned custom domain (not *.docs.buildwithfern.com). */
+        isCustomDomain: z.ZodBoolean;
+        /** Fern CLI version that published the current deployment, when known. */
+        fernCliVersion: z.ZodNullable<z.ZodString>;
+        /** Connected Postman collection id, when one exists. */
+        postmanCollectionId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        status: string | null;
+        domain: string;
+        basepath: string | null;
+        postmanCollectionId: string | null;
+        isPreview: boolean;
+        gitRepository: {
+            gitUrl: string;
+            provider: "github" | "gitlab" | "other";
+            githubRepository: string | null;
+            branch: string | null;
+        } | null;
+        isCustomDomain: boolean;
+        fernCliVersion: string | null;
+    }, {
+        status: string | null;
+        domain: string;
+        basepath: string | null;
+        postmanCollectionId: string | null;
+        isPreview: boolean;
+        gitRepository: {
+            gitUrl: string;
+            provider: "github" | "gitlab" | "other";
+            githubRepository: string | null;
+            branch: string | null;
+        } | null;
+        isCustomDomain: boolean;
+        fernCliVersion: string | null;
+    }>, Record<never, never>, Record<never, never>>;
+    getSiteSettings: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        orgId: z.ZodString;
+        domain: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        orgId: string;
+        domain: string;
+    }, {
+        orgId: string;
+        domain: string;
+    }>, z.ZodObject<{
+        domain: z.ZodString;
+        basepath: z.ZodNullable<z.ZodString>;
+        /** Default basepath route for multi-basepath domains, when configured. */
+        defaultBasepath: z.ZodNullable<z.ZodString>;
+        /** Basepaths routed on this domain, when configured. */
+        basepaths: z.ZodNullable<z.ZodArray<z.ZodString, "many">>;
+        searchBehavior: z.ZodNullable<z.ZodEnum<["hierarchical", "unified"]>>;
+        passwordProtection: z.ZodObject<{
+            enabled: z.ZodBoolean;
+            /** Number of configured passwords. Passwords themselves are never returned. */
+            passwordCount: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+            passwordCount: number;
+        }, {
+            enabled: boolean;
+            passwordCount: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        domain: string;
+        basepath: string | null;
+        defaultBasepath: string | null;
+        basepaths: string[] | null;
+        searchBehavior: "hierarchical" | "unified" | null;
+        passwordProtection: {
+            enabled: boolean;
+            passwordCount: number;
+        };
+    }, {
+        domain: string;
+        basepath: string | null;
+        defaultBasepath: string | null;
+        basepaths: string[] | null;
+        searchBehavior: "hierarchical" | "unified" | null;
+        passwordProtection: {
+            enabled: boolean;
+            passwordCount: number;
+        };
+    }>, Record<never, never>, Record<never, never>>;
+};
+//# sourceMappingURL=contract.d.ts.map