@keystrokehq/sendgrid 0.0.1

package/dist/stats.d.mts

@@ -0,0 +1,215 @@
+import { z } from "zod";
+import * as _keystrokehq_core_credential_set0 from "@keystrokehq/core/credential-set";
+import * as _keystrokehq_core0 from "@keystrokehq/core";
+
+//#region src/stats.d.ts
+declare const getGlobalEmailStats: _keystrokehq_core0.Operation<z.ZodObject<{
+  startDate: z.ZodISODate;
+  endDate: z.ZodOptional<z.ZodISODate>;
+  aggregatedBy: z.ZodOptional<z.ZodEnum<{
+    day: "day";
+    week: "week";
+    month: "month";
+  }>>;
+}, z.core.$strip>, z.ZodArray<z.ZodObject<{
+  date: z.ZodString;
+  stats: z.ZodArray<z.ZodObject<{
+    type: z.ZodString;
+    name: z.ZodString;
+    metrics: z.ZodObject<{
+      requests: z.ZodOptional<z.ZodNumber>;
+      delivered: z.ZodOptional<z.ZodNumber>;
+      opens: z.ZodOptional<z.ZodNumber>;
+      unique_opens: z.ZodOptional<z.ZodNumber>;
+      clicks: z.ZodOptional<z.ZodNumber>;
+      unique_clicks: z.ZodOptional<z.ZodNumber>;
+      bounces: z.ZodOptional<z.ZodNumber>;
+      bounce_drops: z.ZodOptional<z.ZodNumber>;
+      blocks: z.ZodOptional<z.ZodNumber>;
+      spam_reports: z.ZodOptional<z.ZodNumber>;
+      unsubscribes: z.ZodOptional<z.ZodNumber>;
+      unique_unsubscribes: z.ZodOptional<z.ZodNumber>;
+      processed: z.ZodOptional<z.ZodNumber>;
+      deferred: z.ZodOptional<z.ZodNumber>;
+      invalid_emails: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$catchall<z.ZodUnknown>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>>, readonly [_keystrokehq_core0.CredentialSet<"sendgrid", z.ZodObject<{
+  SENDGRID_API_KEY: z.ZodString;
+  SENDGRID_SUBUSER: z.ZodOptional<z.ZodString>;
+  SENDGRID_ACCOUNT_REGION: z.ZodDefault<z.ZodEnum<{
+    global: "global";
+    eu: "eu";
+  }>>;
+  SENDGRID_EVENT_WEBHOOK_PUBLIC_KEY: z.ZodOptional<z.ZodString>;
+  SENDGRID_INBOUND_PARSE_TOKEN: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
+  SENDGRID_API_KEY: z.ZodString;
+  SENDGRID_SUBUSER: z.ZodOptional<z.ZodString>;
+  SENDGRID_ACCOUNT_REGION: z.ZodDefault<z.ZodEnum<{
+    global: "global";
+    eu: "eu";
+  }>>;
+  SENDGRID_EVENT_WEBHOOK_PUBLIC_KEY: z.ZodOptional<z.ZodString>;
+  SENDGRID_INBOUND_PARSE_TOKEN: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>[] | undefined>], undefined>;
+declare const getCategoryStats: _keystrokehq_core0.Operation<z.ZodObject<{
+  startDate: z.ZodISODate;
+  endDate: z.ZodOptional<z.ZodISODate>;
+  aggregatedBy: z.ZodOptional<z.ZodEnum<{
+    day: "day";
+    week: "week";
+    month: "month";
+  }>>;
+  categories: z.ZodArray<z.ZodString>;
+}, z.core.$strip>, z.ZodArray<z.ZodObject<{
+  date: z.ZodString;
+  stats: z.ZodArray<z.ZodObject<{
+    type: z.ZodString;
+    name: z.ZodString;
+    metrics: z.ZodObject<{
+      requests: z.ZodOptional<z.ZodNumber>;
+      delivered: z.ZodOptional<z.ZodNumber>;
+      opens: z.ZodOptional<z.ZodNumber>;
+      unique_opens: z.ZodOptional<z.ZodNumber>;
+      clicks: z.ZodOptional<z.ZodNumber>;
+      unique_clicks: z.ZodOptional<z.ZodNumber>;
+      bounces: z.ZodOptional<z.ZodNumber>;
+      bounce_drops: z.ZodOptional<z.ZodNumber>;
+      blocks: z.ZodOptional<z.ZodNumber>;
+      spam_reports: z.ZodOptional<z.ZodNumber>;
+      unsubscribes: z.ZodOptional<z.ZodNumber>;
+      unique_unsubscribes: z.ZodOptional<z.ZodNumber>;
+      processed: z.ZodOptional<z.ZodNumber>;
+      deferred: z.ZodOptional<z.ZodNumber>;
+      invalid_emails: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$catchall<z.ZodUnknown>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>>, readonly [_keystrokehq_core0.CredentialSet<"sendgrid", z.ZodObject<{
+  SENDGRID_API_KEY: z.ZodString;
+  SENDGRID_SUBUSER: z.ZodOptional<z.ZodString>;
+  SENDGRID_ACCOUNT_REGION: z.ZodDefault<z.ZodEnum<{
+    global: "global";
+    eu: "eu";
+  }>>;
+  SENDGRID_EVENT_WEBHOOK_PUBLIC_KEY: z.ZodOptional<z.ZodString>;
+  SENDGRID_INBOUND_PARSE_TOKEN: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
+  SENDGRID_API_KEY: z.ZodString;
+  SENDGRID_SUBUSER: z.ZodOptional<z.ZodString>;
+  SENDGRID_ACCOUNT_REGION: z.ZodDefault<z.ZodEnum<{
+    global: "global";
+    eu: "eu";
+  }>>;
+  SENDGRID_EVENT_WEBHOOK_PUBLIC_KEY: z.ZodOptional<z.ZodString>;
+  SENDGRID_INBOUND_PARSE_TOKEN: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>[] | undefined>], undefined>;
+declare const listAutomationStats: _keystrokehq_core0.Operation<z.ZodOptional<z.ZodObject<{
+  pageSize: z.ZodOptional<z.ZodNumber>;
+  aggregatedBy: z.ZodOptional<z.ZodEnum<{
+    day: "day";
+    week: "week";
+    month: "month";
+    total: "total";
+  }>>;
+}, z.core.$strip>>, z.ZodObject<{
+  results: z.ZodArray<z.ZodUnknown>;
+  _metadata: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"sendgrid", z.ZodObject<{
+  SENDGRID_API_KEY: z.ZodString;
+  SENDGRID_SUBUSER: z.ZodOptional<z.ZodString>;
+  SENDGRID_ACCOUNT_REGION: z.ZodDefault<z.ZodEnum<{
+    global: "global";
+    eu: "eu";
+  }>>;
+  SENDGRID_EVENT_WEBHOOK_PUBLIC_KEY: z.ZodOptional<z.ZodString>;
+  SENDGRID_INBOUND_PARSE_TOKEN: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
+  SENDGRID_API_KEY: z.ZodString;
+  SENDGRID_SUBUSER: z.ZodOptional<z.ZodString>;
+  SENDGRID_ACCOUNT_REGION: z.ZodDefault<z.ZodEnum<{
+    global: "global";
+    eu: "eu";
+  }>>;
+  SENDGRID_EVENT_WEBHOOK_PUBLIC_KEY: z.ZodOptional<z.ZodString>;
+  SENDGRID_INBOUND_PARSE_TOKEN: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>[] | undefined>], undefined>;
+declare const getEngagementQualityScores: _keystrokehq_core0.Operation<z.ZodObject<{
+  from: z.ZodISODate;
+  to: z.ZodISODate;
+}, z.core.$strip>, z.ZodObject<{
+  account_id: z.ZodOptional<z.ZodString>;
+  date: z.ZodOptional<z.ZodString>;
+  metrics: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$catchall<z.ZodUnknown>>, readonly [_keystrokehq_core0.CredentialSet<"sendgrid", z.ZodObject<{
+  SENDGRID_API_KEY: z.ZodString;
+  SENDGRID_SUBUSER: z.ZodOptional<z.ZodString>;
+  SENDGRID_ACCOUNT_REGION: z.ZodDefault<z.ZodEnum<{
+    global: "global";
+    eu: "eu";
+  }>>;
+  SENDGRID_EVENT_WEBHOOK_PUBLIC_KEY: z.ZodOptional<z.ZodString>;
+  SENDGRID_INBOUND_PARSE_TOKEN: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
+  SENDGRID_API_KEY: z.ZodString;
+  SENDGRID_SUBUSER: z.ZodOptional<z.ZodString>;
+  SENDGRID_ACCOUNT_REGION: z.ZodDefault<z.ZodEnum<{
+    global: "global";
+    eu: "eu";
+  }>>;
+  SENDGRID_EVENT_WEBHOOK_PUBLIC_KEY: z.ZodOptional<z.ZodString>;
+  SENDGRID_INBOUND_PARSE_TOKEN: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>[] | undefined>], undefined>;
+declare const listMailboxProviderStats: _keystrokehq_core0.Operation<z.ZodObject<{
+  startDate: z.ZodISODate;
+  endDate: z.ZodOptional<z.ZodISODate>;
+  aggregatedBy: z.ZodOptional<z.ZodEnum<{
+    day: "day";
+    week: "week";
+    month: "month";
+  }>>;
+  mailboxProviders: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>, z.ZodArray<z.ZodObject<{
+  date: z.ZodString;
+  stats: z.ZodArray<z.ZodObject<{
+    type: z.ZodString;
+    name: z.ZodString;
+    metrics: z.ZodObject<{
+      requests: z.ZodOptional<z.ZodNumber>;
+      delivered: z.ZodOptional<z.ZodNumber>;
+      opens: z.ZodOptional<z.ZodNumber>;
+      unique_opens: z.ZodOptional<z.ZodNumber>;
+      clicks: z.ZodOptional<z.ZodNumber>;
+      unique_clicks: z.ZodOptional<z.ZodNumber>;
+      bounces: z.ZodOptional<z.ZodNumber>;
+      bounce_drops: z.ZodOptional<z.ZodNumber>;
+      blocks: z.ZodOptional<z.ZodNumber>;
+      spam_reports: z.ZodOptional<z.ZodNumber>;
+      unsubscribes: z.ZodOptional<z.ZodNumber>;
+      unique_unsubscribes: z.ZodOptional<z.ZodNumber>;
+      processed: z.ZodOptional<z.ZodNumber>;
+      deferred: z.ZodOptional<z.ZodNumber>;
+      invalid_emails: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$catchall<z.ZodUnknown>>;
+  }, z.core.$strip>>;
+}, z.core.$strip>>, readonly [_keystrokehq_core0.CredentialSet<"sendgrid", z.ZodObject<{
+  SENDGRID_API_KEY: z.ZodString;
+  SENDGRID_SUBUSER: z.ZodOptional<z.ZodString>;
+  SENDGRID_ACCOUNT_REGION: z.ZodDefault<z.ZodEnum<{
+    global: "global";
+    eu: "eu";
+  }>>;
+  SENDGRID_EVENT_WEBHOOK_PUBLIC_KEY: z.ZodOptional<z.ZodString>;
+  SENDGRID_INBOUND_PARSE_TOKEN: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, readonly _keystrokehq_core_credential_set0.CredentialConnection<z.ZodObject<{
+  SENDGRID_API_KEY: z.ZodString;
+  SENDGRID_SUBUSER: z.ZodOptional<z.ZodString>;
+  SENDGRID_ACCOUNT_REGION: z.ZodDefault<z.ZodEnum<{
+    global: "global";
+    eu: "eu";
+  }>>;
+  SENDGRID_EVENT_WEBHOOK_PUBLIC_KEY: z.ZodOptional<z.ZodString>;
+  SENDGRID_INBOUND_PARSE_TOKEN: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>[] | undefined>], undefined>;
+//#endregion
+export { getCategoryStats, getEngagementQualityScores, getGlobalEmailStats, listAutomationStats, listMailboxProviderStats };

package/dist/stats.mjs

@@ -0,0 +1,107 @@
+import { n as __exportAll, t as sendgridOperation } from "./factory-BSL0D2L0.mjs";
+import { n as omitUndefined } from "./shared-CQ8JFNXi.mjs";
+import { createSendGridClient } from "./client.mjs";
+import { F as sendgridAggregationSchema, I as sendgridAutomationStatsSchema, L as sendgridCategoryStatsSchema, R as sendgridEngagementQualitySchema, z as sendgridStatBucketListSchema } from "./webhooks-CKdsIikb.mjs";
+import { z } from "zod";
+
+//#region src/stats.ts
+var stats_exports = /* @__PURE__ */ __exportAll({
+	getCategoryStats: () => getCategoryStats,
+	getEngagementQualityScores: () => getEngagementQualityScores,
+	getGlobalEmailStats: () => getGlobalEmailStats,
+	listAutomationStats: () => listAutomationStats,
+	listMailboxProviderStats: () => listMailboxProviderStats
+});
+const statsRange = z.object({
+	startDate: z.iso.date(),
+	endDate: z.iso.date().optional(),
+	aggregatedBy: sendgridAggregationSchema.optional()
+});
+function mapStatsQuery(input) {
+	return {
+		start_date: input.startDate,
+		end_date: input.endDate,
+		aggregated_by: input.aggregatedBy
+	};
+}
+const getGlobalEmailStats = sendgridOperation({
+	id: "get_global_email_stats",
+	name: "Get Global Email Statistics",
+	description: "Return aggregated global email stats over a date range.",
+	input: statsRange,
+	output: sendgridStatBucketListSchema,
+	run: async (input, credentials) => {
+		const response = await createSendGridClient(credentials).request("/stats", { query: omitUndefined(mapStatsQuery(input)) });
+		return sendgridStatBucketListSchema.parse(response ?? []);
+	}
+});
+const getCategoryStats = sendgridOperation({
+	id: "get_category_stats",
+	name: "Get Category Stats",
+	description: "Return email stats broken down by category.",
+	input: statsRange.extend({ categories: z.array(z.string().min(1)).min(1).max(10) }),
+	output: sendgridCategoryStatsSchema,
+	run: async (input, credentials) => {
+		const response = await createSendGridClient(credentials).request("/categories/stats", { query: omitUndefined({
+			...mapStatsQuery(input),
+			categories: input.categories.join(",")
+		}) });
+		return sendgridCategoryStatsSchema.parse(response ?? []);
+	}
+});
+const listAutomationStats = sendgridOperation({
+	id: "list_automation_stats",
+	name: "List Automation Stats",
+	description: "Return engagement stats for all Automations.",
+	input: z.object({
+		pageSize: z.number().int().positive().max(100).optional(),
+		aggregatedBy: z.enum([
+			"total",
+			"day",
+			"week",
+			"month"
+		]).optional()
+	}).optional(),
+	output: sendgridAutomationStatsSchema,
+	run: async (input, credentials) => {
+		const response = await createSendGridClient(credentials).request("/marketing/stats/automations", { query: omitUndefined({
+			page_size: input?.pageSize,
+			aggregated_by: input?.aggregatedBy
+		}) });
+		return sendgridAutomationStatsSchema.parse(response ?? { results: [] });
+	}
+});
+const getEngagementQualityScores = sendgridOperation({
+	id: "get_engagement_quality_scores",
+	name: "Get Engagement Quality Scores",
+	description: "Return engagement-quality (EQ) scores for the account. Plan-gated — requires Pro+.",
+	input: z.object({
+		from: z.iso.date(),
+		to: z.iso.date()
+	}),
+	output: sendgridEngagementQualitySchema,
+	run: async (input, credentials) => {
+		const response = await createSendGridClient(credentials).request("/user/eq", { query: {
+			from: input.from,
+			to: input.to
+		} });
+		return sendgridEngagementQualitySchema.parse(response);
+	}
+});
+const listMailboxProviderStats = sendgridOperation({
+	id: "list_mailbox_provider_stats",
+	name: "List Mailbox Provider Stats",
+	description: "Return email stats broken down by mailbox provider (Gmail, Outlook, etc.).",
+	input: statsRange.extend({ mailboxProviders: z.array(z.string().min(1)).optional() }),
+	output: sendgridStatBucketListSchema,
+	run: async (input, credentials) => {
+		const response = await createSendGridClient(credentials).request("/mailbox_providers/stats", { query: omitUndefined({
+			...mapStatsQuery(input),
+			mailbox_providers: input.mailboxProviders?.join(",")
+		}) });
+		return sendgridStatBucketListSchema.parse(response ?? []);
+	}
+});
+
+//#endregion
+export { getCategoryStats, getEngagementQualityScores, getGlobalEmailStats, listAutomationStats, listMailboxProviderStats, stats_exports as t };