sequenzy 2.1.23 → 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.
- package/dist/cjs/api/resources/accounts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/accounts/client/Client.js +1 -1
- package/dist/cjs/api/resources/analytics/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/analytics/client/Client.js +108 -1
- package/dist/cjs/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.d.ts +27 -0
- package/dist/cjs/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.js +3 -0
- package/dist/cjs/api/resources/analytics/client/requests/GetMetricsRequest.d.ts +4 -0
- package/dist/cjs/api/resources/analytics/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +8 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestBy.js +11 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +6 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +9 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +8 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +11 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +14 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponse.js +3 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +30 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +3 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsResponse.d.ts +4 -0
- package/dist/cjs/api/resources/analytics/types/index.d.ts +5 -0
- package/dist/cjs/api/resources/analytics/types/index.js +5 -0
- package/dist/cjs/api/resources/integrations/client/Client.d.ts +17 -0
- package/dist/cjs/api/resources/integrations/client/Client.js +66 -0
- package/dist/cjs/api/resources/integrations/client/requests/ConnectIntegrationsRequest.d.ts +1 -1
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +12 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +3 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +11 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +3 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +4 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +3 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +4 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +7 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +10 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +3 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +10 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +12 -0
- package/dist/cjs/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +15 -0
- package/dist/cjs/api/resources/integrations/types/index.d.ts +7 -0
- package/dist/cjs/api/resources/integrations/types/index.js +7 -0
- package/dist/cjs/api/types/EmailEvent.d.ts +5 -0
- package/dist/cjs/api/types/EmailEventOutcome.d.ts +8 -0
- package/dist/cjs/api/types/EmailEventOutcome.js +11 -0
- package/dist/cjs/api/types/EmailSend.d.ts +7 -1
- package/dist/cjs/api/types/EmailSendEvent.d.ts +1 -0
- package/dist/cjs/api/types/EmailSendInternalFailureCode.d.ts +1 -1
- package/dist/cjs/api/types/EmailSendInternalFailureCode.js +1 -1
- package/dist/cjs/api/types/EmailSendOutcome.d.ts +8 -0
- package/dist/cjs/api/types/EmailSendOutcome.js +11 -0
- package/dist/cjs/api/types/SenderHealthMetric.d.ts +1 -1
- package/dist/cjs/api/types/SendingStatusPauseReasonKind.d.ts +1 -0
- package/dist/cjs/api/types/SendingStatusPauseReasonKind.js +1 -0
- package/dist/cjs/api/types/SendingStatusSenderHealth.d.ts +4 -0
- package/dist/cjs/api/types/index.d.ts +2 -0
- package/dist/cjs/api/types/index.js +2 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +7 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.js +29 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +7 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +29 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +7 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +29 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +19 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponse.js +41 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +26 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +48 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsResponse.d.ts +2 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsResponse.js +2 -0
- package/dist/cjs/serialization/resources/analytics/types/index.d.ts +5 -0
- package/dist/cjs/serialization/resources/analytics/types/index.js +5 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +15 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +37 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +13 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +35 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +10 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +32 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +7 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +29 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +15 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +37 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +29 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +7 -0
- package/dist/cjs/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +39 -0
- package/dist/cjs/serialization/resources/integrations/types/index.d.ts +7 -0
- package/dist/cjs/serialization/resources/integrations/types/index.js +7 -0
- package/dist/cjs/serialization/types/EmailEvent.d.ts +3 -0
- package/dist/cjs/serialization/types/EmailEvent.js +3 -0
- package/dist/cjs/serialization/types/EmailEventOutcome.d.ts +7 -0
- package/dist/cjs/serialization/types/EmailEventOutcome.js +29 -0
- package/dist/cjs/serialization/types/EmailSend.d.ts +3 -0
- package/dist/cjs/serialization/types/EmailSend.js +3 -0
- package/dist/cjs/serialization/types/EmailSendOutcome.d.ts +7 -0
- package/dist/cjs/serialization/types/EmailSendOutcome.js +29 -0
- package/dist/cjs/serialization/types/SendingStatusPauseReasonKind.d.ts +1 -1
- package/dist/cjs/serialization/types/SendingStatusPauseReasonKind.js +1 -0
- package/dist/cjs/serialization/types/SendingStatusSenderHealth.d.ts +2 -0
- package/dist/cjs/serialization/types/SendingStatusSenderHealth.js +2 -0
- package/dist/cjs/serialization/types/index.d.ts +2 -0
- package/dist/cjs/serialization/types/index.js +2 -0
- package/dist/esm/api/resources/accounts/client/Client.d.ts +1 -1
- package/dist/esm/api/resources/accounts/client/Client.js +1 -1
- package/dist/esm/api/resources/analytics/client/Client.d.ts +20 -0
- package/dist/esm/api/resources/analytics/client/Client.js +108 -1
- package/dist/esm/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.d.ts +27 -0
- package/dist/esm/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.js +2 -0
- package/dist/esm/api/resources/analytics/client/requests/GetMetricsRequest.d.ts +4 -0
- package/dist/esm/api/resources/analytics/client/requests/index.d.ts +1 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +8 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestBy.js +8 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +6 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +6 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +8 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +8 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +14 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponse.js +2 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +30 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +2 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsResponse.d.ts +4 -0
- package/dist/esm/api/resources/analytics/types/index.d.ts +5 -0
- package/dist/esm/api/resources/analytics/types/index.js +5 -0
- package/dist/esm/api/resources/integrations/client/Client.d.ts +17 -0
- package/dist/esm/api/resources/integrations/client/Client.js +66 -0
- package/dist/esm/api/resources/integrations/client/requests/ConnectIntegrationsRequest.d.ts +1 -1
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +12 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +2 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +11 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +2 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +4 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +2 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +4 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +4 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +10 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +2 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +7 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +12 -0
- package/dist/esm/api/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +12 -0
- package/dist/esm/api/resources/integrations/types/index.d.ts +7 -0
- package/dist/esm/api/resources/integrations/types/index.js +7 -0
- package/dist/esm/api/types/EmailEvent.d.ts +5 -0
- package/dist/esm/api/types/EmailEventOutcome.d.ts +8 -0
- package/dist/esm/api/types/EmailEventOutcome.js +8 -0
- package/dist/esm/api/types/EmailSend.d.ts +7 -1
- package/dist/esm/api/types/EmailSendEvent.d.ts +1 -0
- package/dist/esm/api/types/EmailSendInternalFailureCode.d.ts +1 -1
- package/dist/esm/api/types/EmailSendInternalFailureCode.js +1 -1
- package/dist/esm/api/types/EmailSendOutcome.d.ts +8 -0
- package/dist/esm/api/types/EmailSendOutcome.js +8 -0
- package/dist/esm/api/types/SenderHealthMetric.d.ts +1 -1
- package/dist/esm/api/types/SendingStatusPauseReasonKind.d.ts +1 -0
- package/dist/esm/api/types/SendingStatusPauseReasonKind.js +1 -0
- package/dist/esm/api/types/SendingStatusSenderHealth.d.ts +4 -0
- package/dist/esm/api/types/index.d.ts +2 -0
- package/dist/esm/api/types/index.js +2 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.d.ts +7 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestBy.js +3 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts +7 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.js +3 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts +7 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.js +3 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +19 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponse.js +15 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts +26 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js +22 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsResponse.d.ts +2 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsResponse.js +2 -0
- package/dist/esm/serialization/resources/analytics/types/index.d.ts +5 -0
- package/dist/esm/serialization/resources/analytics/types/index.js +5 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts +15 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.js +11 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.d.ts +13 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProviders.js +9 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.d.ts +10 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js +6 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.d.ts +7 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponsePaymentProvidersReason.js +3 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.d.ts +15 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItem.js +11 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.d.ts +7 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js +3 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.d.ts +7 -0
- package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js +13 -0
- package/dist/esm/serialization/resources/integrations/types/index.d.ts +7 -0
- package/dist/esm/serialization/resources/integrations/types/index.js +7 -0
- package/dist/esm/serialization/types/EmailEvent.d.ts +3 -0
- package/dist/esm/serialization/types/EmailEvent.js +3 -0
- package/dist/esm/serialization/types/EmailEventOutcome.d.ts +7 -0
- package/dist/esm/serialization/types/EmailEventOutcome.js +3 -0
- package/dist/esm/serialization/types/EmailSend.d.ts +3 -0
- package/dist/esm/serialization/types/EmailSend.js +3 -0
- package/dist/esm/serialization/types/EmailSendOutcome.d.ts +7 -0
- package/dist/esm/serialization/types/EmailSendOutcome.js +3 -0
- package/dist/esm/serialization/types/SendingStatusPauseReasonKind.d.ts +1 -1
- package/dist/esm/serialization/types/SendingStatusPauseReasonKind.js +1 -0
- package/dist/esm/serialization/types/SendingStatusSenderHealth.d.ts +2 -0
- package/dist/esm/serialization/types/SendingStatusSenderHealth.js +2 -0
- package/dist/esm/serialization/types/index.d.ts +2 -0
- package/dist/esm/serialization/types/index.js +2 -0
- package/package.json +1 -1
|
@@ -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
|
|
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
|
|
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
|
|
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";
|
|
@@ -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 GetMetricsBreakdownRequestBy: core.serialization.Schema<serializers.GetMetricsBreakdownRequestBy.Raw, Sequenzy.GetMetricsBreakdownRequestBy>;
|
|
5
|
+
export declare namespace GetMetricsBreakdownRequestBy {
|
|
6
|
+
type Raw = "email" | "sequence" | "email_type" | "mailbox_provider" | "recipient_domain";
|
|
7
|
+
}
|
package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestEmailType.d.ts
ADDED
|
@@ -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 GetMetricsBreakdownRequestEmailType: core.serialization.Schema<serializers.GetMetricsBreakdownRequestEmailType.Raw, Sequenzy.GetMetricsBreakdownRequestEmailType>;
|
|
5
|
+
export declare namespace GetMetricsBreakdownRequestEmailType {
|
|
6
|
+
type Raw = "campaign" | "transactional" | "sequence";
|
|
7
|
+
}
|
package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestPeriod.d.ts
ADDED
|
@@ -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 GetMetricsBreakdownRequestPeriod: core.serialization.Schema<serializers.GetMetricsBreakdownRequestPeriod.Raw, Sequenzy.GetMetricsBreakdownRequestPeriod>;
|
|
5
|
+
export declare namespace GetMetricsBreakdownRequestPeriod {
|
|
6
|
+
type Raw = "1h" | "24h" | "7d" | "30d" | "90d";
|
|
7
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
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
|
+
import { GetMetricsBreakdownResponseRowsItem } from "./GetMetricsBreakdownResponseRowsItem.js";
|
|
5
|
+
export declare const GetMetricsBreakdownResponse: core.serialization.ObjectSchema<serializers.GetMetricsBreakdownResponse.Raw, Sequenzy.GetMetricsBreakdownResponse>;
|
|
6
|
+
export declare namespace GetMetricsBreakdownResponse {
|
|
7
|
+
interface Raw {
|
|
8
|
+
by: string;
|
|
9
|
+
emailType?: string | null;
|
|
10
|
+
end: string;
|
|
11
|
+
mailboxProvider?: string | null;
|
|
12
|
+
period?: string | null;
|
|
13
|
+
recipientDomain?: string | null;
|
|
14
|
+
rows: GetMetricsBreakdownResponseRowsItem.Raw[];
|
|
15
|
+
source?: string | null;
|
|
16
|
+
start: string;
|
|
17
|
+
success: boolean;
|
|
18
|
+
}
|
|
19
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
import { GetMetricsBreakdownResponseRowsItem } from "./GetMetricsBreakdownResponseRowsItem.js";
|
|
4
|
+
export const GetMetricsBreakdownResponse = core.serialization.object({
|
|
5
|
+
by: core.serialization.string(),
|
|
6
|
+
emailType: core.serialization.string().optional(),
|
|
7
|
+
end: core.serialization.date(),
|
|
8
|
+
mailboxProvider: core.serialization.string().optional(),
|
|
9
|
+
period: core.serialization.string().optional(),
|
|
10
|
+
recipientDomain: core.serialization.string().optional(),
|
|
11
|
+
rows: core.serialization.list(GetMetricsBreakdownResponseRowsItem),
|
|
12
|
+
source: core.serialization.string().optional(),
|
|
13
|
+
start: core.serialization.date(),
|
|
14
|
+
success: core.serialization.boolean(),
|
|
15
|
+
});
|
package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.d.ts
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
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 GetMetricsBreakdownResponseRowsItem: core.serialization.ObjectSchema<serializers.GetMetricsBreakdownResponseRowsItem.Raw, Sequenzy.GetMetricsBreakdownResponseRowsItem>;
|
|
5
|
+
export declare namespace GetMetricsBreakdownResponseRowsItem {
|
|
6
|
+
interface Raw {
|
|
7
|
+
bounced: number;
|
|
8
|
+
bounceRate: number;
|
|
9
|
+
clicked: number;
|
|
10
|
+
clickRate: number;
|
|
11
|
+
complained: number;
|
|
12
|
+
conversions?: number | null;
|
|
13
|
+
delivered: number;
|
|
14
|
+
deliveryRate: number;
|
|
15
|
+
detail?: (string | null | undefined) | null;
|
|
16
|
+
filter?: (Record<string, unknown> | null | undefined) | null;
|
|
17
|
+
key: string;
|
|
18
|
+
label: string;
|
|
19
|
+
opened: number;
|
|
20
|
+
openRate: number;
|
|
21
|
+
revenue?: number | null;
|
|
22
|
+
sent: number;
|
|
23
|
+
unsubscribed: number;
|
|
24
|
+
unsubscribeRate: number;
|
|
25
|
+
}
|
|
26
|
+
}
|
package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponseRowsItem.js
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
export const GetMetricsBreakdownResponseRowsItem = core.serialization.object({
|
|
4
|
+
bounced: core.serialization.number(),
|
|
5
|
+
bounceRate: core.serialization.number(),
|
|
6
|
+
clicked: core.serialization.number(),
|
|
7
|
+
clickRate: core.serialization.number(),
|
|
8
|
+
complained: core.serialization.number(),
|
|
9
|
+
conversions: core.serialization.number().optional(),
|
|
10
|
+
delivered: core.serialization.number(),
|
|
11
|
+
deliveryRate: core.serialization.number(),
|
|
12
|
+
detail: core.serialization.string().optionalNullable(),
|
|
13
|
+
filter: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optionalNullable(),
|
|
14
|
+
key: core.serialization.string(),
|
|
15
|
+
label: core.serialization.string(),
|
|
16
|
+
opened: core.serialization.number(),
|
|
17
|
+
openRate: core.serialization.number(),
|
|
18
|
+
revenue: core.serialization.number().optional(),
|
|
19
|
+
sent: core.serialization.number(),
|
|
20
|
+
unsubscribed: core.serialization.number(),
|
|
21
|
+
unsubscribeRate: core.serialization.number(),
|
|
22
|
+
});
|
|
@@ -12,6 +12,8 @@ export declare namespace GetMetricsResponse {
|
|
|
12
12
|
emailType?: GetMetricsResponseEmailType.Raw | null;
|
|
13
13
|
mailboxProvider?: string | null;
|
|
14
14
|
period?: string | null;
|
|
15
|
+
recipientDomain?: string | null;
|
|
16
|
+
source?: string | null;
|
|
15
17
|
stats?: EngagementStats.Raw | null;
|
|
16
18
|
subscriberCount?: number | null;
|
|
17
19
|
success?: boolean | null;
|
|
@@ -9,6 +9,8 @@ export const GetMetricsResponse = core.serialization.object({
|
|
|
9
9
|
emailType: GetMetricsResponseEmailType.optional(),
|
|
10
10
|
mailboxProvider: core.serialization.string().optional(),
|
|
11
11
|
period: core.serialization.string().optional(),
|
|
12
|
+
recipientDomain: core.serialization.string().optional(),
|
|
13
|
+
source: core.serialization.string().optional(),
|
|
12
14
|
stats: EngagementStats.optional(),
|
|
13
15
|
subscriberCount: core.serialization.number().optional(),
|
|
14
16
|
success: core.serialization.boolean().optional(),
|
|
@@ -11,6 +11,11 @@ export * from "./GetLinkClickMetricsRequestEmailType.js";
|
|
|
11
11
|
export * from "./GetLinkClickMetricsRequestPeriod.js";
|
|
12
12
|
export * from "./GetLinkClickMetricsResponse.js";
|
|
13
13
|
export * from "./GetLinkClickMetricsResponseEmailType.js";
|
|
14
|
+
export * from "./GetMetricsBreakdownRequestBy.js";
|
|
15
|
+
export * from "./GetMetricsBreakdownRequestEmailType.js";
|
|
16
|
+
export * from "./GetMetricsBreakdownRequestPeriod.js";
|
|
17
|
+
export * from "./GetMetricsBreakdownResponse.js";
|
|
18
|
+
export * from "./GetMetricsBreakdownResponseRowsItem.js";
|
|
14
19
|
export * from "./GetMetricsRequestEmailType.js";
|
|
15
20
|
export * from "./GetMetricsRequestPeriod.js";
|
|
16
21
|
export * from "./GetMetricsResponse.js";
|
|
@@ -11,6 +11,11 @@ export * from "./GetLinkClickMetricsRequestEmailType.js";
|
|
|
11
11
|
export * from "./GetLinkClickMetricsRequestPeriod.js";
|
|
12
12
|
export * from "./GetLinkClickMetricsResponse.js";
|
|
13
13
|
export * from "./GetLinkClickMetricsResponseEmailType.js";
|
|
14
|
+
export * from "./GetMetricsBreakdownRequestBy.js";
|
|
15
|
+
export * from "./GetMetricsBreakdownRequestEmailType.js";
|
|
16
|
+
export * from "./GetMetricsBreakdownRequestPeriod.js";
|
|
17
|
+
export * from "./GetMetricsBreakdownResponse.js";
|
|
18
|
+
export * from "./GetMetricsBreakdownResponseRowsItem.js";
|
|
14
19
|
export * from "./GetMetricsRequestEmailType.js";
|
|
15
20
|
export * from "./GetMetricsRequestPeriod.js";
|
|
16
21
|
export * from "./GetMetricsResponse.js";
|
package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.d.ts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
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
|
+
import { ListSuggestionsIntegrationsResponsePaymentProviders } from "./ListSuggestionsIntegrationsResponsePaymentProviders.js";
|
|
5
|
+
import { ListSuggestionsIntegrationsResponseSuggestionsItem } from "./ListSuggestionsIntegrationsResponseSuggestionsItem.js";
|
|
6
|
+
export declare const ListSuggestionsIntegrationsResponse: core.serialization.ObjectSchema<serializers.ListSuggestionsIntegrationsResponse.Raw, Sequenzy.ListSuggestionsIntegrationsResponse>;
|
|
7
|
+
export declare namespace ListSuggestionsIntegrationsResponse {
|
|
8
|
+
interface Raw {
|
|
9
|
+
paymentProviders?: ListSuggestionsIntegrationsResponsePaymentProviders.Raw | null;
|
|
10
|
+
scanComplete: boolean;
|
|
11
|
+
success: boolean;
|
|
12
|
+
suggestions: ListSuggestionsIntegrationsResponseSuggestionsItem.Raw[];
|
|
13
|
+
websiteUrl?: string | null;
|
|
14
|
+
}
|
|
15
|
+
}
|
package/dist/esm/serialization/resources/integrations/types/ListSuggestionsIntegrationsResponse.js
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
import { ListSuggestionsIntegrationsResponsePaymentProviders } from "./ListSuggestionsIntegrationsResponsePaymentProviders.js";
|
|
4
|
+
import { ListSuggestionsIntegrationsResponseSuggestionsItem } from "./ListSuggestionsIntegrationsResponseSuggestionsItem.js";
|
|
5
|
+
export const ListSuggestionsIntegrationsResponse = core.serialization.object({
|
|
6
|
+
paymentProviders: ListSuggestionsIntegrationsResponsePaymentProviders.nullable(),
|
|
7
|
+
scanComplete: core.serialization.boolean(),
|
|
8
|
+
success: core.serialization.boolean(),
|
|
9
|
+
suggestions: core.serialization.list(ListSuggestionsIntegrationsResponseSuggestionsItem),
|
|
10
|
+
websiteUrl: core.serialization.string().nullable(),
|
|
11
|
+
});
|
|
@@ -0,0 +1,13 @@
|
|
|
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
|
+
import { ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem } from "./ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js";
|
|
5
|
+
import { ListSuggestionsIntegrationsResponsePaymentProvidersReason } from "./ListSuggestionsIntegrationsResponsePaymentProvidersReason.js";
|
|
6
|
+
export declare const ListSuggestionsIntegrationsResponsePaymentProviders: core.serialization.ObjectSchema<serializers.ListSuggestionsIntegrationsResponsePaymentProviders.Raw, Sequenzy.ListSuggestionsIntegrationsResponsePaymentProviders>;
|
|
7
|
+
export declare namespace ListSuggestionsIntegrationsResponsePaymentProviders {
|
|
8
|
+
interface Raw {
|
|
9
|
+
pricingPlanCount: number;
|
|
10
|
+
providers: ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.Raw[];
|
|
11
|
+
reason: ListSuggestionsIntegrationsResponsePaymentProvidersReason.Raw;
|
|
12
|
+
}
|
|
13
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
import { ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem } from "./ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js";
|
|
4
|
+
import { ListSuggestionsIntegrationsResponsePaymentProvidersReason } from "./ListSuggestionsIntegrationsResponsePaymentProvidersReason.js";
|
|
5
|
+
export const ListSuggestionsIntegrationsResponsePaymentProviders = core.serialization.object({
|
|
6
|
+
pricingPlanCount: core.serialization.number(),
|
|
7
|
+
providers: core.serialization.list(ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem),
|
|
8
|
+
reason: ListSuggestionsIntegrationsResponsePaymentProvidersReason,
|
|
9
|
+
});
|
|
@@ -0,0 +1,10 @@
|
|
|
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 ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem: core.serialization.ObjectSchema<serializers.ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.Raw, Sequenzy.ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem>;
|
|
5
|
+
export declare namespace ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem {
|
|
6
|
+
interface Raw {
|
|
7
|
+
name: string;
|
|
8
|
+
provider: string;
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
export const ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem = core.serialization.object({
|
|
4
|
+
name: core.serialization.string(),
|
|
5
|
+
provider: core.serialization.string(),
|
|
6
|
+
});
|
|
@@ -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 ListSuggestionsIntegrationsResponsePaymentProvidersReason: core.serialization.Schema<serializers.ListSuggestionsIntegrationsResponsePaymentProvidersReason.Raw, Sequenzy.ListSuggestionsIntegrationsResponsePaymentProvidersReason>;
|
|
5
|
+
export declare namespace ListSuggestionsIntegrationsResponsePaymentProvidersReason {
|
|
6
|
+
type Raw = "pricing_found";
|
|
7
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
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
|
+
import { ListSuggestionsIntegrationsResponseSuggestionsItemEvidence } from "./ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js";
|
|
5
|
+
import { ListSuggestionsIntegrationsResponseSuggestionsItemProvider } from "./ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js";
|
|
6
|
+
export declare const ListSuggestionsIntegrationsResponseSuggestionsItem: core.serialization.ObjectSchema<serializers.ListSuggestionsIntegrationsResponseSuggestionsItem.Raw, Sequenzy.ListSuggestionsIntegrationsResponseSuggestionsItem>;
|
|
7
|
+
export declare namespace ListSuggestionsIntegrationsResponseSuggestionsItem {
|
|
8
|
+
interface Raw {
|
|
9
|
+
category: string;
|
|
10
|
+
evidence: ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.Raw;
|
|
11
|
+
name: string;
|
|
12
|
+
provider: ListSuggestionsIntegrationsResponseSuggestionsItemProvider.Raw;
|
|
13
|
+
shopDomain?: string | null;
|
|
14
|
+
}
|
|
15
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
import { ListSuggestionsIntegrationsResponseSuggestionsItemEvidence } from "./ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js";
|
|
4
|
+
import { ListSuggestionsIntegrationsResponseSuggestionsItemProvider } from "./ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js";
|
|
5
|
+
export const ListSuggestionsIntegrationsResponseSuggestionsItem = core.serialization.object({
|
|
6
|
+
category: core.serialization.string(),
|
|
7
|
+
evidence: ListSuggestionsIntegrationsResponseSuggestionsItemEvidence,
|
|
8
|
+
name: core.serialization.string(),
|
|
9
|
+
provider: ListSuggestionsIntegrationsResponseSuggestionsItemProvider,
|
|
10
|
+
shopDomain: core.serialization.string().nullable(),
|
|
11
|
+
});
|
|
@@ -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 ListSuggestionsIntegrationsResponseSuggestionsItemEvidence: core.serialization.Schema<serializers.ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.Raw, Sequenzy.ListSuggestionsIntegrationsResponseSuggestionsItemEvidence>;
|
|
5
|
+
export declare namespace ListSuggestionsIntegrationsResponseSuggestionsItemEvidence {
|
|
6
|
+
type Raw = "homepage" | "sign_in_page" | "storefront";
|
|
7
|
+
}
|
|
@@ -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 ListSuggestionsIntegrationsResponseSuggestionsItemProvider: core.serialization.Schema<serializers.ListSuggestionsIntegrationsResponseSuggestionsItemProvider.Raw, Sequenzy.ListSuggestionsIntegrationsResponseSuggestionsItemProvider>;
|
|
5
|
+
export declare namespace ListSuggestionsIntegrationsResponseSuggestionsItemProvider {
|
|
6
|
+
type Raw = "shopify" | "clerk" | "supabase" | "posthog" | "segment" | "woocommerce" | "wordpress" | "webflow" | "wix";
|
|
7
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../../../core/index.js";
|
|
3
|
+
export const ListSuggestionsIntegrationsResponseSuggestionsItemProvider = core.serialization.enum_([
|
|
4
|
+
"shopify",
|
|
5
|
+
"clerk",
|
|
6
|
+
"supabase",
|
|
7
|
+
"posthog",
|
|
8
|
+
"segment",
|
|
9
|
+
"woocommerce",
|
|
10
|
+
"wordpress",
|
|
11
|
+
"webflow",
|
|
12
|
+
"wix",
|
|
13
|
+
]);
|
|
@@ -13,6 +13,13 @@ export * from "./ListActivityIntegrationsRequestStatus.js";
|
|
|
13
13
|
export * from "./ListActivityIntegrationsResponse.js";
|
|
14
14
|
export * from "./ListCapabilitiesIntegrationsResponse.js";
|
|
15
15
|
export * from "./ListIntegrationsResponse.js";
|
|
16
|
+
export * from "./ListSuggestionsIntegrationsResponse.js";
|
|
17
|
+
export * from "./ListSuggestionsIntegrationsResponsePaymentProviders.js";
|
|
18
|
+
export * from "./ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js";
|
|
19
|
+
export * from "./ListSuggestionsIntegrationsResponsePaymentProvidersReason.js";
|
|
20
|
+
export * from "./ListSuggestionsIntegrationsResponseSuggestionsItem.js";
|
|
21
|
+
export * from "./ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js";
|
|
22
|
+
export * from "./ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js";
|
|
16
23
|
export * from "./SyncIntegrationsResponse.js";
|
|
17
24
|
export * from "./SyncIntegrationsResponseSyncTarget.js";
|
|
18
25
|
export * from "./UpdateSyncIntegrationsResponse.js";
|
|
@@ -13,6 +13,13 @@ export * from "./ListActivityIntegrationsRequestStatus.js";
|
|
|
13
13
|
export * from "./ListActivityIntegrationsResponse.js";
|
|
14
14
|
export * from "./ListCapabilitiesIntegrationsResponse.js";
|
|
15
15
|
export * from "./ListIntegrationsResponse.js";
|
|
16
|
+
export * from "./ListSuggestionsIntegrationsResponse.js";
|
|
17
|
+
export * from "./ListSuggestionsIntegrationsResponsePaymentProviders.js";
|
|
18
|
+
export * from "./ListSuggestionsIntegrationsResponsePaymentProvidersProvidersItem.js";
|
|
19
|
+
export * from "./ListSuggestionsIntegrationsResponsePaymentProvidersReason.js";
|
|
20
|
+
export * from "./ListSuggestionsIntegrationsResponseSuggestionsItem.js";
|
|
21
|
+
export * from "./ListSuggestionsIntegrationsResponseSuggestionsItemEvidence.js";
|
|
22
|
+
export * from "./ListSuggestionsIntegrationsResponseSuggestionsItemProvider.js";
|
|
16
23
|
export * from "./SyncIntegrationsResponse.js";
|
|
17
24
|
export * from "./SyncIntegrationsResponseSyncTarget.js";
|
|
18
25
|
export * from "./UpdateSyncIntegrationsResponse.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
|
+
}
|