@fern-api/fdr-sdk 1.2.74-40dc6e178f → 1.2.74-62f00ca999

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/dist/js/client/FdrClient.js +2030 -1802
  2. package/dist/js/client/FdrClient.js.map +1 -1
  3. package/dist/js/client/FdrClient.mjs +2030 -1802
  4. package/dist/js/client/FdrClient.mjs.map +1 -1
  5. package/dist/js/client/types.js +7 -1
  6. package/dist/js/client/types.js.map +1 -1
  7. package/dist/js/client/types.mjs +7 -1
  8. package/dist/js/client/types.mjs.map +1 -1
  9. package/dist/js/converters/index.js +7 -1
  10. package/dist/js/converters/index.js.map +1 -1
  11. package/dist/js/converters/index.mjs +7 -1
  12. package/dist/js/converters/index.mjs.map +1 -1
  13. package/dist/js/docs/index.js +7 -1
  14. package/dist/js/docs/index.js.map +1 -1
  15. package/dist/js/docs/index.mjs +7 -1
  16. package/dist/js/docs/index.mjs.map +1 -1
  17. package/dist/js/index.js +2301 -2073
  18. package/dist/js/index.js.map +1 -1
  19. package/dist/js/index.mjs +2301 -2073
  20. package/dist/js/index.mjs.map +1 -1
  21. package/dist/js/navigation/index.js +7 -1
  22. package/dist/js/navigation/index.js.map +1 -1
  23. package/dist/js/navigation/index.mjs +7 -1
  24. package/dist/js/navigation/index.mjs.map +1 -1
  25. package/dist/js/orpc-client.js +2305 -2015
  26. package/dist/js/orpc-client.js.map +1 -1
  27. package/dist/js/orpc-client.mjs +2272 -2013
  28. package/dist/js/orpc-client.mjs.map +1 -1
  29. package/dist/tsconfig.tsbuildinfo +1 -1
  30. package/dist/types/client/docs-types/db.d.ts +61 -0
  31. package/dist/types/client/docs-types/db.d.ts.map +1 -1
  32. package/dist/types/client/docs-types/read.d.ts +27 -0
  33. package/dist/types/client/docs-types/read.d.ts.map +1 -1
  34. package/dist/types/client/docs-types/shared.d.ts +18 -0
  35. package/dist/types/client/docs-types/shared.d.ts.map +1 -1
  36. package/dist/types/client/docs-types/write.d.ts +16 -0
  37. package/dist/types/client/docs-types/write.d.ts.map +1 -1
  38. package/dist/types/orpc-client/client.d.ts +2 -0
  39. package/dist/types/orpc-client/client.d.ts.map +1 -1
  40. package/dist/types/orpc-client/dashboard-agent/client.d.ts +13 -0
  41. package/dist/types/orpc-client/dashboard-agent/client.d.ts.map +1 -0
  42. package/dist/types/orpc-client/dashboard-agent/contract.d.ts +1444 -0
  43. package/dist/types/orpc-client/dashboard-agent/contract.d.ts.map +1 -0
  44. package/dist/types/orpc-client/dashboard-agent/index.d.ts +3 -0
  45. package/dist/types/orpc-client/dashboard-agent/index.d.ts.map +1 -0
  46. package/dist/types/orpc-client/docs/v1/read/contract.d.ts +18 -0
  47. package/dist/types/orpc-client/docs/v1/read/contract.d.ts.map +1 -1
  48. package/dist/types/orpc-client/docs/v1/write/contract.d.ts +4 -0
  49. package/dist/types/orpc-client/docs/v1/write/contract.d.ts.map +1 -1
  50. package/dist/types/orpc-client/docs/v2/read/contract.d.ts +40 -0
  51. package/dist/types/orpc-client/docs/v2/read/contract.d.ts.map +1 -1
  52. package/dist/types/orpc-client/docs/v2/write/contract.d.ts +8 -0
  53. package/dist/types/orpc-client/docs/v2/write/contract.d.ts.map +1 -1
  54. package/dist/types/orpc-client/docs-ledger/contract.d.ts +56 -0
  55. package/dist/types/orpc-client/docs-ledger/contract.d.ts.map +1 -1
  56. package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts +50 -28
  57. package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts.map +1 -1
  58. package/dist/types/orpc-client/index.d.ts +1 -0
  59. package/dist/types/orpc-client/index.d.ts.map +1 -1
  60. package/package.json +1 -1
@@ -0,0 +1,1444 @@
1
+ import * as z from "zod";
2
+ export declare const DashboardAnalyticsCommonInputSchema: z.ZodObject<{
3
+ orgId: z.ZodString;
4
+ domain: z.ZodString;
5
+ dateRange: z.ZodOptional<z.ZodString>;
6
+ includeInternal: z.ZodOptional<z.ZodBoolean>;
7
+ }, "strip", z.ZodTypeAny, {
8
+ orgId: string;
9
+ domain: string;
10
+ dateRange?: string | undefined;
11
+ includeInternal?: boolean | undefined;
12
+ }, {
13
+ orgId: string;
14
+ domain: string;
15
+ dateRange?: string | undefined;
16
+ includeInternal?: boolean | undefined;
17
+ }>;
18
+ export type DashboardAnalyticsCommonInput = z.infer<typeof DashboardAnalyticsCommonInputSchema>;
19
+ export declare const DashboardFeedbackInputSchema: z.ZodObject<{
20
+ orgId: z.ZodString;
21
+ domain: z.ZodString;
22
+ dateRange: z.ZodOptional<z.ZodString>;
23
+ feedbackType: z.ZodOptional<z.ZodEnum<["page", "code_block", "all"]>>;
24
+ limit: z.ZodOptional<z.ZodNumber>;
25
+ }, "strip", z.ZodTypeAny, {
26
+ orgId: string;
27
+ domain: string;
28
+ limit?: number | undefined;
29
+ dateRange?: string | undefined;
30
+ feedbackType?: "page" | "code_block" | "all" | undefined;
31
+ }, {
32
+ orgId: string;
33
+ domain: string;
34
+ limit?: number | undefined;
35
+ dateRange?: string | undefined;
36
+ feedbackType?: "page" | "code_block" | "all" | undefined;
37
+ }>;
38
+ export type DashboardFeedbackInput = z.infer<typeof DashboardFeedbackInputSchema>;
39
+ export declare const DashboardListOrgDocDomainsInputSchema: z.ZodObject<{
40
+ orgId: z.ZodString;
41
+ }, "strip", z.ZodTypeAny, {
42
+ orgId: string;
43
+ }, {
44
+ orgId: string;
45
+ }>;
46
+ export type DashboardListOrgDocDomainsInput = z.infer<typeof DashboardListOrgDocDomainsInputSchema>;
47
+ export declare const DashboardListOrgMembersInputSchema: z.ZodObject<{
48
+ orgId: z.ZodString;
49
+ includeFernEmployees: z.ZodOptional<z.ZodBoolean>;
50
+ }, "strip", z.ZodTypeAny, {
51
+ orgId: string;
52
+ includeFernEmployees?: boolean | undefined;
53
+ }, {
54
+ orgId: string;
55
+ includeFernEmployees?: boolean | undefined;
56
+ }>;
57
+ export type DashboardListOrgMembersInput = z.infer<typeof DashboardListOrgMembersInputSchema>;
58
+ export declare const DashboardGetSiteConfigInputSchema: z.ZodObject<{
59
+ orgId: z.ZodString;
60
+ domain: z.ZodString;
61
+ }, "strip", z.ZodTypeAny, {
62
+ orgId: string;
63
+ domain: string;
64
+ }, {
65
+ orgId: string;
66
+ domain: string;
67
+ }>;
68
+ export type DashboardGetSiteConfigInput = z.infer<typeof DashboardGetSiteConfigInputSchema>;
69
+ /** Authorizes the caller to edit a docs site (edit or cli permission). Throws FORBIDDEN otherwise. */
70
+ export declare const AuthorizeDocsEditResponseSchema: z.ZodObject<{
71
+ authorized: z.ZodLiteral<true>;
72
+ }, "strip", z.ZodTypeAny, {
73
+ authorized: true;
74
+ }, {
75
+ authorized: true;
76
+ }>;
77
+ export type AuthorizeDocsEditResponse = z.infer<typeof AuthorizeDocsEditResponseSchema>;
78
+ /** Metrics backed by concrete `posthog.events` aggregates (no invented columns). */
79
+ export declare const AnalyticsMetricSchema: z.ZodEnum<["pageviews", "visitors", "sessions", "404s"]>;
80
+ export type AnalyticsMetric = z.infer<typeof AnalyticsMetricSchema>;
81
+ /** Groupable columns. `referrer` is only valid for the pageview-family metrics. */
82
+ export declare const AnalyticsDimensionSchema: z.ZodEnum<["path", "referrer"]>;
83
+ export type AnalyticsDimension = z.infer<typeof AnalyticsDimensionSchema>;
84
+ export declare const AnalyticsGranularitySchema: z.ZodEnum<["day", "week", "month"]>;
85
+ export type AnalyticsGranularity = z.infer<typeof AnalyticsGranularitySchema>;
86
+ export declare const AnalyticsFilterFieldSchema: z.ZodEnum<["path", "referrer"]>;
87
+ export declare const AnalyticsFilterOpSchema: z.ZodEnum<["eq", "prefix", "contains"]>;
88
+ /** A single filter clause; `value` is always bound as a query parameter. */
89
+ export declare const AnalyticsFilterSchema: z.ZodObject<{
90
+ field: z.ZodEnum<["path", "referrer"]>;
91
+ op: z.ZodEnum<["eq", "prefix", "contains"]>;
92
+ value: z.ZodString;
93
+ }, "strip", z.ZodTypeAny, {
94
+ value: string;
95
+ field: "path" | "referrer";
96
+ op: "prefix" | "eq" | "contains";
97
+ }, {
98
+ value: string;
99
+ field: "path" | "referrer";
100
+ op: "prefix" | "eq" | "contains";
101
+ }>;
102
+ export type AnalyticsFilter = z.infer<typeof AnalyticsFilterSchema>;
103
+ export declare const AnalyticsOrderBySchema: z.ZodObject<{
104
+ field: z.ZodEnum<["count", "visitors"]>;
105
+ dir: z.ZodEnum<["asc", "desc"]>;
106
+ }, "strip", z.ZodTypeAny, {
107
+ field: "visitors" | "count";
108
+ dir: "asc" | "desc";
109
+ }, {
110
+ field: "visitors" | "count";
111
+ dir: "asc" | "desc";
112
+ }>;
113
+ /** Either a semantic range string (e.g. `last_n_days:30`) or explicit ISO bounds. */
114
+ export declare const AnalyticsDateRangeSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
115
+ startDate: z.ZodString;
116
+ endDate: z.ZodString;
117
+ }, "strip", z.ZodTypeAny, {
118
+ startDate: string;
119
+ endDate: string;
120
+ }, {
121
+ startDate: string;
122
+ endDate: string;
123
+ }>]>;
124
+ export declare const QueryAnalyticsInputSchema: z.ZodObject<{
125
+ orgId: z.ZodString;
126
+ domain: z.ZodString;
127
+ metric: z.ZodEnum<["pageviews", "visitors", "sessions", "404s"]>;
128
+ dimensions: z.ZodOptional<z.ZodArray<z.ZodEnum<["path", "referrer"]>, "many">>;
129
+ filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
130
+ field: z.ZodEnum<["path", "referrer"]>;
131
+ op: z.ZodEnum<["eq", "prefix", "contains"]>;
132
+ value: z.ZodString;
133
+ }, "strip", z.ZodTypeAny, {
134
+ value: string;
135
+ field: "path" | "referrer";
136
+ op: "prefix" | "eq" | "contains";
137
+ }, {
138
+ value: string;
139
+ field: "path" | "referrer";
140
+ op: "prefix" | "eq" | "contains";
141
+ }>, "many">>;
142
+ dateRange: z.ZodUnion<[z.ZodString, z.ZodObject<{
143
+ startDate: z.ZodString;
144
+ endDate: z.ZodString;
145
+ }, "strip", z.ZodTypeAny, {
146
+ startDate: string;
147
+ endDate: string;
148
+ }, {
149
+ startDate: string;
150
+ endDate: string;
151
+ }>]>;
152
+ granularity: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
153
+ orderBy: z.ZodOptional<z.ZodObject<{
154
+ field: z.ZodEnum<["count", "visitors"]>;
155
+ dir: z.ZodEnum<["asc", "desc"]>;
156
+ }, "strip", z.ZodTypeAny, {
157
+ field: "visitors" | "count";
158
+ dir: "asc" | "desc";
159
+ }, {
160
+ field: "visitors" | "count";
161
+ dir: "asc" | "desc";
162
+ }>>;
163
+ limit: z.ZodOptional<z.ZodNumber>;
164
+ }, "strip", z.ZodTypeAny, {
165
+ orgId: string;
166
+ domain: string;
167
+ dateRange: string | {
168
+ startDate: string;
169
+ endDate: string;
170
+ };
171
+ metric: "pageviews" | "visitors" | "sessions" | "404s";
172
+ limit?: number | undefined;
173
+ dimensions?: ("path" | "referrer")[] | undefined;
174
+ filters?: {
175
+ value: string;
176
+ field: "path" | "referrer";
177
+ op: "prefix" | "eq" | "contains";
178
+ }[] | undefined;
179
+ granularity?: "day" | "week" | "month" | undefined;
180
+ orderBy?: {
181
+ field: "visitors" | "count";
182
+ dir: "asc" | "desc";
183
+ } | undefined;
184
+ }, {
185
+ orgId: string;
186
+ domain: string;
187
+ dateRange: string | {
188
+ startDate: string;
189
+ endDate: string;
190
+ };
191
+ metric: "pageviews" | "visitors" | "sessions" | "404s";
192
+ limit?: number | undefined;
193
+ dimensions?: ("path" | "referrer")[] | undefined;
194
+ filters?: {
195
+ value: string;
196
+ field: "path" | "referrer";
197
+ op: "prefix" | "eq" | "contains";
198
+ }[] | undefined;
199
+ granularity?: "day" | "week" | "month" | undefined;
200
+ orderBy?: {
201
+ field: "visitors" | "count";
202
+ dir: "asc" | "desc";
203
+ } | undefined;
204
+ }>;
205
+ export type QueryAnalyticsInput = z.infer<typeof QueryAnalyticsInputSchema>;
206
+ export declare const ResolvedDateRangeSchema: z.ZodObject<{
207
+ startDate: z.ZodString;
208
+ endDate: z.ZodString;
209
+ }, "strip", z.ZodTypeAny, {
210
+ startDate: string;
211
+ endDate: string;
212
+ }, {
213
+ startDate: string;
214
+ endDate: string;
215
+ }>;
216
+ export type ResolvedDateRange = z.infer<typeof ResolvedDateRangeSchema>;
217
+ export declare const TrafficSummaryResponseSchema: z.ZodObject<{
218
+ resolvedDateRange: z.ZodObject<{
219
+ startDate: z.ZodString;
220
+ endDate: z.ZodString;
221
+ }, "strip", z.ZodTypeAny, {
222
+ startDate: string;
223
+ endDate: string;
224
+ }, {
225
+ startDate: string;
226
+ endDate: string;
227
+ }>;
228
+ metrics: z.ZodObject<{
229
+ visitors: z.ZodNumber;
230
+ pageViews: z.ZodNumber;
231
+ sessions: z.ZodNumber;
232
+ }, "strip", z.ZodTypeAny, {
233
+ visitors: number;
234
+ sessions: number;
235
+ pageViews: number;
236
+ }, {
237
+ visitors: number;
238
+ sessions: number;
239
+ pageViews: number;
240
+ }>;
241
+ baseSiteUrl: z.ZodString;
242
+ }, "strip", z.ZodTypeAny, {
243
+ resolvedDateRange: {
244
+ startDate: string;
245
+ endDate: string;
246
+ };
247
+ metrics: {
248
+ visitors: number;
249
+ sessions: number;
250
+ pageViews: number;
251
+ };
252
+ baseSiteUrl: string;
253
+ }, {
254
+ resolvedDateRange: {
255
+ startDate: string;
256
+ endDate: string;
257
+ };
258
+ metrics: {
259
+ visitors: number;
260
+ sessions: number;
261
+ pageViews: number;
262
+ };
263
+ baseSiteUrl: string;
264
+ }>;
265
+ export type TrafficSummaryResponse = z.infer<typeof TrafficSummaryResponseSchema>;
266
+ export declare const TopPagesResponseSchema: z.ZodObject<{
267
+ resolvedDateRange: z.ZodObject<{
268
+ startDate: z.ZodString;
269
+ endDate: z.ZodString;
270
+ }, "strip", z.ZodTypeAny, {
271
+ startDate: string;
272
+ endDate: string;
273
+ }, {
274
+ startDate: string;
275
+ endDate: string;
276
+ }>;
277
+ topPages: z.ZodArray<z.ZodObject<{
278
+ path: z.ZodString;
279
+ visitors: z.ZodNumber;
280
+ views: z.ZodNumber;
281
+ }, "strip", z.ZodTypeAny, {
282
+ path: string;
283
+ visitors: number;
284
+ views: number;
285
+ }, {
286
+ path: string;
287
+ visitors: number;
288
+ views: number;
289
+ }>, "many">;
290
+ }, "strip", z.ZodTypeAny, {
291
+ resolvedDateRange: {
292
+ startDate: string;
293
+ endDate: string;
294
+ };
295
+ topPages: {
296
+ path: string;
297
+ visitors: number;
298
+ views: number;
299
+ }[];
300
+ }, {
301
+ resolvedDateRange: {
302
+ startDate: string;
303
+ endDate: string;
304
+ };
305
+ topPages: {
306
+ path: string;
307
+ visitors: number;
308
+ views: number;
309
+ }[];
310
+ }>;
311
+ export type TopPagesResponse = z.infer<typeof TopPagesResponseSchema>;
312
+ export declare const Pages404ResponseSchema: z.ZodObject<{
313
+ resolvedDateRange: z.ZodObject<{
314
+ startDate: z.ZodString;
315
+ endDate: z.ZodString;
316
+ }, "strip", z.ZodTypeAny, {
317
+ startDate: string;
318
+ endDate: string;
319
+ }, {
320
+ startDate: string;
321
+ endDate: string;
322
+ }>;
323
+ pages404: z.ZodArray<z.ZodObject<{
324
+ path: z.ZodString;
325
+ count: z.ZodNumber;
326
+ }, "strip", z.ZodTypeAny, {
327
+ path: string;
328
+ count: number;
329
+ }, {
330
+ path: string;
331
+ count: number;
332
+ }>, "many">;
333
+ }, "strip", z.ZodTypeAny, {
334
+ resolvedDateRange: {
335
+ startDate: string;
336
+ endDate: string;
337
+ };
338
+ pages404: {
339
+ path: string;
340
+ count: number;
341
+ }[];
342
+ }, {
343
+ resolvedDateRange: {
344
+ startDate: string;
345
+ endDate: string;
346
+ };
347
+ pages404: {
348
+ path: string;
349
+ count: number;
350
+ }[];
351
+ }>;
352
+ export type Pages404Response = z.infer<typeof Pages404ResponseSchema>;
353
+ export declare const ReferringDomainsResponseSchema: z.ZodObject<{
354
+ resolvedDateRange: z.ZodObject<{
355
+ startDate: z.ZodString;
356
+ endDate: z.ZodString;
357
+ }, "strip", z.ZodTypeAny, {
358
+ startDate: string;
359
+ endDate: string;
360
+ }, {
361
+ startDate: string;
362
+ endDate: string;
363
+ }>;
364
+ referringDomains: z.ZodArray<z.ZodObject<{
365
+ domain: z.ZodString;
366
+ visitors: z.ZodNumber;
367
+ views: z.ZodNumber;
368
+ }, "strip", z.ZodTypeAny, {
369
+ domain: string;
370
+ visitors: number;
371
+ views: number;
372
+ }, {
373
+ domain: string;
374
+ visitors: number;
375
+ views: number;
376
+ }>, "many">;
377
+ }, "strip", z.ZodTypeAny, {
378
+ resolvedDateRange: {
379
+ startDate: string;
380
+ endDate: string;
381
+ };
382
+ referringDomains: {
383
+ domain: string;
384
+ visitors: number;
385
+ views: number;
386
+ }[];
387
+ }, {
388
+ resolvedDateRange: {
389
+ startDate: string;
390
+ endDate: string;
391
+ };
392
+ referringDomains: {
393
+ domain: string;
394
+ visitors: number;
395
+ views: number;
396
+ }[];
397
+ }>;
398
+ export type ReferringDomainsResponse = z.infer<typeof ReferringDomainsResponseSchema>;
399
+ export declare const LlmBotTrafficResponseSchema: z.ZodObject<{
400
+ resolvedDateRange: z.ZodObject<{
401
+ startDate: z.ZodString;
402
+ endDate: z.ZodString;
403
+ }, "strip", z.ZodTypeAny, {
404
+ startDate: string;
405
+ endDate: string;
406
+ }, {
407
+ startDate: string;
408
+ endDate: string;
409
+ }>;
410
+ providers: z.ZodArray<z.ZodObject<{
411
+ provider: z.ZodString;
412
+ count: z.ZodNumber;
413
+ }, "strip", z.ZodTypeAny, {
414
+ count: number;
415
+ provider: string;
416
+ }, {
417
+ count: number;
418
+ provider: string;
419
+ }>, "many">;
420
+ }, "strip", z.ZodTypeAny, {
421
+ resolvedDateRange: {
422
+ startDate: string;
423
+ endDate: string;
424
+ };
425
+ providers: {
426
+ count: number;
427
+ provider: string;
428
+ }[];
429
+ }, {
430
+ resolvedDateRange: {
431
+ startDate: string;
432
+ endDate: string;
433
+ };
434
+ providers: {
435
+ count: number;
436
+ provider: string;
437
+ }[];
438
+ }>;
439
+ export type LlmBotTrafficResponse = z.infer<typeof LlmBotTrafficResponseSchema>;
440
+ export declare const RecentFeedbackResponseSchema: z.ZodObject<{
441
+ resolvedDateRange: z.ZodObject<{
442
+ startDate: z.ZodString;
443
+ endDate: z.ZodString;
444
+ }, "strip", z.ZodTypeAny, {
445
+ startDate: string;
446
+ endDate: string;
447
+ }, {
448
+ startDate: string;
449
+ endDate: string;
450
+ }>;
451
+ helpfulCount: z.ZodNumber;
452
+ unhelpfulCount: z.ZodNumber;
453
+ entries: z.ZodArray<z.ZodObject<{
454
+ date: z.ZodString;
455
+ location: z.ZodString;
456
+ wasHelpful: z.ZodBoolean;
457
+ userFeedback: z.ZodString;
458
+ feedbackType: z.ZodOptional<z.ZodString>;
459
+ }, "strip", z.ZodTypeAny, {
460
+ date: string;
461
+ location: string;
462
+ wasHelpful: boolean;
463
+ userFeedback: string;
464
+ feedbackType?: string | undefined;
465
+ }, {
466
+ date: string;
467
+ location: string;
468
+ wasHelpful: boolean;
469
+ userFeedback: string;
470
+ feedbackType?: string | undefined;
471
+ }>, "many">;
472
+ hasMore: z.ZodBoolean;
473
+ }, "strip", z.ZodTypeAny, {
474
+ entries: {
475
+ date: string;
476
+ location: string;
477
+ wasHelpful: boolean;
478
+ userFeedback: string;
479
+ feedbackType?: string | undefined;
480
+ }[];
481
+ hasMore: boolean;
482
+ resolvedDateRange: {
483
+ startDate: string;
484
+ endDate: string;
485
+ };
486
+ helpfulCount: number;
487
+ unhelpfulCount: number;
488
+ }, {
489
+ entries: {
490
+ date: string;
491
+ location: string;
492
+ wasHelpful: boolean;
493
+ userFeedback: string;
494
+ feedbackType?: string | undefined;
495
+ }[];
496
+ hasMore: boolean;
497
+ resolvedDateRange: {
498
+ startDate: string;
499
+ endDate: string;
500
+ };
501
+ helpfulCount: number;
502
+ unhelpfulCount: number;
503
+ }>;
504
+ export type RecentFeedbackResponse = z.infer<typeof RecentFeedbackResponseSchema>;
505
+ export declare const OrgDocDomainsResponseSchema: z.ZodObject<{
506
+ domains: z.ZodArray<z.ZodString, "many">;
507
+ }, "strip", z.ZodTypeAny, {
508
+ domains: string[];
509
+ }, {
510
+ domains: string[];
511
+ }>;
512
+ export type OrgDocDomainsResponse = z.infer<typeof OrgDocDomainsResponseSchema>;
513
+ export declare const QueryAnalyticsResponseSchema: z.ZodObject<{
514
+ resolvedDateRange: z.ZodObject<{
515
+ startDate: z.ZodString;
516
+ endDate: z.ZodString;
517
+ }, "strip", z.ZodTypeAny, {
518
+ startDate: string;
519
+ endDate: string;
520
+ }, {
521
+ startDate: string;
522
+ endDate: string;
523
+ }>;
524
+ metric: z.ZodEnum<["pageviews", "visitors", "sessions", "404s"]>;
525
+ dimensions: z.ZodArray<z.ZodEnum<["path", "referrer"]>, "many">;
526
+ granularity: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
527
+ rows: z.ZodArray<z.ZodObject<{
528
+ dimensions: z.ZodRecord<z.ZodString, z.ZodString>;
529
+ bucket: z.ZodOptional<z.ZodString>;
530
+ count: z.ZodNumber;
531
+ visitors: z.ZodOptional<z.ZodNumber>;
532
+ sessions: z.ZodOptional<z.ZodNumber>;
533
+ }, "strip", z.ZodTypeAny, {
534
+ count: number;
535
+ dimensions: Record<string, string>;
536
+ visitors?: number | undefined;
537
+ sessions?: number | undefined;
538
+ bucket?: string | undefined;
539
+ }, {
540
+ count: number;
541
+ dimensions: Record<string, string>;
542
+ visitors?: number | undefined;
543
+ sessions?: number | undefined;
544
+ bucket?: string | undefined;
545
+ }>, "many">;
546
+ }, "strip", z.ZodTypeAny, {
547
+ metric: "pageviews" | "visitors" | "sessions" | "404s";
548
+ dimensions: ("path" | "referrer")[];
549
+ resolvedDateRange: {
550
+ startDate: string;
551
+ endDate: string;
552
+ };
553
+ rows: {
554
+ count: number;
555
+ dimensions: Record<string, string>;
556
+ visitors?: number | undefined;
557
+ sessions?: number | undefined;
558
+ bucket?: string | undefined;
559
+ }[];
560
+ granularity?: "day" | "week" | "month" | undefined;
561
+ }, {
562
+ metric: "pageviews" | "visitors" | "sessions" | "404s";
563
+ dimensions: ("path" | "referrer")[];
564
+ resolvedDateRange: {
565
+ startDate: string;
566
+ endDate: string;
567
+ };
568
+ rows: {
569
+ count: number;
570
+ dimensions: Record<string, string>;
571
+ visitors?: number | undefined;
572
+ sessions?: number | undefined;
573
+ bucket?: string | undefined;
574
+ }[];
575
+ granularity?: "day" | "week" | "month" | undefined;
576
+ }>;
577
+ export type QueryAnalyticsResponse = z.infer<typeof QueryAnalyticsResponseSchema>;
578
+ export declare const OrgMembersResponseSchema: z.ZodObject<{
579
+ members: z.ZodArray<z.ZodObject<{
580
+ name: z.ZodString;
581
+ email: z.ZodString;
582
+ roles: z.ZodArray<z.ZodString, "many">;
583
+ }, "strip", z.ZodTypeAny, {
584
+ name: string;
585
+ email: string;
586
+ roles: string[];
587
+ }, {
588
+ name: string;
589
+ email: string;
590
+ roles: string[];
591
+ }>, "many">;
592
+ count: z.ZodNumber;
593
+ }, "strip", z.ZodTypeAny, {
594
+ count: number;
595
+ members: {
596
+ name: string;
597
+ email: string;
598
+ roles: string[];
599
+ }[];
600
+ }, {
601
+ count: number;
602
+ members: {
603
+ name: string;
604
+ email: string;
605
+ roles: string[];
606
+ }[];
607
+ }>;
608
+ export type OrgMembersResponse = z.infer<typeof OrgMembersResponseSchema>;
609
+ export declare const SiteGitRepositorySchema: z.ZodObject<{
610
+ gitUrl: z.ZodString;
611
+ provider: z.ZodEnum<["github", "gitlab", "other"]>;
612
+ /** `owner/repo` when the git url points at GitHub, else null. */
613
+ githubRepository: z.ZodNullable<z.ZodString>;
614
+ branch: z.ZodNullable<z.ZodString>;
615
+ }, "strip", z.ZodTypeAny, {
616
+ gitUrl: string;
617
+ provider: "github" | "gitlab" | "other";
618
+ githubRepository: string | null;
619
+ branch: string | null;
620
+ }, {
621
+ gitUrl: string;
622
+ provider: "github" | "gitlab" | "other";
623
+ githubRepository: string | null;
624
+ branch: string | null;
625
+ }>;
626
+ export type SiteGitRepository = z.infer<typeof SiteGitRepositorySchema>;
627
+ export declare const SiteConfigResponseSchema: z.ZodObject<{
628
+ domain: z.ZodString;
629
+ basepath: z.ZodNullable<z.ZodString>;
630
+ status: z.ZodNullable<z.ZodString>;
631
+ isPreview: z.ZodBoolean;
632
+ /** The git repository connected to this docs site, when one exists. */
633
+ gitRepository: z.ZodNullable<z.ZodObject<{
634
+ gitUrl: z.ZodString;
635
+ provider: z.ZodEnum<["github", "gitlab", "other"]>;
636
+ /** `owner/repo` when the git url points at GitHub, else null. */
637
+ githubRepository: z.ZodNullable<z.ZodString>;
638
+ branch: z.ZodNullable<z.ZodString>;
639
+ }, "strip", z.ZodTypeAny, {
640
+ gitUrl: string;
641
+ provider: "github" | "gitlab" | "other";
642
+ githubRepository: string | null;
643
+ branch: string | null;
644
+ }, {
645
+ gitUrl: string;
646
+ provider: "github" | "gitlab" | "other";
647
+ githubRepository: string | null;
648
+ branch: string | null;
649
+ }>>;
650
+ /** True when the queried domain is a customer-owned custom domain (not *.docs.buildwithfern.com). */
651
+ isCustomDomain: z.ZodBoolean;
652
+ /** Fern CLI version that published the current deployment, when known. */
653
+ fernCliVersion: z.ZodNullable<z.ZodString>;
654
+ /** Connected Postman collection id, when one exists. */
655
+ postmanCollectionId: z.ZodNullable<z.ZodString>;
656
+ }, "strip", z.ZodTypeAny, {
657
+ status: string | null;
658
+ domain: string;
659
+ basepath: string | null;
660
+ postmanCollectionId: string | null;
661
+ isPreview: boolean;
662
+ gitRepository: {
663
+ gitUrl: string;
664
+ provider: "github" | "gitlab" | "other";
665
+ githubRepository: string | null;
666
+ branch: string | null;
667
+ } | null;
668
+ isCustomDomain: boolean;
669
+ fernCliVersion: string | null;
670
+ }, {
671
+ status: string | null;
672
+ domain: string;
673
+ basepath: string | null;
674
+ postmanCollectionId: string | null;
675
+ isPreview: boolean;
676
+ gitRepository: {
677
+ gitUrl: string;
678
+ provider: "github" | "gitlab" | "other";
679
+ githubRepository: string | null;
680
+ branch: string | null;
681
+ } | null;
682
+ isCustomDomain: boolean;
683
+ fernCliVersion: string | null;
684
+ }>;
685
+ export type SiteConfigResponse = z.infer<typeof SiteConfigResponseSchema>;
686
+ export declare const SitePasswordProtectionSchema: z.ZodObject<{
687
+ enabled: z.ZodBoolean;
688
+ /** Number of configured passwords. Passwords themselves are never returned. */
689
+ passwordCount: z.ZodNumber;
690
+ }, "strip", z.ZodTypeAny, {
691
+ enabled: boolean;
692
+ passwordCount: number;
693
+ }, {
694
+ enabled: boolean;
695
+ passwordCount: number;
696
+ }>;
697
+ export type SitePasswordProtection = z.infer<typeof SitePasswordProtectionSchema>;
698
+ export declare const SiteSettingsResponseSchema: z.ZodObject<{
699
+ domain: z.ZodString;
700
+ basepath: z.ZodNullable<z.ZodString>;
701
+ /** Default basepath route for multi-basepath domains, when configured. */
702
+ defaultBasepath: z.ZodNullable<z.ZodString>;
703
+ /** Basepaths routed on this domain, when configured. */
704
+ basepaths: z.ZodNullable<z.ZodArray<z.ZodString, "many">>;
705
+ searchBehavior: z.ZodNullable<z.ZodEnum<["hierarchical", "unified"]>>;
706
+ passwordProtection: z.ZodObject<{
707
+ enabled: z.ZodBoolean;
708
+ /** Number of configured passwords. Passwords themselves are never returned. */
709
+ passwordCount: z.ZodNumber;
710
+ }, "strip", z.ZodTypeAny, {
711
+ enabled: boolean;
712
+ passwordCount: number;
713
+ }, {
714
+ enabled: boolean;
715
+ passwordCount: number;
716
+ }>;
717
+ }, "strip", z.ZodTypeAny, {
718
+ domain: string;
719
+ basepath: string | null;
720
+ defaultBasepath: string | null;
721
+ basepaths: string[] | null;
722
+ searchBehavior: "hierarchical" | "unified" | null;
723
+ passwordProtection: {
724
+ enabled: boolean;
725
+ passwordCount: number;
726
+ };
727
+ }, {
728
+ domain: string;
729
+ basepath: string | null;
730
+ defaultBasepath: string | null;
731
+ basepaths: string[] | null;
732
+ searchBehavior: "hierarchical" | "unified" | null;
733
+ passwordProtection: {
734
+ enabled: boolean;
735
+ passwordCount: number;
736
+ };
737
+ }>;
738
+ export type SiteSettingsResponse = z.infer<typeof SiteSettingsResponseSchema>;
739
+ export declare const dashboardAgentContract: {
740
+ getTrafficSummary: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
741
+ orgId: z.ZodString;
742
+ domain: z.ZodString;
743
+ dateRange: z.ZodOptional<z.ZodString>;
744
+ includeInternal: z.ZodOptional<z.ZodBoolean>;
745
+ }, "strip", z.ZodTypeAny, {
746
+ orgId: string;
747
+ domain: string;
748
+ dateRange?: string | undefined;
749
+ includeInternal?: boolean | undefined;
750
+ }, {
751
+ orgId: string;
752
+ domain: string;
753
+ dateRange?: string | undefined;
754
+ includeInternal?: boolean | undefined;
755
+ }>, z.ZodObject<{
756
+ resolvedDateRange: z.ZodObject<{
757
+ startDate: z.ZodString;
758
+ endDate: z.ZodString;
759
+ }, "strip", z.ZodTypeAny, {
760
+ startDate: string;
761
+ endDate: string;
762
+ }, {
763
+ startDate: string;
764
+ endDate: string;
765
+ }>;
766
+ metrics: z.ZodObject<{
767
+ visitors: z.ZodNumber;
768
+ pageViews: z.ZodNumber;
769
+ sessions: z.ZodNumber;
770
+ }, "strip", z.ZodTypeAny, {
771
+ visitors: number;
772
+ sessions: number;
773
+ pageViews: number;
774
+ }, {
775
+ visitors: number;
776
+ sessions: number;
777
+ pageViews: number;
778
+ }>;
779
+ baseSiteUrl: z.ZodString;
780
+ }, "strip", z.ZodTypeAny, {
781
+ resolvedDateRange: {
782
+ startDate: string;
783
+ endDate: string;
784
+ };
785
+ metrics: {
786
+ visitors: number;
787
+ sessions: number;
788
+ pageViews: number;
789
+ };
790
+ baseSiteUrl: string;
791
+ }, {
792
+ resolvedDateRange: {
793
+ startDate: string;
794
+ endDate: string;
795
+ };
796
+ metrics: {
797
+ visitors: number;
798
+ sessions: number;
799
+ pageViews: number;
800
+ };
801
+ baseSiteUrl: string;
802
+ }>, Record<never, never>, Record<never, never>>;
803
+ getTopPages: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
804
+ orgId: z.ZodString;
805
+ domain: z.ZodString;
806
+ dateRange: z.ZodOptional<z.ZodString>;
807
+ includeInternal: z.ZodOptional<z.ZodBoolean>;
808
+ }, "strip", z.ZodTypeAny, {
809
+ orgId: string;
810
+ domain: string;
811
+ dateRange?: string | undefined;
812
+ includeInternal?: boolean | undefined;
813
+ }, {
814
+ orgId: string;
815
+ domain: string;
816
+ dateRange?: string | undefined;
817
+ includeInternal?: boolean | undefined;
818
+ }>, z.ZodObject<{
819
+ resolvedDateRange: z.ZodObject<{
820
+ startDate: z.ZodString;
821
+ endDate: z.ZodString;
822
+ }, "strip", z.ZodTypeAny, {
823
+ startDate: string;
824
+ endDate: string;
825
+ }, {
826
+ startDate: string;
827
+ endDate: string;
828
+ }>;
829
+ topPages: z.ZodArray<z.ZodObject<{
830
+ path: z.ZodString;
831
+ visitors: z.ZodNumber;
832
+ views: z.ZodNumber;
833
+ }, "strip", z.ZodTypeAny, {
834
+ path: string;
835
+ visitors: number;
836
+ views: number;
837
+ }, {
838
+ path: string;
839
+ visitors: number;
840
+ views: number;
841
+ }>, "many">;
842
+ }, "strip", z.ZodTypeAny, {
843
+ resolvedDateRange: {
844
+ startDate: string;
845
+ endDate: string;
846
+ };
847
+ topPages: {
848
+ path: string;
849
+ visitors: number;
850
+ views: number;
851
+ }[];
852
+ }, {
853
+ resolvedDateRange: {
854
+ startDate: string;
855
+ endDate: string;
856
+ };
857
+ topPages: {
858
+ path: string;
859
+ visitors: number;
860
+ views: number;
861
+ }[];
862
+ }>, Record<never, never>, Record<never, never>>;
863
+ get404Pages: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
864
+ orgId: z.ZodString;
865
+ domain: z.ZodString;
866
+ dateRange: z.ZodOptional<z.ZodString>;
867
+ includeInternal: z.ZodOptional<z.ZodBoolean>;
868
+ }, "strip", z.ZodTypeAny, {
869
+ orgId: string;
870
+ domain: string;
871
+ dateRange?: string | undefined;
872
+ includeInternal?: boolean | undefined;
873
+ }, {
874
+ orgId: string;
875
+ domain: string;
876
+ dateRange?: string | undefined;
877
+ includeInternal?: boolean | undefined;
878
+ }>, z.ZodObject<{
879
+ resolvedDateRange: z.ZodObject<{
880
+ startDate: z.ZodString;
881
+ endDate: z.ZodString;
882
+ }, "strip", z.ZodTypeAny, {
883
+ startDate: string;
884
+ endDate: string;
885
+ }, {
886
+ startDate: string;
887
+ endDate: string;
888
+ }>;
889
+ pages404: z.ZodArray<z.ZodObject<{
890
+ path: z.ZodString;
891
+ count: z.ZodNumber;
892
+ }, "strip", z.ZodTypeAny, {
893
+ path: string;
894
+ count: number;
895
+ }, {
896
+ path: string;
897
+ count: number;
898
+ }>, "many">;
899
+ }, "strip", z.ZodTypeAny, {
900
+ resolvedDateRange: {
901
+ startDate: string;
902
+ endDate: string;
903
+ };
904
+ pages404: {
905
+ path: string;
906
+ count: number;
907
+ }[];
908
+ }, {
909
+ resolvedDateRange: {
910
+ startDate: string;
911
+ endDate: string;
912
+ };
913
+ pages404: {
914
+ path: string;
915
+ count: number;
916
+ }[];
917
+ }>, Record<never, never>, Record<never, never>>;
918
+ getReferringDomains: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
919
+ orgId: z.ZodString;
920
+ domain: z.ZodString;
921
+ dateRange: z.ZodOptional<z.ZodString>;
922
+ includeInternal: z.ZodOptional<z.ZodBoolean>;
923
+ }, "strip", z.ZodTypeAny, {
924
+ orgId: string;
925
+ domain: string;
926
+ dateRange?: string | undefined;
927
+ includeInternal?: boolean | undefined;
928
+ }, {
929
+ orgId: string;
930
+ domain: string;
931
+ dateRange?: string | undefined;
932
+ includeInternal?: boolean | undefined;
933
+ }>, z.ZodObject<{
934
+ resolvedDateRange: z.ZodObject<{
935
+ startDate: z.ZodString;
936
+ endDate: z.ZodString;
937
+ }, "strip", z.ZodTypeAny, {
938
+ startDate: string;
939
+ endDate: string;
940
+ }, {
941
+ startDate: string;
942
+ endDate: string;
943
+ }>;
944
+ referringDomains: z.ZodArray<z.ZodObject<{
945
+ domain: z.ZodString;
946
+ visitors: z.ZodNumber;
947
+ views: z.ZodNumber;
948
+ }, "strip", z.ZodTypeAny, {
949
+ domain: string;
950
+ visitors: number;
951
+ views: number;
952
+ }, {
953
+ domain: string;
954
+ visitors: number;
955
+ views: number;
956
+ }>, "many">;
957
+ }, "strip", z.ZodTypeAny, {
958
+ resolvedDateRange: {
959
+ startDate: string;
960
+ endDate: string;
961
+ };
962
+ referringDomains: {
963
+ domain: string;
964
+ visitors: number;
965
+ views: number;
966
+ }[];
967
+ }, {
968
+ resolvedDateRange: {
969
+ startDate: string;
970
+ endDate: string;
971
+ };
972
+ referringDomains: {
973
+ domain: string;
974
+ visitors: number;
975
+ views: number;
976
+ }[];
977
+ }>, Record<never, never>, Record<never, never>>;
978
+ getLlmBotTraffic: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
979
+ orgId: z.ZodString;
980
+ domain: z.ZodString;
981
+ dateRange: z.ZodOptional<z.ZodString>;
982
+ includeInternal: z.ZodOptional<z.ZodBoolean>;
983
+ }, "strip", z.ZodTypeAny, {
984
+ orgId: string;
985
+ domain: string;
986
+ dateRange?: string | undefined;
987
+ includeInternal?: boolean | undefined;
988
+ }, {
989
+ orgId: string;
990
+ domain: string;
991
+ dateRange?: string | undefined;
992
+ includeInternal?: boolean | undefined;
993
+ }>, z.ZodObject<{
994
+ resolvedDateRange: z.ZodObject<{
995
+ startDate: z.ZodString;
996
+ endDate: z.ZodString;
997
+ }, "strip", z.ZodTypeAny, {
998
+ startDate: string;
999
+ endDate: string;
1000
+ }, {
1001
+ startDate: string;
1002
+ endDate: string;
1003
+ }>;
1004
+ providers: z.ZodArray<z.ZodObject<{
1005
+ provider: z.ZodString;
1006
+ count: z.ZodNumber;
1007
+ }, "strip", z.ZodTypeAny, {
1008
+ count: number;
1009
+ provider: string;
1010
+ }, {
1011
+ count: number;
1012
+ provider: string;
1013
+ }>, "many">;
1014
+ }, "strip", z.ZodTypeAny, {
1015
+ resolvedDateRange: {
1016
+ startDate: string;
1017
+ endDate: string;
1018
+ };
1019
+ providers: {
1020
+ count: number;
1021
+ provider: string;
1022
+ }[];
1023
+ }, {
1024
+ resolvedDateRange: {
1025
+ startDate: string;
1026
+ endDate: string;
1027
+ };
1028
+ providers: {
1029
+ count: number;
1030
+ provider: string;
1031
+ }[];
1032
+ }>, Record<never, never>, Record<never, never>>;
1033
+ getRecentFeedback: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
1034
+ orgId: z.ZodString;
1035
+ domain: z.ZodString;
1036
+ dateRange: z.ZodOptional<z.ZodString>;
1037
+ feedbackType: z.ZodOptional<z.ZodEnum<["page", "code_block", "all"]>>;
1038
+ limit: z.ZodOptional<z.ZodNumber>;
1039
+ }, "strip", z.ZodTypeAny, {
1040
+ orgId: string;
1041
+ domain: string;
1042
+ limit?: number | undefined;
1043
+ dateRange?: string | undefined;
1044
+ feedbackType?: "page" | "code_block" | "all" | undefined;
1045
+ }, {
1046
+ orgId: string;
1047
+ domain: string;
1048
+ limit?: number | undefined;
1049
+ dateRange?: string | undefined;
1050
+ feedbackType?: "page" | "code_block" | "all" | undefined;
1051
+ }>, z.ZodObject<{
1052
+ resolvedDateRange: z.ZodObject<{
1053
+ startDate: z.ZodString;
1054
+ endDate: z.ZodString;
1055
+ }, "strip", z.ZodTypeAny, {
1056
+ startDate: string;
1057
+ endDate: string;
1058
+ }, {
1059
+ startDate: string;
1060
+ endDate: string;
1061
+ }>;
1062
+ helpfulCount: z.ZodNumber;
1063
+ unhelpfulCount: z.ZodNumber;
1064
+ entries: z.ZodArray<z.ZodObject<{
1065
+ date: z.ZodString;
1066
+ location: z.ZodString;
1067
+ wasHelpful: z.ZodBoolean;
1068
+ userFeedback: z.ZodString;
1069
+ feedbackType: z.ZodOptional<z.ZodString>;
1070
+ }, "strip", z.ZodTypeAny, {
1071
+ date: string;
1072
+ location: string;
1073
+ wasHelpful: boolean;
1074
+ userFeedback: string;
1075
+ feedbackType?: string | undefined;
1076
+ }, {
1077
+ date: string;
1078
+ location: string;
1079
+ wasHelpful: boolean;
1080
+ userFeedback: string;
1081
+ feedbackType?: string | undefined;
1082
+ }>, "many">;
1083
+ hasMore: z.ZodBoolean;
1084
+ }, "strip", z.ZodTypeAny, {
1085
+ entries: {
1086
+ date: string;
1087
+ location: string;
1088
+ wasHelpful: boolean;
1089
+ userFeedback: string;
1090
+ feedbackType?: string | undefined;
1091
+ }[];
1092
+ hasMore: boolean;
1093
+ resolvedDateRange: {
1094
+ startDate: string;
1095
+ endDate: string;
1096
+ };
1097
+ helpfulCount: number;
1098
+ unhelpfulCount: number;
1099
+ }, {
1100
+ entries: {
1101
+ date: string;
1102
+ location: string;
1103
+ wasHelpful: boolean;
1104
+ userFeedback: string;
1105
+ feedbackType?: string | undefined;
1106
+ }[];
1107
+ hasMore: boolean;
1108
+ resolvedDateRange: {
1109
+ startDate: string;
1110
+ endDate: string;
1111
+ };
1112
+ helpfulCount: number;
1113
+ unhelpfulCount: number;
1114
+ }>, Record<never, never>, Record<never, never>>;
1115
+ queryAnalytics: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
1116
+ orgId: z.ZodString;
1117
+ domain: z.ZodString;
1118
+ metric: z.ZodEnum<["pageviews", "visitors", "sessions", "404s"]>;
1119
+ dimensions: z.ZodOptional<z.ZodArray<z.ZodEnum<["path", "referrer"]>, "many">>;
1120
+ filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
1121
+ field: z.ZodEnum<["path", "referrer"]>;
1122
+ op: z.ZodEnum<["eq", "prefix", "contains"]>;
1123
+ value: z.ZodString;
1124
+ }, "strip", z.ZodTypeAny, {
1125
+ value: string;
1126
+ field: "path" | "referrer";
1127
+ op: "prefix" | "eq" | "contains";
1128
+ }, {
1129
+ value: string;
1130
+ field: "path" | "referrer";
1131
+ op: "prefix" | "eq" | "contains";
1132
+ }>, "many">>;
1133
+ dateRange: z.ZodUnion<[z.ZodString, z.ZodObject<{
1134
+ startDate: z.ZodString;
1135
+ endDate: z.ZodString;
1136
+ }, "strip", z.ZodTypeAny, {
1137
+ startDate: string;
1138
+ endDate: string;
1139
+ }, {
1140
+ startDate: string;
1141
+ endDate: string;
1142
+ }>]>;
1143
+ granularity: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
1144
+ orderBy: z.ZodOptional<z.ZodObject<{
1145
+ field: z.ZodEnum<["count", "visitors"]>;
1146
+ dir: z.ZodEnum<["asc", "desc"]>;
1147
+ }, "strip", z.ZodTypeAny, {
1148
+ field: "visitors" | "count";
1149
+ dir: "asc" | "desc";
1150
+ }, {
1151
+ field: "visitors" | "count";
1152
+ dir: "asc" | "desc";
1153
+ }>>;
1154
+ limit: z.ZodOptional<z.ZodNumber>;
1155
+ }, "strip", z.ZodTypeAny, {
1156
+ orgId: string;
1157
+ domain: string;
1158
+ dateRange: string | {
1159
+ startDate: string;
1160
+ endDate: string;
1161
+ };
1162
+ metric: "pageviews" | "visitors" | "sessions" | "404s";
1163
+ limit?: number | undefined;
1164
+ dimensions?: ("path" | "referrer")[] | undefined;
1165
+ filters?: {
1166
+ value: string;
1167
+ field: "path" | "referrer";
1168
+ op: "prefix" | "eq" | "contains";
1169
+ }[] | undefined;
1170
+ granularity?: "day" | "week" | "month" | undefined;
1171
+ orderBy?: {
1172
+ field: "visitors" | "count";
1173
+ dir: "asc" | "desc";
1174
+ } | undefined;
1175
+ }, {
1176
+ orgId: string;
1177
+ domain: string;
1178
+ dateRange: string | {
1179
+ startDate: string;
1180
+ endDate: string;
1181
+ };
1182
+ metric: "pageviews" | "visitors" | "sessions" | "404s";
1183
+ limit?: number | undefined;
1184
+ dimensions?: ("path" | "referrer")[] | undefined;
1185
+ filters?: {
1186
+ value: string;
1187
+ field: "path" | "referrer";
1188
+ op: "prefix" | "eq" | "contains";
1189
+ }[] | undefined;
1190
+ granularity?: "day" | "week" | "month" | undefined;
1191
+ orderBy?: {
1192
+ field: "visitors" | "count";
1193
+ dir: "asc" | "desc";
1194
+ } | undefined;
1195
+ }>, z.ZodObject<{
1196
+ resolvedDateRange: z.ZodObject<{
1197
+ startDate: z.ZodString;
1198
+ endDate: z.ZodString;
1199
+ }, "strip", z.ZodTypeAny, {
1200
+ startDate: string;
1201
+ endDate: string;
1202
+ }, {
1203
+ startDate: string;
1204
+ endDate: string;
1205
+ }>;
1206
+ metric: z.ZodEnum<["pageviews", "visitors", "sessions", "404s"]>;
1207
+ dimensions: z.ZodArray<z.ZodEnum<["path", "referrer"]>, "many">;
1208
+ granularity: z.ZodOptional<z.ZodEnum<["day", "week", "month"]>>;
1209
+ rows: z.ZodArray<z.ZodObject<{
1210
+ dimensions: z.ZodRecord<z.ZodString, z.ZodString>;
1211
+ bucket: z.ZodOptional<z.ZodString>;
1212
+ count: z.ZodNumber;
1213
+ visitors: z.ZodOptional<z.ZodNumber>;
1214
+ sessions: z.ZodOptional<z.ZodNumber>;
1215
+ }, "strip", z.ZodTypeAny, {
1216
+ count: number;
1217
+ dimensions: Record<string, string>;
1218
+ visitors?: number | undefined;
1219
+ sessions?: number | undefined;
1220
+ bucket?: string | undefined;
1221
+ }, {
1222
+ count: number;
1223
+ dimensions: Record<string, string>;
1224
+ visitors?: number | undefined;
1225
+ sessions?: number | undefined;
1226
+ bucket?: string | undefined;
1227
+ }>, "many">;
1228
+ }, "strip", z.ZodTypeAny, {
1229
+ metric: "pageviews" | "visitors" | "sessions" | "404s";
1230
+ dimensions: ("path" | "referrer")[];
1231
+ resolvedDateRange: {
1232
+ startDate: string;
1233
+ endDate: string;
1234
+ };
1235
+ rows: {
1236
+ count: number;
1237
+ dimensions: Record<string, string>;
1238
+ visitors?: number | undefined;
1239
+ sessions?: number | undefined;
1240
+ bucket?: string | undefined;
1241
+ }[];
1242
+ granularity?: "day" | "week" | "month" | undefined;
1243
+ }, {
1244
+ metric: "pageviews" | "visitors" | "sessions" | "404s";
1245
+ dimensions: ("path" | "referrer")[];
1246
+ resolvedDateRange: {
1247
+ startDate: string;
1248
+ endDate: string;
1249
+ };
1250
+ rows: {
1251
+ count: number;
1252
+ dimensions: Record<string, string>;
1253
+ visitors?: number | undefined;
1254
+ sessions?: number | undefined;
1255
+ bucket?: string | undefined;
1256
+ }[];
1257
+ granularity?: "day" | "week" | "month" | undefined;
1258
+ }>, Record<never, never>, Record<never, never>>;
1259
+ listOrgDocDomains: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
1260
+ orgId: z.ZodString;
1261
+ }, "strip", z.ZodTypeAny, {
1262
+ orgId: string;
1263
+ }, {
1264
+ orgId: string;
1265
+ }>, z.ZodObject<{
1266
+ domains: z.ZodArray<z.ZodString, "many">;
1267
+ }, "strip", z.ZodTypeAny, {
1268
+ domains: string[];
1269
+ }, {
1270
+ domains: string[];
1271
+ }>, Record<never, never>, Record<never, never>>;
1272
+ listOrgMembers: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
1273
+ orgId: z.ZodString;
1274
+ includeFernEmployees: z.ZodOptional<z.ZodBoolean>;
1275
+ }, "strip", z.ZodTypeAny, {
1276
+ orgId: string;
1277
+ includeFernEmployees?: boolean | undefined;
1278
+ }, {
1279
+ orgId: string;
1280
+ includeFernEmployees?: boolean | undefined;
1281
+ }>, z.ZodObject<{
1282
+ members: z.ZodArray<z.ZodObject<{
1283
+ name: z.ZodString;
1284
+ email: z.ZodString;
1285
+ roles: z.ZodArray<z.ZodString, "many">;
1286
+ }, "strip", z.ZodTypeAny, {
1287
+ name: string;
1288
+ email: string;
1289
+ roles: string[];
1290
+ }, {
1291
+ name: string;
1292
+ email: string;
1293
+ roles: string[];
1294
+ }>, "many">;
1295
+ count: z.ZodNumber;
1296
+ }, "strip", z.ZodTypeAny, {
1297
+ count: number;
1298
+ members: {
1299
+ name: string;
1300
+ email: string;
1301
+ roles: string[];
1302
+ }[];
1303
+ }, {
1304
+ count: number;
1305
+ members: {
1306
+ name: string;
1307
+ email: string;
1308
+ roles: string[];
1309
+ }[];
1310
+ }>, Record<never, never>, Record<never, never>>;
1311
+ getSiteConfig: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
1312
+ orgId: z.ZodString;
1313
+ domain: z.ZodString;
1314
+ }, "strip", z.ZodTypeAny, {
1315
+ orgId: string;
1316
+ domain: string;
1317
+ }, {
1318
+ orgId: string;
1319
+ domain: string;
1320
+ }>, z.ZodObject<{
1321
+ domain: z.ZodString;
1322
+ basepath: z.ZodNullable<z.ZodString>;
1323
+ status: z.ZodNullable<z.ZodString>;
1324
+ isPreview: z.ZodBoolean;
1325
+ /** The git repository connected to this docs site, when one exists. */
1326
+ gitRepository: z.ZodNullable<z.ZodObject<{
1327
+ gitUrl: z.ZodString;
1328
+ provider: z.ZodEnum<["github", "gitlab", "other"]>;
1329
+ /** `owner/repo` when the git url points at GitHub, else null. */
1330
+ githubRepository: z.ZodNullable<z.ZodString>;
1331
+ branch: z.ZodNullable<z.ZodString>;
1332
+ }, "strip", z.ZodTypeAny, {
1333
+ gitUrl: string;
1334
+ provider: "github" | "gitlab" | "other";
1335
+ githubRepository: string | null;
1336
+ branch: string | null;
1337
+ }, {
1338
+ gitUrl: string;
1339
+ provider: "github" | "gitlab" | "other";
1340
+ githubRepository: string | null;
1341
+ branch: string | null;
1342
+ }>>;
1343
+ /** True when the queried domain is a customer-owned custom domain (not *.docs.buildwithfern.com). */
1344
+ isCustomDomain: z.ZodBoolean;
1345
+ /** Fern CLI version that published the current deployment, when known. */
1346
+ fernCliVersion: z.ZodNullable<z.ZodString>;
1347
+ /** Connected Postman collection id, when one exists. */
1348
+ postmanCollectionId: z.ZodNullable<z.ZodString>;
1349
+ }, "strip", z.ZodTypeAny, {
1350
+ status: string | null;
1351
+ domain: string;
1352
+ basepath: string | null;
1353
+ postmanCollectionId: string | null;
1354
+ isPreview: boolean;
1355
+ gitRepository: {
1356
+ gitUrl: string;
1357
+ provider: "github" | "gitlab" | "other";
1358
+ githubRepository: string | null;
1359
+ branch: string | null;
1360
+ } | null;
1361
+ isCustomDomain: boolean;
1362
+ fernCliVersion: string | null;
1363
+ }, {
1364
+ status: string | null;
1365
+ domain: string;
1366
+ basepath: string | null;
1367
+ postmanCollectionId: string | null;
1368
+ isPreview: boolean;
1369
+ gitRepository: {
1370
+ gitUrl: string;
1371
+ provider: "github" | "gitlab" | "other";
1372
+ githubRepository: string | null;
1373
+ branch: string | null;
1374
+ } | null;
1375
+ isCustomDomain: boolean;
1376
+ fernCliVersion: string | null;
1377
+ }>, Record<never, never>, Record<never, never>>;
1378
+ authorizeDocsEdit: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
1379
+ orgId: z.ZodString;
1380
+ domain: z.ZodString;
1381
+ }, "strip", z.ZodTypeAny, {
1382
+ orgId: string;
1383
+ domain: string;
1384
+ }, {
1385
+ orgId: string;
1386
+ domain: string;
1387
+ }>, z.ZodObject<{
1388
+ authorized: z.ZodLiteral<true>;
1389
+ }, "strip", z.ZodTypeAny, {
1390
+ authorized: true;
1391
+ }, {
1392
+ authorized: true;
1393
+ }>, Record<never, never>, Record<never, never>>;
1394
+ getSiteSettings: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
1395
+ orgId: z.ZodString;
1396
+ domain: z.ZodString;
1397
+ }, "strip", z.ZodTypeAny, {
1398
+ orgId: string;
1399
+ domain: string;
1400
+ }, {
1401
+ orgId: string;
1402
+ domain: string;
1403
+ }>, z.ZodObject<{
1404
+ domain: z.ZodString;
1405
+ basepath: z.ZodNullable<z.ZodString>;
1406
+ /** Default basepath route for multi-basepath domains, when configured. */
1407
+ defaultBasepath: z.ZodNullable<z.ZodString>;
1408
+ /** Basepaths routed on this domain, when configured. */
1409
+ basepaths: z.ZodNullable<z.ZodArray<z.ZodString, "many">>;
1410
+ searchBehavior: z.ZodNullable<z.ZodEnum<["hierarchical", "unified"]>>;
1411
+ passwordProtection: z.ZodObject<{
1412
+ enabled: z.ZodBoolean;
1413
+ /** Number of configured passwords. Passwords themselves are never returned. */
1414
+ passwordCount: z.ZodNumber;
1415
+ }, "strip", z.ZodTypeAny, {
1416
+ enabled: boolean;
1417
+ passwordCount: number;
1418
+ }, {
1419
+ enabled: boolean;
1420
+ passwordCount: number;
1421
+ }>;
1422
+ }, "strip", z.ZodTypeAny, {
1423
+ domain: string;
1424
+ basepath: string | null;
1425
+ defaultBasepath: string | null;
1426
+ basepaths: string[] | null;
1427
+ searchBehavior: "hierarchical" | "unified" | null;
1428
+ passwordProtection: {
1429
+ enabled: boolean;
1430
+ passwordCount: number;
1431
+ };
1432
+ }, {
1433
+ domain: string;
1434
+ basepath: string | null;
1435
+ defaultBasepath: string | null;
1436
+ basepaths: string[] | null;
1437
+ searchBehavior: "hierarchical" | "unified" | null;
1438
+ passwordProtection: {
1439
+ enabled: boolean;
1440
+ passwordCount: number;
1441
+ };
1442
+ }>, Record<never, never>, Record<never, never>>;
1443
+ };
1444
+ //# sourceMappingURL=contract.d.ts.map