resend 6.30.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.30.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

@@ -716,19 +716,19 @@ interface EmailRenderOptions {
   /**
    * The React component used to write the message.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   react: React$1.ReactNode;
   /**
    * The HTML version of the message.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   html: string;
   /**
    * The plain text version of the message.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   text: string;
 }
@@ -736,7 +736,7 @@ interface SegmentOptions {
   /**
    * The id of the segment you want to send to
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   segmentId: string;
   /**
@@ -749,7 +749,7 @@ type SendBroadcastOnCreationOptions = {
    * Whether to send the broadcast immediately or keep it as a draft.
    * If not provided or set to false, the broadcast will be created as a draft.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   send: true;
   /**
@@ -757,7 +757,7 @@ type SendBroadcastOnCreationOptions = {
    * The date should be in ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z)
    * or relative time (eg: in 2 days).
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   scheduledAt?: string;
 } | {
@@ -765,7 +765,7 @@ type SendBroadcastOnCreationOptions = {
    * Whether to send the broadcast immediately or keep it as a draft.
    * If not provided or set to false, the broadcast will be created as a draft.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   send?: false;
   /**
@@ -773,7 +773,7 @@ type SendBroadcastOnCreationOptions = {
    * The date should be in ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z)
    * or relative time (eg: in 2 days).
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   scheduledAt?: never;
 };
@@ -781,37 +781,37 @@ interface CreateBroadcastBaseOptions {
   /**
    * The name of the broadcast
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   name?: string;
   /**
    * A short snippet of text displayed as a preview in recipients' inboxes, often shown below or beside the subject line.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   previewText?: string;
   /**
    * Sender email address. To include a friendly name, use the format `"Your Name <sender@domain.com>"`
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   from: string;
   /**
    * Reply-to email address. For multiple addresses, send as an array of strings.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   replyTo?: string | string[];
   /**
    * Email subject.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   subject: string;
   /**
    * The id of the topic you want to send to
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   topicId?: string | null;
 }
@@ -917,7 +917,7 @@ interface SendBroadcastBaseOptions {
    * The date should be in ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z)
    * or relative time (eg: in 2 days).
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/send#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/send-broadcast#body-parameters
    */
   scheduledAt?: string;
 }
@@ -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
@@ -2408,7 +2463,7 @@ declare class Usage {
 }
 //#endregion
 //#region src/webhooks/interfaces/webhook-event.interface.d.ts
-type WebhookEvent = 'email.sent' | 'email.scheduled' | 'email.delivered' | 'email.delivery_delayed' | 'email.complained' | 'email.bounced' | 'email.opened' | 'email.clicked' | 'email.received' | 'email.failed' | 'email.suppressed' | 'contact.created' | 'contact.updated' | 'contact.deleted' | 'domain.created' | 'domain.updated' | 'domain.deleted' | 'suppression.added' | 'suppression.removed';
+type WebhookEvent = 'email.sent' | 'email.scheduled' | 'email.delivered' | 'email.delivery_delayed' | 'email.complained' | 'email.bounced' | 'email.opened' | 'email.clicked' | 'email.received' | 'email.failed' | 'email.suppressed' | 'contact.created' | 'contact.updated' | 'contact.deleted' | 'contact.topics.updated' | 'domain.created' | 'domain.updated' | 'domain.deleted' | 'suppression.added' | 'suppression.removed' | 'topic.created' | 'topic.updated' | 'topic.deleted';
 interface BaseEmailEventData {
   broadcast_id?: string;
   created_at: string;
@@ -2468,6 +2523,13 @@ interface ContactEventData {
   last_name?: string | null;
   unsubscribed: boolean;
 }
+interface ContactTopicsEventData {
+  email: string;
+  topics: {
+    id: string;
+    subscription: 'opt_in' | 'opt_out';
+  }[];
+}
 interface DomainRecord {
   record: string;
   name: string;
@@ -2492,6 +2554,15 @@ interface SuppressionEventData {
   source_id: string | null;
   created_at: string;
 }
+interface TopicEventData {
+  id: string;
+  name: string;
+  description: string | null;
+  default_subscription: 'opt_in' | 'opt_out';
+  deleted: boolean;
+  created_at: string;
+  updated_at: string;
+}
 interface EmailSentEvent {
   type: 'email.sent';
   created_at: string;
@@ -2570,6 +2641,11 @@ interface ContactDeletedEvent {
   created_at: string;
   data: ContactEventData;
 }
+interface ContactTopicsUpdatedEvent {
+  type: 'contact.topics.updated';
+  created_at: string;
+  data: ContactTopicsEventData;
+}
 interface DomainCreatedEvent {
   type: 'domain.created';
   created_at: string;
@@ -2595,7 +2671,22 @@ interface SuppressionRemovedEvent {
   created_at: string;
   data: SuppressionEventData;
 }
-type WebhookEventPayload = EmailSentEvent | EmailScheduledEvent | EmailDeliveredEvent | EmailDeliveryDelayedEvent | EmailComplainedEvent | EmailBouncedEvent | EmailOpenedEvent | EmailClickedEvent | EmailReceivedEvent | EmailFailedEvent | EmailSuppressedEvent | ContactCreatedEvent | ContactUpdatedEvent | ContactDeletedEvent | DomainCreatedEvent | DomainUpdatedEvent | DomainDeletedEvent | SuppressionAddedEvent | SuppressionRemovedEvent;
+interface TopicCreatedEvent {
+  type: 'topic.created';
+  created_at: string;
+  data: TopicEventData;
+}
+interface TopicUpdatedEvent {
+  type: 'topic.updated';
+  created_at: string;
+  data: TopicEventData;
+}
+interface TopicDeletedEvent {
+  type: 'topic.deleted';
+  created_at: string;
+  data: TopicEventData;
+}
+type WebhookEventPayload = EmailSentEvent | EmailScheduledEvent | EmailDeliveredEvent | EmailDeliveryDelayedEvent | EmailComplainedEvent | EmailBouncedEvent | EmailOpenedEvent | EmailClickedEvent | EmailReceivedEvent | EmailFailedEvent | EmailSuppressedEvent | ContactCreatedEvent | ContactUpdatedEvent | ContactDeletedEvent | ContactTopicsUpdatedEvent | DomainCreatedEvent | DomainUpdatedEvent | DomainDeletedEvent | SuppressionAddedEvent | SuppressionRemovedEvent | TopicCreatedEvent | TopicUpdatedEvent | TopicDeletedEvent;
 //#endregion
 //#region src/webhooks/interfaces/list-webhook-events.interface.d.ts
 type WebhookEventLogStatus = 'success' | 'pending' | 'failed' | 'attempting';
@@ -2814,4 +2905,4 @@ export declare class Resend {
   delete<T>(path: string, query?: unknown, options?: DeleteOptions): Promise<Response<T>>;
 }
 //#endregion
-export type { ContactCreatedEvent, ContactDeletedEvent, ContactUpdatedEvent, CreateWebhookOptions, CreateWebhookRequestOptions, CreateWebhookResponse, CreateWebhookResponseSuccess, DomainCreatedEvent, DomainDeletedEvent, DomainUpdatedEvent, EmailBouncedEvent, EmailClickedEvent, EmailComplainedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailOpenedEvent, EmailReceivedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, ErrorResponse, GetAttachmentOptions, GetAttachmentResponse, GetAttachmentResponseSuccess, GetWebhookEventOptions, GetWebhookEventResponse, GetWebhookEventResponseSuccess, GetWebhookResponse, GetWebhookResponseSuccess, ListAttachmentsOptions, ListAttachmentsResponse, ListAttachmentsResponseSuccess, ListOAuthGrantsOptions, ListOAuthGrantsResponse, ListOAuthGrantsResponseSuccess, ListWebhookEventAttemptsOptions, ListWebhookEventAttemptsResponse, ListWebhookEventAttemptsResponseSuccess, ListWebhookEventsOptions, ListWebhookEventsResponse, ListWebhookEventsResponseSuccess, ListWebhooksOptions, ListWebhooksResponse, ListWebhooksResponseSuccess, OAuthGrant, RemoveWebhookResponse, RemoveWebhookResponseSuccess, ReplayWebhookEventOptions, ReplayWebhookEventResponse, ReplayWebhookEventResponseSuccess, ResendOptions, Response, RevokeOAuthGrantResponse, RevokeOAuthGrantResponseSuccess, RotateWebhookSigningSecretResponse, RotateWebhookSigningSecretResponseSuccess, SuppressionAddedEvent, SuppressionRemovedEvent, UpdateWebhookOptions, UpdateWebhookResponse, UpdateWebhookResponseSuccess, Webhook, WebhookEvent, WebhookEventAttempt, WebhookEventLog, WebhookEventLogStatus, WebhookEventPayload };
+export type { ContactCreatedEvent, ContactDeletedEvent, ContactTopicsUpdatedEvent, ContactUpdatedEvent, CreateWebhookOptions, CreateWebhookRequestOptions, CreateWebhookResponse, CreateWebhookResponseSuccess, DomainCreatedEvent, DomainDeletedEvent, DomainUpdatedEvent, EmailBouncedEvent, EmailClickedEvent, EmailComplainedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailOpenedEvent, EmailReceivedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, ErrorResponse, GetAttachmentOptions, GetAttachmentResponse, GetAttachmentResponseSuccess, GetWebhookEventOptions, GetWebhookEventResponse, GetWebhookEventResponseSuccess, GetWebhookResponse, GetWebhookResponseSuccess, ListAttachmentsOptions, ListAttachmentsResponse, ListAttachmentsResponseSuccess, ListOAuthGrantsOptions, ListOAuthGrantsResponse, ListOAuthGrantsResponseSuccess, ListWebhookEventAttemptsOptions, ListWebhookEventAttemptsResponse, ListWebhookEventAttemptsResponseSuccess, ListWebhookEventsOptions, ListWebhookEventsResponse, ListWebhookEventsResponseSuccess, ListWebhooksOptions, ListWebhooksResponse, ListWebhooksResponseSuccess, OAuthGrant, RemoveWebhookResponse, RemoveWebhookResponseSuccess, ReplayWebhookEventOptions, ReplayWebhookEventResponse, ReplayWebhookEventResponseSuccess, ResendOptions, Response, RevokeOAuthGrantResponse, RevokeOAuthGrantResponseSuccess, RotateWebhookSigningSecretResponse, RotateWebhookSigningSecretResponseSuccess, SuppressionAddedEvent, SuppressionRemovedEvent, TopicCreatedEvent, TopicDeletedEvent, TopicUpdatedEvent, UpdateWebhookOptions, UpdateWebhookResponse, UpdateWebhookResponseSuccess, Webhook, WebhookEvent, WebhookEventAttempt, WebhookEventLog, WebhookEventLogStatus, WebhookEventPayload };

package/dist/index.d.mts

@@ -716,19 +716,19 @@ interface EmailRenderOptions {
   /**
    * The React component used to write the message.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   react: React$1.ReactNode;
   /**
    * The HTML version of the message.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   html: string;
   /**
    * The plain text version of the message.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   text: string;
 }
@@ -736,7 +736,7 @@ interface SegmentOptions {
   /**
    * The id of the segment you want to send to
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   segmentId: string;
   /**
@@ -749,7 +749,7 @@ type SendBroadcastOnCreationOptions = {
    * Whether to send the broadcast immediately or keep it as a draft.
    * If not provided or set to false, the broadcast will be created as a draft.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   send: true;
   /**
@@ -757,7 +757,7 @@ type SendBroadcastOnCreationOptions = {
    * The date should be in ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z)
    * or relative time (eg: in 2 days).
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   scheduledAt?: string;
 } | {
@@ -765,7 +765,7 @@ type SendBroadcastOnCreationOptions = {
    * Whether to send the broadcast immediately or keep it as a draft.
    * If not provided or set to false, the broadcast will be created as a draft.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   send?: false;
   /**
@@ -773,7 +773,7 @@ type SendBroadcastOnCreationOptions = {
    * The date should be in ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z)
    * or relative time (eg: in 2 days).
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   scheduledAt?: never;
 };
@@ -781,37 +781,37 @@ interface CreateBroadcastBaseOptions {
   /**
    * The name of the broadcast
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   name?: string;
   /**
    * A short snippet of text displayed as a preview in recipients' inboxes, often shown below or beside the subject line.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   previewText?: string;
   /**
    * Sender email address. To include a friendly name, use the format `"Your Name <sender@domain.com>"`
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   from: string;
   /**
    * Reply-to email address. For multiple addresses, send as an array of strings.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   replyTo?: string | string[];
   /**
    * Email subject.
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   subject: string;
   /**
    * The id of the topic you want to send to
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/create#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/create-broadcast#body-parameters
    */
   topicId?: string | null;
 }
@@ -917,7 +917,7 @@ interface SendBroadcastBaseOptions {
    * The date should be in ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z)
    * or relative time (eg: in 2 days).
    *
-   * @link https://resend.com/docs/api-reference/broadcasts/send#body-parameters
+   * @link https://resend.com/docs/api-reference/broadcasts/send-broadcast#body-parameters
    */
   scheduledAt?: string;
 }
@@ -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
@@ -2408,7 +2463,7 @@ declare class Usage {
 }
 //#endregion
 //#region src/webhooks/interfaces/webhook-event.interface.d.ts
-type WebhookEvent = 'email.sent' | 'email.scheduled' | 'email.delivered' | 'email.delivery_delayed' | 'email.complained' | 'email.bounced' | 'email.opened' | 'email.clicked' | 'email.received' | 'email.failed' | 'email.suppressed' | 'contact.created' | 'contact.updated' | 'contact.deleted' | 'domain.created' | 'domain.updated' | 'domain.deleted' | 'suppression.added' | 'suppression.removed';
+type WebhookEvent = 'email.sent' | 'email.scheduled' | 'email.delivered' | 'email.delivery_delayed' | 'email.complained' | 'email.bounced' | 'email.opened' | 'email.clicked' | 'email.received' | 'email.failed' | 'email.suppressed' | 'contact.created' | 'contact.updated' | 'contact.deleted' | 'contact.topics.updated' | 'domain.created' | 'domain.updated' | 'domain.deleted' | 'suppression.added' | 'suppression.removed' | 'topic.created' | 'topic.updated' | 'topic.deleted';
 interface BaseEmailEventData {
   broadcast_id?: string;
   created_at: string;
@@ -2468,6 +2523,13 @@ interface ContactEventData {
   last_name?: string | null;
   unsubscribed: boolean;
 }
+interface ContactTopicsEventData {
+  email: string;
+  topics: {
+    id: string;
+    subscription: 'opt_in' | 'opt_out';
+  }[];
+}
 interface DomainRecord {
   record: string;
   name: string;
@@ -2492,6 +2554,15 @@ interface SuppressionEventData {
   source_id: string | null;
   created_at: string;
 }
+interface TopicEventData {
+  id: string;
+  name: string;
+  description: string | null;
+  default_subscription: 'opt_in' | 'opt_out';
+  deleted: boolean;
+  created_at: string;
+  updated_at: string;
+}
 interface EmailSentEvent {
   type: 'email.sent';
   created_at: string;
@@ -2570,6 +2641,11 @@ interface ContactDeletedEvent {
   created_at: string;
   data: ContactEventData;
 }
+interface ContactTopicsUpdatedEvent {
+  type: 'contact.topics.updated';
+  created_at: string;
+  data: ContactTopicsEventData;
+}
 interface DomainCreatedEvent {
   type: 'domain.created';
   created_at: string;
@@ -2595,7 +2671,22 @@ interface SuppressionRemovedEvent {
   created_at: string;
   data: SuppressionEventData;
 }
-type WebhookEventPayload = EmailSentEvent | EmailScheduledEvent | EmailDeliveredEvent | EmailDeliveryDelayedEvent | EmailComplainedEvent | EmailBouncedEvent | EmailOpenedEvent | EmailClickedEvent | EmailReceivedEvent | EmailFailedEvent | EmailSuppressedEvent | ContactCreatedEvent | ContactUpdatedEvent | ContactDeletedEvent | DomainCreatedEvent | DomainUpdatedEvent | DomainDeletedEvent | SuppressionAddedEvent | SuppressionRemovedEvent;
+interface TopicCreatedEvent {
+  type: 'topic.created';
+  created_at: string;
+  data: TopicEventData;
+}
+interface TopicUpdatedEvent {
+  type: 'topic.updated';
+  created_at: string;
+  data: TopicEventData;
+}
+interface TopicDeletedEvent {
+  type: 'topic.deleted';
+  created_at: string;
+  data: TopicEventData;
+}
+type WebhookEventPayload = EmailSentEvent | EmailScheduledEvent | EmailDeliveredEvent | EmailDeliveryDelayedEvent | EmailComplainedEvent | EmailBouncedEvent | EmailOpenedEvent | EmailClickedEvent | EmailReceivedEvent | EmailFailedEvent | EmailSuppressedEvent | ContactCreatedEvent | ContactUpdatedEvent | ContactDeletedEvent | ContactTopicsUpdatedEvent | DomainCreatedEvent | DomainUpdatedEvent | DomainDeletedEvent | SuppressionAddedEvent | SuppressionRemovedEvent | TopicCreatedEvent | TopicUpdatedEvent | TopicDeletedEvent;
 //#endregion
 //#region src/webhooks/interfaces/list-webhook-events.interface.d.ts
 type WebhookEventLogStatus = 'success' | 'pending' | 'failed' | 'attempting';
@@ -2814,4 +2905,4 @@ export declare class Resend {
   delete<T>(path: string, query?: unknown, options?: DeleteOptions): Promise<Response<T>>;
 }
 //#endregion
-export type { ContactCreatedEvent, ContactDeletedEvent, ContactUpdatedEvent, CreateWebhookOptions, CreateWebhookRequestOptions, CreateWebhookResponse, CreateWebhookResponseSuccess, DomainCreatedEvent, DomainDeletedEvent, DomainUpdatedEvent, EmailBouncedEvent, EmailClickedEvent, EmailComplainedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailOpenedEvent, EmailReceivedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, ErrorResponse, GetAttachmentOptions, GetAttachmentResponse, GetAttachmentResponseSuccess, GetWebhookEventOptions, GetWebhookEventResponse, GetWebhookEventResponseSuccess, GetWebhookResponse, GetWebhookResponseSuccess, ListAttachmentsOptions, ListAttachmentsResponse, ListAttachmentsResponseSuccess, ListOAuthGrantsOptions, ListOAuthGrantsResponse, ListOAuthGrantsResponseSuccess, ListWebhookEventAttemptsOptions, ListWebhookEventAttemptsResponse, ListWebhookEventAttemptsResponseSuccess, ListWebhookEventsOptions, ListWebhookEventsResponse, ListWebhookEventsResponseSuccess, ListWebhooksOptions, ListWebhooksResponse, ListWebhooksResponseSuccess, OAuthGrant, RemoveWebhookResponse, RemoveWebhookResponseSuccess, ReplayWebhookEventOptions, ReplayWebhookEventResponse, ReplayWebhookEventResponseSuccess, ResendOptions, Response, RevokeOAuthGrantResponse, RevokeOAuthGrantResponseSuccess, RotateWebhookSigningSecretResponse, RotateWebhookSigningSecretResponseSuccess, SuppressionAddedEvent, SuppressionRemovedEvent, UpdateWebhookOptions, UpdateWebhookResponse, UpdateWebhookResponseSuccess, Webhook, WebhookEvent, WebhookEventAttempt, WebhookEventLog, WebhookEventLogStatus, WebhookEventPayload };
+export type { ContactCreatedEvent, ContactDeletedEvent, ContactTopicsUpdatedEvent, ContactUpdatedEvent, CreateWebhookOptions, CreateWebhookRequestOptions, CreateWebhookResponse, CreateWebhookResponseSuccess, DomainCreatedEvent, DomainDeletedEvent, DomainUpdatedEvent, EmailBouncedEvent, EmailClickedEvent, EmailComplainedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailOpenedEvent, EmailReceivedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, ErrorResponse, GetAttachmentOptions, GetAttachmentResponse, GetAttachmentResponseSuccess, GetWebhookEventOptions, GetWebhookEventResponse, GetWebhookEventResponseSuccess, GetWebhookResponse, GetWebhookResponseSuccess, ListAttachmentsOptions, ListAttachmentsResponse, ListAttachmentsResponseSuccess, ListOAuthGrantsOptions, ListOAuthGrantsResponse, ListOAuthGrantsResponseSuccess, ListWebhookEventAttemptsOptions, ListWebhookEventAttemptsResponse, ListWebhookEventAttemptsResponseSuccess, ListWebhookEventsOptions, ListWebhookEventsResponse, ListWebhookEventsResponseSuccess, ListWebhooksOptions, ListWebhooksResponse, ListWebhooksResponseSuccess, OAuthGrant, RemoveWebhookResponse, RemoveWebhookResponseSuccess, ReplayWebhookEventOptions, ReplayWebhookEventResponse, ReplayWebhookEventResponseSuccess, ResendOptions, Response, RevokeOAuthGrantResponse, RevokeOAuthGrantResponseSuccess, RotateWebhookSigningSecretResponse, RotateWebhookSigningSecretResponseSuccess, SuppressionAddedEvent, SuppressionRemovedEvent, TopicCreatedEvent, TopicDeletedEvent, TopicUpdatedEvent, UpdateWebhookOptions, UpdateWebhookResponse, UpdateWebhookResponseSuccess, Webhook, WebhookEvent, WebhookEventAttempt, WebhookEventLog, WebhookEventLogStatus, WebhookEventPayload };

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import PostalMime from "postal-mime";
 import { Webhook } from "standardwebhooks";
 //#region package.json
-var version = "6.30.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.30.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",