resend 6.31.0 → 6.31.1-preview-headless-dashboard.0

package/dist/index.cjs

@@ -25,7 +25,7 @@ let postal_mime = require("postal-mime");
 postal_mime = __toESM(postal_mime);
 let standardwebhooks = require("standardwebhooks");
 //#region package.json
-var version = "6.31.0";
+var version = "6.31.1-preview-headless-dashboard.0";
 //#endregion
 //#region src/common/utils/build-pagination-query.ts
 function buildPaginationUrl(base, options) {
@@ -916,12 +916,12 @@ var Emails = class {
 		return await this.resend.post(`/emails/${id}/share`, { expires_in: payload?.expiresIn });
 	}
 	async metrics(options = {}) {
-		const queryString = buildMetricsQuery(options);
+		const queryString = buildMetricsQuery$1(options);
 		const url = queryString ? `/emails/metrics?${queryString}` : "/emails/metrics";
 		return await this.resend.get(url);
 	}
 };
-function buildMetricsQuery(options) {
+function buildMetricsQuery$1(options) {
 	const params = {
 		start_date: options.startDate,
 		end_date: options.endDate,
@@ -1013,7 +1013,24 @@ var Segments = class {
 	async remove(id) {
 		return await this.resend.delete(`/segments/${id}`);
 	}
+	async metrics(options = {}) {
+		const queryString = buildMetricsQuery(options);
+		const url = queryString ? `/segments/metrics?${queryString}` : "/segments/metrics";
+		return await this.resend.get(url);
+	}
 };
+function buildMetricsQuery(options) {
+	const params = {
+		metrics: options.metrics?.join(","),
+		dimensions: options.dimensions?.join(","),
+		segment_id: options.filter?.segmentId?.join(","),
+		sort_by: options.sortBy,
+		sort_order: options.sortOrder
+	};
+	const searchParams = new URLSearchParams();
+	for (const [key, value] of Object.entries(params)) if (value !== void 0 && value !== "") searchParams.set(key, value);
+	return searchParams.toString();
+}
 //#endregion
 //#region src/suppressions/batch/batch.ts
 var Batch = class {

package/dist/index.d.cts

@@ -2034,6 +2034,60 @@ export interface CreateSegmentResponseSuccess extends Pick<Segment, 'name' | 'id
 }
 export type CreateSegmentResponse = Response<CreateSegmentResponseSuccess>;
 //#endregion
+//#region src/segments/interfaces/get-metrics.interface.d.ts
+export type SegmentMetric = 'all_contacts' | 'subscribers' | 'unsubscribers';
+export type SegmentMetricsDimension = 'segment';
+export type SegmentMetricsSortBy = 'date' | SegmentMetric;
+export type SegmentMetricsSortOrder = 'asc' | 'desc';
+export type GetSegmentsMetricsOptions = {
+  /**
+   * The metrics to include in the response. Defaults to all metrics.
+   *
+   * @link https://resend.com/docs/api-reference/segments/get-segment-metrics#query-parameters
+   */
+  metrics?: SegmentMetric[];
+  /**
+   * The dimensions to break `data` down by. Defaults to `[]`, which returns
+   * only `totals` with no `data`.
+   */
+  dimensions?: SegmentMetricsDimension[];
+  filter?: {
+    /**
+     * Restrict `totals` (and `data`, when requested) to these segment IDs,
+     * without double-counting contacts that belong to more than one.
+     */
+    segmentId?: string[];
+  };
+  /**
+   * What to sort the segment breakdown by: `date` (each segment's creation
+   * date), or a metric key to sort by that value instead. Only applies to
+   * `data` (when `dimensions` includes `segment`) — `totals` ignores sort
+   * params. Defaults to `date`.
+   *
+   * @link https://resend.com/docs/api-reference/segments/get-segment-metrics#query-parameters
+   */
+  sortBy?: SegmentMetricsSortBy;
+  /**
+   * The sort direction for `sortBy`. Defaults to `desc`.
+   */
+  sortOrder?: SegmentMetricsSortOrder;
+};
+export type SegmentMetricsTotals = Partial<Record<SegmentMetric, number>>;
+export type SegmentMetricsDataRow = SegmentMetricsTotals & {
+  segment_id: string;
+  segment_name: string;
+};
+export interface GetSegmentsMetricsResponseSuccess {
+  object: 'segments_metrics';
+  metrics: SegmentMetric[];
+  dimensions: SegmentMetricsDimension[];
+  sort_by: SegmentMetricsSortBy;
+  sort_order: SegmentMetricsSortOrder;
+  totals: SegmentMetricsTotals;
+  data?: SegmentMetricsDataRow[];
+}
+export type GetSegmentsMetricsResponse = Response<GetSegmentsMetricsResponseSuccess>;
+//#endregion
 //#region src/segments/interfaces/get-segment.interface.d.ts
 export interface GetSegmentResponseSuccess extends Pick<Segment, 'id' | 'name' | 'created_at'> {
   object: 'segment';
@@ -2074,6 +2128,7 @@ declare class Segments {
   get(id: string): Promise<GetSegmentResponse>;
   update(id: string, payload: UpdateSegmentOptions): Promise<UpdateSegmentResponse>;
   remove(id: string): Promise<RemoveSegmentResponse>;
+  metrics(options?: GetSegmentsMetricsOptions): Promise<GetSegmentsMetricsResponse>;
 }
 //#endregion
 //#region src/suppressions/batch/interfaces/batch-add-suppressions.interface.d.ts

package/dist/index.d.mts

@@ -2034,6 +2034,60 @@ export interface CreateSegmentResponseSuccess extends Pick<Segment, 'name' | 'id
 }
 export type CreateSegmentResponse = Response<CreateSegmentResponseSuccess>;
 //#endregion
+//#region src/segments/interfaces/get-metrics.interface.d.ts
+export type SegmentMetric = 'all_contacts' | 'subscribers' | 'unsubscribers';
+export type SegmentMetricsDimension = 'segment';
+export type SegmentMetricsSortBy = 'date' | SegmentMetric;
+export type SegmentMetricsSortOrder = 'asc' | 'desc';
+export type GetSegmentsMetricsOptions = {
+  /**
+   * The metrics to include in the response. Defaults to all metrics.
+   *
+   * @link https://resend.com/docs/api-reference/segments/get-segment-metrics#query-parameters
+   */
+  metrics?: SegmentMetric[];
+  /**
+   * The dimensions to break `data` down by. Defaults to `[]`, which returns
+   * only `totals` with no `data`.
+   */
+  dimensions?: SegmentMetricsDimension[];
+  filter?: {
+    /**
+     * Restrict `totals` (and `data`, when requested) to these segment IDs,
+     * without double-counting contacts that belong to more than one.
+     */
+    segmentId?: string[];
+  };
+  /**
+   * What to sort the segment breakdown by: `date` (each segment's creation
+   * date), or a metric key to sort by that value instead. Only applies to
+   * `data` (when `dimensions` includes `segment`) — `totals` ignores sort
+   * params. Defaults to `date`.
+   *
+   * @link https://resend.com/docs/api-reference/segments/get-segment-metrics#query-parameters
+   */
+  sortBy?: SegmentMetricsSortBy;
+  /**
+   * The sort direction for `sortBy`. Defaults to `desc`.
+   */
+  sortOrder?: SegmentMetricsSortOrder;
+};
+export type SegmentMetricsTotals = Partial<Record<SegmentMetric, number>>;
+export type SegmentMetricsDataRow = SegmentMetricsTotals & {
+  segment_id: string;
+  segment_name: string;
+};
+export interface GetSegmentsMetricsResponseSuccess {
+  object: 'segments_metrics';
+  metrics: SegmentMetric[];
+  dimensions: SegmentMetricsDimension[];
+  sort_by: SegmentMetricsSortBy;
+  sort_order: SegmentMetricsSortOrder;
+  totals: SegmentMetricsTotals;
+  data?: SegmentMetricsDataRow[];
+}
+export type GetSegmentsMetricsResponse = Response<GetSegmentsMetricsResponseSuccess>;
+//#endregion
 //#region src/segments/interfaces/get-segment.interface.d.ts
 export interface GetSegmentResponseSuccess extends Pick<Segment, 'id' | 'name' | 'created_at'> {
   object: 'segment';
@@ -2074,6 +2128,7 @@ declare class Segments {
   get(id: string): Promise<GetSegmentResponse>;
   update(id: string, payload: UpdateSegmentOptions): Promise<UpdateSegmentResponse>;
   remove(id: string): Promise<RemoveSegmentResponse>;
+  metrics(options?: GetSegmentsMetricsOptions): Promise<GetSegmentsMetricsResponse>;
 }
 //#endregion
 //#region src/suppressions/batch/interfaces/batch-add-suppressions.interface.d.ts

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import PostalMime from "postal-mime";
 import { Webhook } from "standardwebhooks";
 //#region package.json
-var version = "6.31.0";
+var version = "6.31.1-preview-headless-dashboard.0";
 //#endregion
 //#region src/common/utils/build-pagination-query.ts
 function buildPaginationUrl(base, options) {
@@ -892,12 +892,12 @@ var Emails = class {
 		return await this.resend.post(`/emails/${id}/share`, { expires_in: payload?.expiresIn });
 	}
 	async metrics(options = {}) {
-		const queryString = buildMetricsQuery(options);
+		const queryString = buildMetricsQuery$1(options);
 		const url = queryString ? `/emails/metrics?${queryString}` : "/emails/metrics";
 		return await this.resend.get(url);
 	}
 };
-function buildMetricsQuery(options) {
+function buildMetricsQuery$1(options) {
 	const params = {
 		start_date: options.startDate,
 		end_date: options.endDate,
@@ -989,7 +989,24 @@ var Segments = class {
 	async remove(id) {
 		return await this.resend.delete(`/segments/${id}`);
 	}
+	async metrics(options = {}) {
+		const queryString = buildMetricsQuery(options);
+		const url = queryString ? `/segments/metrics?${queryString}` : "/segments/metrics";
+		return await this.resend.get(url);
+	}
 };
+function buildMetricsQuery(options) {
+	const params = {
+		metrics: options.metrics?.join(","),
+		dimensions: options.dimensions?.join(","),
+		segment_id: options.filter?.segmentId?.join(","),
+		sort_by: options.sortBy,
+		sort_order: options.sortOrder
+	};
+	const searchParams = new URLSearchParams();
+	for (const [key, value] of Object.entries(params)) if (value !== void 0 && value !== "") searchParams.set(key, value);
+	return searchParams.toString();
+}
 //#endregion
 //#region src/suppressions/batch/batch.ts
 var Batch = class {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resend",
-  "version": "6.31.0",
+  "version": "6.31.1-preview-headless-dashboard.0",
   "description": "Node.js library for the Resend API",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",