@8ms/helpers 3.0.27 → 3.1.1

package/dist/googleAds/keywordPlanner/zodPHP.d.cts

@@ -0,0 +1,71 @@
+import { z } from "zod";
+//#region src/googleAds/keywordPlanner/zodPHP.d.ts
+/**
+ * PHP Single Row request details - row-specific fields only. Batch-level context (date/module/
+ * topic/subtopic/competitorId/endpoint) lives once on `PHPConfig` instead of being repeated per
+ * row in the echoed response.
+ */
+export declare const phpRowDetailsSchema: z.ZodObject<{
+  id: z.ZodString;
+  queries: z.ZodNullable<z.ZodArray<z.ZodString>>;
+  url: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type PHPRowDetails = z.infer<typeof phpRowDetailsSchema>;
+/**
+ * PHP Payload-level config (top-level) - only what `KwpRequest` actually sends, plus `customerId`
+ * which PHP adds itself and echoes back on the response (read in `uploadKeywordPlanner.ts`).
+ */
+export declare const phpConfigSchema: z.ZodObject<{
+  endpoint: z.ZodEnum<{
+    readonly HISTORIC_METRICS: "HISTORIC_METRICS";
+    readonly KEYWORD_IDEAS: "KEYWORD_IDEAS";
+  }>;
+  websiteId: z.ZodString;
+  request: z.ZodObject<{
+    competitorId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    module: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    topic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    subtopic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  }, z.core.$strip>;
+  api: z.ZodObject<{
+    customerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    countries: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    language: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    network: z.ZodNumber;
+    historicalMetricsOptions: z.ZodNullable<z.ZodObject<{
+      startYear: z.ZodNumber;
+      startMonth: z.ZodEnum<{
+        readonly JANUARY: "JANUARY";
+        readonly FEBRUARY: "FEBRUARY";
+        readonly MARCH: "MARCH";
+        readonly APRIL: "APRIL";
+        readonly MAY: "MAY";
+        readonly JUNE: "JUNE";
+        readonly JULY: "JULY";
+        readonly AUGUST: "AUGUST";
+        readonly SEPTEMBER: "SEPTEMBER";
+        readonly OCTOBER: "OCTOBER";
+        readonly NOVEMBER: "NOVEMBER";
+        readonly DECEMBER: "DECEMBER";
+      }>;
+      endYear: z.ZodNumber;
+      endMonth: z.ZodEnum<{
+        readonly JANUARY: "JANUARY";
+        readonly FEBRUARY: "FEBRUARY";
+        readonly MARCH: "MARCH";
+        readonly APRIL: "APRIL";
+        readonly MAY: "MAY";
+        readonly JUNE: "JUNE";
+        readonly JULY: "JULY";
+        readonly AUGUST: "AUGUST";
+        readonly SEPTEMBER: "SEPTEMBER";
+        readonly OCTOBER: "OCTOBER";
+        readonly NOVEMBER: "NOVEMBER";
+        readonly DECEMBER: "DECEMBER";
+      }>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+export type PHPConfig = z.infer<typeof phpConfigSchema>;
+//#endregion

package/dist/googleAds/keywordPlanner/zodPHP.d.mts

@@ -0,0 +1,71 @@
+import { z } from "zod";
+//#region src/googleAds/keywordPlanner/zodPHP.d.ts
+/**
+ * PHP Single Row request details - row-specific fields only. Batch-level context (date/module/
+ * topic/subtopic/competitorId/endpoint) lives once on `PHPConfig` instead of being repeated per
+ * row in the echoed response.
+ */
+export declare const phpRowDetailsSchema: z.ZodObject<{
+  id: z.ZodString;
+  queries: z.ZodNullable<z.ZodArray<z.ZodString>>;
+  url: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type PHPRowDetails = z.infer<typeof phpRowDetailsSchema>;
+/**
+ * PHP Payload-level config (top-level) - only what `KwpRequest` actually sends, plus `customerId`
+ * which PHP adds itself and echoes back on the response (read in `uploadKeywordPlanner.ts`).
+ */
+export declare const phpConfigSchema: z.ZodObject<{
+  endpoint: z.ZodEnum<{
+    readonly HISTORIC_METRICS: "HISTORIC_METRICS";
+    readonly KEYWORD_IDEAS: "KEYWORD_IDEAS";
+  }>;
+  websiteId: z.ZodString;
+  request: z.ZodObject<{
+    competitorId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    module: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    topic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    subtopic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  }, z.core.$strip>;
+  api: z.ZodObject<{
+    customerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    countries: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+    language: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    network: z.ZodNumber;
+    historicalMetricsOptions: z.ZodNullable<z.ZodObject<{
+      startYear: z.ZodNumber;
+      startMonth: z.ZodEnum<{
+        readonly JANUARY: "JANUARY";
+        readonly FEBRUARY: "FEBRUARY";
+        readonly MARCH: "MARCH";
+        readonly APRIL: "APRIL";
+        readonly MAY: "MAY";
+        readonly JUNE: "JUNE";
+        readonly JULY: "JULY";
+        readonly AUGUST: "AUGUST";
+        readonly SEPTEMBER: "SEPTEMBER";
+        readonly OCTOBER: "OCTOBER";
+        readonly NOVEMBER: "NOVEMBER";
+        readonly DECEMBER: "DECEMBER";
+      }>;
+      endYear: z.ZodNumber;
+      endMonth: z.ZodEnum<{
+        readonly JANUARY: "JANUARY";
+        readonly FEBRUARY: "FEBRUARY";
+        readonly MARCH: "MARCH";
+        readonly APRIL: "APRIL";
+        readonly MAY: "MAY";
+        readonly JUNE: "JUNE";
+        readonly JULY: "JULY";
+        readonly AUGUST: "AUGUST";
+        readonly SEPTEMBER: "SEPTEMBER";
+        readonly OCTOBER: "OCTOBER";
+        readonly NOVEMBER: "NOVEMBER";
+        readonly DECEMBER: "DECEMBER";
+      }>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+export type PHPConfig = z.infer<typeof phpConfigSchema>;
+//#endregion

package/dist/googleAds/keywordPlanner/zodPHP.mjs

@@ -0,0 +1,43 @@
+import { month } from "../../date/date.mjs";
+import { endpoint } from "./endpoint.mjs";
+import { z } from "zod";
+//#region src/googleAds/keywordPlanner/zodPHP.ts
+/**
+* PHP Single Row request details - row-specific fields only. Batch-level context (date/module/
+* topic/subtopic/competitorId/endpoint) lives once on `PHPConfig` instead of being repeated per
+* row in the echoed response.
+*/
+const phpRowDetailsSchema = z.object({
+	id: z.string(),
+	queries: z.string().array().nullable(),
+	url: z.string().nullable()
+});
+/**
+* PHP Payload-level config (top-level) - only what `KwpRequest` actually sends, plus `customerId`
+* which PHP adds itself and echoes back on the response (read in `uploadKeywordPlanner.ts`).
+*/
+const phpConfigSchema = z.object({
+	endpoint: z.enum(endpoint),
+	websiteId: z.string(),
+	request: z.object({
+		competitorId: z.string().nullable().optional(),
+		date: z.string().nullable().optional(),
+		module: z.string().nullable().optional(),
+		topic: z.string().nullable().optional(),
+		subtopic: z.string().nullable().optional()
+	}),
+	api: z.object({
+		customerId: z.string().nullable().optional(),
+		countries: z.number().array().nullable().optional(),
+		language: z.number().nullable().optional(),
+		network: z.number(),
+		historicalMetricsOptions: z.object({
+			startYear: z.number(),
+			startMonth: z.enum(month),
+			endYear: z.number(),
+			endMonth: z.enum(month)
+		}).nullable()
+	})
+});
+//#endregion
+export { phpConfigSchema, phpRowDetailsSchema };

package/dist/googleAds/keywordPlanner/zodPHPPayload.cjs

@@ -0,0 +1,29 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_googleAds_keywordPlanner_zodPHP = require("./zodPHP.cjs");
+let zod = require("zod");
+//#region src/googleAds/keywordPlanner/zodPHPPayload.ts
+/**
+* Single request row - request-specific fields only, matching what `KwpRequest.addRow`/`addRows`
+* produce. Shared batch context (date/module/topic/subtopic) lives once on
+* `PHPPayload.requestDetails` instead of being repeated per row.
+*/
+const phpPayloadRequestDetailsSchema = zod.z.object({
+	id: zod.z.string(),
+	queries: zod.z.string().array().nullable(),
+	url: zod.z.string().nullable()
+});
+/**
+* Main Payload - date/module/topic/subtopic/competitorId live on `config` (batch-level), so
+* there's no separate `requestDetails` here.
+*/
+const phpPayloadSchema = zod.z.object({
+	config: require_googleAds_keywordPlanner_zodPHP.phpConfigSchema,
+	requests: phpPayloadRequestDetailsSchema.array(),
+	s3Response: zod.z.object({
+		bucket: zod.z.string(),
+		key: zod.z.string()
+	}).optional()
+});
+//#endregion
+exports.phpPayloadRequestDetailsSchema = phpPayloadRequestDetailsSchema;
+exports.phpPayloadSchema = phpPayloadSchema;

package/dist/googleAds/keywordPlanner/zodPHPPayload.d.cts

@@ -0,0 +1,82 @@
+import { z } from "zod";
+//#region src/googleAds/keywordPlanner/zodPHPPayload.d.ts
+/**
+ * Single request row - request-specific fields only, matching what `KwpRequest.addRow`/`addRows`
+ * produce. Shared batch context (date/module/topic/subtopic) lives once on
+ * `PHPPayload.requestDetails` instead of being repeated per row.
+ */
+export declare const phpPayloadRequestDetailsSchema: z.ZodObject<{
+  id: z.ZodString;
+  queries: z.ZodNullable<z.ZodArray<z.ZodString>>;
+  url: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type PHPPayloadRequestDetails = z.infer<typeof phpPayloadRequestDetailsSchema>;
+/**
+ * Main Payload - date/module/topic/subtopic/competitorId live on `config` (batch-level), so
+ * there's no separate `requestDetails` here.
+ */
+export declare const phpPayloadSchema: z.ZodObject<{
+  config: z.ZodObject<{
+    endpoint: z.ZodEnum<{
+      readonly HISTORIC_METRICS: "HISTORIC_METRICS";
+      readonly KEYWORD_IDEAS: "KEYWORD_IDEAS";
+    }>;
+    websiteId: z.ZodString;
+    request: z.ZodObject<{
+      competitorId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      module: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      topic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      subtopic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>;
+    api: z.ZodObject<{
+      customerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      countries: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+      language: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+      network: z.ZodNumber;
+      historicalMetricsOptions: z.ZodNullable<z.ZodObject<{
+        startYear: z.ZodNumber;
+        startMonth: z.ZodEnum<{
+          readonly JANUARY: "JANUARY";
+          readonly FEBRUARY: "FEBRUARY";
+          readonly MARCH: "MARCH";
+          readonly APRIL: "APRIL";
+          readonly MAY: "MAY";
+          readonly JUNE: "JUNE";
+          readonly JULY: "JULY";
+          readonly AUGUST: "AUGUST";
+          readonly SEPTEMBER: "SEPTEMBER";
+          readonly OCTOBER: "OCTOBER";
+          readonly NOVEMBER: "NOVEMBER";
+          readonly DECEMBER: "DECEMBER";
+        }>;
+        endYear: z.ZodNumber;
+        endMonth: z.ZodEnum<{
+          readonly JANUARY: "JANUARY";
+          readonly FEBRUARY: "FEBRUARY";
+          readonly MARCH: "MARCH";
+          readonly APRIL: "APRIL";
+          readonly MAY: "MAY";
+          readonly JUNE: "JUNE";
+          readonly JULY: "JULY";
+          readonly AUGUST: "AUGUST";
+          readonly SEPTEMBER: "SEPTEMBER";
+          readonly OCTOBER: "OCTOBER";
+          readonly NOVEMBER: "NOVEMBER";
+          readonly DECEMBER: "DECEMBER";
+        }>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
+  requests: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    queries: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    url: z.ZodNullable<z.ZodString>;
+  }, z.core.$strip>>;
+  s3Response: z.ZodOptional<z.ZodObject<{
+    bucket: z.ZodString;
+    key: z.ZodString;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PHPPayload = z.infer<typeof phpPayloadSchema>;
+//#endregion

package/dist/googleAds/keywordPlanner/zodPHPPayload.d.mts

@@ -0,0 +1,82 @@
+import { z } from "zod";
+//#region src/googleAds/keywordPlanner/zodPHPPayload.d.ts
+/**
+ * Single request row - request-specific fields only, matching what `KwpRequest.addRow`/`addRows`
+ * produce. Shared batch context (date/module/topic/subtopic) lives once on
+ * `PHPPayload.requestDetails` instead of being repeated per row.
+ */
+export declare const phpPayloadRequestDetailsSchema: z.ZodObject<{
+  id: z.ZodString;
+  queries: z.ZodNullable<z.ZodArray<z.ZodString>>;
+  url: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type PHPPayloadRequestDetails = z.infer<typeof phpPayloadRequestDetailsSchema>;
+/**
+ * Main Payload - date/module/topic/subtopic/competitorId live on `config` (batch-level), so
+ * there's no separate `requestDetails` here.
+ */
+export declare const phpPayloadSchema: z.ZodObject<{
+  config: z.ZodObject<{
+    endpoint: z.ZodEnum<{
+      readonly HISTORIC_METRICS: "HISTORIC_METRICS";
+      readonly KEYWORD_IDEAS: "KEYWORD_IDEAS";
+    }>;
+    websiteId: z.ZodString;
+    request: z.ZodObject<{
+      competitorId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      module: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      topic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      subtopic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>;
+    api: z.ZodObject<{
+      customerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      countries: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+      language: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+      network: z.ZodNumber;
+      historicalMetricsOptions: z.ZodNullable<z.ZodObject<{
+        startYear: z.ZodNumber;
+        startMonth: z.ZodEnum<{
+          readonly JANUARY: "JANUARY";
+          readonly FEBRUARY: "FEBRUARY";
+          readonly MARCH: "MARCH";
+          readonly APRIL: "APRIL";
+          readonly MAY: "MAY";
+          readonly JUNE: "JUNE";
+          readonly JULY: "JULY";
+          readonly AUGUST: "AUGUST";
+          readonly SEPTEMBER: "SEPTEMBER";
+          readonly OCTOBER: "OCTOBER";
+          readonly NOVEMBER: "NOVEMBER";
+          readonly DECEMBER: "DECEMBER";
+        }>;
+        endYear: z.ZodNumber;
+        endMonth: z.ZodEnum<{
+          readonly JANUARY: "JANUARY";
+          readonly FEBRUARY: "FEBRUARY";
+          readonly MARCH: "MARCH";
+          readonly APRIL: "APRIL";
+          readonly MAY: "MAY";
+          readonly JUNE: "JUNE";
+          readonly JULY: "JULY";
+          readonly AUGUST: "AUGUST";
+          readonly SEPTEMBER: "SEPTEMBER";
+          readonly OCTOBER: "OCTOBER";
+          readonly NOVEMBER: "NOVEMBER";
+          readonly DECEMBER: "DECEMBER";
+        }>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
+  requests: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    queries: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    url: z.ZodNullable<z.ZodString>;
+  }, z.core.$strip>>;
+  s3Response: z.ZodOptional<z.ZodObject<{
+    bucket: z.ZodString;
+    key: z.ZodString;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PHPPayload = z.infer<typeof phpPayloadSchema>;
+//#endregion

package/dist/googleAds/keywordPlanner/zodPHPPayload.mjs

@@ -0,0 +1,27 @@
+import { phpConfigSchema } from "./zodPHP.mjs";
+import { z } from "zod";
+//#region src/googleAds/keywordPlanner/zodPHPPayload.ts
+/**
+* Single request row - request-specific fields only, matching what `KwpRequest.addRow`/`addRows`
+* produce. Shared batch context (date/module/topic/subtopic) lives once on
+* `PHPPayload.requestDetails` instead of being repeated per row.
+*/
+const phpPayloadRequestDetailsSchema = z.object({
+	id: z.string(),
+	queries: z.string().array().nullable(),
+	url: z.string().nullable()
+});
+/**
+* Main Payload - date/module/topic/subtopic/competitorId live on `config` (batch-level), so
+* there's no separate `requestDetails` here.
+*/
+const phpPayloadSchema = z.object({
+	config: phpConfigSchema,
+	requests: phpPayloadRequestDetailsSchema.array(),
+	s3Response: z.object({
+		bucket: z.string(),
+		key: z.string()
+	}).optional()
+});
+//#endregion
+export { phpPayloadRequestDetailsSchema, phpPayloadSchema };

package/dist/googleAds/keywordPlanner/zodPHPResponse.cjs

@@ -0,0 +1,52 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_googleAds_keywordPlanner_zodPHP = require("./zodPHP.cjs");
+let zod = require("zod");
+//#region src/googleAds/keywordPlanner/zodPHPResponse.ts
+/**
+* PHP S3 Response Schema - from the S3 response file.
+*/
+const phpResponseMonthSchema = zod.z.object({
+	date: zod.z.string(),
+	searchVolume: zod.z.number()
+});
+/**
+* A single row exported from PHP - one per query. Flat, matching PHP's `buildMissingRow` (and the
+* equivalent matched-row builder): `id`/`queries`/`url` are the caller-supplied request echoed back
+* directly on the row, not nested under a `requestDetails` key.
+*/
+const phpResponseRowSchema = zod.z.object({
+	...require_googleAds_keywordPlanner_zodPHP.phpRowDetailsSchema.shape,
+	id: zod.z.string().nullable(),
+	query: zod.z.string().nullable(),
+	avgCpc: zod.z.number().nullable(),
+	avgSearchVolume: zod.z.number(),
+	competition: zod.z.number().nullable(),
+	competitionIndex: zod.z.number().nullable(),
+	months: phpResponseMonthSchema.array(),
+	topOfPageBidHigh: zod.z.number().nullable(),
+	topOfPageBidLow: zod.z.number().nullable(),
+	totalSearchVolume: zod.z.number().nullable(),
+	missing: zod.z.boolean(),
+	error: zod.z.string().nullable().optional()
+});
+/**
+* Response from KWP Api
+*
+* Shared response envelope, used by both historicalMetrics and keywordIdeas endpoints.
+*
+* `bucket` is empty string "" if not used
+* `key` is empty string "" if not used
+* `body` is empty array [] if storing to S3 due to response size.
+* `rows` always populated
+*/
+const phpResponseSchema = zod.z.object({
+	config: require_googleAds_keywordPlanner_zodPHP.phpConfigSchema,
+	bucket: zod.z.string(),
+	key: zod.z.string(),
+	body: phpResponseRowSchema.array(),
+	rows: zod.z.number()
+});
+//#endregion
+exports.phpResponseMonthSchema = phpResponseMonthSchema;
+exports.phpResponseRowSchema = phpResponseRowSchema;
+exports.phpResponseSchema = phpResponseSchema;

package/dist/googleAds/keywordPlanner/zodPHPResponse.d.cts

@@ -0,0 +1,123 @@
+import { z } from "zod";
+//#region src/googleAds/keywordPlanner/zodPHPResponse.d.ts
+/**
+ * PHP S3 Response Schema - from the S3 response file.
+ */
+export declare const phpResponseMonthSchema: z.ZodObject<{
+  date: z.ZodString;
+  searchVolume: z.ZodNumber;
+}, z.core.$strip>;
+export type PHPResponseMonth = z.infer<typeof phpResponseMonthSchema>;
+/**
+ * A single row exported from PHP - one per query. Flat, matching PHP's `buildMissingRow` (and the
+ * equivalent matched-row builder): `id`/`queries`/`url` are the caller-supplied request echoed back
+ * directly on the row, not nested under a `requestDetails` key.
+ */
+export declare const phpResponseRowSchema: z.ZodObject<{
+  queries: z.ZodNullable<z.ZodArray<z.ZodString>>;
+  url: z.ZodNullable<z.ZodString>;
+  id: z.ZodNullable<z.ZodString>;
+  query: z.ZodNullable<z.ZodString>;
+  avgCpc: z.ZodNullable<z.ZodNumber>;
+  avgSearchVolume: z.ZodNumber;
+  competition: z.ZodNullable<z.ZodNumber>;
+  competitionIndex: z.ZodNullable<z.ZodNumber>;
+  months: z.ZodArray<z.ZodObject<{
+    date: z.ZodString;
+    searchVolume: z.ZodNumber;
+  }, z.core.$strip>>;
+  topOfPageBidHigh: z.ZodNullable<z.ZodNumber>;
+  topOfPageBidLow: z.ZodNullable<z.ZodNumber>;
+  totalSearchVolume: z.ZodNullable<z.ZodNumber>;
+  missing: z.ZodBoolean;
+  error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type PHPResponseRow = z.infer<typeof phpResponseRowSchema>;
+/**
+ * Response from KWP Api
+ *
+ * Shared response envelope, used by both historicalMetrics and keywordIdeas endpoints.
+ *
+ * `bucket` is empty string "" if not used
+ * `key` is empty string "" if not used
+ * `body` is empty array [] if storing to S3 due to response size.
+ * `rows` always populated
+ */
+export declare const phpResponseSchema: z.ZodObject<{
+  config: z.ZodObject<{
+    endpoint: z.ZodEnum<{
+      readonly HISTORIC_METRICS: "HISTORIC_METRICS";
+      readonly KEYWORD_IDEAS: "KEYWORD_IDEAS";
+    }>;
+    websiteId: z.ZodString;
+    request: z.ZodObject<{
+      competitorId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      module: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      topic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      subtopic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>;
+    api: z.ZodObject<{
+      customerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+      countries: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber>>>;
+      language: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+      network: z.ZodNumber;
+      historicalMetricsOptions: z.ZodNullable<z.ZodObject<{
+        startYear: z.ZodNumber;
+        startMonth: z.ZodEnum<{
+          readonly JANUARY: "JANUARY";
+          readonly FEBRUARY: "FEBRUARY";
+          readonly MARCH: "MARCH";
+          readonly APRIL: "APRIL";
+          readonly MAY: "MAY";
+          readonly JUNE: "JUNE";
+          readonly JULY: "JULY";
+          readonly AUGUST: "AUGUST";
+          readonly SEPTEMBER: "SEPTEMBER";
+          readonly OCTOBER: "OCTOBER";
+          readonly NOVEMBER: "NOVEMBER";
+          readonly DECEMBER: "DECEMBER";
+        }>;
+        endYear: z.ZodNumber;
+        endMonth: z.ZodEnum<{
+          readonly JANUARY: "JANUARY";
+          readonly FEBRUARY: "FEBRUARY";
+          readonly MARCH: "MARCH";
+          readonly APRIL: "APRIL";
+          readonly MAY: "MAY";
+          readonly JUNE: "JUNE";
+          readonly JULY: "JULY";
+          readonly AUGUST: "AUGUST";
+          readonly SEPTEMBER: "SEPTEMBER";
+          readonly OCTOBER: "OCTOBER";
+          readonly NOVEMBER: "NOVEMBER";
+          readonly DECEMBER: "DECEMBER";
+        }>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>;
+  }, z.core.$strip>;
+  bucket: z.ZodString;
+  key: z.ZodString;
+  body: z.ZodArray<z.ZodObject<{
+    queries: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    url: z.ZodNullable<z.ZodString>;
+    id: z.ZodNullable<z.ZodString>;
+    query: z.ZodNullable<z.ZodString>;
+    avgCpc: z.ZodNullable<z.ZodNumber>;
+    avgSearchVolume: z.ZodNumber;
+    competition: z.ZodNullable<z.ZodNumber>;
+    competitionIndex: z.ZodNullable<z.ZodNumber>;
+    months: z.ZodArray<z.ZodObject<{
+      date: z.ZodString;
+      searchVolume: z.ZodNumber;
+    }, z.core.$strip>>;
+    topOfPageBidHigh: z.ZodNullable<z.ZodNumber>;
+    topOfPageBidLow: z.ZodNullable<z.ZodNumber>;
+    totalSearchVolume: z.ZodNullable<z.ZodNumber>;
+    missing: z.ZodBoolean;
+    error: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  }, z.core.$strip>>;
+  rows: z.ZodNumber;
+}, z.core.$strip>;
+export type PHPResponse = z.infer<typeof phpResponseSchema>;
+//#endregion