sequenzy 2.1.29 → 2.1.34
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/analytics/client/Client.js +14 -2
- package/dist/cjs/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.d.ts +2 -0
- package/dist/cjs/api/resources/analytics/client/requests/GetMetricsRequest.d.ts +2 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestOutcome.d.ts +7 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownRequestOutcome.js +10 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +1 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsRequestOutcome.d.ts +7 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsRequestOutcome.js +10 -0
- package/dist/cjs/api/resources/analytics/types/GetMetricsResponse.d.ts +2 -0
- package/dist/cjs/api/resources/analytics/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/analytics/types/index.js +2 -0
- package/dist/cjs/api/resources/companies/client/requests/UpdateCompaniesRequest.d.ts +2 -0
- package/dist/cjs/api/resources/companies/types/UpdateCompaniesRequestEmailTheme.d.ts +1 -1
- package/dist/cjs/api/resources/companies/types/UpdateCompaniesRequestEmailThemeLayout.d.ts +5 -1
- package/dist/cjs/api/resources/companies/types/UpdateCompaniesRequestEmailThemeLayoutContentAlign.d.ts +6 -0
- package/dist/cjs/api/resources/companies/types/UpdateCompaniesRequestEmailThemeLayoutContentAlign.js +9 -0
- package/dist/cjs/api/resources/companies/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/companies/types/index.js +1 -0
- package/dist/cjs/api/resources/subscribers/resources/events/types/TriggerBulkEventsResponseOptIn.d.ts +1 -0
- package/dist/cjs/api/resources/subscribers/resources/events/types/TriggerEventsResponseOptIn.d.ts +1 -0
- package/dist/cjs/api/resources/subscribers/resources/tags/types/AddTagsResponseOptIn.d.ts +1 -0
- package/dist/cjs/api/resources/subscribers/types/AddTagsBulkResponseOptIn.d.ts +1 -0
- package/dist/cjs/api/resources/subscribers/types/CreateSubscribersResponseOptIn.d.ts +1 -0
- package/dist/cjs/api/resources/trackingDomain/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/trackingDomain/client/Client.js +1 -1
- package/dist/cjs/api/types/Company.d.ts +4 -0
- package/dist/cjs/api/types/CompanyDarkModeLogoStatus.d.ts +8 -0
- package/dist/cjs/api/types/CompanyDarkModeLogoStatus.js +11 -0
- package/dist/cjs/api/types/EmailAiStyleCanvas.d.ts +1 -1
- package/dist/cjs/api/types/EmailAiStyleCanvasTheme.d.ts +2 -2
- package/dist/cjs/api/types/EmailAiStyleCanvasThemeLayout.d.ts +4 -0
- package/dist/cjs/api/types/EmailAiStyleCanvasThemeLayout.js +3 -0
- package/dist/cjs/api/types/EmailAiStyleCanvasThemeLayoutContentAlign.d.ts +5 -0
- package/dist/cjs/api/types/EmailAiStyleCanvasThemeLayoutContentAlign.js +8 -0
- package/dist/cjs/api/types/EmailBlockStyles.d.ts +2 -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/EmailThemePatchLayout.d.ts +3 -0
- package/dist/cjs/api/types/EmailThemePatchLayoutContentAlign.d.ts +6 -0
- package/dist/cjs/api/types/EmailThemePatchLayoutContentAlign.js +9 -0
- package/dist/cjs/api/types/SavedFormEmbed.d.ts +10 -3
- package/dist/cjs/api/types/SavedFormEmbedRecommendedSnippet.d.ts +5 -0
- package/dist/cjs/api/types/SavedFormEmbedRecommendedSnippet.js +8 -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 +7 -0
- package/dist/cjs/api/types/index.js +7 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestOutcome.d.ts +7 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownRequestOutcome.js +29 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +1 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsBreakdownResponse.js +1 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsRequestOutcome.d.ts +7 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsRequestOutcome.js +29 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsResponse.d.ts +1 -0
- package/dist/cjs/serialization/resources/analytics/types/GetMetricsResponse.js +1 -0
- package/dist/cjs/serialization/resources/analytics/types/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/analytics/types/index.js +2 -0
- package/dist/cjs/serialization/resources/companies/client/requests/UpdateCompaniesRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/companies/client/requests/UpdateCompaniesRequest.js +1 -0
- package/dist/cjs/serialization/resources/companies/types/UpdateCompaniesRequestEmailThemeLayout.d.ts +3 -0
- package/dist/cjs/serialization/resources/companies/types/UpdateCompaniesRequestEmailThemeLayout.js +3 -0
- package/dist/cjs/serialization/resources/companies/types/UpdateCompaniesRequestEmailThemeLayoutContentAlign.d.ts +7 -0
- package/dist/cjs/serialization/resources/companies/types/UpdateCompaniesRequestEmailThemeLayoutContentAlign.js +29 -0
- package/dist/cjs/serialization/resources/companies/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/companies/types/index.js +1 -0
- package/dist/cjs/serialization/types/Company.d.ts +3 -0
- package/dist/cjs/serialization/types/Company.js +3 -0
- package/dist/cjs/serialization/types/CompanyDarkModeLogoStatus.d.ts +7 -0
- package/dist/cjs/serialization/types/CompanyDarkModeLogoStatus.js +29 -0
- package/dist/cjs/serialization/types/EmailAiStyleCanvasTheme.d.ts +2 -1
- package/dist/cjs/serialization/types/EmailAiStyleCanvasTheme.js +2 -1
- package/dist/cjs/serialization/types/EmailAiStyleCanvasThemeLayout.d.ts +10 -0
- package/dist/cjs/serialization/types/EmailAiStyleCanvasThemeLayout.js +32 -0
- package/dist/cjs/serialization/types/EmailAiStyleCanvasThemeLayoutContentAlign.d.ts +7 -0
- package/dist/cjs/serialization/types/EmailAiStyleCanvasThemeLayoutContentAlign.js +29 -0
- package/dist/cjs/serialization/types/EmailBlockStyles.d.ts +1 -0
- package/dist/cjs/serialization/types/EmailBlockStyles.js +1 -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/EmailThemePatchLayout.d.ts +2 -0
- package/dist/cjs/serialization/types/EmailThemePatchLayout.js +2 -0
- package/dist/cjs/serialization/types/EmailThemePatchLayoutContentAlign.d.ts +7 -0
- package/dist/cjs/serialization/types/EmailThemePatchLayoutContentAlign.js +29 -0
- package/dist/cjs/serialization/types/SavedFormEmbed.d.ts +4 -0
- package/dist/cjs/serialization/types/SavedFormEmbed.js +4 -0
- package/dist/cjs/serialization/types/SavedFormEmbedRecommendedSnippet.d.ts +7 -0
- package/dist/cjs/serialization/types/SavedFormEmbedRecommendedSnippet.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 +7 -0
- package/dist/cjs/serialization/types/index.js +7 -0
- package/dist/esm/api/resources/analytics/client/Client.js +14 -2
- package/dist/esm/api/resources/analytics/client/requests/GetMetricsBreakdownRequest.d.ts +2 -0
- package/dist/esm/api/resources/analytics/client/requests/GetMetricsRequest.d.ts +2 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestOutcome.d.ts +7 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownRequestOutcome.js +7 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +1 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsRequestOutcome.d.ts +7 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsRequestOutcome.js +7 -0
- package/dist/esm/api/resources/analytics/types/GetMetricsResponse.d.ts +2 -0
- package/dist/esm/api/resources/analytics/types/index.d.ts +2 -0
- package/dist/esm/api/resources/analytics/types/index.js +2 -0
- package/dist/esm/api/resources/companies/client/requests/UpdateCompaniesRequest.d.ts +2 -0
- package/dist/esm/api/resources/companies/types/UpdateCompaniesRequestEmailTheme.d.ts +1 -1
- package/dist/esm/api/resources/companies/types/UpdateCompaniesRequestEmailThemeLayout.d.ts +5 -1
- package/dist/esm/api/resources/companies/types/UpdateCompaniesRequestEmailThemeLayoutContentAlign.d.ts +6 -0
- package/dist/esm/api/resources/companies/types/UpdateCompaniesRequestEmailThemeLayoutContentAlign.js +6 -0
- package/dist/esm/api/resources/companies/types/index.d.ts +1 -0
- package/dist/esm/api/resources/companies/types/index.js +1 -0
- package/dist/esm/api/resources/subscribers/resources/events/types/TriggerBulkEventsResponseOptIn.d.ts +1 -0
- package/dist/esm/api/resources/subscribers/resources/events/types/TriggerEventsResponseOptIn.d.ts +1 -0
- package/dist/esm/api/resources/subscribers/resources/tags/types/AddTagsResponseOptIn.d.ts +1 -0
- package/dist/esm/api/resources/subscribers/types/AddTagsBulkResponseOptIn.d.ts +1 -0
- package/dist/esm/api/resources/subscribers/types/CreateSubscribersResponseOptIn.d.ts +1 -0
- package/dist/esm/api/resources/trackingDomain/client/Client.d.ts +1 -1
- package/dist/esm/api/resources/trackingDomain/client/Client.js +1 -1
- package/dist/esm/api/types/Company.d.ts +4 -0
- package/dist/esm/api/types/CompanyDarkModeLogoStatus.d.ts +8 -0
- package/dist/esm/api/types/CompanyDarkModeLogoStatus.js +8 -0
- package/dist/esm/api/types/EmailAiStyleCanvas.d.ts +1 -1
- package/dist/esm/api/types/EmailAiStyleCanvasTheme.d.ts +2 -2
- package/dist/esm/api/types/EmailAiStyleCanvasThemeLayout.d.ts +4 -0
- package/dist/esm/api/types/EmailAiStyleCanvasThemeLayout.js +2 -0
- package/dist/esm/api/types/EmailAiStyleCanvasThemeLayoutContentAlign.d.ts +5 -0
- package/dist/esm/api/types/EmailAiStyleCanvasThemeLayoutContentAlign.js +5 -0
- package/dist/esm/api/types/EmailBlockStyles.d.ts +2 -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/EmailThemePatchLayout.d.ts +3 -0
- package/dist/esm/api/types/EmailThemePatchLayoutContentAlign.d.ts +6 -0
- package/dist/esm/api/types/EmailThemePatchLayoutContentAlign.js +6 -0
- package/dist/esm/api/types/SavedFormEmbed.d.ts +10 -3
- package/dist/esm/api/types/SavedFormEmbedRecommendedSnippet.d.ts +5 -0
- package/dist/esm/api/types/SavedFormEmbedRecommendedSnippet.js +5 -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 +7 -0
- package/dist/esm/api/types/index.js +7 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestOutcome.d.ts +7 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownRequestOutcome.js +3 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponse.d.ts +1 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsBreakdownResponse.js +1 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsRequestOutcome.d.ts +7 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsRequestOutcome.js +3 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsResponse.d.ts +1 -0
- package/dist/esm/serialization/resources/analytics/types/GetMetricsResponse.js +1 -0
- package/dist/esm/serialization/resources/analytics/types/index.d.ts +2 -0
- package/dist/esm/serialization/resources/analytics/types/index.js +2 -0
- package/dist/esm/serialization/resources/companies/client/requests/UpdateCompaniesRequest.d.ts +1 -0
- package/dist/esm/serialization/resources/companies/client/requests/UpdateCompaniesRequest.js +1 -0
- package/dist/esm/serialization/resources/companies/types/UpdateCompaniesRequestEmailThemeLayout.d.ts +3 -0
- package/dist/esm/serialization/resources/companies/types/UpdateCompaniesRequestEmailThemeLayout.js +3 -0
- package/dist/esm/serialization/resources/companies/types/UpdateCompaniesRequestEmailThemeLayoutContentAlign.d.ts +7 -0
- package/dist/esm/serialization/resources/companies/types/UpdateCompaniesRequestEmailThemeLayoutContentAlign.js +3 -0
- package/dist/esm/serialization/resources/companies/types/index.d.ts +1 -0
- package/dist/esm/serialization/resources/companies/types/index.js +1 -0
- package/dist/esm/serialization/types/Company.d.ts +3 -0
- package/dist/esm/serialization/types/Company.js +3 -0
- package/dist/esm/serialization/types/CompanyDarkModeLogoStatus.d.ts +7 -0
- package/dist/esm/serialization/types/CompanyDarkModeLogoStatus.js +3 -0
- package/dist/esm/serialization/types/EmailAiStyleCanvasTheme.d.ts +2 -1
- package/dist/esm/serialization/types/EmailAiStyleCanvasTheme.js +2 -1
- package/dist/esm/serialization/types/EmailAiStyleCanvasThemeLayout.d.ts +10 -0
- package/dist/esm/serialization/types/EmailAiStyleCanvasThemeLayout.js +6 -0
- package/dist/esm/serialization/types/EmailAiStyleCanvasThemeLayoutContentAlign.d.ts +7 -0
- package/dist/esm/serialization/types/EmailAiStyleCanvasThemeLayoutContentAlign.js +3 -0
- package/dist/esm/serialization/types/EmailBlockStyles.d.ts +1 -0
- package/dist/esm/serialization/types/EmailBlockStyles.js +1 -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/EmailThemePatchLayout.d.ts +2 -0
- package/dist/esm/serialization/types/EmailThemePatchLayout.js +2 -0
- package/dist/esm/serialization/types/EmailThemePatchLayoutContentAlign.d.ts +7 -0
- package/dist/esm/serialization/types/EmailThemePatchLayoutContentAlign.js +3 -0
- package/dist/esm/serialization/types/SavedFormEmbed.d.ts +4 -0
- package/dist/esm/serialization/types/SavedFormEmbed.js +4 -0
- package/dist/esm/serialization/types/SavedFormEmbedRecommendedSnippet.d.ts +7 -0
- package/dist/esm/serialization/types/SavedFormEmbedRecommendedSnippet.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 +7 -0
- package/dist/esm/serialization/types/index.js +7 -0
- package/package.json +1 -1
|
@@ -485,7 +485,7 @@ class AnalyticsClient {
|
|
|
485
485
|
return core.HttpResponsePromise.fromPromise(this.__getMetrics(request, requestOptions));
|
|
486
486
|
}
|
|
487
487
|
async __getMetrics(request = {}, requestOptions) {
|
|
488
|
-
const { emailType, end, includeMachineEngagement, mailboxProvider, period, recipientDomain, source, start } = request;
|
|
488
|
+
const { emailType, end, includeMachineEngagement, mailboxProvider, outcome, period, recipientDomain, source, start, } = request;
|
|
489
489
|
const _queryParams = {
|
|
490
490
|
emailType: emailType != null
|
|
491
491
|
? serializers.GetMetricsRequestEmailType.jsonOrThrow(emailType, {
|
|
@@ -496,6 +496,12 @@ class AnalyticsClient {
|
|
|
496
496
|
end: end != null ? end?.toISOString() : undefined,
|
|
497
497
|
includeMachineEngagement,
|
|
498
498
|
mailboxProvider,
|
|
499
|
+
outcome: outcome != null
|
|
500
|
+
? serializers.GetMetricsRequestOutcome.jsonOrThrow(outcome, {
|
|
501
|
+
unrecognizedObjectKeys: "strip",
|
|
502
|
+
omitUndefined: true,
|
|
503
|
+
})
|
|
504
|
+
: undefined,
|
|
499
505
|
period: period != null
|
|
500
506
|
? serializers.GetMetricsRequestPeriod.jsonOrThrow(period, {
|
|
501
507
|
unrecognizedObjectKeys: "strip",
|
|
@@ -578,7 +584,7 @@ class AnalyticsClient {
|
|
|
578
584
|
return core.HttpResponsePromise.fromPromise(this.__getMetricsBreakdown(request, requestOptions));
|
|
579
585
|
}
|
|
580
586
|
async __getMetricsBreakdown(request = {}, requestOptions) {
|
|
581
|
-
const { by, emailType, end, includeMachineEngagement, limit, mailboxProvider, period, recipientDomain, source, start, } = request;
|
|
587
|
+
const { by, emailType, end, includeMachineEngagement, limit, mailboxProvider, outcome, period, recipientDomain, source, start, } = request;
|
|
582
588
|
const _queryParams = {
|
|
583
589
|
by: by != null
|
|
584
590
|
? serializers.GetMetricsBreakdownRequestBy.jsonOrThrow(by, {
|
|
@@ -596,6 +602,12 @@ class AnalyticsClient {
|
|
|
596
602
|
includeMachineEngagement,
|
|
597
603
|
limit,
|
|
598
604
|
mailboxProvider,
|
|
605
|
+
outcome: outcome != null
|
|
606
|
+
? serializers.GetMetricsBreakdownRequestOutcome.jsonOrThrow(outcome, {
|
|
607
|
+
unrecognizedObjectKeys: "strip",
|
|
608
|
+
omitUndefined: true,
|
|
609
|
+
})
|
|
610
|
+
: undefined,
|
|
599
611
|
period: period != null
|
|
600
612
|
? serializers.GetMetricsBreakdownRequestPeriod.jsonOrThrow(period, {
|
|
601
613
|
unrecognizedObjectKeys: "strip",
|
|
@@ -16,6 +16,8 @@ export interface GetMetricsBreakdownRequest {
|
|
|
16
16
|
limit?: number;
|
|
17
17
|
/** Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). */
|
|
18
18
|
mailboxProvider?: string;
|
|
19
|
+
/** Only sends that had this outcome: a permanent bounce, a temporary bounce, a blocked bounce (the receiver refused it over content, policy or reputation) or a spam complaint. Matches the dashboard's Sender Quality cards. Filtered responses report replies as 0 and omit the commerce forecast. */
|
|
20
|
+
outcome?: Sequenzy.GetMetricsBreakdownRequestOutcome;
|
|
19
21
|
/** Sliding window over send times. Ignored when start/end are provided. */
|
|
20
22
|
period?: Sequenzy.GetMetricsBreakdownRequestPeriod;
|
|
21
23
|
/** Recipient domain filter (e.g. gmail.com). Case-insensitive. */
|
|
@@ -12,6 +12,8 @@ export interface GetMetricsRequest {
|
|
|
12
12
|
includeMachineEngagement?: boolean;
|
|
13
13
|
/** Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). Scopes engagement metrics to recipients of that provider. Provider-filtered responses report replies as 0 (replies cannot be segmented per provider) and omit the commerce forecast. */
|
|
14
14
|
mailboxProvider?: string;
|
|
15
|
+
/** Only sends that had this outcome: a permanent bounce, a temporary bounce, a blocked bounce (the receiver refused it over content, policy or reputation) or a spam complaint. Matches the dashboard's Sender Quality cards. Filtered responses report replies as 0 and omit the commerce forecast. */
|
|
16
|
+
outcome?: Sequenzy.GetMetricsRequestOutcome;
|
|
15
17
|
/** Sliding time window. Ignored when start/end are provided. */
|
|
16
18
|
period?: Sequenzy.GetMetricsRequestPeriod;
|
|
17
19
|
/** Recipient domain filter (e.g. gmail.com). Case-insensitive. */
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export declare const GetMetricsBreakdownRequestOutcome: {
|
|
2
|
+
readonly PermanentBounce: "permanent_bounce";
|
|
3
|
+
readonly TemporaryBounce: "temporary_bounce";
|
|
4
|
+
readonly Blocked: "blocked";
|
|
5
|
+
readonly Complaint: "complaint";
|
|
6
|
+
};
|
|
7
|
+
export type GetMetricsBreakdownRequestOutcome = (typeof GetMetricsBreakdownRequestOutcome)[keyof typeof GetMetricsBreakdownRequestOutcome];
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.GetMetricsBreakdownRequestOutcome = void 0;
|
|
5
|
+
exports.GetMetricsBreakdownRequestOutcome = {
|
|
6
|
+
PermanentBounce: "permanent_bounce",
|
|
7
|
+
TemporaryBounce: "temporary_bounce",
|
|
8
|
+
Blocked: "blocked",
|
|
9
|
+
Complaint: "complaint",
|
|
10
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export declare const GetMetricsRequestOutcome: {
|
|
2
|
+
readonly PermanentBounce: "permanent_bounce";
|
|
3
|
+
readonly TemporaryBounce: "temporary_bounce";
|
|
4
|
+
readonly Blocked: "blocked";
|
|
5
|
+
readonly Complaint: "complaint";
|
|
6
|
+
};
|
|
7
|
+
export type GetMetricsRequestOutcome = (typeof GetMetricsRequestOutcome)[keyof typeof GetMetricsRequestOutcome];
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.GetMetricsRequestOutcome = void 0;
|
|
5
|
+
exports.GetMetricsRequestOutcome = {
|
|
6
|
+
PermanentBounce: "permanent_bounce",
|
|
7
|
+
TemporaryBounce: "temporary_bounce",
|
|
8
|
+
Blocked: "blocked",
|
|
9
|
+
Complaint: "complaint",
|
|
10
|
+
};
|
|
@@ -7,6 +7,8 @@ export interface GetMetricsResponse {
|
|
|
7
7
|
emailType?: Sequenzy.GetMetricsResponseEmailType;
|
|
8
8
|
/** Echoed back when `mailboxProvider` is provided. */
|
|
9
9
|
mailboxProvider?: string;
|
|
10
|
+
/** Echoed back when `outcome` is provided. */
|
|
11
|
+
outcome?: string;
|
|
10
12
|
period?: string;
|
|
11
13
|
/** Echoed back, lowercased, when `recipientDomain` is provided. */
|
|
12
14
|
recipientDomain?: string;
|
|
@@ -13,10 +13,12 @@ export * from "./GetLinkClickMetricsResponse.js";
|
|
|
13
13
|
export * from "./GetLinkClickMetricsResponseEmailType.js";
|
|
14
14
|
export * from "./GetMetricsBreakdownRequestBy.js";
|
|
15
15
|
export * from "./GetMetricsBreakdownRequestEmailType.js";
|
|
16
|
+
export * from "./GetMetricsBreakdownRequestOutcome.js";
|
|
16
17
|
export * from "./GetMetricsBreakdownRequestPeriod.js";
|
|
17
18
|
export * from "./GetMetricsBreakdownResponse.js";
|
|
18
19
|
export * from "./GetMetricsBreakdownResponseRowsItem.js";
|
|
19
20
|
export * from "./GetMetricsRequestEmailType.js";
|
|
21
|
+
export * from "./GetMetricsRequestOutcome.js";
|
|
20
22
|
export * from "./GetMetricsRequestPeriod.js";
|
|
21
23
|
export * from "./GetMetricsResponse.js";
|
|
22
24
|
export * from "./GetMetricsResponseEmailType.js";
|
|
@@ -29,10 +29,12 @@ __exportStar(require("./GetLinkClickMetricsResponse.js"), exports);
|
|
|
29
29
|
__exportStar(require("./GetLinkClickMetricsResponseEmailType.js"), exports);
|
|
30
30
|
__exportStar(require("./GetMetricsBreakdownRequestBy.js"), exports);
|
|
31
31
|
__exportStar(require("./GetMetricsBreakdownRequestEmailType.js"), exports);
|
|
32
|
+
__exportStar(require("./GetMetricsBreakdownRequestOutcome.js"), exports);
|
|
32
33
|
__exportStar(require("./GetMetricsBreakdownRequestPeriod.js"), exports);
|
|
33
34
|
__exportStar(require("./GetMetricsBreakdownResponse.js"), exports);
|
|
34
35
|
__exportStar(require("./GetMetricsBreakdownResponseRowsItem.js"), exports);
|
|
35
36
|
__exportStar(require("./GetMetricsRequestEmailType.js"), exports);
|
|
37
|
+
__exportStar(require("./GetMetricsRequestOutcome.js"), exports);
|
|
36
38
|
__exportStar(require("./GetMetricsRequestPeriod.js"), exports);
|
|
37
39
|
__exportStar(require("./GetMetricsResponse.js"), exports);
|
|
38
40
|
__exportStar(require("./GetMetricsResponseEmailType.js"), exports);
|
|
@@ -11,6 +11,8 @@ export interface UpdateCompaniesRequest {
|
|
|
11
11
|
address?: string | null;
|
|
12
12
|
brandColors?: Record<string, unknown> | null;
|
|
13
13
|
companyContext?: string | null;
|
|
14
|
+
/** Your own dark-mode version of the logo. Every email uses it instead of the automatic outlined copy, in light and dark inboxes, so it must read on both. Requires a logo (here or already saved); changing the logo later drops it. Send null to go back to the automatic one. */
|
|
15
|
+
darkModeLogoUrl?: string | null;
|
|
14
16
|
/** Which lists new contacts join when something creates a subscriber without explicit list targeting - forms, API writes, events, tag actions, imports, and any integration without its own list targeting. null means every current and future list, [] means no list at all, and an array means exactly those lists. Unknown or foreign list IDs are rejected rather than skipped. Applies only to later writes; nobody is moved or removed retroactively. Requires the companies:manage scope. */
|
|
15
17
|
defaultSubscriberListIds?: string[] | null;
|
|
16
18
|
description?: string | null;
|
|
@@ -7,7 +7,7 @@ export interface UpdateCompaniesRequestEmailTheme {
|
|
|
7
7
|
buttonStyle?: Sequenzy.UpdateCompaniesRequestEmailThemeButtonStyle;
|
|
8
8
|
/** 6-digit hex values. */
|
|
9
9
|
colors?: Sequenzy.UpdateCompaniesRequestEmailThemeColors;
|
|
10
|
-
/**
|
|
10
|
+
/** Layout settings. Every field is a number except contentAlign. */
|
|
11
11
|
layout?: Sequenzy.UpdateCompaniesRequestEmailThemeLayout;
|
|
12
12
|
presetId?: Sequenzy.UpdateCompaniesRequestEmailThemePresetId;
|
|
13
13
|
/** Numeric type settings. */
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../../index.js";
|
|
1
2
|
/**
|
|
2
|
-
*
|
|
3
|
+
* Layout settings. Every field is a number except contentAlign.
|
|
3
4
|
*/
|
|
4
5
|
export interface UpdateCompaniesRequestEmailThemeLayout {
|
|
5
6
|
baseRadius?: number;
|
|
@@ -7,8 +8,11 @@ export interface UpdateCompaniesRequestEmailThemeLayout {
|
|
|
7
8
|
borderedBlockPadding?: number;
|
|
8
9
|
buttonPaddingX?: number;
|
|
9
10
|
buttonPaddingY?: number;
|
|
11
|
+
buttonRadius?: number;
|
|
10
12
|
containerPaddingX?: number;
|
|
11
13
|
containerPaddingY?: number;
|
|
14
|
+
/** Where the content column sits in a wide email client. center (default) or left (flush left, like a plain personal email). With left, buttons, the logo and footers line up on the left too unless set to right, or centered with styles.keepAlign. Phones show the column full width either way. */
|
|
15
|
+
contentAlign?: Sequenzy.UpdateCompaniesRequestEmailThemeLayoutContentAlign;
|
|
12
16
|
contentWidth?: number;
|
|
13
17
|
sectionPadding?: number;
|
|
14
18
|
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/** Where the content column sits in a wide email client. center (default) or left (flush left, like a plain personal email). With left, buttons, the logo and footers line up on the left too unless set to right, or centered with styles.keepAlign. Phones show the column full width either way. */
|
|
2
|
+
export declare const UpdateCompaniesRequestEmailThemeLayoutContentAlign: {
|
|
3
|
+
readonly Center: "center";
|
|
4
|
+
readonly Left: "left";
|
|
5
|
+
};
|
|
6
|
+
export type UpdateCompaniesRequestEmailThemeLayoutContentAlign = (typeof UpdateCompaniesRequestEmailThemeLayoutContentAlign)[keyof typeof UpdateCompaniesRequestEmailThemeLayoutContentAlign];
|
package/dist/cjs/api/resources/companies/types/UpdateCompaniesRequestEmailThemeLayoutContentAlign.js
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.UpdateCompaniesRequestEmailThemeLayoutContentAlign = void 0;
|
|
5
|
+
/** Where the content column sits in a wide email client. center (default) or left (flush left, like a plain personal email). With left, buttons, the logo and footers line up on the left too unless set to right, or centered with styles.keepAlign. Phones show the column full width either way. */
|
|
6
|
+
exports.UpdateCompaniesRequestEmailThemeLayoutContentAlign = {
|
|
7
|
+
Center: "center",
|
|
8
|
+
Left: "left",
|
|
9
|
+
};
|
|
@@ -10,6 +10,7 @@ export * from "./UpdateCompaniesRequestEmailTheme.js";
|
|
|
10
10
|
export * from "./UpdateCompaniesRequestEmailThemeButtonStyle.js";
|
|
11
11
|
export * from "./UpdateCompaniesRequestEmailThemeColors.js";
|
|
12
12
|
export * from "./UpdateCompaniesRequestEmailThemeLayout.js";
|
|
13
|
+
export * from "./UpdateCompaniesRequestEmailThemeLayoutContentAlign.js";
|
|
13
14
|
export * from "./UpdateCompaniesRequestEmailThemePresetId.js";
|
|
14
15
|
export * from "./UpdateCompaniesRequestEmailThemeTypography.js";
|
|
15
16
|
export * from "./UpdateCompaniesRequestFooterStyle.js";
|
|
@@ -26,6 +26,7 @@ __exportStar(require("./UpdateCompaniesRequestEmailTheme.js"), exports);
|
|
|
26
26
|
__exportStar(require("./UpdateCompaniesRequestEmailThemeButtonStyle.js"), exports);
|
|
27
27
|
__exportStar(require("./UpdateCompaniesRequestEmailThemeColors.js"), exports);
|
|
28
28
|
__exportStar(require("./UpdateCompaniesRequestEmailThemeLayout.js"), exports);
|
|
29
|
+
__exportStar(require("./UpdateCompaniesRequestEmailThemeLayoutContentAlign.js"), exports);
|
|
29
30
|
__exportStar(require("./UpdateCompaniesRequestEmailThemePresetId.js"), exports);
|
|
30
31
|
__exportStar(require("./UpdateCompaniesRequestEmailThemeTypography.js"), exports);
|
|
31
32
|
__exportStar(require("./UpdateCompaniesRequestFooterStyle.js"), exports);
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
* Present when this request created a brand-new subscriber while workspace double opt-in is enabled. The subscriber stays pending and matching sequences wait until they confirm.
|
|
3
3
|
*/
|
|
4
4
|
export interface TriggerBulkEventsResponseOptIn {
|
|
5
|
+
/** False when no confirmation email was queued because the last one went out less than 24 hours ago, the contact already got three, or it unsubscribed or complained. The latest link keeps working. */
|
|
5
6
|
emailQueued?: boolean;
|
|
6
7
|
required?: boolean;
|
|
7
8
|
}
|
package/dist/cjs/api/resources/subscribers/resources/events/types/TriggerEventsResponseOptIn.d.ts
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
* Present when this event created a brand-new subscriber while workspace double opt-in is enabled. The subscriber stays pending and matching sequences wait until they confirm.
|
|
3
3
|
*/
|
|
4
4
|
export interface TriggerEventsResponseOptIn {
|
|
5
|
+
/** False when no confirmation email was queued because the last one went out less than 24 hours ago, the contact already got three, or it unsubscribed or complained. The latest link keeps working. */
|
|
5
6
|
emailQueued?: boolean;
|
|
6
7
|
required?: boolean;
|
|
7
8
|
}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
* Present when this request created a brand-new subscriber while workspace double opt-in is enabled. The tag is applied, but the subscriber stays pending and tag automations wait until they confirm.
|
|
3
3
|
*/
|
|
4
4
|
export interface AddTagsResponseOptIn {
|
|
5
|
+
/** False when no confirmation email was queued because the last one went out less than 24 hours ago, the contact already got three, or it unsubscribed or complained. The latest link keeps working. */
|
|
5
6
|
emailQueued?: boolean;
|
|
6
7
|
required?: boolean;
|
|
7
8
|
}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
* Present when this request created a brand-new subscriber while workspace double opt-in is enabled. The tags are applied, but the subscriber stays pending and tag automations wait until they confirm.
|
|
3
3
|
*/
|
|
4
4
|
export interface AddTagsBulkResponseOptIn {
|
|
5
|
+
/** False when no confirmation email was queued because the last one went out less than 24 hours ago, the contact already got three, or it unsubscribed or complained. The latest link keeps working. */
|
|
5
6
|
emailQueued?: boolean;
|
|
6
7
|
required?: boolean;
|
|
7
8
|
}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
* Present when the subscriber is awaiting double opt-in confirmation.
|
|
3
3
|
*/
|
|
4
4
|
export interface CreateSubscribersResponseOptIn {
|
|
5
|
+
/** False when no confirmation email was queued because the last one went out less than 24 hours ago, the contact already got three, or it unsubscribed or complained. The latest link keeps working. */
|
|
5
6
|
emailQueued?: boolean;
|
|
6
7
|
required?: boolean;
|
|
7
8
|
}
|
|
@@ -27,7 +27,7 @@ export declare class TrackingDomainClient {
|
|
|
27
27
|
getTrackingDomain(requestOptions?: TrackingDomainClient.RequestOptions): core.HttpResponsePromise<Sequenzy.GetTrackingDomainResponse>;
|
|
28
28
|
private __getTrackingDomain;
|
|
29
29
|
/**
|
|
30
|
-
* Removes the company tracking domain. New emails use the shared Sequenzy tracking domain, and links in emails already sent through the removed domain stop working. Removing when none is set succeeds with removed false. Requires the companies:manage scope plus owner or admin access.
|
|
30
|
+
* Removes the company tracking domain. New emails use the shared Sequenzy tracking domain, and links and images in emails already sent through the removed domain stop working. Removing when none is set succeeds with removed false. Requires the companies:manage scope plus owner or admin access.
|
|
31
31
|
*
|
|
32
32
|
* @param {TrackingDomainClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
33
33
|
*
|
|
@@ -102,7 +102,7 @@ class TrackingDomainClient {
|
|
|
102
102
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/tracking-domain");
|
|
103
103
|
}
|
|
104
104
|
/**
|
|
105
|
-
* Removes the company tracking domain. New emails use the shared Sequenzy tracking domain, and links in emails already sent through the removed domain stop working. Removing when none is set succeeds with removed false. Requires the companies:manage scope plus owner or admin access.
|
|
105
|
+
* Removes the company tracking domain. New emails use the shared Sequenzy tracking domain, and links and images in emails already sent through the removed domain stop working. Removing when none is set succeeds with removed false. Requires the companies:manage scope plus owner or admin access.
|
|
106
106
|
*
|
|
107
107
|
* @param {TrackingDomainClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
108
108
|
*
|
|
@@ -4,6 +4,10 @@ export interface Company {
|
|
|
4
4
|
brandColors?: Record<string, unknown> | null;
|
|
5
5
|
companyContext?: string | null;
|
|
6
6
|
createdAt?: Date;
|
|
7
|
+
/** Read-only. How the logo is handled in dark-mode inboxes. `outlined` and `custom` emails use darkModeLogoUrl (`custom` is one you uploaded); `pending` is checked within about 10 minutes; null without a logo. */
|
|
8
|
+
darkModeLogoStatus?: Sequenzy.CompanyDarkModeLogoStatus | null;
|
|
9
|
+
/** The logo emails use instead of logoUrl when darkModeLogoStatus is `outlined` (automatic, with a thin white outline) or `custom` (uploaded, set via PATCH), otherwise null. */
|
|
10
|
+
darkModeLogoUrl?: string | null;
|
|
7
11
|
defaultFromEmail?: string | null;
|
|
8
12
|
defaultFromName?: string | null;
|
|
9
13
|
defaultReplyProfileId?: string | null;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/** Read-only. How the logo is handled in dark-mode inboxes. `outlined` and `custom` emails use darkModeLogoUrl (`custom` is one you uploaded); `pending` is checked within about 10 minutes; null without a logo. */
|
|
2
|
+
export declare const CompanyDarkModeLogoStatus: {
|
|
3
|
+
readonly Pending: "pending";
|
|
4
|
+
readonly Outlined: "outlined";
|
|
5
|
+
readonly NotNeeded: "not_needed";
|
|
6
|
+
readonly Custom: "custom";
|
|
7
|
+
};
|
|
8
|
+
export type CompanyDarkModeLogoStatus = (typeof CompanyDarkModeLogoStatus)[keyof typeof CompanyDarkModeLogoStatus];
|
|
@@ -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.CompanyDarkModeLogoStatus = void 0;
|
|
5
|
+
/** Read-only. How the logo is handled in dark-mode inboxes. `outlined` and `custom` emails use darkModeLogoUrl (`custom` is one you uploaded); `pending` is checked within about 10 minutes; null without a logo. */
|
|
6
|
+
exports.CompanyDarkModeLogoStatus = {
|
|
7
|
+
Pending: "pending",
|
|
8
|
+
Outlined: "outlined",
|
|
9
|
+
NotNeeded: "not_needed",
|
|
10
|
+
Custom: "custom",
|
|
11
|
+
};
|
|
@@ -4,6 +4,6 @@ export interface EmailAiStyleCanvas {
|
|
|
4
4
|
blocks: Record<string, unknown>[];
|
|
5
5
|
emailPreset: Sequenzy.EmailAiStyleCanvasEmailPreset;
|
|
6
6
|
fontFamily: string;
|
|
7
|
-
/** Complete editor theme. Required color keys are primary, background, surface, text, mutedText, heading, border and link. Required typography keys are baseFontSize, leadFontSize, baseLineHeight, heading1Size, heading2Size, heading3Size and buttonFontSize. Required layout keys are contentWidth, containerPaddingX, containerPaddingY, blockSpacing, baseRadius, sectionPadding, buttonPaddingX, buttonPaddingY and borderedBlockPadding. Optional theme fields match the editor, including content color, heading font, button radius and weight. */
|
|
7
|
+
/** Complete editor theme. Required color keys are primary, background, surface, text, mutedText, heading, border and link. Required typography keys are baseFontSize, leadFontSize, baseLineHeight, heading1Size, heading2Size, heading3Size and buttonFontSize. Required layout keys are contentWidth, containerPaddingX, containerPaddingY, blockSpacing, baseRadius, sectionPadding, buttonPaddingX, buttonPaddingY and borderedBlockPadding. Optional theme fields match the editor, including content color, heading font, button radius and weight, and layout.contentAlign (center or left). */
|
|
8
8
|
theme: Sequenzy.EmailAiStyleCanvasTheme;
|
|
9
9
|
}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import type * as Sequenzy from "../index.js";
|
|
2
2
|
/**
|
|
3
|
-
* Complete editor theme. Required color keys are primary, background, surface, text, mutedText, heading, border and link. Required typography keys are baseFontSize, leadFontSize, baseLineHeight, heading1Size, heading2Size, heading3Size and buttonFontSize. Required layout keys are contentWidth, containerPaddingX, containerPaddingY, blockSpacing, baseRadius, sectionPadding, buttonPaddingX, buttonPaddingY and borderedBlockPadding. Optional theme fields match the editor, including content color, heading font, button radius and weight.
|
|
3
|
+
* Complete editor theme. Required color keys are primary, background, surface, text, mutedText, heading, border and link. Required typography keys are baseFontSize, leadFontSize, baseLineHeight, heading1Size, heading2Size, heading3Size and buttonFontSize. Required layout keys are contentWidth, containerPaddingX, containerPaddingY, blockSpacing, baseRadius, sectionPadding, buttonPaddingX, buttonPaddingY and borderedBlockPadding. Optional theme fields match the editor, including content color, heading font, button radius and weight, and layout.contentAlign (center or left).
|
|
4
4
|
*/
|
|
5
5
|
export interface EmailAiStyleCanvasTheme {
|
|
6
6
|
colors: Record<string, string>;
|
|
7
|
-
layout:
|
|
7
|
+
layout: Sequenzy.EmailAiStyleCanvasThemeLayout;
|
|
8
8
|
presetId: Sequenzy.EmailAiStyleCanvasThemePresetId;
|
|
9
9
|
typography: Record<string, unknown>;
|
|
10
10
|
/** Accepts any additional properties */
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export declare const EmailAiStyleCanvasThemeLayoutContentAlign: {
|
|
2
|
+
readonly Center: "center";
|
|
3
|
+
readonly Left: "left";
|
|
4
|
+
};
|
|
5
|
+
export type EmailAiStyleCanvasThemeLayoutContentAlign = (typeof EmailAiStyleCanvasThemeLayoutContentAlign)[keyof typeof EmailAiStyleCanvasThemeLayoutContentAlign];
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.EmailAiStyleCanvasThemeLayoutContentAlign = void 0;
|
|
5
|
+
exports.EmailAiStyleCanvasThemeLayoutContentAlign = {
|
|
6
|
+
Center: "center",
|
|
7
|
+
Left: "left",
|
|
8
|
+
};
|
|
@@ -11,6 +11,8 @@ export interface EmailBlockStyles {
|
|
|
11
11
|
borderColor?: string;
|
|
12
12
|
borderRadius?: number;
|
|
13
13
|
borderWidth?: number;
|
|
14
|
+
/** Keep a centered button, logo or footer centered when the email is left-aligned (layout.contentAlign left). Without it a left email moves these blocks left; right always stays. */
|
|
15
|
+
keepAlign?: boolean;
|
|
14
16
|
paddingBottom?: number;
|
|
15
17
|
paddingLeft?: number;
|
|
16
18
|
paddingRight?: number;
|
|
@@ -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
|
|
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";
|
|
@@ -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
|
|
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
|
+
};
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as Sequenzy from "../index.js";
|
|
1
2
|
export interface EmailThemePatchLayout {
|
|
2
3
|
baseRadius?: number;
|
|
3
4
|
blockSpacing?: number;
|
|
@@ -7,6 +8,8 @@ export interface EmailThemePatchLayout {
|
|
|
7
8
|
buttonRadius?: number;
|
|
8
9
|
containerPaddingX?: number;
|
|
9
10
|
containerPaddingY?: number;
|
|
11
|
+
/** Where the content column sits in a wide email client. center (default) or left (flush left, like a plain personal email). With left, buttons, the logo and footers line up on the left too unless set to right, or centered with styles.keepAlign. Phones show the column full width either way. */
|
|
12
|
+
contentAlign?: Sequenzy.EmailThemePatchLayoutContentAlign;
|
|
10
13
|
contentWidth?: number;
|
|
11
14
|
sectionPadding?: number;
|
|
12
15
|
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/** Where the content column sits in a wide email client. center (default) or left (flush left, like a plain personal email). With left, buttons, the logo and footers line up on the left too unless set to right, or centered with styles.keepAlign. Phones show the column full width either way. */
|
|
2
|
+
export declare const EmailThemePatchLayoutContentAlign: {
|
|
3
|
+
readonly Center: "center";
|
|
4
|
+
readonly Left: "left";
|
|
5
|
+
};
|
|
6
|
+
export type EmailThemePatchLayoutContentAlign = (typeof EmailThemePatchLayoutContentAlign)[keyof typeof EmailThemePatchLayoutContentAlign];
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.EmailThemePatchLayoutContentAlign = void 0;
|
|
5
|
+
/** Where the content column sits in a wide email client. center (default) or left (flush left, like a plain personal email). With left, buttons, the logo and footers line up on the left too unless set to right, or centered with styles.keepAlign. Phones show the column full width either way. */
|
|
6
|
+
exports.EmailThemePatchLayoutContentAlign = {
|
|
7
|
+
Center: "center",
|
|
8
|
+
Left: "left",
|
|
9
|
+
};
|
|
@@ -1,11 +1,18 @@
|
|
|
1
|
+
import type * as Sequenzy from "../index.js";
|
|
1
2
|
export interface SavedFormEmbed {
|
|
2
3
|
actionUrl: string;
|
|
3
|
-
/** Fetch-enhanced embed markup. */
|
|
4
|
+
/** Fetch-enhanced embed markup. Has weaker spam protection; use only on pages that cannot run scripts. */
|
|
4
5
|
fetch: string;
|
|
5
|
-
/** Hosted JavaScript embed markup. */
|
|
6
|
+
/** Hosted JavaScript embed markup. The recommended install, and the only one that carries Sequenzy's spam protection (signed submit token and, with bot protection on, the bot check). The form appears right after the script tag, unless the page has a placeholder for it. */
|
|
6
7
|
javascript: string;
|
|
7
|
-
/** Native HTML form embed markup. */
|
|
8
|
+
/** Native HTML form embed markup. Has weaker spam protection; use only on pages that cannot run scripts. */
|
|
8
9
|
nativeForm: string;
|
|
10
|
+
/** Optional placeholder for the javascript embed, such as `<div data-sequenzy-form="form_123"></div>`. Put it where the form should appear when the script has to load elsewhere (the page head, a tag manager or a site-wide footer); the script fills it. Each script tag fills one placeholder. */
|
|
11
|
+
placeholder?: string;
|
|
12
|
+
/** The snippet to install unless the page cannot run scripts. */
|
|
13
|
+
recommendedSnippet?: Sequenzy.SavedFormEmbedRecommendedSnippet;
|
|
14
|
+
/** What changes when nativeForm or fetch is used instead of javascript, worded for the form's current bot protection setting. Show it to the person installing the form. */
|
|
15
|
+
reducedProtectionWarning?: string;
|
|
9
16
|
scriptUrl: string;
|
|
10
17
|
supportedPlatforms: string[];
|
|
11
18
|
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
/** The snippet to install unless the page cannot run scripts. */
|
|
2
|
+
export declare const SavedFormEmbedRecommendedSnippet: {
|
|
3
|
+
readonly Javascript: "javascript";
|
|
4
|
+
};
|
|
5
|
+
export type SavedFormEmbedRecommendedSnippet = (typeof SavedFormEmbedRecommendedSnippet)[keyof typeof SavedFormEmbedRecommendedSnippet];
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.SavedFormEmbedRecommendedSnippet = void 0;
|
|
5
|
+
/** The snippet to install unless the page cannot run scripts. */
|
|
6
|
+
exports.SavedFormEmbedRecommendedSnippet = {
|
|
7
|
+
Javascript: "javascript",
|
|
8
|
+
};
|