sequenzy 2.1.34 → 2.1.36
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/websites/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/websites/client/Client.js +1 -1
- package/dist/cjs/api/resources/websites/client/requests/AddWebsitesRequest.d.ts +1 -1
- package/dist/cjs/api/types/AccountHealthActionKind.d.ts +1 -0
- package/dist/cjs/api/types/AccountHealthActionKind.js +1 -0
- package/dist/cjs/api/types/AccountHealthInsight.d.ts +1 -1
- package/dist/cjs/api/types/AccountHealthInsightDetector.d.ts +1 -0
- package/dist/cjs/api/types/AccountHealthInsightDetector.js +1 -0
- package/dist/cjs/serialization/types/AccountHealthActionKind.d.ts +1 -1
- package/dist/cjs/serialization/types/AccountHealthActionKind.js +1 -0
- package/dist/cjs/serialization/types/AccountHealthInsightDetector.d.ts +1 -1
- package/dist/cjs/serialization/types/AccountHealthInsightDetector.js +1 -0
- package/dist/esm/api/resources/websites/client/Client.d.ts +1 -1
- package/dist/esm/api/resources/websites/client/Client.js +1 -1
- package/dist/esm/api/resources/websites/client/requests/AddWebsitesRequest.d.ts +1 -1
- package/dist/esm/api/types/AccountHealthActionKind.d.ts +1 -0
- package/dist/esm/api/types/AccountHealthActionKind.js +1 -0
- package/dist/esm/api/types/AccountHealthInsight.d.ts +1 -1
- package/dist/esm/api/types/AccountHealthInsightDetector.d.ts +1 -0
- package/dist/esm/api/types/AccountHealthInsightDetector.js +1 -0
- package/dist/esm/serialization/types/AccountHealthActionKind.d.ts +1 -1
- package/dist/esm/serialization/types/AccountHealthActionKind.js +1 -0
- package/dist/esm/serialization/types/AccountHealthInsightDetector.d.ts +1 -1
- package/dist/esm/serialization/types/AccountHealthInsightDetector.js +1 -0
- package/package.json +1 -1
|
@@ -11,7 +11,7 @@ export declare class WebsitesClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<WebsitesClient.Options>;
|
|
12
12
|
constructor(options?: WebsitesClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it
|
|
14
|
+
* Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it under itself (links.<domain>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
|
|
15
15
|
*
|
|
16
16
|
* @param {Sequenzy.AddWebsitesRequest} request
|
|
17
17
|
* @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -39,7 +39,7 @@ class WebsitesClient {
|
|
|
39
39
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
|
-
* Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it
|
|
42
|
+
* Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it under itself (links.<domain>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
|
|
43
43
|
*
|
|
44
44
|
* @param {Sequenzy.AddWebsitesRequest} request
|
|
45
45
|
* @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -9,6 +9,6 @@ export interface AddWebsitesRequest {
|
|
|
9
9
|
domain: string;
|
|
10
10
|
/** Return-path (MAIL FROM) subdomain label. Defaults to rp. New domains also get a second return path, usually <label>2 (rp2 by default); publish the returned names. One DNS label of 1 to 63 letters, numbers or hyphens; inbound is reserved. Applies only when the domain is created; re-adding an existing domain returns its stored records. */
|
|
11
11
|
mailFromPrefix?: string;
|
|
12
|
-
/** Label of the company tracking domain created
|
|
12
|
+
/** Label of the company tracking domain created under the domain (<label>.<domain>, or <label>.<root> when it equals mailFromPrefix) when the company has none yet; ignored otherwise. Defaults to links. When the hostname is taken, the label followed by 2 to 5 is tried (for example links2); when none is free, the domain is added without a tracking domain. A label that would land on the bounce hostname returns 400. Change the tracking domain later with PUT /tracking-domain. */
|
|
13
13
|
trackingPrefix?: string;
|
|
14
14
|
}
|
|
@@ -11,5 +11,6 @@ export declare const AccountHealthActionKind: {
|
|
|
11
11
|
readonly ReviewDeliverability: "review_deliverability";
|
|
12
12
|
readonly OpenFrequencyCapSettings: "open_frequency_cap_settings";
|
|
13
13
|
readonly ApplyFrequencyCap: "apply_frequency_cap";
|
|
14
|
+
readonly ReviewSubscribers: "review_subscribers";
|
|
14
15
|
};
|
|
15
16
|
export type AccountHealthActionKind = (typeof AccountHealthActionKind)[keyof typeof AccountHealthActionKind];
|
|
@@ -7,7 +7,7 @@ export interface AccountHealthInsight {
|
|
|
7
7
|
actions?: Sequenzy.AccountHealthAction[];
|
|
8
8
|
detail?: string;
|
|
9
9
|
detector?: Sequenzy.AccountHealthInsightDetector;
|
|
10
|
-
/** Detector-specific numbers behind the finding. Event findings carry `monthlyRevenue` (USD a month the people behind the event pay) when a payment integration syncs revenue to contacts. A missing_sequence finding carries the suggested `playbook`, `name`, `goal`, `trigger` and `steps`. An over_emailing finding carries `overloadedSubscribers`, `recipients`, `peakPerDay`, `dailyThreshold`, `windowDays`, `frequencyCap` (null when off) and `sources` (type campaign, sequence or api, id, name, sends, and respectsFrequencyCap for sequences, plus enrollsEveryTime when the sequence uses unlimited re-entry and peakEnrollmentsPerPerson, the most times one person entered it in the window; the api source has an empty id and stands for marketing Send API email, which the frequency cap does not limit). A neglected_subscribers finding carries `neglectedSubscribers`, `eligibleSubscribers`, `days`, `estimated` and `sampled`. */
|
|
10
|
+
/** Detector-specific numbers behind the finding. Event findings carry `monthlyRevenue` (USD a month the people behind the event pay) when a payment integration syncs revenue to contacts. A missing_sequence finding carries the suggested `playbook`, `name`, `goal`, `trigger` and `steps`. An over_emailing finding carries `overloadedSubscribers`, `recipients`, `peakPerDay`, `dailyThreshold`, `windowDays`, `frequencyCap` (null when off) and `sources` (type campaign, sequence or api, id, name, sends, and respectsFrequencyCap for sequences, plus enrollsEveryTime when the sequence uses unlimited re-entry and peakEnrollmentsPerPerson, the most times one person entered it in the window; the api source has an empty id and stands for marketing Send API email, which the frequency cap does not limit). A neglected_subscribers finding carries `neglectedSubscribers`, `eligibleSubscribers`, `days`, `estimated` and `sampled`. An unengaged_signups finding carries `provider` and `providerLabel` (a consumer mailbox provider such as gmail or yahoo; business domains are never reported), `listId` and `listName` (the list these contacts joined first, null for none), `subscribers`, `emailed` (how many got at least two emails), `sends`, `engaged` (how many of them opened or clicked), `baselineEmailed` and `baselineEngaged` (the same for the other new signups), `windowDays`, `sampled` and `capped` (`true` when more people joined than were checked). */
|
|
11
11
|
evidence?: Record<string, unknown>;
|
|
12
12
|
/** Included in Get Account Health only. Your own answer to "was this useful?" for this finding (the API key owner's), or null when you have not answered. Other responses that return an insight leave it out. */
|
|
13
13
|
feedback?: Sequenzy.AccountHealthInsightFeedback | null;
|
|
@@ -9,5 +9,6 @@ export declare const AccountHealthInsightDetector: {
|
|
|
9
9
|
readonly MissingSequence: "missing_sequence";
|
|
10
10
|
readonly OverEmailing: "over_emailing";
|
|
11
11
|
readonly NeglectedSubscribers: "neglected_subscribers";
|
|
12
|
+
readonly UnengagedSignups: "unengaged_signups";
|
|
12
13
|
};
|
|
13
14
|
export type AccountHealthInsightDetector = (typeof AccountHealthInsightDetector)[keyof typeof AccountHealthInsightDetector];
|
|
@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
|
|
|
3
3
|
import type * as serializers from "../index.js";
|
|
4
4
|
export declare const AccountHealthActionKind: core.serialization.Schema<serializers.AccountHealthActionKind.Raw, Sequenzy.AccountHealthActionKind>;
|
|
5
5
|
export declare namespace AccountHealthActionKind {
|
|
6
|
-
type Raw = "create_sequence" | "open_sequence" | "activate_sequence" | "pause_sequence" | "create_campaign" | "review_campaign_drafts" | "open_campaign" | "verify_sending_domain" | "open_domain_settings" | "review_deliverability" | "open_frequency_cap_settings" | "apply_frequency_cap";
|
|
6
|
+
type Raw = "create_sequence" | "open_sequence" | "activate_sequence" | "pause_sequence" | "create_campaign" | "review_campaign_drafts" | "open_campaign" | "verify_sending_domain" | "open_domain_settings" | "review_deliverability" | "open_frequency_cap_settings" | "apply_frequency_cap" | "review_subscribers";
|
|
7
7
|
}
|
|
@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
|
|
|
3
3
|
import type * as serializers from "../index.js";
|
|
4
4
|
export declare const AccountHealthInsightDetector: core.serialization.Schema<serializers.AccountHealthInsightDetector.Raw, Sequenzy.AccountHealthInsightDetector>;
|
|
5
5
|
export declare namespace AccountHealthInsightDetector {
|
|
6
|
-
type Raw = "unhandled_event" | "stalled_sequence" | "campaign_gap" | "stale_campaign_drafts" | "underperforming_sequence_email" | "deliverability_spike" | "sending_domain_failing" | "missing_sequence" | "over_emailing" | "neglected_subscribers";
|
|
6
|
+
type Raw = "unhandled_event" | "stalled_sequence" | "campaign_gap" | "stale_campaign_drafts" | "underperforming_sequence_email" | "deliverability_spike" | "sending_domain_failing" | "missing_sequence" | "over_emailing" | "neglected_subscribers" | "unengaged_signups";
|
|
7
7
|
}
|
|
@@ -11,7 +11,7 @@ export declare class WebsitesClient {
|
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<WebsitesClient.Options>;
|
|
12
12
|
constructor(options?: WebsitesClient.Options);
|
|
13
13
|
/**
|
|
14
|
-
* Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it
|
|
14
|
+
* Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it under itself (links.<domain>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
|
|
15
15
|
*
|
|
16
16
|
* @param {Sequenzy.AddWebsitesRequest} request
|
|
17
17
|
* @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -13,7 +13,7 @@ export class WebsitesClient {
|
|
|
13
13
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it
|
|
16
|
+
* Adds a sending domain to the authenticated company and returns the SPF, DKIM, MAIL FROM, DMARC, and tracking DNS records required for setup. Tracked links use the company tracking domain, shared by every sending domain: the first domain creates it under itself (links.<domain>) and returns its CNAME as dnsRecords.trackingRecord. It is optional and never gates verification or sending. A domain belongs to exactly one company, so confirm the target company before adding it.
|
|
17
17
|
*
|
|
18
18
|
* @param {Sequenzy.AddWebsitesRequest} request
|
|
19
19
|
* @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -9,6 +9,6 @@ export interface AddWebsitesRequest {
|
|
|
9
9
|
domain: string;
|
|
10
10
|
/** Return-path (MAIL FROM) subdomain label. Defaults to rp. New domains also get a second return path, usually <label>2 (rp2 by default); publish the returned names. One DNS label of 1 to 63 letters, numbers or hyphens; inbound is reserved. Applies only when the domain is created; re-adding an existing domain returns its stored records. */
|
|
11
11
|
mailFromPrefix?: string;
|
|
12
|
-
/** Label of the company tracking domain created
|
|
12
|
+
/** Label of the company tracking domain created under the domain (<label>.<domain>, or <label>.<root> when it equals mailFromPrefix) when the company has none yet; ignored otherwise. Defaults to links. When the hostname is taken, the label followed by 2 to 5 is tried (for example links2); when none is free, the domain is added without a tracking domain. A label that would land on the bounce hostname returns 400. Change the tracking domain later with PUT /tracking-domain. */
|
|
13
13
|
trackingPrefix?: string;
|
|
14
14
|
}
|
|
@@ -11,5 +11,6 @@ export declare const AccountHealthActionKind: {
|
|
|
11
11
|
readonly ReviewDeliverability: "review_deliverability";
|
|
12
12
|
readonly OpenFrequencyCapSettings: "open_frequency_cap_settings";
|
|
13
13
|
readonly ApplyFrequencyCap: "apply_frequency_cap";
|
|
14
|
+
readonly ReviewSubscribers: "review_subscribers";
|
|
14
15
|
};
|
|
15
16
|
export type AccountHealthActionKind = (typeof AccountHealthActionKind)[keyof typeof AccountHealthActionKind];
|
|
@@ -7,7 +7,7 @@ export interface AccountHealthInsight {
|
|
|
7
7
|
actions?: Sequenzy.AccountHealthAction[];
|
|
8
8
|
detail?: string;
|
|
9
9
|
detector?: Sequenzy.AccountHealthInsightDetector;
|
|
10
|
-
/** Detector-specific numbers behind the finding. Event findings carry `monthlyRevenue` (USD a month the people behind the event pay) when a payment integration syncs revenue to contacts. A missing_sequence finding carries the suggested `playbook`, `name`, `goal`, `trigger` and `steps`. An over_emailing finding carries `overloadedSubscribers`, `recipients`, `peakPerDay`, `dailyThreshold`, `windowDays`, `frequencyCap` (null when off) and `sources` (type campaign, sequence or api, id, name, sends, and respectsFrequencyCap for sequences, plus enrollsEveryTime when the sequence uses unlimited re-entry and peakEnrollmentsPerPerson, the most times one person entered it in the window; the api source has an empty id and stands for marketing Send API email, which the frequency cap does not limit). A neglected_subscribers finding carries `neglectedSubscribers`, `eligibleSubscribers`, `days`, `estimated` and `sampled`. */
|
|
10
|
+
/** Detector-specific numbers behind the finding. Event findings carry `monthlyRevenue` (USD a month the people behind the event pay) when a payment integration syncs revenue to contacts. A missing_sequence finding carries the suggested `playbook`, `name`, `goal`, `trigger` and `steps`. An over_emailing finding carries `overloadedSubscribers`, `recipients`, `peakPerDay`, `dailyThreshold`, `windowDays`, `frequencyCap` (null when off) and `sources` (type campaign, sequence or api, id, name, sends, and respectsFrequencyCap for sequences, plus enrollsEveryTime when the sequence uses unlimited re-entry and peakEnrollmentsPerPerson, the most times one person entered it in the window; the api source has an empty id and stands for marketing Send API email, which the frequency cap does not limit). A neglected_subscribers finding carries `neglectedSubscribers`, `eligibleSubscribers`, `days`, `estimated` and `sampled`. An unengaged_signups finding carries `provider` and `providerLabel` (a consumer mailbox provider such as gmail or yahoo; business domains are never reported), `listId` and `listName` (the list these contacts joined first, null for none), `subscribers`, `emailed` (how many got at least two emails), `sends`, `engaged` (how many of them opened or clicked), `baselineEmailed` and `baselineEngaged` (the same for the other new signups), `windowDays`, `sampled` and `capped` (`true` when more people joined than were checked). */
|
|
11
11
|
evidence?: Record<string, unknown>;
|
|
12
12
|
/** Included in Get Account Health only. Your own answer to "was this useful?" for this finding (the API key owner's), or null when you have not answered. Other responses that return an insight leave it out. */
|
|
13
13
|
feedback?: Sequenzy.AccountHealthInsightFeedback | null;
|
|
@@ -9,5 +9,6 @@ export declare const AccountHealthInsightDetector: {
|
|
|
9
9
|
readonly MissingSequence: "missing_sequence";
|
|
10
10
|
readonly OverEmailing: "over_emailing";
|
|
11
11
|
readonly NeglectedSubscribers: "neglected_subscribers";
|
|
12
|
+
readonly UnengagedSignups: "unengaged_signups";
|
|
12
13
|
};
|
|
13
14
|
export type AccountHealthInsightDetector = (typeof AccountHealthInsightDetector)[keyof typeof AccountHealthInsightDetector];
|
|
@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
|
|
|
3
3
|
import type * as serializers from "../index.js";
|
|
4
4
|
export declare const AccountHealthActionKind: core.serialization.Schema<serializers.AccountHealthActionKind.Raw, Sequenzy.AccountHealthActionKind>;
|
|
5
5
|
export declare namespace AccountHealthActionKind {
|
|
6
|
-
type Raw = "create_sequence" | "open_sequence" | "activate_sequence" | "pause_sequence" | "create_campaign" | "review_campaign_drafts" | "open_campaign" | "verify_sending_domain" | "open_domain_settings" | "review_deliverability" | "open_frequency_cap_settings" | "apply_frequency_cap";
|
|
6
|
+
type Raw = "create_sequence" | "open_sequence" | "activate_sequence" | "pause_sequence" | "create_campaign" | "review_campaign_drafts" | "open_campaign" | "verify_sending_domain" | "open_domain_settings" | "review_deliverability" | "open_frequency_cap_settings" | "apply_frequency_cap" | "review_subscribers";
|
|
7
7
|
}
|
|
@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
|
|
|
3
3
|
import type * as serializers from "../index.js";
|
|
4
4
|
export declare const AccountHealthInsightDetector: core.serialization.Schema<serializers.AccountHealthInsightDetector.Raw, Sequenzy.AccountHealthInsightDetector>;
|
|
5
5
|
export declare namespace AccountHealthInsightDetector {
|
|
6
|
-
type Raw = "unhandled_event" | "stalled_sequence" | "campaign_gap" | "stale_campaign_drafts" | "underperforming_sequence_email" | "deliverability_spike" | "sending_domain_failing" | "missing_sequence" | "over_emailing" | "neglected_subscribers";
|
|
6
|
+
type Raw = "unhandled_event" | "stalled_sequence" | "campaign_gap" | "stale_campaign_drafts" | "underperforming_sequence_email" | "deliverability_spike" | "sending_domain_failing" | "missing_sequence" | "over_emailing" | "neglected_subscribers" | "unengaged_signups";
|
|
7
7
|
}
|