resend 6.19.0-preview-usage.0 → 6.19.0-preview-headless-dashboard.1

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.19.0-preview-usage.0";
+var version = "6.19.0-preview-headless-dashboard.1";
 //#endregion
 //#region src/common/utils/build-pagination-query.ts
 /**
@@ -301,6 +301,13 @@ var Broadcasts = class {
 	async get(id) {
 		return await this.resend.get(`/broadcasts/${id}`);
 	}
+	async metrics(id) {
+		return await this.resend.get(`/broadcasts/${id}/metrics`);
+	}
+	async recipients(id, options) {
+		const url = `/broadcasts/${id}/recipients?${buildRecipientsQuery(options)}`;
+		return await this.resend.get(url);
+	}
 	async remove(id) {
 		return await this.resend.delete(`/broadcasts/${id}`);
 	}
@@ -320,6 +327,14 @@ var Broadcasts = class {
 		});
 	}
 };
+function buildRecipientsQuery(options) {
+	const { type, email, bounceType, ...pagination } = options;
+	const searchParams = new URLSearchParams(buildPaginationQuery(pagination));
+	searchParams.set("type", type);
+	if (email !== void 0) searchParams.set("email", email);
+	if (bounceType !== void 0) searchParams.set("bounce_type", bounceType);
+	return searchParams.toString();
+}
 //#endregion
 //#region src/common/utils/parse-contact-properties-to-api-options.ts
 function parseContactPropertyFromApi(contactProperty) {
@@ -894,7 +909,29 @@ var Emails = class {
 	async cancel(id) {
 		return await this.resend.post(`/emails/${id}/cancel`);
 	}
+	async metrics(options = {}) {
+		const queryString = buildMetricsQuery$1(options);
+		const url = queryString ? `/emails/metrics?${queryString}` : "/emails/metrics";
+		return await this.resend.get(url);
+	}
 };
+function buildMetricsQuery$1(options) {
+	const params = {
+		start_date: options.startDate,
+		end_date: options.endDate,
+		timezone: options.timezone,
+		granularity: options.granularity,
+		metrics: options.metrics?.join(","),
+		dimensions: options.dimensions?.join(","),
+		"filter[domain_id]": options.filter?.domainId?.join(","),
+		"filter[email_id]": options.filter?.emailId?.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/events/events.ts
 var Events = class {
@@ -972,7 +1009,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(","),
+		"filter[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

@@ -801,6 +801,82 @@ interface GetBroadcastResponseSuccess extends Broadcast {
 }
 type GetBroadcastResponse = Response<GetBroadcastResponseSuccess>;
 //#endregion
+//#region src/broadcasts/interfaces/get-broadcast-metrics.interface.d.ts
+interface BroadcastMetricCounter {
+  total: number;
+  percentage: number;
+}
+interface BroadcastMetricsClickedLink {
+  url: string;
+  clicks: number;
+  unique_clicks: number;
+  percentage: number;
+}
+interface GetBroadcastMetricsResponseSuccess {
+  object: 'broadcast_metrics';
+  broadcast_id: string;
+  status: Broadcast['status'];
+  created_at: string;
+  scheduled_at: string | null;
+  sent_at: string | null;
+  total: number;
+  sent: number;
+  remaining: number;
+  delivered: BroadcastMetricCounter;
+  opened: BroadcastMetricCounter;
+  clicked: BroadcastMetricCounter;
+  unsubscribed: BroadcastMetricCounter;
+  bounced: BroadcastMetricCounter;
+  complained: BroadcastMetricCounter;
+  suppressed: BroadcastMetricCounter;
+  clicked_links: BroadcastMetricsClickedLink[];
+}
+type GetBroadcastMetricsResponse = Response<GetBroadcastMetricsResponseSuccess>;
+//#endregion
+//#region src/broadcasts/interfaces/list-broadcast-recipients.interface.d.ts
+type BroadcastRecipientEventType = 'sent' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'unsubscribed' | 'suppressed';
+type BroadcastRecipientBounceType = 'permanent' | 'transient' | 'undetermined';
+type ListBroadcastRecipientsOptions<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = PaginationOptions & {
+  type: T;
+  email?: string;
+  bounceType?: T extends 'bounced' ? BroadcastRecipientBounceType : never;
+};
+interface BroadcastRecipientClickedLink {
+  url: string;
+  clicks: number;
+}
+type BroadcastRecipientBase = {
+  id: string;
+  contact_id: string | null;
+  email: string;
+};
+type BroadcastRecipientLoose = BroadcastRecipientBase & {
+  count?: number;
+  clicked_links?: BroadcastRecipientClickedLink[];
+  bounce_type?: BroadcastRecipientBounceType;
+};
+type IsUnion<T, B = T> = T extends B ? ([B] extends [T] ? false : true) : never;
+type BroadcastRecipientFieldsByType = {
+  sent: unknown;
+  delivered: unknown;
+  opened: {
+    count: number;
+  };
+  clicked: {
+    count: number;
+    clicked_links: BroadcastRecipientClickedLink[];
+  };
+  bounced: {
+    bounce_type: BroadcastRecipientBounceType;
+  };
+  complained: unknown;
+  unsubscribed: unknown;
+  suppressed: unknown;
+};
+type BroadcastRecipient<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = IsUnion<T> extends true ? BroadcastRecipientLoose : BroadcastRecipientBase & BroadcastRecipientFieldsByType[T];
+type ListBroadcastRecipientsResponseSuccess<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = PaginatedData<BroadcastRecipient<T>[]>;
+type ListBroadcastRecipientsResponse<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = Response<ListBroadcastRecipientsResponseSuccess<T>>;
+//#endregion
 //#region src/broadcasts/interfaces/list-broadcasts.interface.d.ts
 type ListBroadcastsOptions = PaginationOptions;
 type ListBroadcastsResponseSuccess = {
@@ -1391,6 +1467,91 @@ interface GetEmailResponseSuccess {
 }
 type GetEmailResponse = Response<GetEmailResponseSuccess>;
 //#endregion
+//#region src/emails/interfaces/get-metrics.interface.d.ts
+type EmailMetric = 'received' | 'delivered' | 'complained' | 'suppressed' | 'bounced' | 'bounced_transient' | 'bounced_permanent' | 'bounced_undetermined' | 'opened' | 'clicked' | 'unsubscribed' | 'delivery_delayed' | 'failed' | 'sent' | 'unique_opened' | 'unique_clicked' | 'delivery_rate' | 'open_rate' | 'click_rate' | 'bounce_rate' | 'complaint_rate' | 'unsubscribe_rate';
+type EmailMetricsDimension = 'period' | 'domain' | 'email';
+type EmailMetricsGranularity = 'hourly' | 'daily' | 'weekly';
+type EmailMetricsSortBy = 'date' | EmailMetric;
+type EmailMetricsSortOrder = 'asc' | 'desc';
+type GetEmailsMetricsOptions = {
+  /**
+   * The start of the date range, as an ISO 8601 date or datetime.
+   * Defaults to 6 days before `endDate`.
+   *
+   * @link https://resend.com/docs/api-reference/emails/get-metrics#query-parameters
+   */
+  startDate?: string;
+  /**
+   * The end of the date range, as an ISO 8601 date or datetime.
+   * Defaults to now.
+   *
+   * @link https://resend.com/docs/api-reference/emails/get-metrics#query-parameters
+   */
+  endDate?: string;
+  /**
+   * The IANA timezone used to bucket periods when `period` is in `dimensions`.
+   * Defaults to `UTC`.
+   */
+  timezone?: string;
+  /**
+   * The bucket size used when `period` is in `dimensions`.
+   * Defaults to `daily`.
+   */
+  granularity?: EmailMetricsGranularity;
+  /**
+   * The metrics to include in the response. Defaults to all metrics.
+   */
+  metrics?: EmailMetric[];
+  /**
+   * The dimensions to break the response down by. Defaults to `[]`, which
+   * returns a single `totals` row for the whole range, with no `data`.
+   */
+  dimensions?: EmailMetricsDimension[];
+  filter?: {
+    /**
+     * Restrict the response to these sending domain IDs.
+     */
+    domainId?: string[];
+    /**
+     * Restrict the response to these email IDs. Cannot be combined with the
+     * `domain` dimension.
+     */
+    emailId?: string[];
+  };
+  /**
+   * What to sort `data` by. Defaults to `date` when `dimensions` includes
+   * `period`, or `sent` otherwise.
+   *
+   * @link https://resend.com/docs/api-reference/emails/get-metrics#query-parameters
+   */
+  sortBy?: EmailMetricsSortBy;
+  /**
+   * The sort direction for `sortBy`. Defaults to `asc` when `dimensions`
+   * includes `period`, `desc` otherwise.
+   */
+  sortOrder?: EmailMetricsSortOrder;
+};
+type EmailMetricsTotals = Partial<Record<EmailMetric, number>>;
+type EmailMetricsDataRow = EmailMetricsTotals & {
+  period?: string;
+  domain_id?: string;
+  domain_name?: string;
+  email_id?: string;
+};
+interface GetEmailsMetricsResponseSuccess {
+  object: 'metrics';
+  start_date: string;
+  end_date: string;
+  metrics: EmailMetric[];
+  dimensions: EmailMetricsDimension[];
+  granularity: EmailMetricsGranularity;
+  sort_by: EmailMetricsSortBy;
+  sort_order: EmailMetricsSortOrder;
+  totals: EmailMetricsTotals;
+  data?: EmailMetricsDataRow[];
+}
+type GetEmailsMetricsResponse = Response<GetEmailsMetricsResponseSuccess>;
+//#endregion
 //#region src/emails/interfaces/list-emails-options.interface.d.ts
 type ListEmailsOptions = PaginationOptions;
 type ListEmail = Omit<GetEmailResponseSuccess, 'html' | 'text' | 'tags' | 'object'>;
@@ -1675,6 +1836,8 @@ declare class Broadcasts {
   send(id: string, payload?: SendBroadcastOptions): Promise<SendBroadcastResponse>;
   list(options?: ListBroadcastsOptions): Promise<ListBroadcastsResponse>;
   get(id: string): Promise<GetBroadcastResponse>;
+  metrics(id: string): Promise<GetBroadcastMetricsResponse>;
+  recipients<T extends BroadcastRecipientEventType>(id: string, options: ListBroadcastRecipientsOptions<T>): Promise<ListBroadcastRecipientsResponse<T>>;
   remove(id: string): Promise<RemoveBroadcastResponse>;
   update(id: string, payload: UpdateBroadcastOptions): Promise<UpdateBroadcastResponse>;
 }
@@ -1796,6 +1959,7 @@ declare class Emails {
   list(options?: ListEmailsOptions): Promise<ListEmailsResponse>;
   update(payload: UpdateEmailOptions): Promise<UpdateEmailResponse>;
   cancel(id: string): Promise<CancelEmailResponse>;
+  metrics(options?: GetEmailsMetricsOptions): Promise<GetEmailsMetricsResponse>;
 }
 //#endregion
 //#region src/events/events.d.ts
@@ -1836,6 +2000,60 @@ interface CreateSegmentResponseSuccess extends Pick<Segment, 'name' | 'id'> {
 }
 type CreateSegmentResponse = Response<CreateSegmentResponseSuccess>;
 //#endregion
+//#region src/segments/interfaces/get-metrics.interface.d.ts
+type SegmentMetric = 'all_contacts' | 'subscribers' | 'unsubscribers';
+type SegmentMetricsDimension = 'segment';
+type SegmentMetricsSortBy = 'date' | SegmentMetric;
+type SegmentMetricsSortOrder = 'asc' | 'desc';
+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;
+};
+type SegmentMetricsTotals = Partial<Record<SegmentMetric, number>>;
+type SegmentMetricsDataRow = SegmentMetricsTotals & {
+  segment_id: string;
+  segment_name: string;
+};
+interface GetSegmentsMetricsResponseSuccess {
+  object: 'segments_metrics';
+  metrics: SegmentMetric[];
+  dimensions: SegmentMetricsDimension[];
+  sort_by: SegmentMetricsSortBy;
+  sort_order: SegmentMetricsSortOrder;
+  totals: SegmentMetricsTotals;
+  data?: SegmentMetricsDataRow[];
+}
+type GetSegmentsMetricsResponse = Response<GetSegmentsMetricsResponseSuccess>;
+//#endregion
 //#region src/segments/interfaces/get-segment.interface.d.ts
 interface GetSegmentResponseSuccess extends Pick<Segment, 'id' | 'name' | 'created_at'> {
   object: 'segment';
@@ -1866,6 +2084,7 @@ declare class Segments {
   list(options?: ListSegmentsOptions): Promise<ListSegmentsResponse>;
   get(id: string): Promise<GetSegmentResponse>;
   remove(id: string): Promise<RemoveSegmentResponse>;
+  metrics(options?: GetSegmentsMetricsOptions): Promise<GetSegmentsMetricsResponse>;
 }
 //#endregion
 //#region src/suppressions/batch/interfaces/batch-add-suppressions.interface.d.ts
@@ -2512,4 +2731,4 @@ declare class Resend {
   delete<T>(path: string, query?: unknown, options?: DeleteOptions): Promise<Response<T>>;
 }
 //#endregion
-export { AddContactSegmentOptions, AddContactSegmentResponse, AddContactSegmentResponseSuccess, AddSuppressionOptions, AddSuppressionResponse, AddSuppressionResponseSuccess, AddToSegmentStepConfig, ApiContactProperty, ApiKey, Attachment, AttachmentData, Automation, AutomationConnection, AutomationConnectionType, AutomationResponseConnection, AutomationResponseStep, AutomationRun, AutomationRunItem, AutomationRunStatus, AutomationRunStep, AutomationRunStepStatus, AutomationStatus, AutomationStep, AutomationStepType, BatchAddSuppressionsOptions, BatchAddSuppressionsResponse, BatchAddSuppressionsResponseSuccess, BatchRemoveSuppressionsOptions, BatchRemoveSuppressionsResponse, BatchRemoveSuppressionsResponseSuccess, Broadcast, CancelEmailResponse, CancelEmailResponseSuccess, ClaimDomainOptions, ClaimDomainRequestOptions, ClaimDomainResponse, ClaimDomainResponseSuccess, ConditionRule, ConditionStepConfig, Contact, ContactCreatedEvent, ContactDeleteStepConfig, ContactDeletedEvent, ContactImport, ContactImportColumnMap, ContactImportCounts, ContactImportOnConflict, ContactImportPropertyMapping, ContactImportPropertyType, ContactImportSegment, ContactImportStatus, ContactImportTopic, ContactProperty, ContactSegmentsBaseOptions, ContactTopic, ContactUpdateStepConfig, ContactUpdatedEvent, CreateApiKeyOptions, CreateApiKeyRequestOptions, CreateApiKeyResponse, CreateApiKeyResponseSuccess, CreateAutomationOptions, CreateAutomationResponse, CreateAutomationResponseSuccess, CreateBatchEmailOptions, CreateBatchOptions, CreateBatchRequestOptions, CreateBatchResponse, CreateBatchSuccessResponse, CreateBroadcastOptions, CreateBroadcastRequestOptions, CreateBroadcastResponse, CreateBroadcastResponseSuccess, CreateContactImportOptions, CreateContactImportRequestOptions, CreateContactImportResponse, CreateContactImportResponseSuccess, CreateContactOptions, CreateContactPropertyApiOptions, CreateContactPropertyOptions, CreateContactPropertyResponse, CreateContactPropertyResponseSuccess, CreateContactRequestOptions, CreateContactResponse, CreateContactResponseSuccess, CreateDomainOptions, CreateDomainRequestOptions, CreateDomainResponse, CreateDomainResponseSuccess, CreateEmailOptions, CreateEmailRequestOptions, CreateEmailResponse, CreateEmailResponseSuccess, CreateEventOptions, CreateEventResponse, CreateEventResponseSuccess, CreateSegmentOptions, CreateSegmentRequestOptions, CreateSegmentResponse, CreateSegmentResponseSuccess, CreateTemplateOptions, CreateTemplateRequestOptions, CreateTemplateResponse, CreateTemplateResponseSuccess, CreateTopicOptions, CreateTopicResponse, CreateTopicResponseSuccess, CreateWebhookOptions, CreateWebhookRequestOptions, CreateWebhookResponse, CreateWebhookResponseSuccess, DelayStepConfig, DeleteOptions, Domain, DomainApiOptions, DomainCapabilities, DomainCapabilityStatus, DomainClaim, DomainClaimBlockedReason, DomainClaimRecord, DomainClaimStatus, DomainCreatedEvent, DomainDeletedEvent, DomainDkimRecord, DomainNameservers, DomainRecordStatus, DomainRecords, DomainRegion, DomainSpfRecord, DomainStatus, DomainUpdatedEvent, DuplicateTemplateResponse, DuplicateTemplateResponseSuccess, EmailApiAttachment, EmailApiOptions, EmailBouncedEvent, EmailClickedEvent, EmailComplainedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailOpenedEvent, EmailReceivedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, type ErrorResponse, Event, EventSchemaMap, EventSchemaType, ForwardReceivingEmailOptions, ForwardReceivingEmailRequestOptions, ForwardReceivingEmailResponse, ForwardReceivingEmailResponseSuccess, GetAttachmentOptions, GetAttachmentResponse, GetAttachmentResponseSuccess, GetAutomationResponse, GetAutomationResponseSuccess, GetAutomationRunOptions, GetAutomationRunResponse, GetAutomationRunResponseSuccess, GetBroadcastResponse, GetBroadcastResponseSuccess, GetContactImportResponse, GetContactImportResponseSuccess, GetContactOptions, GetContactPropertyResponse, GetContactPropertyResponseSuccess, GetContactResponse, GetContactResponseSuccess, GetDomainClaimResponse, GetDomainClaimResponseSuccess, GetDomainResponse, GetDomainResponseSuccess, GetEmailResponse, GetEmailResponseSuccess, GetEventResponse, GetEventResponseSuccess, GetLogResponse, GetLogResponseSuccess, GetOptions, GetReceivingEmailOptions, GetReceivingEmailResponse, GetReceivingEmailResponseSuccess, GetSegmentResponse, GetSegmentResponseSuccess, GetSuppressionResponse, GetSuppressionResponseSuccess, GetTemplateResponse, GetTemplateResponseSuccess, GetTopicOptions, GetTopicResponse, GetTopicResponseSuccess, GetUsageResponse, GetUsageResponseSuccess, GetWebhookResponse, GetWebhookResponseSuccess, IdempotentRequest, InboundAttachment, LegacyCreateContactOptions, ListApiKeysOptions, ListApiKeysResponse, ListApiKeysResponseSuccess, ListAttachmentsOptions, ListAttachmentsResponse, ListAttachmentsResponseSuccess, ListAutomationRunsOptions, ListAutomationRunsResponse, ListAutomationRunsResponseSuccess, ListAutomationsOptions, ListAutomationsResponse, ListAutomationsResponseSuccess, ListBroadcastsOptions, ListBroadcastsResponse, ListBroadcastsResponseSuccess, ListContactImportsOptions, ListContactImportsResponse, ListContactImportsResponseSuccess, ListContactPropertiesOptions, ListContactPropertiesResponse, ListContactPropertiesResponseSuccess, ListContactSegmentsOptions, ListContactSegmentsResponse, ListContactSegmentsResponseSuccess, ListContactTopicsOptions, ListContactTopicsRequestOptions, ListContactTopicsResponse, ListContactTopicsResponseSuccess, ListContactsOptions, ListContactsResponse, ListContactsResponseSuccess, ListDomainsOptions, ListDomainsResponse, ListDomainsResponseSuccess, ListEmail, ListEmailsOptions, ListEmailsResponse, ListEmailsResponseSuccess, ListEventsOptions, ListEventsResponse, ListEventsResponseSuccess, ListLogsOptions, ListLogsResponse, ListLogsResponseSuccess, ListOAuthGrantsOptions, ListOAuthGrantsResponse, ListOAuthGrantsResponseSuccess, ListReceivingEmail, ListReceivingEmailsOptions, ListReceivingEmailsResponse, ListReceivingEmailsResponseSuccess, ListSegmentsOptions, ListSegmentsResponse, ListSegmentsResponseSuccess, ListSuppressionsOptions, ListSuppressionsResponse, ListSuppressionsResponseSuccess, ListTemplatesOptions, ListTemplatesResponse, ListTemplatesResponseSuccess, ListTopicsResponse, ListTopicsResponseSuccess, ListWebhooksOptions, ListWebhooksResponse, ListWebhooksResponseSuccess, Log, OAuthGrant, PaginatedData, PaginationOptions, PatchOptions, PostOptions, PublishTemplateResponse, PublishTemplateResponseSuccess, PutOptions, ReceivingRecord, RemoveApiKeyResponse, RemoveApiKeyResponseSuccess, RemoveAutomationResponse, RemoveAutomationResponseSuccess, RemoveBroadcastResponse, RemoveBroadcastResponseSuccess, RemoveContactOptions, RemoveContactPropertyResponse, RemoveContactPropertyResponseSuccess, RemoveContactSegmentOptions, RemoveContactSegmentResponse, RemoveContactSegmentResponseSuccess, RemoveContactsResponse, RemoveContactsResponseSuccess, RemoveDomainsResponse, RemoveDomainsResponseSuccess, RemoveEventResponse, RemoveEventResponseSuccess, RemoveSegmentResponse, RemoveSegmentResponseSuccess, RemoveSuppressionResponse, RemoveSuppressionResponseSuccess, RemoveTemplateResponse, RemoveTemplateResponseSuccess, RemoveTopicResponse, RemoveTopicResponseSuccess, RemoveWebhookResponse, RemoveWebhookResponseSuccess, RequireAtLeastOne, Resend, type ResendOptions, type Response, RevokeOAuthGrantResponse, RevokeOAuthGrantResponseSuccess, Segment, SelectingField, SendBroadcastOptions, SendBroadcastRequestOptions, SendBroadcastResponse, SendBroadcastResponseSuccess, SendEmailStepConfig, SendEventOptions, SendEventResponse, SendEventResponseSuccess, StopAutomationResponse, StopAutomationResponseSuccess, Suppression, SuppressionAddedEvent, SuppressionListEntry, SuppressionOrigin, SuppressionRemovedEvent, Tag, Template, TemplateVariable, TemplateVariableValue, Topic, TrackingCaaRecord, TrackingRecord, TriggerStepConfig, UpdateAutomationOptions, UpdateAutomationResponse, UpdateAutomationResponseSuccess, UpdateBroadcastOptions, UpdateBroadcastResponse, UpdateBroadcastResponseSuccess, UpdateContactOptions, UpdateContactPropertyApiOptions, UpdateContactPropertyOptions, UpdateContactPropertyResponse, UpdateContactPropertyResponseSuccess, UpdateContactResponse, UpdateContactResponseSuccess, UpdateContactTopicsOptions, UpdateContactTopicsRequestOptions, UpdateContactTopicsResponse, UpdateContactTopicsResponseSuccess, UpdateDomainsOptions, UpdateDomainsResponse, UpdateDomainsResponseSuccess, UpdateEmailOptions, UpdateEmailResponse, UpdateEmailResponseSuccess, UpdateEventOptions, UpdateEventResponse, UpdateEventResponseSuccess, UpdateTemplateOptions, UpdateTemplateResponse, UpdateTemplateResponseSuccess, UpdateTopicOptions, UpdateTopicResponse, UpdateTopicResponseSuccess, UpdateWebhookOptions, UpdateWebhookResponse, UpdateWebhookResponseSuccess, VerifyDomainClaimResponse, VerifyDomainClaimResponseSuccess, VerifyDomainsResponse, VerifyDomainsResponseSuccess, WaitForEventStepConfig, Webhook, WebhookEvent, WebhookEventPayload };
+export { AddContactSegmentOptions, AddContactSegmentResponse, AddContactSegmentResponseSuccess, AddSuppressionOptions, AddSuppressionResponse, AddSuppressionResponseSuccess, AddToSegmentStepConfig, ApiContactProperty, ApiKey, Attachment, AttachmentData, Automation, AutomationConnection, AutomationConnectionType, AutomationResponseConnection, AutomationResponseStep, AutomationRun, AutomationRunItem, AutomationRunStatus, AutomationRunStep, AutomationRunStepStatus, AutomationStatus, AutomationStep, AutomationStepType, BatchAddSuppressionsOptions, BatchAddSuppressionsResponse, BatchAddSuppressionsResponseSuccess, BatchRemoveSuppressionsOptions, BatchRemoveSuppressionsResponse, BatchRemoveSuppressionsResponseSuccess, Broadcast, BroadcastMetricCounter, BroadcastMetricsClickedLink, BroadcastRecipient, BroadcastRecipientBounceType, BroadcastRecipientClickedLink, BroadcastRecipientEventType, CancelEmailResponse, CancelEmailResponseSuccess, ClaimDomainOptions, ClaimDomainRequestOptions, ClaimDomainResponse, ClaimDomainResponseSuccess, ConditionRule, ConditionStepConfig, Contact, ContactCreatedEvent, ContactDeleteStepConfig, ContactDeletedEvent, ContactImport, ContactImportColumnMap, ContactImportCounts, ContactImportOnConflict, ContactImportPropertyMapping, ContactImportPropertyType, ContactImportSegment, ContactImportStatus, ContactImportTopic, ContactProperty, ContactSegmentsBaseOptions, ContactTopic, ContactUpdateStepConfig, ContactUpdatedEvent, CreateApiKeyOptions, CreateApiKeyRequestOptions, CreateApiKeyResponse, CreateApiKeyResponseSuccess, CreateAutomationOptions, CreateAutomationResponse, CreateAutomationResponseSuccess, CreateBatchEmailOptions, CreateBatchOptions, CreateBatchRequestOptions, CreateBatchResponse, CreateBatchSuccessResponse, CreateBroadcastOptions, CreateBroadcastRequestOptions, CreateBroadcastResponse, CreateBroadcastResponseSuccess, CreateContactImportOptions, CreateContactImportRequestOptions, CreateContactImportResponse, CreateContactImportResponseSuccess, CreateContactOptions, CreateContactPropertyApiOptions, CreateContactPropertyOptions, CreateContactPropertyResponse, CreateContactPropertyResponseSuccess, CreateContactRequestOptions, CreateContactResponse, CreateContactResponseSuccess, CreateDomainOptions, CreateDomainRequestOptions, CreateDomainResponse, CreateDomainResponseSuccess, CreateEmailOptions, CreateEmailRequestOptions, CreateEmailResponse, CreateEmailResponseSuccess, CreateEventOptions, CreateEventResponse, CreateEventResponseSuccess, CreateSegmentOptions, CreateSegmentRequestOptions, CreateSegmentResponse, CreateSegmentResponseSuccess, CreateTemplateOptions, CreateTemplateRequestOptions, CreateTemplateResponse, CreateTemplateResponseSuccess, CreateTopicOptions, CreateTopicResponse, CreateTopicResponseSuccess, CreateWebhookOptions, CreateWebhookRequestOptions, CreateWebhookResponse, CreateWebhookResponseSuccess, DelayStepConfig, DeleteOptions, Domain, DomainApiOptions, DomainCapabilities, DomainCapabilityStatus, DomainClaim, DomainClaimBlockedReason, DomainClaimRecord, DomainClaimStatus, DomainCreatedEvent, DomainDeletedEvent, DomainDkimRecord, DomainNameservers, DomainRecordStatus, DomainRecords, DomainRegion, DomainSpfRecord, DomainStatus, DomainUpdatedEvent, DuplicateTemplateResponse, DuplicateTemplateResponseSuccess, EmailApiAttachment, EmailApiOptions, EmailBouncedEvent, EmailClickedEvent, EmailComplainedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailMetric, EmailMetricsDataRow, EmailMetricsDimension, EmailMetricsGranularity, EmailMetricsSortBy, EmailMetricsSortOrder, EmailMetricsTotals, EmailOpenedEvent, EmailReceivedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, type ErrorResponse, Event, EventSchemaMap, EventSchemaType, ForwardReceivingEmailOptions, ForwardReceivingEmailRequestOptions, ForwardReceivingEmailResponse, ForwardReceivingEmailResponseSuccess, GetAttachmentOptions, GetAttachmentResponse, GetAttachmentResponseSuccess, GetAutomationResponse, GetAutomationResponseSuccess, GetAutomationRunOptions, GetAutomationRunResponse, GetAutomationRunResponseSuccess, GetBroadcastMetricsResponse, GetBroadcastMetricsResponseSuccess, GetBroadcastResponse, GetBroadcastResponseSuccess, GetContactImportResponse, GetContactImportResponseSuccess, GetContactOptions, GetContactPropertyResponse, GetContactPropertyResponseSuccess, GetContactResponse, GetContactResponseSuccess, GetDomainClaimResponse, GetDomainClaimResponseSuccess, GetDomainResponse, GetDomainResponseSuccess, GetEmailResponse, GetEmailResponseSuccess, GetEmailsMetricsOptions, GetEmailsMetricsResponse, GetEmailsMetricsResponseSuccess, GetEventResponse, GetEventResponseSuccess, GetLogResponse, GetLogResponseSuccess, GetOptions, GetReceivingEmailOptions, GetReceivingEmailResponse, GetReceivingEmailResponseSuccess, GetSegmentResponse, GetSegmentResponseSuccess, GetSegmentsMetricsOptions, GetSegmentsMetricsResponse, GetSegmentsMetricsResponseSuccess, GetSuppressionResponse, GetSuppressionResponseSuccess, GetTemplateResponse, GetTemplateResponseSuccess, GetTopicOptions, GetTopicResponse, GetTopicResponseSuccess, GetUsageResponse, GetUsageResponseSuccess, GetWebhookResponse, GetWebhookResponseSuccess, IdempotentRequest, InboundAttachment, LegacyCreateContactOptions, ListApiKeysOptions, ListApiKeysResponse, ListApiKeysResponseSuccess, ListAttachmentsOptions, ListAttachmentsResponse, ListAttachmentsResponseSuccess, ListAutomationRunsOptions, ListAutomationRunsResponse, ListAutomationRunsResponseSuccess, ListAutomationsOptions, ListAutomationsResponse, ListAutomationsResponseSuccess, ListBroadcastRecipientsOptions, ListBroadcastRecipientsResponse, ListBroadcastRecipientsResponseSuccess, ListBroadcastsOptions, ListBroadcastsResponse, ListBroadcastsResponseSuccess, ListContactImportsOptions, ListContactImportsResponse, ListContactImportsResponseSuccess, ListContactPropertiesOptions, ListContactPropertiesResponse, ListContactPropertiesResponseSuccess, ListContactSegmentsOptions, ListContactSegmentsResponse, ListContactSegmentsResponseSuccess, ListContactTopicsOptions, ListContactTopicsRequestOptions, ListContactTopicsResponse, ListContactTopicsResponseSuccess, ListContactsOptions, ListContactsResponse, ListContactsResponseSuccess, ListDomainsOptions, ListDomainsResponse, ListDomainsResponseSuccess, ListEmail, ListEmailsOptions, ListEmailsResponse, ListEmailsResponseSuccess, ListEventsOptions, ListEventsResponse, ListEventsResponseSuccess, ListLogsOptions, ListLogsResponse, ListLogsResponseSuccess, ListOAuthGrantsOptions, ListOAuthGrantsResponse, ListOAuthGrantsResponseSuccess, ListReceivingEmail, ListReceivingEmailsOptions, ListReceivingEmailsResponse, ListReceivingEmailsResponseSuccess, ListSegmentsOptions, ListSegmentsResponse, ListSegmentsResponseSuccess, ListSuppressionsOptions, ListSuppressionsResponse, ListSuppressionsResponseSuccess, ListTemplatesOptions, ListTemplatesResponse, ListTemplatesResponseSuccess, ListTopicsResponse, ListTopicsResponseSuccess, ListWebhooksOptions, ListWebhooksResponse, ListWebhooksResponseSuccess, Log, OAuthGrant, PaginatedData, PaginationOptions, PatchOptions, PostOptions, PublishTemplateResponse, PublishTemplateResponseSuccess, PutOptions, ReceivingRecord, RemoveApiKeyResponse, RemoveApiKeyResponseSuccess, RemoveAutomationResponse, RemoveAutomationResponseSuccess, RemoveBroadcastResponse, RemoveBroadcastResponseSuccess, RemoveContactOptions, RemoveContactPropertyResponse, RemoveContactPropertyResponseSuccess, RemoveContactSegmentOptions, RemoveContactSegmentResponse, RemoveContactSegmentResponseSuccess, RemoveContactsResponse, RemoveContactsResponseSuccess, RemoveDomainsResponse, RemoveDomainsResponseSuccess, RemoveEventResponse, RemoveEventResponseSuccess, RemoveSegmentResponse, RemoveSegmentResponseSuccess, RemoveSuppressionResponse, RemoveSuppressionResponseSuccess, RemoveTemplateResponse, RemoveTemplateResponseSuccess, RemoveTopicResponse, RemoveTopicResponseSuccess, RemoveWebhookResponse, RemoveWebhookResponseSuccess, RequireAtLeastOne, Resend, type ResendOptions, type Response, RevokeOAuthGrantResponse, RevokeOAuthGrantResponseSuccess, Segment, SegmentMetric, SegmentMetricsDataRow, SegmentMetricsDimension, SegmentMetricsSortBy, SegmentMetricsSortOrder, SegmentMetricsTotals, SelectingField, SendBroadcastOptions, SendBroadcastRequestOptions, SendBroadcastResponse, SendBroadcastResponseSuccess, SendEmailStepConfig, SendEventOptions, SendEventResponse, SendEventResponseSuccess, StopAutomationResponse, StopAutomationResponseSuccess, Suppression, SuppressionAddedEvent, SuppressionListEntry, SuppressionOrigin, SuppressionRemovedEvent, Tag, Template, TemplateVariable, TemplateVariableValue, Topic, TrackingCaaRecord, TrackingRecord, TriggerStepConfig, UpdateAutomationOptions, UpdateAutomationResponse, UpdateAutomationResponseSuccess, UpdateBroadcastOptions, UpdateBroadcastResponse, UpdateBroadcastResponseSuccess, UpdateContactOptions, UpdateContactPropertyApiOptions, UpdateContactPropertyOptions, UpdateContactPropertyResponse, UpdateContactPropertyResponseSuccess, UpdateContactResponse, UpdateContactResponseSuccess, UpdateContactTopicsOptions, UpdateContactTopicsRequestOptions, UpdateContactTopicsResponse, UpdateContactTopicsResponseSuccess, UpdateDomainsOptions, UpdateDomainsResponse, UpdateDomainsResponseSuccess, UpdateEmailOptions, UpdateEmailResponse, UpdateEmailResponseSuccess, UpdateEventOptions, UpdateEventResponse, UpdateEventResponseSuccess, UpdateTemplateOptions, UpdateTemplateResponse, UpdateTemplateResponseSuccess, UpdateTopicOptions, UpdateTopicResponse, UpdateTopicResponseSuccess, UpdateWebhookOptions, UpdateWebhookResponse, UpdateWebhookResponseSuccess, VerifyDomainClaimResponse, VerifyDomainClaimResponseSuccess, VerifyDomainsResponse, VerifyDomainsResponseSuccess, WaitForEventStepConfig, Webhook, WebhookEvent, WebhookEventPayload };

package/dist/index.d.mts

@@ -801,6 +801,82 @@ interface GetBroadcastResponseSuccess extends Broadcast {
 }
 type GetBroadcastResponse = Response<GetBroadcastResponseSuccess>;
 //#endregion
+//#region src/broadcasts/interfaces/get-broadcast-metrics.interface.d.ts
+interface BroadcastMetricCounter {
+  total: number;
+  percentage: number;
+}
+interface BroadcastMetricsClickedLink {
+  url: string;
+  clicks: number;
+  unique_clicks: number;
+  percentage: number;
+}
+interface GetBroadcastMetricsResponseSuccess {
+  object: 'broadcast_metrics';
+  broadcast_id: string;
+  status: Broadcast['status'];
+  created_at: string;
+  scheduled_at: string | null;
+  sent_at: string | null;
+  total: number;
+  sent: number;
+  remaining: number;
+  delivered: BroadcastMetricCounter;
+  opened: BroadcastMetricCounter;
+  clicked: BroadcastMetricCounter;
+  unsubscribed: BroadcastMetricCounter;
+  bounced: BroadcastMetricCounter;
+  complained: BroadcastMetricCounter;
+  suppressed: BroadcastMetricCounter;
+  clicked_links: BroadcastMetricsClickedLink[];
+}
+type GetBroadcastMetricsResponse = Response<GetBroadcastMetricsResponseSuccess>;
+//#endregion
+//#region src/broadcasts/interfaces/list-broadcast-recipients.interface.d.ts
+type BroadcastRecipientEventType = 'sent' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | 'unsubscribed' | 'suppressed';
+type BroadcastRecipientBounceType = 'permanent' | 'transient' | 'undetermined';
+type ListBroadcastRecipientsOptions<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = PaginationOptions & {
+  type: T;
+  email?: string;
+  bounceType?: T extends 'bounced' ? BroadcastRecipientBounceType : never;
+};
+interface BroadcastRecipientClickedLink {
+  url: string;
+  clicks: number;
+}
+type BroadcastRecipientBase = {
+  id: string;
+  contact_id: string | null;
+  email: string;
+};
+type BroadcastRecipientLoose = BroadcastRecipientBase & {
+  count?: number;
+  clicked_links?: BroadcastRecipientClickedLink[];
+  bounce_type?: BroadcastRecipientBounceType;
+};
+type IsUnion<T, B = T> = T extends B ? ([B] extends [T] ? false : true) : never;
+type BroadcastRecipientFieldsByType = {
+  sent: unknown;
+  delivered: unknown;
+  opened: {
+    count: number;
+  };
+  clicked: {
+    count: number;
+    clicked_links: BroadcastRecipientClickedLink[];
+  };
+  bounced: {
+    bounce_type: BroadcastRecipientBounceType;
+  };
+  complained: unknown;
+  unsubscribed: unknown;
+  suppressed: unknown;
+};
+type BroadcastRecipient<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = IsUnion<T> extends true ? BroadcastRecipientLoose : BroadcastRecipientBase & BroadcastRecipientFieldsByType[T];
+type ListBroadcastRecipientsResponseSuccess<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = PaginatedData<BroadcastRecipient<T>[]>;
+type ListBroadcastRecipientsResponse<T extends BroadcastRecipientEventType = BroadcastRecipientEventType> = Response<ListBroadcastRecipientsResponseSuccess<T>>;
+//#endregion
 //#region src/broadcasts/interfaces/list-broadcasts.interface.d.ts
 type ListBroadcastsOptions = PaginationOptions;
 type ListBroadcastsResponseSuccess = {
@@ -1391,6 +1467,91 @@ interface GetEmailResponseSuccess {
 }
 type GetEmailResponse = Response<GetEmailResponseSuccess>;
 //#endregion
+//#region src/emails/interfaces/get-metrics.interface.d.ts
+type EmailMetric = 'received' | 'delivered' | 'complained' | 'suppressed' | 'bounced' | 'bounced_transient' | 'bounced_permanent' | 'bounced_undetermined' | 'opened' | 'clicked' | 'unsubscribed' | 'delivery_delayed' | 'failed' | 'sent' | 'unique_opened' | 'unique_clicked' | 'delivery_rate' | 'open_rate' | 'click_rate' | 'bounce_rate' | 'complaint_rate' | 'unsubscribe_rate';
+type EmailMetricsDimension = 'period' | 'domain' | 'email';
+type EmailMetricsGranularity = 'hourly' | 'daily' | 'weekly';
+type EmailMetricsSortBy = 'date' | EmailMetric;
+type EmailMetricsSortOrder = 'asc' | 'desc';
+type GetEmailsMetricsOptions = {
+  /**
+   * The start of the date range, as an ISO 8601 date or datetime.
+   * Defaults to 6 days before `endDate`.
+   *
+   * @link https://resend.com/docs/api-reference/emails/get-metrics#query-parameters
+   */
+  startDate?: string;
+  /**
+   * The end of the date range, as an ISO 8601 date or datetime.
+   * Defaults to now.
+   *
+   * @link https://resend.com/docs/api-reference/emails/get-metrics#query-parameters
+   */
+  endDate?: string;
+  /**
+   * The IANA timezone used to bucket periods when `period` is in `dimensions`.
+   * Defaults to `UTC`.
+   */
+  timezone?: string;
+  /**
+   * The bucket size used when `period` is in `dimensions`.
+   * Defaults to `daily`.
+   */
+  granularity?: EmailMetricsGranularity;
+  /**
+   * The metrics to include in the response. Defaults to all metrics.
+   */
+  metrics?: EmailMetric[];
+  /**
+   * The dimensions to break the response down by. Defaults to `[]`, which
+   * returns a single `totals` row for the whole range, with no `data`.
+   */
+  dimensions?: EmailMetricsDimension[];
+  filter?: {
+    /**
+     * Restrict the response to these sending domain IDs.
+     */
+    domainId?: string[];
+    /**
+     * Restrict the response to these email IDs. Cannot be combined with the
+     * `domain` dimension.
+     */
+    emailId?: string[];
+  };
+  /**
+   * What to sort `data` by. Defaults to `date` when `dimensions` includes
+   * `period`, or `sent` otherwise.
+   *
+   * @link https://resend.com/docs/api-reference/emails/get-metrics#query-parameters
+   */
+  sortBy?: EmailMetricsSortBy;
+  /**
+   * The sort direction for `sortBy`. Defaults to `asc` when `dimensions`
+   * includes `period`, `desc` otherwise.
+   */
+  sortOrder?: EmailMetricsSortOrder;
+};
+type EmailMetricsTotals = Partial<Record<EmailMetric, number>>;
+type EmailMetricsDataRow = EmailMetricsTotals & {
+  period?: string;
+  domain_id?: string;
+  domain_name?: string;
+  email_id?: string;
+};
+interface GetEmailsMetricsResponseSuccess {
+  object: 'metrics';
+  start_date: string;
+  end_date: string;
+  metrics: EmailMetric[];
+  dimensions: EmailMetricsDimension[];
+  granularity: EmailMetricsGranularity;
+  sort_by: EmailMetricsSortBy;
+  sort_order: EmailMetricsSortOrder;
+  totals: EmailMetricsTotals;
+  data?: EmailMetricsDataRow[];
+}
+type GetEmailsMetricsResponse = Response<GetEmailsMetricsResponseSuccess>;
+//#endregion
 //#region src/emails/interfaces/list-emails-options.interface.d.ts
 type ListEmailsOptions = PaginationOptions;
 type ListEmail = Omit<GetEmailResponseSuccess, 'html' | 'text' | 'tags' | 'object'>;
@@ -1675,6 +1836,8 @@ declare class Broadcasts {
   send(id: string, payload?: SendBroadcastOptions): Promise<SendBroadcastResponse>;
   list(options?: ListBroadcastsOptions): Promise<ListBroadcastsResponse>;
   get(id: string): Promise<GetBroadcastResponse>;
+  metrics(id: string): Promise<GetBroadcastMetricsResponse>;
+  recipients<T extends BroadcastRecipientEventType>(id: string, options: ListBroadcastRecipientsOptions<T>): Promise<ListBroadcastRecipientsResponse<T>>;
   remove(id: string): Promise<RemoveBroadcastResponse>;
   update(id: string, payload: UpdateBroadcastOptions): Promise<UpdateBroadcastResponse>;
 }
@@ -1796,6 +1959,7 @@ declare class Emails {
   list(options?: ListEmailsOptions): Promise<ListEmailsResponse>;
   update(payload: UpdateEmailOptions): Promise<UpdateEmailResponse>;
   cancel(id: string): Promise<CancelEmailResponse>;
+  metrics(options?: GetEmailsMetricsOptions): Promise<GetEmailsMetricsResponse>;
 }
 //#endregion
 //#region src/events/events.d.ts
@@ -1836,6 +2000,60 @@ interface CreateSegmentResponseSuccess extends Pick<Segment, 'name' | 'id'> {
 }
 type CreateSegmentResponse = Response<CreateSegmentResponseSuccess>;
 //#endregion
+//#region src/segments/interfaces/get-metrics.interface.d.ts
+type SegmentMetric = 'all_contacts' | 'subscribers' | 'unsubscribers';
+type SegmentMetricsDimension = 'segment';
+type SegmentMetricsSortBy = 'date' | SegmentMetric;
+type SegmentMetricsSortOrder = 'asc' | 'desc';
+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;
+};
+type SegmentMetricsTotals = Partial<Record<SegmentMetric, number>>;
+type SegmentMetricsDataRow = SegmentMetricsTotals & {
+  segment_id: string;
+  segment_name: string;
+};
+interface GetSegmentsMetricsResponseSuccess {
+  object: 'segments_metrics';
+  metrics: SegmentMetric[];
+  dimensions: SegmentMetricsDimension[];
+  sort_by: SegmentMetricsSortBy;
+  sort_order: SegmentMetricsSortOrder;
+  totals: SegmentMetricsTotals;
+  data?: SegmentMetricsDataRow[];
+}
+type GetSegmentsMetricsResponse = Response<GetSegmentsMetricsResponseSuccess>;
+//#endregion
 //#region src/segments/interfaces/get-segment.interface.d.ts
 interface GetSegmentResponseSuccess extends Pick<Segment, 'id' | 'name' | 'created_at'> {
   object: 'segment';
@@ -1866,6 +2084,7 @@ declare class Segments {
   list(options?: ListSegmentsOptions): Promise<ListSegmentsResponse>;
   get(id: string): Promise<GetSegmentResponse>;
   remove(id: string): Promise<RemoveSegmentResponse>;
+  metrics(options?: GetSegmentsMetricsOptions): Promise<GetSegmentsMetricsResponse>;
 }
 //#endregion
 //#region src/suppressions/batch/interfaces/batch-add-suppressions.interface.d.ts
@@ -2512,4 +2731,4 @@ declare class Resend {
   delete<T>(path: string, query?: unknown, options?: DeleteOptions): Promise<Response<T>>;
 }
 //#endregion
-export { AddContactSegmentOptions, AddContactSegmentResponse, AddContactSegmentResponseSuccess, AddSuppressionOptions, AddSuppressionResponse, AddSuppressionResponseSuccess, AddToSegmentStepConfig, ApiContactProperty, ApiKey, Attachment, AttachmentData, Automation, AutomationConnection, AutomationConnectionType, AutomationResponseConnection, AutomationResponseStep, AutomationRun, AutomationRunItem, AutomationRunStatus, AutomationRunStep, AutomationRunStepStatus, AutomationStatus, AutomationStep, AutomationStepType, BatchAddSuppressionsOptions, BatchAddSuppressionsResponse, BatchAddSuppressionsResponseSuccess, BatchRemoveSuppressionsOptions, BatchRemoveSuppressionsResponse, BatchRemoveSuppressionsResponseSuccess, Broadcast, CancelEmailResponse, CancelEmailResponseSuccess, ClaimDomainOptions, ClaimDomainRequestOptions, ClaimDomainResponse, ClaimDomainResponseSuccess, ConditionRule, ConditionStepConfig, Contact, ContactCreatedEvent, ContactDeleteStepConfig, ContactDeletedEvent, ContactImport, ContactImportColumnMap, ContactImportCounts, ContactImportOnConflict, ContactImportPropertyMapping, ContactImportPropertyType, ContactImportSegment, ContactImportStatus, ContactImportTopic, ContactProperty, ContactSegmentsBaseOptions, ContactTopic, ContactUpdateStepConfig, ContactUpdatedEvent, CreateApiKeyOptions, CreateApiKeyRequestOptions, CreateApiKeyResponse, CreateApiKeyResponseSuccess, CreateAutomationOptions, CreateAutomationResponse, CreateAutomationResponseSuccess, CreateBatchEmailOptions, CreateBatchOptions, CreateBatchRequestOptions, CreateBatchResponse, CreateBatchSuccessResponse, CreateBroadcastOptions, CreateBroadcastRequestOptions, CreateBroadcastResponse, CreateBroadcastResponseSuccess, CreateContactImportOptions, CreateContactImportRequestOptions, CreateContactImportResponse, CreateContactImportResponseSuccess, CreateContactOptions, CreateContactPropertyApiOptions, CreateContactPropertyOptions, CreateContactPropertyResponse, CreateContactPropertyResponseSuccess, CreateContactRequestOptions, CreateContactResponse, CreateContactResponseSuccess, CreateDomainOptions, CreateDomainRequestOptions, CreateDomainResponse, CreateDomainResponseSuccess, CreateEmailOptions, CreateEmailRequestOptions, CreateEmailResponse, CreateEmailResponseSuccess, CreateEventOptions, CreateEventResponse, CreateEventResponseSuccess, CreateSegmentOptions, CreateSegmentRequestOptions, CreateSegmentResponse, CreateSegmentResponseSuccess, CreateTemplateOptions, CreateTemplateRequestOptions, CreateTemplateResponse, CreateTemplateResponseSuccess, CreateTopicOptions, CreateTopicResponse, CreateTopicResponseSuccess, CreateWebhookOptions, CreateWebhookRequestOptions, CreateWebhookResponse, CreateWebhookResponseSuccess, DelayStepConfig, DeleteOptions, Domain, DomainApiOptions, DomainCapabilities, DomainCapabilityStatus, DomainClaim, DomainClaimBlockedReason, DomainClaimRecord, DomainClaimStatus, DomainCreatedEvent, DomainDeletedEvent, DomainDkimRecord, DomainNameservers, DomainRecordStatus, DomainRecords, DomainRegion, DomainSpfRecord, DomainStatus, DomainUpdatedEvent, DuplicateTemplateResponse, DuplicateTemplateResponseSuccess, EmailApiAttachment, EmailApiOptions, EmailBouncedEvent, EmailClickedEvent, EmailComplainedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailOpenedEvent, EmailReceivedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, type ErrorResponse, Event, EventSchemaMap, EventSchemaType, ForwardReceivingEmailOptions, ForwardReceivingEmailRequestOptions, ForwardReceivingEmailResponse, ForwardReceivingEmailResponseSuccess, GetAttachmentOptions, GetAttachmentResponse, GetAttachmentResponseSuccess, GetAutomationResponse, GetAutomationResponseSuccess, GetAutomationRunOptions, GetAutomationRunResponse, GetAutomationRunResponseSuccess, GetBroadcastResponse, GetBroadcastResponseSuccess, GetContactImportResponse, GetContactImportResponseSuccess, GetContactOptions, GetContactPropertyResponse, GetContactPropertyResponseSuccess, GetContactResponse, GetContactResponseSuccess, GetDomainClaimResponse, GetDomainClaimResponseSuccess, GetDomainResponse, GetDomainResponseSuccess, GetEmailResponse, GetEmailResponseSuccess, GetEventResponse, GetEventResponseSuccess, GetLogResponse, GetLogResponseSuccess, GetOptions, GetReceivingEmailOptions, GetReceivingEmailResponse, GetReceivingEmailResponseSuccess, GetSegmentResponse, GetSegmentResponseSuccess, GetSuppressionResponse, GetSuppressionResponseSuccess, GetTemplateResponse, GetTemplateResponseSuccess, GetTopicOptions, GetTopicResponse, GetTopicResponseSuccess, GetUsageResponse, GetUsageResponseSuccess, GetWebhookResponse, GetWebhookResponseSuccess, IdempotentRequest, InboundAttachment, LegacyCreateContactOptions, ListApiKeysOptions, ListApiKeysResponse, ListApiKeysResponseSuccess, ListAttachmentsOptions, ListAttachmentsResponse, ListAttachmentsResponseSuccess, ListAutomationRunsOptions, ListAutomationRunsResponse, ListAutomationRunsResponseSuccess, ListAutomationsOptions, ListAutomationsResponse, ListAutomationsResponseSuccess, ListBroadcastsOptions, ListBroadcastsResponse, ListBroadcastsResponseSuccess, ListContactImportsOptions, ListContactImportsResponse, ListContactImportsResponseSuccess, ListContactPropertiesOptions, ListContactPropertiesResponse, ListContactPropertiesResponseSuccess, ListContactSegmentsOptions, ListContactSegmentsResponse, ListContactSegmentsResponseSuccess, ListContactTopicsOptions, ListContactTopicsRequestOptions, ListContactTopicsResponse, ListContactTopicsResponseSuccess, ListContactsOptions, ListContactsResponse, ListContactsResponseSuccess, ListDomainsOptions, ListDomainsResponse, ListDomainsResponseSuccess, ListEmail, ListEmailsOptions, ListEmailsResponse, ListEmailsResponseSuccess, ListEventsOptions, ListEventsResponse, ListEventsResponseSuccess, ListLogsOptions, ListLogsResponse, ListLogsResponseSuccess, ListOAuthGrantsOptions, ListOAuthGrantsResponse, ListOAuthGrantsResponseSuccess, ListReceivingEmail, ListReceivingEmailsOptions, ListReceivingEmailsResponse, ListReceivingEmailsResponseSuccess, ListSegmentsOptions, ListSegmentsResponse, ListSegmentsResponseSuccess, ListSuppressionsOptions, ListSuppressionsResponse, ListSuppressionsResponseSuccess, ListTemplatesOptions, ListTemplatesResponse, ListTemplatesResponseSuccess, ListTopicsResponse, ListTopicsResponseSuccess, ListWebhooksOptions, ListWebhooksResponse, ListWebhooksResponseSuccess, Log, OAuthGrant, PaginatedData, PaginationOptions, PatchOptions, PostOptions, PublishTemplateResponse, PublishTemplateResponseSuccess, PutOptions, ReceivingRecord, RemoveApiKeyResponse, RemoveApiKeyResponseSuccess, RemoveAutomationResponse, RemoveAutomationResponseSuccess, RemoveBroadcastResponse, RemoveBroadcastResponseSuccess, RemoveContactOptions, RemoveContactPropertyResponse, RemoveContactPropertyResponseSuccess, RemoveContactSegmentOptions, RemoveContactSegmentResponse, RemoveContactSegmentResponseSuccess, RemoveContactsResponse, RemoveContactsResponseSuccess, RemoveDomainsResponse, RemoveDomainsResponseSuccess, RemoveEventResponse, RemoveEventResponseSuccess, RemoveSegmentResponse, RemoveSegmentResponseSuccess, RemoveSuppressionResponse, RemoveSuppressionResponseSuccess, RemoveTemplateResponse, RemoveTemplateResponseSuccess, RemoveTopicResponse, RemoveTopicResponseSuccess, RemoveWebhookResponse, RemoveWebhookResponseSuccess, RequireAtLeastOne, Resend, type ResendOptions, type Response, RevokeOAuthGrantResponse, RevokeOAuthGrantResponseSuccess, Segment, SelectingField, SendBroadcastOptions, SendBroadcastRequestOptions, SendBroadcastResponse, SendBroadcastResponseSuccess, SendEmailStepConfig, SendEventOptions, SendEventResponse, SendEventResponseSuccess, StopAutomationResponse, StopAutomationResponseSuccess, Suppression, SuppressionAddedEvent, SuppressionListEntry, SuppressionOrigin, SuppressionRemovedEvent, Tag, Template, TemplateVariable, TemplateVariableValue, Topic, TrackingCaaRecord, TrackingRecord, TriggerStepConfig, UpdateAutomationOptions, UpdateAutomationResponse, UpdateAutomationResponseSuccess, UpdateBroadcastOptions, UpdateBroadcastResponse, UpdateBroadcastResponseSuccess, UpdateContactOptions, UpdateContactPropertyApiOptions, UpdateContactPropertyOptions, UpdateContactPropertyResponse, UpdateContactPropertyResponseSuccess, UpdateContactResponse, UpdateContactResponseSuccess, UpdateContactTopicsOptions, UpdateContactTopicsRequestOptions, UpdateContactTopicsResponse, UpdateContactTopicsResponseSuccess, UpdateDomainsOptions, UpdateDomainsResponse, UpdateDomainsResponseSuccess, UpdateEmailOptions, UpdateEmailResponse, UpdateEmailResponseSuccess, UpdateEventOptions, UpdateEventResponse, UpdateEventResponseSuccess, UpdateTemplateOptions, UpdateTemplateResponse, UpdateTemplateResponseSuccess, UpdateTopicOptions, UpdateTopicResponse, UpdateTopicResponseSuccess, UpdateWebhookOptions, UpdateWebhookResponse, UpdateWebhookResponseSuccess, VerifyDomainClaimResponse, VerifyDomainClaimResponseSuccess, VerifyDomainsResponse, VerifyDomainsResponseSuccess, WaitForEventStepConfig, Webhook, WebhookEvent, WebhookEventPayload };
+export { AddContactSegmentOptions, AddContactSegmentResponse, AddContactSegmentResponseSuccess, AddSuppressionOptions, AddSuppressionResponse, AddSuppressionResponseSuccess, AddToSegmentStepConfig, ApiContactProperty, ApiKey, Attachment, AttachmentData, Automation, AutomationConnection, AutomationConnectionType, AutomationResponseConnection, AutomationResponseStep, AutomationRun, AutomationRunItem, AutomationRunStatus, AutomationRunStep, AutomationRunStepStatus, AutomationStatus, AutomationStep, AutomationStepType, BatchAddSuppressionsOptions, BatchAddSuppressionsResponse, BatchAddSuppressionsResponseSuccess, BatchRemoveSuppressionsOptions, BatchRemoveSuppressionsResponse, BatchRemoveSuppressionsResponseSuccess, Broadcast, BroadcastMetricCounter, BroadcastMetricsClickedLink, BroadcastRecipient, BroadcastRecipientBounceType, BroadcastRecipientClickedLink, BroadcastRecipientEventType, CancelEmailResponse, CancelEmailResponseSuccess, ClaimDomainOptions, ClaimDomainRequestOptions, ClaimDomainResponse, ClaimDomainResponseSuccess, ConditionRule, ConditionStepConfig, Contact, ContactCreatedEvent, ContactDeleteStepConfig, ContactDeletedEvent, ContactImport, ContactImportColumnMap, ContactImportCounts, ContactImportOnConflict, ContactImportPropertyMapping, ContactImportPropertyType, ContactImportSegment, ContactImportStatus, ContactImportTopic, ContactProperty, ContactSegmentsBaseOptions, ContactTopic, ContactUpdateStepConfig, ContactUpdatedEvent, CreateApiKeyOptions, CreateApiKeyRequestOptions, CreateApiKeyResponse, CreateApiKeyResponseSuccess, CreateAutomationOptions, CreateAutomationResponse, CreateAutomationResponseSuccess, CreateBatchEmailOptions, CreateBatchOptions, CreateBatchRequestOptions, CreateBatchResponse, CreateBatchSuccessResponse, CreateBroadcastOptions, CreateBroadcastRequestOptions, CreateBroadcastResponse, CreateBroadcastResponseSuccess, CreateContactImportOptions, CreateContactImportRequestOptions, CreateContactImportResponse, CreateContactImportResponseSuccess, CreateContactOptions, CreateContactPropertyApiOptions, CreateContactPropertyOptions, CreateContactPropertyResponse, CreateContactPropertyResponseSuccess, CreateContactRequestOptions, CreateContactResponse, CreateContactResponseSuccess, CreateDomainOptions, CreateDomainRequestOptions, CreateDomainResponse, CreateDomainResponseSuccess, CreateEmailOptions, CreateEmailRequestOptions, CreateEmailResponse, CreateEmailResponseSuccess, CreateEventOptions, CreateEventResponse, CreateEventResponseSuccess, CreateSegmentOptions, CreateSegmentRequestOptions, CreateSegmentResponse, CreateSegmentResponseSuccess, CreateTemplateOptions, CreateTemplateRequestOptions, CreateTemplateResponse, CreateTemplateResponseSuccess, CreateTopicOptions, CreateTopicResponse, CreateTopicResponseSuccess, CreateWebhookOptions, CreateWebhookRequestOptions, CreateWebhookResponse, CreateWebhookResponseSuccess, DelayStepConfig, DeleteOptions, Domain, DomainApiOptions, DomainCapabilities, DomainCapabilityStatus, DomainClaim, DomainClaimBlockedReason, DomainClaimRecord, DomainClaimStatus, DomainCreatedEvent, DomainDeletedEvent, DomainDkimRecord, DomainNameservers, DomainRecordStatus, DomainRecords, DomainRegion, DomainSpfRecord, DomainStatus, DomainUpdatedEvent, DuplicateTemplateResponse, DuplicateTemplateResponseSuccess, EmailApiAttachment, EmailApiOptions, EmailBouncedEvent, EmailClickedEvent, EmailComplainedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailMetric, EmailMetricsDataRow, EmailMetricsDimension, EmailMetricsGranularity, EmailMetricsSortBy, EmailMetricsSortOrder, EmailMetricsTotals, EmailOpenedEvent, EmailReceivedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, type ErrorResponse, Event, EventSchemaMap, EventSchemaType, ForwardReceivingEmailOptions, ForwardReceivingEmailRequestOptions, ForwardReceivingEmailResponse, ForwardReceivingEmailResponseSuccess, GetAttachmentOptions, GetAttachmentResponse, GetAttachmentResponseSuccess, GetAutomationResponse, GetAutomationResponseSuccess, GetAutomationRunOptions, GetAutomationRunResponse, GetAutomationRunResponseSuccess, GetBroadcastMetricsResponse, GetBroadcastMetricsResponseSuccess, GetBroadcastResponse, GetBroadcastResponseSuccess, GetContactImportResponse, GetContactImportResponseSuccess, GetContactOptions, GetContactPropertyResponse, GetContactPropertyResponseSuccess, GetContactResponse, GetContactResponseSuccess, GetDomainClaimResponse, GetDomainClaimResponseSuccess, GetDomainResponse, GetDomainResponseSuccess, GetEmailResponse, GetEmailResponseSuccess, GetEmailsMetricsOptions, GetEmailsMetricsResponse, GetEmailsMetricsResponseSuccess, GetEventResponse, GetEventResponseSuccess, GetLogResponse, GetLogResponseSuccess, GetOptions, GetReceivingEmailOptions, GetReceivingEmailResponse, GetReceivingEmailResponseSuccess, GetSegmentResponse, GetSegmentResponseSuccess, GetSegmentsMetricsOptions, GetSegmentsMetricsResponse, GetSegmentsMetricsResponseSuccess, GetSuppressionResponse, GetSuppressionResponseSuccess, GetTemplateResponse, GetTemplateResponseSuccess, GetTopicOptions, GetTopicResponse, GetTopicResponseSuccess, GetUsageResponse, GetUsageResponseSuccess, GetWebhookResponse, GetWebhookResponseSuccess, IdempotentRequest, InboundAttachment, LegacyCreateContactOptions, ListApiKeysOptions, ListApiKeysResponse, ListApiKeysResponseSuccess, ListAttachmentsOptions, ListAttachmentsResponse, ListAttachmentsResponseSuccess, ListAutomationRunsOptions, ListAutomationRunsResponse, ListAutomationRunsResponseSuccess, ListAutomationsOptions, ListAutomationsResponse, ListAutomationsResponseSuccess, ListBroadcastRecipientsOptions, ListBroadcastRecipientsResponse, ListBroadcastRecipientsResponseSuccess, ListBroadcastsOptions, ListBroadcastsResponse, ListBroadcastsResponseSuccess, ListContactImportsOptions, ListContactImportsResponse, ListContactImportsResponseSuccess, ListContactPropertiesOptions, ListContactPropertiesResponse, ListContactPropertiesResponseSuccess, ListContactSegmentsOptions, ListContactSegmentsResponse, ListContactSegmentsResponseSuccess, ListContactTopicsOptions, ListContactTopicsRequestOptions, ListContactTopicsResponse, ListContactTopicsResponseSuccess, ListContactsOptions, ListContactsResponse, ListContactsResponseSuccess, ListDomainsOptions, ListDomainsResponse, ListDomainsResponseSuccess, ListEmail, ListEmailsOptions, ListEmailsResponse, ListEmailsResponseSuccess, ListEventsOptions, ListEventsResponse, ListEventsResponseSuccess, ListLogsOptions, ListLogsResponse, ListLogsResponseSuccess, ListOAuthGrantsOptions, ListOAuthGrantsResponse, ListOAuthGrantsResponseSuccess, ListReceivingEmail, ListReceivingEmailsOptions, ListReceivingEmailsResponse, ListReceivingEmailsResponseSuccess, ListSegmentsOptions, ListSegmentsResponse, ListSegmentsResponseSuccess, ListSuppressionsOptions, ListSuppressionsResponse, ListSuppressionsResponseSuccess, ListTemplatesOptions, ListTemplatesResponse, ListTemplatesResponseSuccess, ListTopicsResponse, ListTopicsResponseSuccess, ListWebhooksOptions, ListWebhooksResponse, ListWebhooksResponseSuccess, Log, OAuthGrant, PaginatedData, PaginationOptions, PatchOptions, PostOptions, PublishTemplateResponse, PublishTemplateResponseSuccess, PutOptions, ReceivingRecord, RemoveApiKeyResponse, RemoveApiKeyResponseSuccess, RemoveAutomationResponse, RemoveAutomationResponseSuccess, RemoveBroadcastResponse, RemoveBroadcastResponseSuccess, RemoveContactOptions, RemoveContactPropertyResponse, RemoveContactPropertyResponseSuccess, RemoveContactSegmentOptions, RemoveContactSegmentResponse, RemoveContactSegmentResponseSuccess, RemoveContactsResponse, RemoveContactsResponseSuccess, RemoveDomainsResponse, RemoveDomainsResponseSuccess, RemoveEventResponse, RemoveEventResponseSuccess, RemoveSegmentResponse, RemoveSegmentResponseSuccess, RemoveSuppressionResponse, RemoveSuppressionResponseSuccess, RemoveTemplateResponse, RemoveTemplateResponseSuccess, RemoveTopicResponse, RemoveTopicResponseSuccess, RemoveWebhookResponse, RemoveWebhookResponseSuccess, RequireAtLeastOne, Resend, type ResendOptions, type Response, RevokeOAuthGrantResponse, RevokeOAuthGrantResponseSuccess, Segment, SegmentMetric, SegmentMetricsDataRow, SegmentMetricsDimension, SegmentMetricsSortBy, SegmentMetricsSortOrder, SegmentMetricsTotals, SelectingField, SendBroadcastOptions, SendBroadcastRequestOptions, SendBroadcastResponse, SendBroadcastResponseSuccess, SendEmailStepConfig, SendEventOptions, SendEventResponse, SendEventResponseSuccess, StopAutomationResponse, StopAutomationResponseSuccess, Suppression, SuppressionAddedEvent, SuppressionListEntry, SuppressionOrigin, SuppressionRemovedEvent, Tag, Template, TemplateVariable, TemplateVariableValue, Topic, TrackingCaaRecord, TrackingRecord, TriggerStepConfig, UpdateAutomationOptions, UpdateAutomationResponse, UpdateAutomationResponseSuccess, UpdateBroadcastOptions, UpdateBroadcastResponse, UpdateBroadcastResponseSuccess, UpdateContactOptions, UpdateContactPropertyApiOptions, UpdateContactPropertyOptions, UpdateContactPropertyResponse, UpdateContactPropertyResponseSuccess, UpdateContactResponse, UpdateContactResponseSuccess, UpdateContactTopicsOptions, UpdateContactTopicsRequestOptions, UpdateContactTopicsResponse, UpdateContactTopicsResponseSuccess, UpdateDomainsOptions, UpdateDomainsResponse, UpdateDomainsResponseSuccess, UpdateEmailOptions, UpdateEmailResponse, UpdateEmailResponseSuccess, UpdateEventOptions, UpdateEventResponse, UpdateEventResponseSuccess, UpdateTemplateOptions, UpdateTemplateResponse, UpdateTemplateResponseSuccess, UpdateTopicOptions, UpdateTopicResponse, UpdateTopicResponseSuccess, UpdateWebhookOptions, UpdateWebhookResponse, UpdateWebhookResponseSuccess, VerifyDomainClaimResponse, VerifyDomainClaimResponseSuccess, VerifyDomainsResponse, VerifyDomainsResponseSuccess, WaitForEventStepConfig, Webhook, WebhookEvent, WebhookEventPayload };

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import PostalMime from "postal-mime";
 import { Webhook } from "standardwebhooks";
 //#region package.json
-var version = "6.19.0-preview-usage.0";
+var version = "6.19.0-preview-headless-dashboard.1";
 //#endregion
 //#region src/common/utils/build-pagination-query.ts
 /**
@@ -277,6 +277,13 @@ var Broadcasts = class {
 	async get(id) {
 		return await this.resend.get(`/broadcasts/${id}`);
 	}
+	async metrics(id) {
+		return await this.resend.get(`/broadcasts/${id}/metrics`);
+	}
+	async recipients(id, options) {
+		const url = `/broadcasts/${id}/recipients?${buildRecipientsQuery(options)}`;
+		return await this.resend.get(url);
+	}
 	async remove(id) {
 		return await this.resend.delete(`/broadcasts/${id}`);
 	}
@@ -296,6 +303,14 @@ var Broadcasts = class {
 		});
 	}
 };
+function buildRecipientsQuery(options) {
+	const { type, email, bounceType, ...pagination } = options;
+	const searchParams = new URLSearchParams(buildPaginationQuery(pagination));
+	searchParams.set("type", type);
+	if (email !== void 0) searchParams.set("email", email);
+	if (bounceType !== void 0) searchParams.set("bounce_type", bounceType);
+	return searchParams.toString();
+}
 //#endregion
 //#region src/common/utils/parse-contact-properties-to-api-options.ts
 function parseContactPropertyFromApi(contactProperty) {
@@ -870,7 +885,29 @@ var Emails = class {
 	async cancel(id) {
 		return await this.resend.post(`/emails/${id}/cancel`);
 	}
+	async metrics(options = {}) {
+		const queryString = buildMetricsQuery$1(options);
+		const url = queryString ? `/emails/metrics?${queryString}` : "/emails/metrics";
+		return await this.resend.get(url);
+	}
 };
+function buildMetricsQuery$1(options) {
+	const params = {
+		start_date: options.startDate,
+		end_date: options.endDate,
+		timezone: options.timezone,
+		granularity: options.granularity,
+		metrics: options.metrics?.join(","),
+		dimensions: options.dimensions?.join(","),
+		"filter[domain_id]": options.filter?.domainId?.join(","),
+		"filter[email_id]": options.filter?.emailId?.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/events/events.ts
 var Events = class {
@@ -948,7 +985,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(","),
+		"filter[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.19.0-preview-usage.0",
+  "version": "6.19.0-preview-headless-dashboard.1",
   "description": "Node.js library for the Resend API",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -29,6 +29,19 @@
       }
     }
   },
+  "scripts": {
+    "build": "tsdown src/index.ts --format esm,cjs --dts",
+    "integration:nextjs": "cd ./e2e/nextjs && next build --turbopack",
+    "lint": "biome check .",
+    "lint:fix": "biome check . --write",
+    "prepublishOnly": "pnpm run build",
+    "test": "vitest run --exclude e2e",
+    "test:dev": "cross-env TEST_MODE=dev vitest run --exclude e2e",
+    "test:e2e": "vitest run e2e",
+    "test:record": "rimraf --glob \"**/__recordings__\" && cross-env TEST_MODE=record vitest run --exclude e2e",
+    "test:watch": "vitest --exclude e2e",
+    "typecheck": "tsc --noEmit"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/resend/resend-node.git"
@@ -70,16 +83,5 @@
     "vitest": "4.1.10",
     "vitest-fetch-mock": "0.4.5"
   },
-  "scripts": {
-    "build": "tsdown src/index.ts --format esm,cjs --dts",
-    "integration:nextjs": "cd ./e2e/nextjs && next build --turbopack",
-    "lint": "biome check .",
-    "lint:fix": "biome check . --write",
-    "test": "vitest run --exclude e2e",
-    "test:dev": "cross-env TEST_MODE=dev vitest run --exclude e2e",
-    "test:e2e": "vitest run e2e",
-    "test:record": "rimraf --glob \"**/__recordings__\" && cross-env TEST_MODE=record vitest run --exclude e2e",
-    "test:watch": "vitest --exclude e2e",
-    "typecheck": "tsc --noEmit"
-  }
-}
+  "packageManager": "pnpm@11.12.0"
+}