sequenzy 2.1.29 → 2.1.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/dist/cjs/api/types/EmailEvent.d.ts +5 -0
  2. package/dist/cjs/api/types/EmailEventOutcome.d.ts +8 -0
  3. package/dist/cjs/api/types/EmailEventOutcome.js +11 -0
  4. package/dist/cjs/api/types/EmailSend.d.ts +7 -1
  5. package/dist/cjs/api/types/EmailSendEvent.d.ts +1 -0
  6. package/dist/cjs/api/types/EmailSendInternalFailureCode.d.ts +1 -1
  7. package/dist/cjs/api/types/EmailSendInternalFailureCode.js +1 -1
  8. package/dist/cjs/api/types/EmailSendOutcome.d.ts +8 -0
  9. package/dist/cjs/api/types/EmailSendOutcome.js +11 -0
  10. package/dist/cjs/api/types/SenderHealthMetric.d.ts +1 -1
  11. package/dist/cjs/api/types/SendingStatusPauseReasonKind.d.ts +1 -0
  12. package/dist/cjs/api/types/SendingStatusPauseReasonKind.js +1 -0
  13. package/dist/cjs/api/types/SendingStatusSenderHealth.d.ts +4 -0
  14. package/dist/cjs/api/types/index.d.ts +2 -0
  15. package/dist/cjs/api/types/index.js +2 -0
  16. package/dist/cjs/serialization/types/EmailEvent.d.ts +3 -0
  17. package/dist/cjs/serialization/types/EmailEvent.js +3 -0
  18. package/dist/cjs/serialization/types/EmailEventOutcome.d.ts +7 -0
  19. package/dist/cjs/serialization/types/EmailEventOutcome.js +29 -0
  20. package/dist/cjs/serialization/types/EmailSend.d.ts +3 -0
  21. package/dist/cjs/serialization/types/EmailSend.js +3 -0
  22. package/dist/cjs/serialization/types/EmailSendOutcome.d.ts +7 -0
  23. package/dist/cjs/serialization/types/EmailSendOutcome.js +29 -0
  24. package/dist/cjs/serialization/types/SendingStatusPauseReasonKind.d.ts +1 -1
  25. package/dist/cjs/serialization/types/SendingStatusPauseReasonKind.js +1 -0
  26. package/dist/cjs/serialization/types/SendingStatusSenderHealth.d.ts +2 -0
  27. package/dist/cjs/serialization/types/SendingStatusSenderHealth.js +2 -0
  28. package/dist/cjs/serialization/types/index.d.ts +2 -0
  29. package/dist/cjs/serialization/types/index.js +2 -0
  30. package/dist/esm/api/types/EmailEvent.d.ts +5 -0
  31. package/dist/esm/api/types/EmailEventOutcome.d.ts +8 -0
  32. package/dist/esm/api/types/EmailEventOutcome.js +8 -0
  33. package/dist/esm/api/types/EmailSend.d.ts +7 -1
  34. package/dist/esm/api/types/EmailSendEvent.d.ts +1 -0
  35. package/dist/esm/api/types/EmailSendInternalFailureCode.d.ts +1 -1
  36. package/dist/esm/api/types/EmailSendInternalFailureCode.js +1 -1
  37. package/dist/esm/api/types/EmailSendOutcome.d.ts +8 -0
  38. package/dist/esm/api/types/EmailSendOutcome.js +8 -0
  39. package/dist/esm/api/types/SenderHealthMetric.d.ts +1 -1
  40. package/dist/esm/api/types/SendingStatusPauseReasonKind.d.ts +1 -0
  41. package/dist/esm/api/types/SendingStatusPauseReasonKind.js +1 -0
  42. package/dist/esm/api/types/SendingStatusSenderHealth.d.ts +4 -0
  43. package/dist/esm/api/types/index.d.ts +2 -0
  44. package/dist/esm/api/types/index.js +2 -0
  45. package/dist/esm/serialization/types/EmailEvent.d.ts +3 -0
  46. package/dist/esm/serialization/types/EmailEvent.js +3 -0
  47. package/dist/esm/serialization/types/EmailEventOutcome.d.ts +7 -0
  48. package/dist/esm/serialization/types/EmailEventOutcome.js +3 -0
  49. package/dist/esm/serialization/types/EmailSend.d.ts +3 -0
  50. package/dist/esm/serialization/types/EmailSend.js +3 -0
  51. package/dist/esm/serialization/types/EmailSendOutcome.d.ts +7 -0
  52. package/dist/esm/serialization/types/EmailSendOutcome.js +3 -0
  53. package/dist/esm/serialization/types/SendingStatusPauseReasonKind.d.ts +1 -1
  54. package/dist/esm/serialization/types/SendingStatusPauseReasonKind.js +1 -0
  55. package/dist/esm/serialization/types/SendingStatusSenderHealth.d.ts +2 -0
  56. package/dist/esm/serialization/types/SendingStatusSenderHealth.js +2 -0
  57. package/dist/esm/serialization/types/index.d.ts +2 -0
  58. package/dist/esm/serialization/types/index.js +2 -0
  59. package/package.json +1 -1
@@ -18,7 +18,12 @@ export interface EmailEvent {
18
18
  eventType?: Sequenzy.EmailEventEventType;
19
19
  id?: string;
20
20
  ipAddress?: string | null;
21
+ /** Event details. Receiver replies (recipients[].diagnosticCode) are masked for bounced and blocked outcomes, generic for failed ones, and kept for delays only when the sender caused them. Sending infrastructure is never included. */
21
22
  metadata?: Record<string, unknown>;
23
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
24
+ outcome?: Sequenzy.EmailEventOutcome | null;
25
+ /** One plain sentence about the outcome, with the receiver's status code when there is one. Null when outcome is null. */
26
+ reason?: string | null;
22
27
  subscriberId?: string | null;
23
28
  transactionalEmailId?: string | null;
24
29
  userAgent?: string | null;
@@ -0,0 +1,8 @@
1
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
2
+ export declare const EmailEventOutcome: {
3
+ readonly Bounced: "bounced";
4
+ readonly Blocked: "blocked";
5
+ readonly Delayed: "delayed";
6
+ readonly Failed: "failed";
7
+ };
8
+ export type EmailEventOutcome = (typeof EmailEventOutcome)[keyof typeof EmailEventOutcome];
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.EmailEventOutcome = void 0;
5
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
6
+ exports.EmailEventOutcome = {
7
+ Bounced: "bounced",
8
+ Blocked: "blocked",
9
+ Delayed: "delayed",
10
+ Failed: "failed",
11
+ };
@@ -24,7 +24,7 @@ export interface EmailSend {
24
24
  emailType?: Sequenzy.EmailSendEmailType | null;
25
25
  errorMessage?: string | null;
26
26
  id?: string;
27
- /** Why a send reached status "failed". Present only for terminal delivery failures. "transport_exhausted" means every available delivery route was refused by the recipient provider; "admin_bounce" means an operator removed the message from the delivery queue; "crash_orphaned_claim" means the sending worker stopped between claiming the send and recording a transport outcome, so the message was never confirmed as reaching the provider. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
27
+ /** Why a send reached status "failed". Present only for terminal delivery failures, each of which has outcome "failed": "transport_exhausted" means we could not deliver the email; "admin_bounce" means the message was withdrawn before delivery; "crash_orphaned_claim" means sending stopped before the message was confirmed as handed off. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
28
28
  internalFailureCode?: Sequenzy.EmailSendInternalFailureCode | null;
29
29
  /** Whether this is an auxiliary CC/BCC delivery record whose content and engagement belong to a primary email send. */
30
30
  isCopiedRecipient?: boolean;
@@ -32,15 +32,21 @@ export interface EmailSend {
32
32
  isTestEmail?: boolean;
33
33
  /** Stored delivery-policy snapshot. Prefer emailType for a normalized value. */
34
34
  isTransactional?: boolean | null;
35
+ /** Always null. Sending IPs are not shared with customers. */
35
36
  observedSendingIpAddress?: string | null;
36
37
  openedAt?: Date | null;
37
38
  /** Resolved reply destination, optionally including a display name. When reply tracking is disabled, this is the sent Reply-To header. When reply tracking is enabled, the sent header is a unique trackable address and this value is the forwarding destination. */
38
39
  originalReplyTo?: string | null;
40
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
41
+ outcome?: Sequenzy.EmailSendOutcome | null;
39
42
  /** Primary email send ID for a copied-recipient delivery, or null for ordinary sends and when the primary record is unavailable. */
40
43
  primaryEmailSendId?: string | null;
44
+ /** One plain sentence about the outcome, with the receiver's status code when there is one. Null when outcome is null. */
45
+ reason?: string | null;
41
46
  recipientEmail?: string | null;
42
47
  senderEmail?: string | null;
43
48
  senderName?: string | null;
49
+ /** Always null. Sending IPs are not shared with customers. */
44
50
  sendingIpAddress?: string | null;
45
51
  sentAt?: Date | null;
46
52
  sesMessageId?: string | null;
@@ -20,6 +20,7 @@ export interface EmailSendEvent {
20
20
  eventType?: string;
21
21
  id?: string;
22
22
  ipAddress?: string | null;
23
+ /** Event details. Receiver replies (recipients[].diagnosticCode) are masked for bounced and blocked outcomes, generic for failed ones, and kept for delays only when the sender caused them. Sending infrastructure is never included. */
23
24
  metadata?: Record<string, unknown>;
24
25
  subscriberId?: string | null;
25
26
  transactionalEmailId?: string | null;
@@ -1,4 +1,4 @@
1
- /** Why a send reached status "failed". Present only for terminal delivery failures. "transport_exhausted" means every available delivery route was refused by the recipient provider; "admin_bounce" means an operator removed the message from the delivery queue; "crash_orphaned_claim" means the sending worker stopped between claiming the send and recording a transport outcome, so the message was never confirmed as reaching the provider. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
1
+ /** Why a send reached status "failed". Present only for terminal delivery failures, each of which has outcome "failed": "transport_exhausted" means we could not deliver the email; "admin_bounce" means the message was withdrawn before delivery; "crash_orphaned_claim" means sending stopped before the message was confirmed as handed off. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
2
2
  export declare const EmailSendInternalFailureCode: {
3
3
  readonly TransportExhausted: "transport_exhausted";
4
4
  readonly AdminBounce: "admin_bounce";
@@ -2,7 +2,7 @@
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.EmailSendInternalFailureCode = void 0;
5
- /** Why a send reached status "failed". Present only for terminal delivery failures. "transport_exhausted" means every available delivery route was refused by the recipient provider; "admin_bounce" means an operator removed the message from the delivery queue; "crash_orphaned_claim" means the sending worker stopped between claiming the send and recording a transport outcome, so the message was never confirmed as reaching the provider. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
5
+ /** Why a send reached status "failed". Present only for terminal delivery failures, each of which has outcome "failed": "transport_exhausted" means we could not deliver the email; "admin_bounce" means the message was withdrawn before delivery; "crash_orphaned_claim" means sending stopped before the message was confirmed as handed off. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
6
6
  exports.EmailSendInternalFailureCode = {
7
7
  TransportExhausted: "transport_exhausted",
8
8
  AdminBounce: "admin_bounce",
@@ -0,0 +1,8 @@
1
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
2
+ export declare const EmailSendOutcome: {
3
+ readonly Bounced: "bounced";
4
+ readonly Blocked: "blocked";
5
+ readonly Delayed: "delayed";
6
+ readonly Failed: "failed";
7
+ };
8
+ export type EmailSendOutcome = (typeof EmailSendOutcome)[keyof typeof EmailSendOutcome];
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.EmailSendOutcome = void 0;
5
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
6
+ exports.EmailSendOutcome = {
7
+ Bounced: "bounced",
8
+ Blocked: "blocked",
9
+ Delayed: "delayed",
10
+ Failed: "failed",
11
+ };
@@ -2,7 +2,7 @@ import type * as Sequenzy from "../index.js";
2
2
  export interface SenderHealthMetric {
3
3
  count?: number;
4
4
  pauseThreshold?: Sequenzy.SenderHealthThresholdBound;
5
- /** Percentage of the applicable bounceScopedSent or complaintScopedSent denominator. */
5
+ /** Percentage of the applicable bounceScopedSent, blockScopedSent or complaintScopedSent denominator. */
6
6
  rate?: number;
7
7
  warnThreshold?: Sequenzy.SenderHealthThresholdBound;
8
8
  }
@@ -2,6 +2,7 @@
2
2
  export declare const SendingStatusPauseReasonKind: {
3
3
  readonly HighHardBounceRate: "high_hard_bounce_rate";
4
4
  readonly HighSoftBounceRate: "high_soft_bounce_rate";
5
+ readonly HighBlockRate: "high_block_rate";
5
6
  readonly HighComplaintRate: "high_complaint_rate";
6
7
  readonly PhishingGuard: "phishing_guard";
7
8
  readonly OverEmailLimit: "over_email_limit";
@@ -6,6 +6,7 @@ exports.SendingStatusPauseReasonKind = void 0;
6
6
  exports.SendingStatusPauseReasonKind = {
7
7
  HighHardBounceRate: "high_hard_bounce_rate",
8
8
  HighSoftBounceRate: "high_soft_bounce_rate",
9
+ HighBlockRate: "high_block_rate",
9
10
  HighComplaintRate: "high_complaint_rate",
10
11
  PhishingGuard: "phishing_guard",
11
12
  OverEmailLimit: "over_email_limit",
@@ -3,6 +3,10 @@ import type * as Sequenzy from "../index.js";
3
3
  * Null when the workspace has no metrics record yet or sender-health analytics are temporarily unavailable. Pause state and remediation remain available during an analytics outage.
4
4
  */
5
5
  export interface SendingStatusSenderHealth {
6
+ /** Refusals the sender caused - spam or content, the sending domain's reputation, policy, or failed SPF, DKIM or DMARC. Refusals caused by our infrastructure never count. */
7
+ block?: Sequenzy.SenderHealthMetric;
8
+ /** Sends, test sends included, counted from the bounce reset watermark - the denominator for the block rate. */
9
+ blockScopedSent?: number;
6
10
  /** Non-test sends counted from the bounce reset watermark - the denominator for hard- and soft-bounce rates. */
7
11
  bounceScopedSent?: number;
8
12
  complaint?: Sequenzy.SenderHealthMetric;
@@ -226,6 +226,7 @@ export * from "./EmailDesignSystemSource.js";
226
226
  export * from "./EmailEvent.js";
227
227
  export * from "./EmailEventEmailType.js";
228
228
  export * from "./EmailEventEventType.js";
229
+ export * from "./EmailEventOutcome.js";
229
230
  export * from "./EmailPreset.js";
230
231
  export * from "./EmailSectionOption.js";
231
232
  export * from "./EmailSend.js";
@@ -237,6 +238,7 @@ export * from "./EmailSendEvent.js";
237
238
  export * from "./EmailSendEventDeliveryPolicy.js";
238
239
  export * from "./EmailSendEventEmailType.js";
239
240
  export * from "./EmailSendInternalFailureCode.js";
241
+ export * from "./EmailSendOutcome.js";
240
242
  export * from "./EmailSendStatus.js";
241
243
  export * from "./EmailSendSubscriber.js";
242
244
  export * from "./EmailSendSuppressionReason.js";
@@ -242,6 +242,7 @@ __exportStar(require("./EmailDesignSystemSource.js"), exports);
242
242
  __exportStar(require("./EmailEvent.js"), exports);
243
243
  __exportStar(require("./EmailEventEmailType.js"), exports);
244
244
  __exportStar(require("./EmailEventEventType.js"), exports);
245
+ __exportStar(require("./EmailEventOutcome.js"), exports);
245
246
  __exportStar(require("./EmailPreset.js"), exports);
246
247
  __exportStar(require("./EmailSectionOption.js"), exports);
247
248
  __exportStar(require("./EmailSend.js"), exports);
@@ -253,6 +254,7 @@ __exportStar(require("./EmailSendEvent.js"), exports);
253
254
  __exportStar(require("./EmailSendEventDeliveryPolicy.js"), exports);
254
255
  __exportStar(require("./EmailSendEventEmailType.js"), exports);
255
256
  __exportStar(require("./EmailSendInternalFailureCode.js"), exports);
257
+ __exportStar(require("./EmailSendOutcome.js"), exports);
256
258
  __exportStar(require("./EmailSendStatus.js"), exports);
257
259
  __exportStar(require("./EmailSendSubscriber.js"), exports);
258
260
  __exportStar(require("./EmailSendSuppressionReason.js"), exports);
@@ -3,6 +3,7 @@ import * as core from "../../core/index.js";
3
3
  import type * as serializers from "../index.js";
4
4
  import { EmailEventEmailType } from "./EmailEventEmailType.js";
5
5
  import { EmailEventEventType } from "./EmailEventEventType.js";
6
+ import { EmailEventOutcome } from "./EmailEventOutcome.js";
6
7
  export declare const EmailEvent: core.serialization.ObjectSchema<serializers.EmailEvent.Raw, Sequenzy.EmailEvent>;
7
8
  export declare namespace EmailEvent {
8
9
  interface Raw {
@@ -24,6 +25,8 @@ export declare namespace EmailEvent {
24
25
  id?: string | null;
25
26
  ipAddress?: (string | null | undefined) | null;
26
27
  metadata?: Record<string, unknown> | null;
28
+ outcome?: (EmailEventOutcome.Raw | null | undefined) | null;
29
+ reason?: (string | null | undefined) | null;
27
30
  subscriberId?: (string | null | undefined) | null;
28
31
  transactionalEmailId?: (string | null | undefined) | null;
29
32
  userAgent?: (string | null | undefined) | null;
@@ -28,6 +28,7 @@ exports.EmailEvent = void 0;
28
28
  const core = __importStar(require("../../core/index.js"));
29
29
  const EmailEventEmailType_js_1 = require("./EmailEventEmailType.js");
30
30
  const EmailEventEventType_js_1 = require("./EmailEventEventType.js");
31
+ const EmailEventOutcome_js_1 = require("./EmailEventOutcome.js");
31
32
  exports.EmailEvent = core.serialization.object({
32
33
  abTestId: core.serialization.string().optionalNullable(),
33
34
  abTestVariantId: core.serialization.string().optionalNullable(),
@@ -47,6 +48,8 @@ exports.EmailEvent = core.serialization.object({
47
48
  id: core.serialization.string().optional(),
48
49
  ipAddress: core.serialization.string().optionalNullable(),
49
50
  metadata: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
51
+ outcome: EmailEventOutcome_js_1.EmailEventOutcome.optionalNullable(),
52
+ reason: core.serialization.string().optionalNullable(),
50
53
  subscriberId: core.serialization.string().optionalNullable(),
51
54
  transactionalEmailId: core.serialization.string().optionalNullable(),
52
55
  userAgent: core.serialization.string().optionalNullable(),
@@ -0,0 +1,7 @@
1
+ import type * as Sequenzy from "../../api/index.js";
2
+ import * as core from "../../core/index.js";
3
+ import type * as serializers from "../index.js";
4
+ export declare const EmailEventOutcome: core.serialization.Schema<serializers.EmailEventOutcome.Raw, Sequenzy.EmailEventOutcome>;
5
+ export declare namespace EmailEventOutcome {
6
+ type Raw = "bounced" | "blocked" | "delayed" | "failed";
7
+ }
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || function (mod) {
20
+ if (mod && mod.__esModule) return mod;
21
+ var result = {};
22
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
23
+ __setModuleDefault(result, mod);
24
+ return result;
25
+ };
26
+ Object.defineProperty(exports, "__esModule", { value: true });
27
+ exports.EmailEventOutcome = void 0;
28
+ const core = __importStar(require("../../core/index.js"));
29
+ exports.EmailEventOutcome = core.serialization.enum_(["bounced", "blocked", "delayed", "failed"]);
@@ -6,6 +6,7 @@ import { EmailSendAutomation } from "./EmailSendAutomation.js";
6
6
  import { EmailSendCampaign } from "./EmailSendCampaign.js";
7
7
  import { EmailSendEmailType } from "./EmailSendEmailType.js";
8
8
  import { EmailSendInternalFailureCode } from "./EmailSendInternalFailureCode.js";
9
+ import { EmailSendOutcome } from "./EmailSendOutcome.js";
9
10
  import { EmailSendStatus } from "./EmailSendStatus.js";
10
11
  import { EmailSendSubscriber } from "./EmailSendSubscriber.js";
11
12
  import { EmailSendSuppressionReason } from "./EmailSendSuppressionReason.js";
@@ -41,7 +42,9 @@ export declare namespace EmailSend {
41
42
  observedSendingIpAddress?: (string | null | undefined) | null;
42
43
  openedAt?: (string | null | undefined) | null;
43
44
  originalReplyTo?: (string | null | undefined) | null;
45
+ outcome?: (EmailSendOutcome.Raw | null | undefined) | null;
44
46
  primaryEmailSendId?: (string | null | undefined) | null;
47
+ reason?: (string | null | undefined) | null;
45
48
  recipientEmail?: (string | null | undefined) | null;
46
49
  senderEmail?: (string | null | undefined) | null;
47
50
  senderName?: (string | null | undefined) | null;
@@ -31,6 +31,7 @@ const EmailSendAutomation_js_1 = require("./EmailSendAutomation.js");
31
31
  const EmailSendCampaign_js_1 = require("./EmailSendCampaign.js");
32
32
  const EmailSendEmailType_js_1 = require("./EmailSendEmailType.js");
33
33
  const EmailSendInternalFailureCode_js_1 = require("./EmailSendInternalFailureCode.js");
34
+ const EmailSendOutcome_js_1 = require("./EmailSendOutcome.js");
34
35
  const EmailSendStatus_js_1 = require("./EmailSendStatus.js");
35
36
  const EmailSendSubscriber_js_1 = require("./EmailSendSubscriber.js");
36
37
  const EmailSendSuppressionReason_js_1 = require("./EmailSendSuppressionReason.js");
@@ -64,7 +65,9 @@ exports.EmailSend = core.serialization.object({
64
65
  observedSendingIpAddress: core.serialization.string().optionalNullable(),
65
66
  openedAt: core.serialization.date().optionalNullable(),
66
67
  originalReplyTo: core.serialization.string().optionalNullable(),
68
+ outcome: EmailSendOutcome_js_1.EmailSendOutcome.optionalNullable(),
67
69
  primaryEmailSendId: core.serialization.string().optionalNullable(),
70
+ reason: core.serialization.string().optionalNullable(),
68
71
  recipientEmail: core.serialization.string().optionalNullable(),
69
72
  senderEmail: core.serialization.string().optionalNullable(),
70
73
  senderName: core.serialization.string().optionalNullable(),
@@ -0,0 +1,7 @@
1
+ import type * as Sequenzy from "../../api/index.js";
2
+ import * as core from "../../core/index.js";
3
+ import type * as serializers from "../index.js";
4
+ export declare const EmailSendOutcome: core.serialization.Schema<serializers.EmailSendOutcome.Raw, Sequenzy.EmailSendOutcome>;
5
+ export declare namespace EmailSendOutcome {
6
+ type Raw = "bounced" | "blocked" | "delayed" | "failed";
7
+ }
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || function (mod) {
20
+ if (mod && mod.__esModule) return mod;
21
+ var result = {};
22
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
23
+ __setModuleDefault(result, mod);
24
+ return result;
25
+ };
26
+ Object.defineProperty(exports, "__esModule", { value: true });
27
+ exports.EmailSendOutcome = void 0;
28
+ const core = __importStar(require("../../core/index.js"));
29
+ exports.EmailSendOutcome = core.serialization.enum_(["bounced", "blocked", "delayed", "failed"]);
@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
3
3
  import type * as serializers from "../index.js";
4
4
  export declare const SendingStatusPauseReasonKind: core.serialization.Schema<serializers.SendingStatusPauseReasonKind.Raw, Sequenzy.SendingStatusPauseReasonKind>;
5
5
  export declare namespace SendingStatusPauseReasonKind {
6
- type Raw = "high_hard_bounce_rate" | "high_soft_bounce_rate" | "high_complaint_rate" | "phishing_guard" | "over_email_limit" | "manual" | "other";
6
+ type Raw = "high_hard_bounce_rate" | "high_soft_bounce_rate" | "high_block_rate" | "high_complaint_rate" | "phishing_guard" | "over_email_limit" | "manual" | "other";
7
7
  }
@@ -29,6 +29,7 @@ const core = __importStar(require("../../core/index.js"));
29
29
  exports.SendingStatusPauseReasonKind = core.serialization.enum_([
30
30
  "high_hard_bounce_rate",
31
31
  "high_soft_bounce_rate",
32
+ "high_block_rate",
32
33
  "high_complaint_rate",
33
34
  "phishing_guard",
34
35
  "over_email_limit",
@@ -6,6 +6,8 @@ import { SendingStatusSenderHealthEnforcementMode } from "./SendingStatusSenderH
6
6
  export declare const SendingStatusSenderHealth: core.serialization.ObjectSchema<serializers.SendingStatusSenderHealth.Raw, Sequenzy.SendingStatusSenderHealth>;
7
7
  export declare namespace SendingStatusSenderHealth {
8
8
  interface Raw {
9
+ block?: SenderHealthMetric.Raw | null;
10
+ blockScopedSent?: number | null;
9
11
  bounceScopedSent?: number | null;
10
12
  complaint?: SenderHealthMetric.Raw | null;
11
13
  complaintScopedSent?: number | null;
@@ -29,6 +29,8 @@ const core = __importStar(require("../../core/index.js"));
29
29
  const SenderHealthMetric_js_1 = require("./SenderHealthMetric.js");
30
30
  const SendingStatusSenderHealthEnforcementMode_js_1 = require("./SendingStatusSenderHealthEnforcementMode.js");
31
31
  exports.SendingStatusSenderHealth = core.serialization.object({
32
+ block: SenderHealthMetric_js_1.SenderHealthMetric.optional(),
33
+ blockScopedSent: core.serialization.number().optional(),
32
34
  bounceScopedSent: core.serialization.number().optional(),
33
35
  complaint: SenderHealthMetric_js_1.SenderHealthMetric.optional(),
34
36
  complaintScopedSent: core.serialization.number().optional(),
@@ -226,6 +226,7 @@ export * from "./EmailDesignSystemSource.js";
226
226
  export * from "./EmailEvent.js";
227
227
  export * from "./EmailEventEmailType.js";
228
228
  export * from "./EmailEventEventType.js";
229
+ export * from "./EmailEventOutcome.js";
229
230
  export * from "./EmailPreset.js";
230
231
  export * from "./EmailSectionOption.js";
231
232
  export * from "./EmailSend.js";
@@ -237,6 +238,7 @@ export * from "./EmailSendEvent.js";
237
238
  export * from "./EmailSendEventDeliveryPolicy.js";
238
239
  export * from "./EmailSendEventEmailType.js";
239
240
  export * from "./EmailSendInternalFailureCode.js";
241
+ export * from "./EmailSendOutcome.js";
240
242
  export * from "./EmailSendStatus.js";
241
243
  export * from "./EmailSendSubscriber.js";
242
244
  export * from "./EmailSendSuppressionReason.js";
@@ -242,6 +242,7 @@ __exportStar(require("./EmailDesignSystemSource.js"), exports);
242
242
  __exportStar(require("./EmailEvent.js"), exports);
243
243
  __exportStar(require("./EmailEventEmailType.js"), exports);
244
244
  __exportStar(require("./EmailEventEventType.js"), exports);
245
+ __exportStar(require("./EmailEventOutcome.js"), exports);
245
246
  __exportStar(require("./EmailPreset.js"), exports);
246
247
  __exportStar(require("./EmailSectionOption.js"), exports);
247
248
  __exportStar(require("./EmailSend.js"), exports);
@@ -253,6 +254,7 @@ __exportStar(require("./EmailSendEvent.js"), exports);
253
254
  __exportStar(require("./EmailSendEventDeliveryPolicy.js"), exports);
254
255
  __exportStar(require("./EmailSendEventEmailType.js"), exports);
255
256
  __exportStar(require("./EmailSendInternalFailureCode.js"), exports);
257
+ __exportStar(require("./EmailSendOutcome.js"), exports);
256
258
  __exportStar(require("./EmailSendStatus.js"), exports);
257
259
  __exportStar(require("./EmailSendSubscriber.js"), exports);
258
260
  __exportStar(require("./EmailSendSuppressionReason.js"), exports);
@@ -18,7 +18,12 @@ export interface EmailEvent {
18
18
  eventType?: Sequenzy.EmailEventEventType;
19
19
  id?: string;
20
20
  ipAddress?: string | null;
21
+ /** Event details. Receiver replies (recipients[].diagnosticCode) are masked for bounced and blocked outcomes, generic for failed ones, and kept for delays only when the sender caused them. Sending infrastructure is never included. */
21
22
  metadata?: Record<string, unknown>;
23
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
24
+ outcome?: Sequenzy.EmailEventOutcome | null;
25
+ /** One plain sentence about the outcome, with the receiver's status code when there is one. Null when outcome is null. */
26
+ reason?: string | null;
22
27
  subscriberId?: string | null;
23
28
  transactionalEmailId?: string | null;
24
29
  userAgent?: string | null;
@@ -0,0 +1,8 @@
1
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
2
+ export declare const EmailEventOutcome: {
3
+ readonly Bounced: "bounced";
4
+ readonly Blocked: "blocked";
5
+ readonly Delayed: "delayed";
6
+ readonly Failed: "failed";
7
+ };
8
+ export type EmailEventOutcome = (typeof EmailEventOutcome)[keyof typeof EmailEventOutcome];
@@ -0,0 +1,8 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
3
+ export const EmailEventOutcome = {
4
+ Bounced: "bounced",
5
+ Blocked: "blocked",
6
+ Delayed: "delayed",
7
+ Failed: "failed",
8
+ };
@@ -24,7 +24,7 @@ export interface EmailSend {
24
24
  emailType?: Sequenzy.EmailSendEmailType | null;
25
25
  errorMessage?: string | null;
26
26
  id?: string;
27
- /** Why a send reached status "failed". Present only for terminal delivery failures. "transport_exhausted" means every available delivery route was refused by the recipient provider; "admin_bounce" means an operator removed the message from the delivery queue; "crash_orphaned_claim" means the sending worker stopped between claiming the send and recording a transport outcome, so the message was never confirmed as reaching the provider. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
27
+ /** Why a send reached status "failed". Present only for terminal delivery failures, each of which has outcome "failed": "transport_exhausted" means we could not deliver the email; "admin_bounce" means the message was withdrawn before delivery; "crash_orphaned_claim" means sending stopped before the message was confirmed as handed off. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
28
28
  internalFailureCode?: Sequenzy.EmailSendInternalFailureCode | null;
29
29
  /** Whether this is an auxiliary CC/BCC delivery record whose content and engagement belong to a primary email send. */
30
30
  isCopiedRecipient?: boolean;
@@ -32,15 +32,21 @@ export interface EmailSend {
32
32
  isTestEmail?: boolean;
33
33
  /** Stored delivery-policy snapshot. Prefer emailType for a normalized value. */
34
34
  isTransactional?: boolean | null;
35
+ /** Always null. Sending IPs are not shared with customers. */
35
36
  observedSendingIpAddress?: string | null;
36
37
  openedAt?: Date | null;
37
38
  /** Resolved reply destination, optionally including a display name. When reply tracking is disabled, this is the sent Reply-To header. When reply tracking is enabled, the sent header is a unique trackable address and this value is the forwarding destination. */
38
39
  originalReplyTo?: string | null;
40
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
41
+ outcome?: Sequenzy.EmailSendOutcome | null;
39
42
  /** Primary email send ID for a copied-recipient delivery, or null for ordinary sends and when the primary record is unavailable. */
40
43
  primaryEmailSendId?: string | null;
44
+ /** One plain sentence about the outcome, with the receiver's status code when there is one. Null when outcome is null. */
45
+ reason?: string | null;
41
46
  recipientEmail?: string | null;
42
47
  senderEmail?: string | null;
43
48
  senderName?: string | null;
49
+ /** Always null. Sending IPs are not shared with customers. */
44
50
  sendingIpAddress?: string | null;
45
51
  sentAt?: Date | null;
46
52
  sesMessageId?: string | null;
@@ -20,6 +20,7 @@ export interface EmailSendEvent {
20
20
  eventType?: string;
21
21
  id?: string;
22
22
  ipAddress?: string | null;
23
+ /** Event details. Receiver replies (recipients[].diagnosticCode) are masked for bounced and blocked outcomes, generic for failed ones, and kept for delays only when the sender caused them. Sending infrastructure is never included. */
23
24
  metadata?: Record<string, unknown>;
24
25
  subscriberId?: string | null;
25
26
  transactionalEmailId?: string | null;
@@ -1,4 +1,4 @@
1
- /** Why a send reached status "failed". Present only for terminal delivery failures. "transport_exhausted" means every available delivery route was refused by the recipient provider; "admin_bounce" means an operator removed the message from the delivery queue; "crash_orphaned_claim" means the sending worker stopped between claiming the send and recording a transport outcome, so the message was never confirmed as reaching the provider. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
1
+ /** Why a send reached status "failed". Present only for terminal delivery failures, each of which has outcome "failed": "transport_exhausted" means we could not deliver the email; "admin_bounce" means the message was withdrawn before delivery; "crash_orphaned_claim" means sending stopped before the message was confirmed as handed off. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
2
2
  export declare const EmailSendInternalFailureCode: {
3
3
  readonly TransportExhausted: "transport_exhausted";
4
4
  readonly AdminBounce: "admin_bounce";
@@ -1,5 +1,5 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- /** Why a send reached status "failed". Present only for terminal delivery failures. "transport_exhausted" means every available delivery route was refused by the recipient provider; "admin_bounce" means an operator removed the message from the delivery queue; "crash_orphaned_claim" means the sending worker stopped between claiming the send and recording a transport outcome, so the message was never confirmed as reaching the provider. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
2
+ /** Why a send reached status "failed". Present only for terminal delivery failures, each of which has outcome "failed": "transport_exhausted" means we could not deliver the email; "admin_bounce" means the message was withdrawn before delivery; "crash_orphaned_claim" means sending stopped before the message was confirmed as handed off. None of them is a bounce: the address is still valid, stays subscribed, and is not suppressed. New codes can be added over time, so treat an unrecognized value as a generic failure rather than rejecting the response. */
3
3
  export const EmailSendInternalFailureCode = {
4
4
  TransportExhausted: "transport_exhausted",
5
5
  AdminBounce: "admin_bounce",
@@ -0,0 +1,8 @@
1
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
2
+ export declare const EmailSendOutcome: {
3
+ readonly Bounced: "bounced";
4
+ readonly Blocked: "blocked";
5
+ readonly Delayed: "delayed";
6
+ readonly Failed: "failed";
7
+ };
8
+ export type EmailSendOutcome = (typeof EmailSendOutcome)[keyof typeof EmailSendOutcome];
@@ -0,0 +1,8 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ /** Why the email did not arrive. "bounced": the address cannot take mail. "blocked": the receiver refused because of the sender (spam or content, the sending domain, policy, or its SPF, DKIM or DMARC). "delayed": still retrying. "failed": we could not deliver it. Null for emails that arrived or have not finished. */
3
+ export const EmailSendOutcome = {
4
+ Bounced: "bounced",
5
+ Blocked: "blocked",
6
+ Delayed: "delayed",
7
+ Failed: "failed",
8
+ };
@@ -2,7 +2,7 @@ import type * as Sequenzy from "../index.js";
2
2
  export interface SenderHealthMetric {
3
3
  count?: number;
4
4
  pauseThreshold?: Sequenzy.SenderHealthThresholdBound;
5
- /** Percentage of the applicable bounceScopedSent or complaintScopedSent denominator. */
5
+ /** Percentage of the applicable bounceScopedSent, blockScopedSent or complaintScopedSent denominator. */
6
6
  rate?: number;
7
7
  warnThreshold?: Sequenzy.SenderHealthThresholdBound;
8
8
  }
@@ -2,6 +2,7 @@
2
2
  export declare const SendingStatusPauseReasonKind: {
3
3
  readonly HighHardBounceRate: "high_hard_bounce_rate";
4
4
  readonly HighSoftBounceRate: "high_soft_bounce_rate";
5
+ readonly HighBlockRate: "high_block_rate";
5
6
  readonly HighComplaintRate: "high_complaint_rate";
6
7
  readonly PhishingGuard: "phishing_guard";
7
8
  readonly OverEmailLimit: "over_email_limit";
@@ -3,6 +3,7 @@
3
3
  export const SendingStatusPauseReasonKind = {
4
4
  HighHardBounceRate: "high_hard_bounce_rate",
5
5
  HighSoftBounceRate: "high_soft_bounce_rate",
6
+ HighBlockRate: "high_block_rate",
6
7
  HighComplaintRate: "high_complaint_rate",
7
8
  PhishingGuard: "phishing_guard",
8
9
  OverEmailLimit: "over_email_limit",
@@ -3,6 +3,10 @@ import type * as Sequenzy from "../index.js";
3
3
  * Null when the workspace has no metrics record yet or sender-health analytics are temporarily unavailable. Pause state and remediation remain available during an analytics outage.
4
4
  */
5
5
  export interface SendingStatusSenderHealth {
6
+ /** Refusals the sender caused - spam or content, the sending domain's reputation, policy, or failed SPF, DKIM or DMARC. Refusals caused by our infrastructure never count. */
7
+ block?: Sequenzy.SenderHealthMetric;
8
+ /** Sends, test sends included, counted from the bounce reset watermark - the denominator for the block rate. */
9
+ blockScopedSent?: number;
6
10
  /** Non-test sends counted from the bounce reset watermark - the denominator for hard- and soft-bounce rates. */
7
11
  bounceScopedSent?: number;
8
12
  complaint?: Sequenzy.SenderHealthMetric;
@@ -226,6 +226,7 @@ export * from "./EmailDesignSystemSource.js";
226
226
  export * from "./EmailEvent.js";
227
227
  export * from "./EmailEventEmailType.js";
228
228
  export * from "./EmailEventEventType.js";
229
+ export * from "./EmailEventOutcome.js";
229
230
  export * from "./EmailPreset.js";
230
231
  export * from "./EmailSectionOption.js";
231
232
  export * from "./EmailSend.js";
@@ -237,6 +238,7 @@ export * from "./EmailSendEvent.js";
237
238
  export * from "./EmailSendEventDeliveryPolicy.js";
238
239
  export * from "./EmailSendEventEmailType.js";
239
240
  export * from "./EmailSendInternalFailureCode.js";
241
+ export * from "./EmailSendOutcome.js";
240
242
  export * from "./EmailSendStatus.js";
241
243
  export * from "./EmailSendSubscriber.js";
242
244
  export * from "./EmailSendSuppressionReason.js";
@@ -226,6 +226,7 @@ export * from "./EmailDesignSystemSource.js";
226
226
  export * from "./EmailEvent.js";
227
227
  export * from "./EmailEventEmailType.js";
228
228
  export * from "./EmailEventEventType.js";
229
+ export * from "./EmailEventOutcome.js";
229
230
  export * from "./EmailPreset.js";
230
231
  export * from "./EmailSectionOption.js";
231
232
  export * from "./EmailSend.js";
@@ -237,6 +238,7 @@ export * from "./EmailSendEvent.js";
237
238
  export * from "./EmailSendEventDeliveryPolicy.js";
238
239
  export * from "./EmailSendEventEmailType.js";
239
240
  export * from "./EmailSendInternalFailureCode.js";
241
+ export * from "./EmailSendOutcome.js";
240
242
  export * from "./EmailSendStatus.js";
241
243
  export * from "./EmailSendSubscriber.js";
242
244
  export * from "./EmailSendSuppressionReason.js";
@@ -3,6 +3,7 @@ import * as core from "../../core/index.js";
3
3
  import type * as serializers from "../index.js";
4
4
  import { EmailEventEmailType } from "./EmailEventEmailType.js";
5
5
  import { EmailEventEventType } from "./EmailEventEventType.js";
6
+ import { EmailEventOutcome } from "./EmailEventOutcome.js";
6
7
  export declare const EmailEvent: core.serialization.ObjectSchema<serializers.EmailEvent.Raw, Sequenzy.EmailEvent>;
7
8
  export declare namespace EmailEvent {
8
9
  interface Raw {
@@ -24,6 +25,8 @@ export declare namespace EmailEvent {
24
25
  id?: string | null;
25
26
  ipAddress?: (string | null | undefined) | null;
26
27
  metadata?: Record<string, unknown> | null;
28
+ outcome?: (EmailEventOutcome.Raw | null | undefined) | null;
29
+ reason?: (string | null | undefined) | null;
27
30
  subscriberId?: (string | null | undefined) | null;
28
31
  transactionalEmailId?: (string | null | undefined) | null;
29
32
  userAgent?: (string | null | undefined) | null;
@@ -2,6 +2,7 @@
2
2
  import * as core from "../../core/index.js";
3
3
  import { EmailEventEmailType } from "./EmailEventEmailType.js";
4
4
  import { EmailEventEventType } from "./EmailEventEventType.js";
5
+ import { EmailEventOutcome } from "./EmailEventOutcome.js";
5
6
  export const EmailEvent = core.serialization.object({
6
7
  abTestId: core.serialization.string().optionalNullable(),
7
8
  abTestVariantId: core.serialization.string().optionalNullable(),
@@ -21,6 +22,8 @@ export const EmailEvent = core.serialization.object({
21
22
  id: core.serialization.string().optional(),
22
23
  ipAddress: core.serialization.string().optionalNullable(),
23
24
  metadata: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
25
+ outcome: EmailEventOutcome.optionalNullable(),
26
+ reason: core.serialization.string().optionalNullable(),
24
27
  subscriberId: core.serialization.string().optionalNullable(),
25
28
  transactionalEmailId: core.serialization.string().optionalNullable(),
26
29
  userAgent: core.serialization.string().optionalNullable(),
@@ -0,0 +1,7 @@
1
+ import type * as Sequenzy from "../../api/index.js";
2
+ import * as core from "../../core/index.js";
3
+ import type * as serializers from "../index.js";
4
+ export declare const EmailEventOutcome: core.serialization.Schema<serializers.EmailEventOutcome.Raw, Sequenzy.EmailEventOutcome>;
5
+ export declare namespace EmailEventOutcome {
6
+ type Raw = "bounced" | "blocked" | "delayed" | "failed";
7
+ }
@@ -0,0 +1,3 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../core/index.js";
3
+ export const EmailEventOutcome = core.serialization.enum_(["bounced", "blocked", "delayed", "failed"]);
@@ -6,6 +6,7 @@ import { EmailSendAutomation } from "./EmailSendAutomation.js";
6
6
  import { EmailSendCampaign } from "./EmailSendCampaign.js";
7
7
  import { EmailSendEmailType } from "./EmailSendEmailType.js";
8
8
  import { EmailSendInternalFailureCode } from "./EmailSendInternalFailureCode.js";
9
+ import { EmailSendOutcome } from "./EmailSendOutcome.js";
9
10
  import { EmailSendStatus } from "./EmailSendStatus.js";
10
11
  import { EmailSendSubscriber } from "./EmailSendSubscriber.js";
11
12
  import { EmailSendSuppressionReason } from "./EmailSendSuppressionReason.js";
@@ -41,7 +42,9 @@ export declare namespace EmailSend {
41
42
  observedSendingIpAddress?: (string | null | undefined) | null;
42
43
  openedAt?: (string | null | undefined) | null;
43
44
  originalReplyTo?: (string | null | undefined) | null;
45
+ outcome?: (EmailSendOutcome.Raw | null | undefined) | null;
44
46
  primaryEmailSendId?: (string | null | undefined) | null;
47
+ reason?: (string | null | undefined) | null;
45
48
  recipientEmail?: (string | null | undefined) | null;
46
49
  senderEmail?: (string | null | undefined) | null;
47
50
  senderName?: (string | null | undefined) | null;
@@ -5,6 +5,7 @@ import { EmailSendAutomation } from "./EmailSendAutomation.js";
5
5
  import { EmailSendCampaign } from "./EmailSendCampaign.js";
6
6
  import { EmailSendEmailType } from "./EmailSendEmailType.js";
7
7
  import { EmailSendInternalFailureCode } from "./EmailSendInternalFailureCode.js";
8
+ import { EmailSendOutcome } from "./EmailSendOutcome.js";
8
9
  import { EmailSendStatus } from "./EmailSendStatus.js";
9
10
  import { EmailSendSubscriber } from "./EmailSendSubscriber.js";
10
11
  import { EmailSendSuppressionReason } from "./EmailSendSuppressionReason.js";
@@ -38,7 +39,9 @@ export const EmailSend = core.serialization.object({
38
39
  observedSendingIpAddress: core.serialization.string().optionalNullable(),
39
40
  openedAt: core.serialization.date().optionalNullable(),
40
41
  originalReplyTo: core.serialization.string().optionalNullable(),
42
+ outcome: EmailSendOutcome.optionalNullable(),
41
43
  primaryEmailSendId: core.serialization.string().optionalNullable(),
44
+ reason: core.serialization.string().optionalNullable(),
42
45
  recipientEmail: core.serialization.string().optionalNullable(),
43
46
  senderEmail: core.serialization.string().optionalNullable(),
44
47
  senderName: core.serialization.string().optionalNullable(),
@@ -0,0 +1,7 @@
1
+ import type * as Sequenzy from "../../api/index.js";
2
+ import * as core from "../../core/index.js";
3
+ import type * as serializers from "../index.js";
4
+ export declare const EmailSendOutcome: core.serialization.Schema<serializers.EmailSendOutcome.Raw, Sequenzy.EmailSendOutcome>;
5
+ export declare namespace EmailSendOutcome {
6
+ type Raw = "bounced" | "blocked" | "delayed" | "failed";
7
+ }
@@ -0,0 +1,3 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../../core/index.js";
3
+ export const EmailSendOutcome = core.serialization.enum_(["bounced", "blocked", "delayed", "failed"]);
@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
3
3
  import type * as serializers from "../index.js";
4
4
  export declare const SendingStatusPauseReasonKind: core.serialization.Schema<serializers.SendingStatusPauseReasonKind.Raw, Sequenzy.SendingStatusPauseReasonKind>;
5
5
  export declare namespace SendingStatusPauseReasonKind {
6
- type Raw = "high_hard_bounce_rate" | "high_soft_bounce_rate" | "high_complaint_rate" | "phishing_guard" | "over_email_limit" | "manual" | "other";
6
+ type Raw = "high_hard_bounce_rate" | "high_soft_bounce_rate" | "high_block_rate" | "high_complaint_rate" | "phishing_guard" | "over_email_limit" | "manual" | "other";
7
7
  }
@@ -3,6 +3,7 @@ import * as core from "../../core/index.js";
3
3
  export const SendingStatusPauseReasonKind = core.serialization.enum_([
4
4
  "high_hard_bounce_rate",
5
5
  "high_soft_bounce_rate",
6
+ "high_block_rate",
6
7
  "high_complaint_rate",
7
8
  "phishing_guard",
8
9
  "over_email_limit",
@@ -6,6 +6,8 @@ import { SendingStatusSenderHealthEnforcementMode } from "./SendingStatusSenderH
6
6
  export declare const SendingStatusSenderHealth: core.serialization.ObjectSchema<serializers.SendingStatusSenderHealth.Raw, Sequenzy.SendingStatusSenderHealth>;
7
7
  export declare namespace SendingStatusSenderHealth {
8
8
  interface Raw {
9
+ block?: SenderHealthMetric.Raw | null;
10
+ blockScopedSent?: number | null;
9
11
  bounceScopedSent?: number | null;
10
12
  complaint?: SenderHealthMetric.Raw | null;
11
13
  complaintScopedSent?: number | null;
@@ -3,6 +3,8 @@ import * as core from "../../core/index.js";
3
3
  import { SenderHealthMetric } from "./SenderHealthMetric.js";
4
4
  import { SendingStatusSenderHealthEnforcementMode } from "./SendingStatusSenderHealthEnforcementMode.js";
5
5
  export const SendingStatusSenderHealth = core.serialization.object({
6
+ block: SenderHealthMetric.optional(),
7
+ blockScopedSent: core.serialization.number().optional(),
6
8
  bounceScopedSent: core.serialization.number().optional(),
7
9
  complaint: SenderHealthMetric.optional(),
8
10
  complaintScopedSent: core.serialization.number().optional(),
@@ -226,6 +226,7 @@ export * from "./EmailDesignSystemSource.js";
226
226
  export * from "./EmailEvent.js";
227
227
  export * from "./EmailEventEmailType.js";
228
228
  export * from "./EmailEventEventType.js";
229
+ export * from "./EmailEventOutcome.js";
229
230
  export * from "./EmailPreset.js";
230
231
  export * from "./EmailSectionOption.js";
231
232
  export * from "./EmailSend.js";
@@ -237,6 +238,7 @@ export * from "./EmailSendEvent.js";
237
238
  export * from "./EmailSendEventDeliveryPolicy.js";
238
239
  export * from "./EmailSendEventEmailType.js";
239
240
  export * from "./EmailSendInternalFailureCode.js";
241
+ export * from "./EmailSendOutcome.js";
240
242
  export * from "./EmailSendStatus.js";
241
243
  export * from "./EmailSendSubscriber.js";
242
244
  export * from "./EmailSendSuppressionReason.js";
@@ -226,6 +226,7 @@ export * from "./EmailDesignSystemSource.js";
226
226
  export * from "./EmailEvent.js";
227
227
  export * from "./EmailEventEmailType.js";
228
228
  export * from "./EmailEventEventType.js";
229
+ export * from "./EmailEventOutcome.js";
229
230
  export * from "./EmailPreset.js";
230
231
  export * from "./EmailSectionOption.js";
231
232
  export * from "./EmailSend.js";
@@ -237,6 +238,7 @@ export * from "./EmailSendEvent.js";
237
238
  export * from "./EmailSendEventDeliveryPolicy.js";
238
239
  export * from "./EmailSendEventEmailType.js";
239
240
  export * from "./EmailSendInternalFailureCode.js";
241
+ export * from "./EmailSendOutcome.js";
240
242
  export * from "./EmailSendStatus.js";
241
243
  export * from "./EmailSendSubscriber.js";
242
244
  export * from "./EmailSendSuppressionReason.js";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sequenzy",
3
- "version": "2.1.29",
3
+ "version": "2.1.30",
4
4
  "description": "Official TypeScript SDK for the Sequenzy API",
5
5
  "license": "MIT",
6
6
  "homepage": "https://docs.sequenzy.com",