sequenzy 2.1.91 → 2.1.96
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/sequences/client/requests/SequenceCreateRequest.d.ts +3 -1
- package/dist/cjs/api/resources/sequences/client/requests/SequenceUpdateRequest.d.ts +3 -1
- package/dist/cjs/api/resources/sequences/types/UpdateSequencesResponseSequence.d.ts +2 -0
- package/dist/cjs/api/resources/subscribers/client/requests/CreateSubscribersRequest.d.ts +1 -1
- package/dist/cjs/api/resources/subscribers/client/requests/UpdateByExternalIdPathSubscribersRequest.d.ts +1 -1
- package/dist/cjs/api/resources/subscribers/client/requests/UpdateByExternalIdSubscribersRequest.d.ts +1 -1
- package/dist/cjs/api/resources/subscribers/client/requests/UpdateSubscribersRequest.d.ts +1 -1
- package/dist/cjs/api/resources/subscribers/types/CreateSubscribersRequestStatus.d.ts +2 -1
- package/dist/cjs/api/resources/subscribers/types/CreateSubscribersRequestStatus.js +2 -1
- package/dist/cjs/api/resources/subscribers/types/ListSubscribersRequestStatus.d.ts +1 -0
- package/dist/cjs/api/resources/subscribers/types/ListSubscribersRequestStatus.js +1 -0
- package/dist/cjs/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.d.ts +2 -1
- package/dist/cjs/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.js +2 -1
- package/dist/cjs/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.d.ts +2 -1
- package/dist/cjs/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.js +2 -1
- package/dist/cjs/api/resources/subscribers/types/UpdateSubscribersRequestStatus.d.ts +2 -1
- package/dist/cjs/api/resources/subscribers/types/UpdateSubscribersRequestStatus.js +2 -1
- 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/types/SequenceCreateResponseSequence.d.ts +3 -1
- package/dist/cjs/api/types/SequenceDefinitionSettings.d.ts +2 -0
- package/dist/cjs/api/types/SequenceSummary.d.ts +3 -1
- package/dist/cjs/api/types/Subscriber.d.ts +1 -0
- package/dist/cjs/api/types/SubscriberImportRecord.d.ts +1 -1
- package/dist/cjs/api/types/SubscriberImportRecordStatus.d.ts +2 -1
- package/dist/cjs/api/types/SubscriberImportRecordStatus.js +2 -1
- package/dist/cjs/api/types/SubscriberStatus.d.ts +2 -0
- package/dist/cjs/api/types/SubscriberStatus.js +2 -0
- package/dist/cjs/api/types/WebsiteDnsUpgrade.d.ts +2 -0
- package/dist/cjs/api/types/WebsiteDnsUpgradeTrackingRecord.d.ts +11 -0
- package/dist/cjs/api/types/WebsiteDnsUpgradeTrackingRecord.js +3 -0
- package/dist/cjs/api/types/WebsiteDnsUpgradeTrackingRecordStatus.d.ts +7 -0
- package/dist/cjs/api/types/WebsiteDnsUpgradeTrackingRecordStatus.js +10 -0
- package/dist/cjs/api/types/WebsiteDnsUpgradeTrackingRecordType.d.ts +4 -0
- package/dist/cjs/api/types/WebsiteDnsUpgradeTrackingRecordType.js +7 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -0
- package/dist/cjs/serialization/resources/sequences/client/requests/SequenceCreateRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/sequences/client/requests/SequenceCreateRequest.js +1 -0
- package/dist/cjs/serialization/resources/sequences/client/requests/SequenceUpdateRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/sequences/client/requests/SequenceUpdateRequest.js +1 -0
- package/dist/cjs/serialization/resources/sequences/types/UpdateSequencesResponseSequence.d.ts +1 -0
- package/dist/cjs/serialization/resources/sequences/types/UpdateSequencesResponseSequence.js +1 -0
- package/dist/cjs/serialization/resources/subscribers/types/CreateSubscribersRequestStatus.d.ts +1 -1
- package/dist/cjs/serialization/resources/subscribers/types/CreateSubscribersRequestStatus.js +1 -1
- package/dist/cjs/serialization/resources/subscribers/types/ListSubscribersRequestStatus.d.ts +1 -1
- package/dist/cjs/serialization/resources/subscribers/types/ListSubscribersRequestStatus.js +1 -1
- package/dist/cjs/serialization/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.d.ts +1 -1
- package/dist/cjs/serialization/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.js +1 -1
- package/dist/cjs/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.d.ts +1 -1
- package/dist/cjs/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.js +1 -1
- package/dist/cjs/serialization/resources/subscribers/types/UpdateSubscribersRequestStatus.d.ts +1 -1
- package/dist/cjs/serialization/resources/subscribers/types/UpdateSubscribersRequestStatus.js +1 -1
- package/dist/cjs/serialization/types/SequenceCreateResponseSequence.d.ts +1 -0
- package/dist/cjs/serialization/types/SequenceCreateResponseSequence.js +1 -0
- package/dist/cjs/serialization/types/SequenceDefinitionSettings.d.ts +1 -0
- package/dist/cjs/serialization/types/SequenceDefinitionSettings.js +1 -0
- package/dist/cjs/serialization/types/SequenceSummary.d.ts +1 -0
- package/dist/cjs/serialization/types/SequenceSummary.js +1 -0
- package/dist/cjs/serialization/types/SubscriberImportRecordStatus.d.ts +1 -1
- package/dist/cjs/serialization/types/SubscriberImportRecordStatus.js +1 -1
- package/dist/cjs/serialization/types/SubscriberStatus.d.ts +1 -1
- package/dist/cjs/serialization/types/SubscriberStatus.js +1 -1
- package/dist/cjs/serialization/types/WebsiteDnsUpgrade.d.ts +2 -0
- package/dist/cjs/serialization/types/WebsiteDnsUpgrade.js +2 -0
- package/dist/cjs/serialization/types/WebsiteDnsUpgradeTrackingRecord.d.ts +15 -0
- package/dist/cjs/serialization/types/WebsiteDnsUpgradeTrackingRecord.js +37 -0
- package/dist/cjs/serialization/types/WebsiteDnsUpgradeTrackingRecordStatus.d.ts +7 -0
- package/dist/cjs/serialization/types/WebsiteDnsUpgradeTrackingRecordStatus.js +29 -0
- package/dist/cjs/serialization/types/WebsiteDnsUpgradeTrackingRecordType.d.ts +7 -0
- package/dist/cjs/serialization/types/WebsiteDnsUpgradeTrackingRecordType.js +29 -0
- package/dist/cjs/serialization/types/index.d.ts +3 -0
- package/dist/cjs/serialization/types/index.js +3 -0
- package/dist/esm/api/resources/sequences/client/requests/SequenceCreateRequest.d.ts +3 -1
- package/dist/esm/api/resources/sequences/client/requests/SequenceUpdateRequest.d.ts +3 -1
- package/dist/esm/api/resources/sequences/types/UpdateSequencesResponseSequence.d.ts +2 -0
- package/dist/esm/api/resources/subscribers/client/requests/CreateSubscribersRequest.d.ts +1 -1
- package/dist/esm/api/resources/subscribers/client/requests/UpdateByExternalIdPathSubscribersRequest.d.ts +1 -1
- package/dist/esm/api/resources/subscribers/client/requests/UpdateByExternalIdSubscribersRequest.d.ts +1 -1
- package/dist/esm/api/resources/subscribers/client/requests/UpdateSubscribersRequest.d.ts +1 -1
- package/dist/esm/api/resources/subscribers/types/CreateSubscribersRequestStatus.d.ts +2 -1
- package/dist/esm/api/resources/subscribers/types/CreateSubscribersRequestStatus.js +2 -1
- package/dist/esm/api/resources/subscribers/types/ListSubscribersRequestStatus.d.ts +1 -0
- package/dist/esm/api/resources/subscribers/types/ListSubscribersRequestStatus.js +1 -0
- package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.d.ts +2 -1
- package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.js +2 -1
- package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.d.ts +2 -1
- package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.js +2 -1
- package/dist/esm/api/resources/subscribers/types/UpdateSubscribersRequestStatus.d.ts +2 -1
- package/dist/esm/api/resources/subscribers/types/UpdateSubscribersRequestStatus.js +2 -1
- 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/types/SequenceCreateResponseSequence.d.ts +3 -1
- package/dist/esm/api/types/SequenceDefinitionSettings.d.ts +2 -0
- package/dist/esm/api/types/SequenceSummary.d.ts +3 -1
- package/dist/esm/api/types/Subscriber.d.ts +1 -0
- package/dist/esm/api/types/SubscriberImportRecord.d.ts +1 -1
- package/dist/esm/api/types/SubscriberImportRecordStatus.d.ts +2 -1
- package/dist/esm/api/types/SubscriberImportRecordStatus.js +2 -1
- package/dist/esm/api/types/SubscriberStatus.d.ts +2 -0
- package/dist/esm/api/types/SubscriberStatus.js +2 -0
- package/dist/esm/api/types/WebsiteDnsUpgrade.d.ts +2 -0
- package/dist/esm/api/types/WebsiteDnsUpgradeTrackingRecord.d.ts +11 -0
- package/dist/esm/api/types/WebsiteDnsUpgradeTrackingRecord.js +2 -0
- package/dist/esm/api/types/WebsiteDnsUpgradeTrackingRecordStatus.d.ts +7 -0
- package/dist/esm/api/types/WebsiteDnsUpgradeTrackingRecordStatus.js +7 -0
- package/dist/esm/api/types/WebsiteDnsUpgradeTrackingRecordType.d.ts +4 -0
- package/dist/esm/api/types/WebsiteDnsUpgradeTrackingRecordType.js +4 -0
- package/dist/esm/api/types/index.d.ts +3 -0
- package/dist/esm/api/types/index.js +3 -0
- package/dist/esm/serialization/resources/sequences/client/requests/SequenceCreateRequest.d.ts +1 -0
- package/dist/esm/serialization/resources/sequences/client/requests/SequenceCreateRequest.js +1 -0
- package/dist/esm/serialization/resources/sequences/client/requests/SequenceUpdateRequest.d.ts +1 -0
- package/dist/esm/serialization/resources/sequences/client/requests/SequenceUpdateRequest.js +1 -0
- package/dist/esm/serialization/resources/sequences/types/UpdateSequencesResponseSequence.d.ts +1 -0
- package/dist/esm/serialization/resources/sequences/types/UpdateSequencesResponseSequence.js +1 -0
- package/dist/esm/serialization/resources/subscribers/types/CreateSubscribersRequestStatus.d.ts +1 -1
- package/dist/esm/serialization/resources/subscribers/types/CreateSubscribersRequestStatus.js +1 -1
- package/dist/esm/serialization/resources/subscribers/types/ListSubscribersRequestStatus.d.ts +1 -1
- package/dist/esm/serialization/resources/subscribers/types/ListSubscribersRequestStatus.js +1 -1
- package/dist/esm/serialization/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.d.ts +1 -1
- package/dist/esm/serialization/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.js +1 -1
- package/dist/esm/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.d.ts +1 -1
- package/dist/esm/serialization/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.js +1 -1
- package/dist/esm/serialization/resources/subscribers/types/UpdateSubscribersRequestStatus.d.ts +1 -1
- package/dist/esm/serialization/resources/subscribers/types/UpdateSubscribersRequestStatus.js +1 -1
- package/dist/esm/serialization/types/SequenceCreateResponseSequence.d.ts +1 -0
- package/dist/esm/serialization/types/SequenceCreateResponseSequence.js +1 -0
- package/dist/esm/serialization/types/SequenceDefinitionSettings.d.ts +1 -0
- package/dist/esm/serialization/types/SequenceDefinitionSettings.js +1 -0
- package/dist/esm/serialization/types/SequenceSummary.d.ts +1 -0
- package/dist/esm/serialization/types/SequenceSummary.js +1 -0
- package/dist/esm/serialization/types/SubscriberImportRecordStatus.d.ts +1 -1
- package/dist/esm/serialization/types/SubscriberImportRecordStatus.js +1 -1
- package/dist/esm/serialization/types/SubscriberStatus.d.ts +1 -1
- package/dist/esm/serialization/types/SubscriberStatus.js +1 -1
- package/dist/esm/serialization/types/WebsiteDnsUpgrade.d.ts +2 -0
- package/dist/esm/serialization/types/WebsiteDnsUpgrade.js +2 -0
- package/dist/esm/serialization/types/WebsiteDnsUpgradeTrackingRecord.d.ts +15 -0
- package/dist/esm/serialization/types/WebsiteDnsUpgradeTrackingRecord.js +11 -0
- package/dist/esm/serialization/types/WebsiteDnsUpgradeTrackingRecordStatus.d.ts +7 -0
- package/dist/esm/serialization/types/WebsiteDnsUpgradeTrackingRecordStatus.js +3 -0
- package/dist/esm/serialization/types/WebsiteDnsUpgradeTrackingRecordType.d.ts +7 -0
- package/dist/esm/serialization/types/WebsiteDnsUpgradeTrackingRecordType.js +3 -0
- package/dist/esm/serialization/types/index.d.ts +3 -0
- package/dist/esm/serialization/types/index.js +3 -0
- package/package.json +1 -1
|
@@ -24,6 +24,7 @@ export declare namespace SequenceCreateResponseSequence {
|
|
|
24
24
|
nodeCount?: number | null;
|
|
25
25
|
processesExistingEnrollments?: boolean | null;
|
|
26
26
|
sendingWindow?: (SequenceSendingWindow.Raw | null | undefined) | null;
|
|
27
|
+
sendToNotSubscribed?: boolean | null;
|
|
27
28
|
status?: SequenceStatus.Raw | null;
|
|
28
29
|
stopCondition?: SequenceStopCondition.Raw | null;
|
|
29
30
|
subscriberUpdateCount?: number | null;
|
|
@@ -47,6 +47,7 @@ exports.SequenceCreateResponseSequence = core.serialization.object({
|
|
|
47
47
|
nodeCount: core.serialization.number().optional(),
|
|
48
48
|
processesExistingEnrollments: core.serialization.boolean().optional(),
|
|
49
49
|
sendingWindow: SequenceSendingWindow_js_1.SequenceSendingWindow.optionalNullable(),
|
|
50
|
+
sendToNotSubscribed: core.serialization.boolean().optional(),
|
|
50
51
|
status: SequenceStatus_js_1.SequenceStatus.optional(),
|
|
51
52
|
stopCondition: SequenceStopCondition_js_1.SequenceStopCondition.optional(),
|
|
52
53
|
subscriberUpdateCount: core.serialization.number().optional(),
|
|
@@ -14,6 +14,7 @@ export declare namespace SequenceDefinitionSettings {
|
|
|
14
14
|
replyProfileId?: (string | null | undefined) | null;
|
|
15
15
|
senderProfileId?: (string | null | undefined) | null;
|
|
16
16
|
sendingWindow?: (Record<string, unknown> | null | undefined) | null;
|
|
17
|
+
sendToNotSubscribed?: (boolean | null | undefined) | null;
|
|
17
18
|
stopCondition?: SequenceDefinitionSettingsStopCondition.Raw | null;
|
|
18
19
|
userCancellable?: boolean | null;
|
|
19
20
|
}
|
|
@@ -39,6 +39,7 @@ exports.SequenceDefinitionSettings = core.serialization.object({
|
|
|
39
39
|
sendingWindow: core.serialization
|
|
40
40
|
.record(core.serialization.string(), core.serialization.unknown())
|
|
41
41
|
.optionalNullable(),
|
|
42
|
+
sendToNotSubscribed: core.serialization.boolean().optionalNullable(),
|
|
42
43
|
stopCondition: SequenceDefinitionSettingsStopCondition_js_1.SequenceDefinitionSettingsStopCondition.optional(),
|
|
43
44
|
userCancellable: core.serialization.boolean().optional(),
|
|
44
45
|
});
|
|
@@ -43,6 +43,7 @@ export declare namespace SequenceSummary {
|
|
|
43
43
|
replyToName?: (string | null | undefined) | null;
|
|
44
44
|
senderProfileId?: (string | null | undefined) | null;
|
|
45
45
|
sendingWindow?: (SequenceSendingWindow.Raw | null | undefined) | null;
|
|
46
|
+
sendToNotSubscribed?: boolean | null;
|
|
46
47
|
status?: SequenceStatus.Raw | null;
|
|
47
48
|
trigger?: (string | null | undefined) | null;
|
|
48
49
|
triggerConfig?: (Record<string, unknown> | null | undefined) | null;
|
|
@@ -66,6 +66,7 @@ exports.SequenceSummary = core.serialization.object({
|
|
|
66
66
|
replyToName: core.serialization.string().optionalNullable(),
|
|
67
67
|
senderProfileId: core.serialization.string().optionalNullable(),
|
|
68
68
|
sendingWindow: SequenceSendingWindow_js_1.SequenceSendingWindow.optionalNullable(),
|
|
69
|
+
sendToNotSubscribed: core.serialization.boolean().optional(),
|
|
69
70
|
status: SequenceStatus_js_1.SequenceStatus.optional(),
|
|
70
71
|
trigger: core.serialization.string().optionalNullable(),
|
|
71
72
|
triggerConfig: core.serialization
|
|
@@ -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 SubscriberImportRecordStatus: core.serialization.Schema<serializers.SubscriberImportRecordStatus.Raw, Sequenzy.SubscriberImportRecordStatus>;
|
|
5
5
|
export declare namespace SubscriberImportRecordStatus {
|
|
6
|
-
type Raw = "active" | "unsubscribed" | "bounced";
|
|
6
|
+
type Raw = "active" | "not_subscribed" | "unsubscribed" | "bounced";
|
|
7
7
|
}
|
|
@@ -26,4 +26,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
26
26
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
27
|
exports.SubscriberImportRecordStatus = void 0;
|
|
28
28
|
const core = __importStar(require("../../core/index.js"));
|
|
29
|
-
exports.SubscriberImportRecordStatus = core.serialization.enum_(["active", "unsubscribed", "bounced"]);
|
|
29
|
+
exports.SubscriberImportRecordStatus = core.serialization.enum_(["active", "not_subscribed", "unsubscribed", "bounced"]);
|
|
@@ -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 SubscriberStatus: core.serialization.Schema<serializers.SubscriberStatus.Raw, Sequenzy.SubscriberStatus>;
|
|
5
5
|
export declare namespace SubscriberStatus {
|
|
6
|
-
type Raw = "active" | "unsubscribed" | "bounced";
|
|
6
|
+
type Raw = "active" | "not_subscribed" | "unsubscribed" | "bounced";
|
|
7
7
|
}
|
|
@@ -26,4 +26,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
26
26
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
27
|
exports.SubscriberStatus = void 0;
|
|
28
28
|
const core = __importStar(require("../../core/index.js"));
|
|
29
|
-
exports.SubscriberStatus = core.serialization.enum_(["active", "unsubscribed", "bounced"]);
|
|
29
|
+
exports.SubscriberStatus = core.serialization.enum_(["active", "not_subscribed", "unsubscribed", "bounced"]);
|
|
@@ -5,6 +5,7 @@ import { WebsiteDnsUpgradeOldRecordsItem } from "./WebsiteDnsUpgradeOldRecordsIt
|
|
|
5
5
|
import { WebsiteDnsUpgradeRecordsItem } from "./WebsiteDnsUpgradeRecordsItem.js";
|
|
6
6
|
import { WebsiteDnsUpgradeReplacedRecordsItem } from "./WebsiteDnsUpgradeReplacedRecordsItem.js";
|
|
7
7
|
import { WebsiteDnsUpgradeStatus } from "./WebsiteDnsUpgradeStatus.js";
|
|
8
|
+
import { WebsiteDnsUpgradeTrackingRecord } from "./WebsiteDnsUpgradeTrackingRecord.js";
|
|
8
9
|
export declare const WebsiteDnsUpgrade: core.serialization.ObjectSchema<serializers.WebsiteDnsUpgrade.Raw, Sequenzy.WebsiteDnsUpgrade>;
|
|
9
10
|
export declare namespace WebsiteDnsUpgrade {
|
|
10
11
|
interface Raw {
|
|
@@ -15,5 +16,6 @@ export declare namespace WebsiteDnsUpgrade {
|
|
|
15
16
|
replacedRecords?: WebsiteDnsUpgradeReplacedRecordsItem.Raw[] | null;
|
|
16
17
|
startedAt?: string | null;
|
|
17
18
|
status: WebsiteDnsUpgradeStatus.Raw;
|
|
19
|
+
trackingRecord?: WebsiteDnsUpgradeTrackingRecord.Raw | null;
|
|
18
20
|
}
|
|
19
21
|
}
|
|
@@ -30,6 +30,7 @@ const WebsiteDnsUpgradeOldRecordsItem_js_1 = require("./WebsiteDnsUpgradeOldReco
|
|
|
30
30
|
const WebsiteDnsUpgradeRecordsItem_js_1 = require("./WebsiteDnsUpgradeRecordsItem.js");
|
|
31
31
|
const WebsiteDnsUpgradeReplacedRecordsItem_js_1 = require("./WebsiteDnsUpgradeReplacedRecordsItem.js");
|
|
32
32
|
const WebsiteDnsUpgradeStatus_js_1 = require("./WebsiteDnsUpgradeStatus.js");
|
|
33
|
+
const WebsiteDnsUpgradeTrackingRecord_js_1 = require("./WebsiteDnsUpgradeTrackingRecord.js");
|
|
33
34
|
exports.WebsiteDnsUpgrade = core.serialization.object({
|
|
34
35
|
completedAt: core.serialization.date().nullable(),
|
|
35
36
|
deleteOldRecordsAfter: core.serialization.date().nullable(),
|
|
@@ -38,4 +39,5 @@ exports.WebsiteDnsUpgrade = core.serialization.object({
|
|
|
38
39
|
replacedRecords: core.serialization.list(WebsiteDnsUpgradeReplacedRecordsItem_js_1.WebsiteDnsUpgradeReplacedRecordsItem).nullable(),
|
|
39
40
|
startedAt: core.serialization.date().nullable(),
|
|
40
41
|
status: WebsiteDnsUpgradeStatus_js_1.WebsiteDnsUpgradeStatus,
|
|
42
|
+
trackingRecord: WebsiteDnsUpgradeTrackingRecord_js_1.WebsiteDnsUpgradeTrackingRecord.nullable(),
|
|
41
43
|
});
|
|
@@ -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 { WebsiteDnsUpgradeTrackingRecordStatus } from "./WebsiteDnsUpgradeTrackingRecordStatus.js";
|
|
5
|
+
import { WebsiteDnsUpgradeTrackingRecordType } from "./WebsiteDnsUpgradeTrackingRecordType.js";
|
|
6
|
+
export declare const WebsiteDnsUpgradeTrackingRecord: core.serialization.ObjectSchema<serializers.WebsiteDnsUpgradeTrackingRecord.Raw, Sequenzy.WebsiteDnsUpgradeTrackingRecord>;
|
|
7
|
+
export declare namespace WebsiteDnsUpgradeTrackingRecord {
|
|
8
|
+
interface Raw {
|
|
9
|
+
name: string;
|
|
10
|
+
required: boolean;
|
|
11
|
+
status: WebsiteDnsUpgradeTrackingRecordStatus.Raw;
|
|
12
|
+
type: WebsiteDnsUpgradeTrackingRecordType.Raw;
|
|
13
|
+
value: string;
|
|
14
|
+
}
|
|
15
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
20
|
+
if (mod && mod.__esModule) return mod;
|
|
21
|
+
var result = {};
|
|
22
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
23
|
+
__setModuleDefault(result, mod);
|
|
24
|
+
return result;
|
|
25
|
+
};
|
|
26
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
|
+
exports.WebsiteDnsUpgradeTrackingRecord = void 0;
|
|
28
|
+
const core = __importStar(require("../../core/index.js"));
|
|
29
|
+
const WebsiteDnsUpgradeTrackingRecordStatus_js_1 = require("./WebsiteDnsUpgradeTrackingRecordStatus.js");
|
|
30
|
+
const WebsiteDnsUpgradeTrackingRecordType_js_1 = require("./WebsiteDnsUpgradeTrackingRecordType.js");
|
|
31
|
+
exports.WebsiteDnsUpgradeTrackingRecord = core.serialization.object({
|
|
32
|
+
name: core.serialization.string(),
|
|
33
|
+
required: core.serialization.boolean(),
|
|
34
|
+
status: WebsiteDnsUpgradeTrackingRecordStatus_js_1.WebsiteDnsUpgradeTrackingRecordStatus,
|
|
35
|
+
type: WebsiteDnsUpgradeTrackingRecordType_js_1.WebsiteDnsUpgradeTrackingRecordType,
|
|
36
|
+
value: core.serialization.string(),
|
|
37
|
+
});
|
|
@@ -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 WebsiteDnsUpgradeTrackingRecordStatus: core.serialization.Schema<serializers.WebsiteDnsUpgradeTrackingRecordStatus.Raw, Sequenzy.WebsiteDnsUpgradeTrackingRecordStatus>;
|
|
5
|
+
export declare namespace WebsiteDnsUpgradeTrackingRecordStatus {
|
|
6
|
+
type Raw = "not_started" | "pending" | "verified" | "failed";
|
|
7
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
20
|
+
if (mod && mod.__esModule) return mod;
|
|
21
|
+
var result = {};
|
|
22
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
23
|
+
__setModuleDefault(result, mod);
|
|
24
|
+
return result;
|
|
25
|
+
};
|
|
26
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
|
+
exports.WebsiteDnsUpgradeTrackingRecordStatus = void 0;
|
|
28
|
+
const core = __importStar(require("../../core/index.js"));
|
|
29
|
+
exports.WebsiteDnsUpgradeTrackingRecordStatus = core.serialization.enum_(["not_started", "pending", "verified", "failed"]);
|
|
@@ -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 WebsiteDnsUpgradeTrackingRecordType: core.serialization.Schema<serializers.WebsiteDnsUpgradeTrackingRecordType.Raw, Sequenzy.WebsiteDnsUpgradeTrackingRecordType>;
|
|
5
|
+
export declare namespace WebsiteDnsUpgradeTrackingRecordType {
|
|
6
|
+
type Raw = "CNAME";
|
|
7
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
20
|
+
if (mod && mod.__esModule) return mod;
|
|
21
|
+
var result = {};
|
|
22
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
23
|
+
__setModuleDefault(result, mod);
|
|
24
|
+
return result;
|
|
25
|
+
};
|
|
26
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
|
+
exports.WebsiteDnsUpgradeTrackingRecordType = void 0;
|
|
28
|
+
const core = __importStar(require("../../core/index.js"));
|
|
29
|
+
exports.WebsiteDnsUpgradeTrackingRecordType = core.serialization.enum_(["CNAME"]);
|
|
@@ -1016,6 +1016,9 @@ export * from "./WebsiteDnsUpgradeRecordsItemType.js";
|
|
|
1016
1016
|
export * from "./WebsiteDnsUpgradeReplacedRecordsItem.js";
|
|
1017
1017
|
export * from "./WebsiteDnsUpgradeReplacedRecordsItemType.js";
|
|
1018
1018
|
export * from "./WebsiteDnsUpgradeStatus.js";
|
|
1019
|
+
export * from "./WebsiteDnsUpgradeTrackingRecord.js";
|
|
1020
|
+
export * from "./WebsiteDnsUpgradeTrackingRecordStatus.js";
|
|
1021
|
+
export * from "./WebsiteDnsUpgradeTrackingRecordType.js";
|
|
1019
1022
|
export * from "./WebsiteReadiness.js";
|
|
1020
1023
|
export * from "./WebsiteReadinessReason.js";
|
|
1021
1024
|
export * from "./WebsiteReadinessStatus.js";
|
|
@@ -1032,6 +1032,9 @@ __exportStar(require("./WebsiteDnsUpgradeRecordsItemType.js"), exports);
|
|
|
1032
1032
|
__exportStar(require("./WebsiteDnsUpgradeReplacedRecordsItem.js"), exports);
|
|
1033
1033
|
__exportStar(require("./WebsiteDnsUpgradeReplacedRecordsItemType.js"), exports);
|
|
1034
1034
|
__exportStar(require("./WebsiteDnsUpgradeStatus.js"), exports);
|
|
1035
|
+
__exportStar(require("./WebsiteDnsUpgradeTrackingRecord.js"), exports);
|
|
1036
|
+
__exportStar(require("./WebsiteDnsUpgradeTrackingRecordStatus.js"), exports);
|
|
1037
|
+
__exportStar(require("./WebsiteDnsUpgradeTrackingRecordType.js"), exports);
|
|
1035
1038
|
__exportStar(require("./WebsiteReadiness.js"), exports);
|
|
1036
1039
|
__exportStar(require("./WebsiteReadinessReason.js"), exports);
|
|
1037
1040
|
__exportStar(require("./WebsiteReadinessStatus.js"), exports);
|
|
@@ -106,7 +106,7 @@ import type * as Sequenzy from "../../../../index.js";
|
|
|
106
106
|
* }
|
|
107
107
|
*/
|
|
108
108
|
export interface SequenceCreateRequest {
|
|
109
|
-
/** Only enroll contacts whose status is `active`. Defaults to `false`: unsubscribed and
|
|
109
|
+
/** Only enroll contacts whose status is `active`. Defaults to `false`: unsubscribed, bounced and not subscribed contacts still enter on tag, event, list and contact triggers so non-marketing steps run for them. Marketing emails are skipped at send time for unsubscribed and bounced contacts, and for not subscribed contacts unless `sendToNotSubscribed` is on. When `true`, none of them enter, including not subscribed contacts when `sendToNotSubscribed` is on. Pending double opt-in contacts still wait for confirmation. */
|
|
110
110
|
activeSubscribersOnly?: boolean;
|
|
111
111
|
/** Addresses blind-copied on every sequence email. */
|
|
112
112
|
bccEmails?: string[] | null;
|
|
@@ -167,6 +167,8 @@ export interface SequenceCreateRequest {
|
|
|
167
167
|
/** Existing sender profile ID. It already supplies both the From address and display name, so send it on its own and omit fromEmail and fromName. To keep this profile under a different display name, set fromName on the email steps instead, where it is a per-step override. */
|
|
168
168
|
senderProfileId?: string;
|
|
169
169
|
sendingWindow?: Sequenzy.SequenceSendingWindow | null;
|
|
170
|
+
/** Whether marketing emails in this sequence also go to contacts whose status is `not_subscribed` (never opted in, never opted out). Omit it or pass `null` to use the default for the trigger: `true` when the sequence starts on the `ecommerce.checkout_started` event, `false` otherwise. Unsubscribed and bounced contacts never receive marketing email. With `activeSubscribersOnly: true`, not subscribed contacts do not enter the sequence at all. */
|
|
171
|
+
sendToNotSubscribed?: boolean | null;
|
|
170
172
|
/** Explicit email and action steps. Provide either steps or goal, or omit both for a blank dashboard-compatible draft. */
|
|
171
173
|
steps?: Sequenzy.SequenceStepInput[];
|
|
172
174
|
stopCondition?: Sequenzy.SequenceStopCondition;
|
|
@@ -165,7 +165,7 @@ import type * as Sequenzy from "../../../../index.js";
|
|
|
165
165
|
export interface SequenceUpdateRequest {
|
|
166
166
|
/** Sequence ID */
|
|
167
167
|
sequenceId: string;
|
|
168
|
-
/** Only enroll contacts whose status is `active`. Defaults to `false`: unsubscribed and
|
|
168
|
+
/** Only enroll contacts whose status is `active`. Defaults to `false`: unsubscribed, bounced and not subscribed contacts still enter on tag, event, list and contact triggers so non-marketing steps run for them. Marketing emails are skipped at send time for unsubscribed and bounced contacts, and for not subscribed contacts unless `sendToNotSubscribed` is on. When `true`, none of them enter, including not subscribed contacts when `sendToNotSubscribed` is on. Pending double opt-in contacts still wait for confirmation. */
|
|
169
169
|
activeSubscribersOnly?: boolean;
|
|
170
170
|
/** Keep enrolling later joiners of an audience until the last key date. Null clears it. Changing the trigger away from manual switches it off (endedReason "disabled"). */
|
|
171
171
|
audienceAutoEnroll?: Sequenzy.SequenceAudienceAutoEnroll | null;
|
|
@@ -230,6 +230,8 @@ export interface SequenceUpdateRequest {
|
|
|
230
230
|
/** Existing sender profile ID. It already supplies both the From address and display name, so send it on its own and omit fromEmail and fromName. To keep this profile under a different display name, set fromName on the email steps instead, where it is a per-step override. */
|
|
231
231
|
senderProfileId?: string;
|
|
232
232
|
sendingWindow?: Sequenzy.SequenceSendingWindow | null;
|
|
233
|
+
/** Whether marketing emails in this sequence also go to contacts whose status is `not_subscribed` (never opted in, never opted out). Omit it to keep the current choice. Pass `null` to go back to the default for the trigger: `true` when the sequence starts on the `ecommerce.checkout_started` event, `false` otherwise. Unsubscribed and bounced contacts never receive marketing email. With `activeSubscribersOnly: true`, not subscribed contacts do not enter the sequence at all. */
|
|
234
|
+
sendToNotSubscribed?: boolean | null;
|
|
233
235
|
/** Content updates for existing SMS steps, targeted by action_sms nodeId. Content-only edits; use insertSteps to create new SMS steps. */
|
|
234
236
|
smsSteps?: Sequenzy.SequenceSmsStepUpdateInput[];
|
|
235
237
|
/** Alias for emails. Use insertSteps to create new steps. */
|
|
@@ -30,6 +30,8 @@ export interface UpdateSequencesResponseSequence {
|
|
|
30
30
|
/** Number of edges in the committed graph after a structural graph edit. */
|
|
31
31
|
replacedEdgeCount?: number;
|
|
32
32
|
sendingWindow?: Sequenzy.SequenceSendingWindow | null;
|
|
33
|
+
/** Whether marketing emails in this sequence also go to contacts whose status is `not_subscribed`. This is the value in effect, after the trigger default is applied. */
|
|
34
|
+
sendToNotSubscribed?: boolean;
|
|
33
35
|
status?: Sequenzy.SequenceStatus;
|
|
34
36
|
stopCondition?: Sequenzy.SequenceStopCondition;
|
|
35
37
|
updatedEmailCount?: number;
|
|
@@ -37,7 +37,7 @@ export interface CreateSubscribersRequest {
|
|
|
37
37
|
phoneCountry?: string | null;
|
|
38
38
|
/** SMS marketing consent. true sets smsStatus to subscribed with consent source api, false sets unsubscribed, omitted leaves SMS status unchanged. Never inferred from phone presence. */
|
|
39
39
|
smsConsent?: boolean;
|
|
40
|
-
/** Initial subscriber status. */
|
|
40
|
+
/** Initial subscriber status. Use `not_subscribed` for a contact who never opted in to marketing email and never opted out. */
|
|
41
41
|
status?: Sequenzy.CreateSubscribersRequestStatus;
|
|
42
42
|
tags?: string[];
|
|
43
43
|
/** IANA timezone identifier (e.g. America/New_York) used for recipient-local campaign delivery. Invalid values fail with a 400 validation error; null clears the stored value. */
|
|
@@ -26,7 +26,7 @@ export interface UpdateByExternalIdPathSubscribersRequest {
|
|
|
26
26
|
phoneCountry?: string | null;
|
|
27
27
|
/** SMS marketing consent. true sets smsStatus to subscribed with consent source api, false sets unsubscribed, omitted leaves SMS status unchanged. Never inferred from phone presence. */
|
|
28
28
|
smsConsent?: boolean;
|
|
29
|
-
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
29
|
+
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `not_subscribed` marks the contact as never opted in without recording an opt-out; an active contact leaves every audience and its running sequences continue. A contact who is `unsubscribed` or `bounced` cannot be set to `not_subscribed`: the request returns `400`. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
30
30
|
status?: Sequenzy.UpdateByExternalIdPathSubscribersRequestStatus;
|
|
31
31
|
tags?: string[];
|
|
32
32
|
/** IANA timezone identifier (e.g. America/New_York) used for recipient-local campaign delivery. Invalid values fail with a 400 validation error; null clears the stored value. */
|
package/dist/esm/api/resources/subscribers/client/requests/UpdateByExternalIdSubscribersRequest.d.ts
CHANGED
|
@@ -26,7 +26,7 @@ export interface UpdateByExternalIdSubscribersRequest {
|
|
|
26
26
|
phoneCountry?: string | null;
|
|
27
27
|
/** SMS marketing consent. true sets smsStatus to subscribed with consent source api, false sets unsubscribed, omitted leaves SMS status unchanged. Never inferred from phone presence. */
|
|
28
28
|
smsConsent?: boolean;
|
|
29
|
-
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
29
|
+
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `not_subscribed` marks the contact as never opted in without recording an opt-out; an active contact leaves every audience and its running sequences continue. A contact who is `unsubscribed` or `bounced` cannot be set to `not_subscribed`: the request returns `400`. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
30
30
|
status?: Sequenzy.UpdateByExternalIdSubscribersRequestStatus;
|
|
31
31
|
tags?: string[];
|
|
32
32
|
/** IANA timezone identifier (e.g. America/New_York) used for recipient-local campaign delivery. Invalid values fail with a 400 validation error; null clears the stored value. */
|
|
@@ -26,7 +26,7 @@ export interface UpdateSubscribersRequest {
|
|
|
26
26
|
phoneCountry?: string | null;
|
|
27
27
|
/** SMS marketing consent. true sets smsStatus to subscribed with consent source api, false sets unsubscribed, omitted leaves SMS status unchanged. Never inferred from phone presence. */
|
|
28
28
|
smsConsent?: boolean;
|
|
29
|
-
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
29
|
+
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `not_subscribed` marks the contact as never opted in without recording an opt-out; an active contact leaves every audience and its running sequences continue. A contact who is `unsubscribed` or `bounced` cannot be set to `not_subscribed`: the request returns `400`. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
30
30
|
status?: Sequenzy.UpdateSubscribersRequestStatus;
|
|
31
31
|
tags?: string[];
|
|
32
32
|
/** IANA timezone identifier such as America/New_York, stored as a native profile field and used for recipient-local campaign delivery. An invalid identifier returns 400 VALIDATION_ERROR. Omit to keep unchanged, or send null to clear. */
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
/** Initial subscriber status. */
|
|
1
|
+
/** Initial subscriber status. Use `not_subscribed` for a contact who never opted in to marketing email and never opted out. */
|
|
2
2
|
export declare const CreateSubscribersRequestStatus: {
|
|
3
3
|
readonly Active: "active";
|
|
4
|
+
readonly NotSubscribed: "not_subscribed";
|
|
4
5
|
readonly Unsubscribed: "unsubscribed";
|
|
5
6
|
readonly Bounced: "bounced";
|
|
6
7
|
};
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/** Initial subscriber status. */
|
|
2
|
+
/** Initial subscriber status. Use `not_subscribed` for a contact who never opted in to marketing email and never opted out. */
|
|
3
3
|
export const CreateSubscribersRequestStatus = {
|
|
4
4
|
Active: "active",
|
|
5
|
+
NotSubscribed: "not_subscribed",
|
|
5
6
|
Unsubscribed: "unsubscribed",
|
|
6
7
|
Bounced: "bounced",
|
|
7
8
|
};
|
package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
1
|
+
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `not_subscribed` marks the contact as never opted in without recording an opt-out; an active contact leaves every audience and its running sequences continue. A contact who is `unsubscribed` or `bounced` cannot be set to `not_subscribed`: the request returns `400`. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
2
2
|
export declare const UpdateByExternalIdPathSubscribersRequestStatus: {
|
|
3
3
|
readonly Active: "active";
|
|
4
|
+
readonly NotSubscribed: "not_subscribed";
|
|
4
5
|
readonly Unsubscribed: "unsubscribed";
|
|
5
6
|
readonly Bounced: "bounced";
|
|
6
7
|
readonly Complained: "complained";
|
package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.js
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
2
|
+
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `not_subscribed` marks the contact as never opted in without recording an opt-out; an active contact leaves every audience and its running sequences continue. A contact who is `unsubscribed` or `bounced` cannot be set to `not_subscribed`: the request returns `400`. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
3
3
|
export const UpdateByExternalIdPathSubscribersRequestStatus = {
|
|
4
4
|
Active: "active",
|
|
5
|
+
NotSubscribed: "not_subscribed",
|
|
5
6
|
Unsubscribed: "unsubscribed",
|
|
6
7
|
Bounced: "bounced",
|
|
7
8
|
Complained: "complained",
|
package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
1
|
+
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `not_subscribed` marks the contact as never opted in without recording an opt-out; an active contact leaves every audience and its running sequences continue. A contact who is `unsubscribed` or `bounced` cannot be set to `not_subscribed`: the request returns `400`. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
2
2
|
export declare const UpdateByExternalIdSubscribersRequestStatus: {
|
|
3
3
|
readonly Active: "active";
|
|
4
|
+
readonly NotSubscribed: "not_subscribed";
|
|
4
5
|
readonly Unsubscribed: "unsubscribed";
|
|
5
6
|
readonly Bounced: "bounced";
|
|
6
7
|
readonly Complained: "complained";
|
package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.js
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
2
|
+
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `not_subscribed` marks the contact as never opted in without recording an opt-out; an active contact leaves every audience and its running sequences continue. A contact who is `unsubscribed` or `bounced` cannot be set to `not_subscribed`: the request returns `400`. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
3
3
|
export const UpdateByExternalIdSubscribersRequestStatus = {
|
|
4
4
|
Active: "active",
|
|
5
|
+
NotSubscribed: "not_subscribed",
|
|
5
6
|
Unsubscribed: "unsubscribed",
|
|
6
7
|
Bounced: "bounced",
|
|
7
8
|
Complained: "complained",
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
1
|
+
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `not_subscribed` marks the contact as never opted in without recording an opt-out; an active contact leaves every audience and its running sequences continue. A contact who is `unsubscribed` or `bounced` cannot be set to `not_subscribed`: the request returns `400`. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
2
2
|
export declare const UpdateSubscribersRequestStatus: {
|
|
3
3
|
readonly Active: "active";
|
|
4
|
+
readonly NotSubscribed: "not_subscribed";
|
|
4
5
|
readonly Unsubscribed: "unsubscribed";
|
|
5
6
|
readonly Bounced: "bounced";
|
|
6
7
|
readonly Complained: "complained";
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
2
|
+
/** Setting `unsubscribed` performs a full global unsubscribe. Setting `not_subscribed` marks the contact as never opted in without recording an opt-out; an active contact leaves every audience and its running sequences continue. A contact who is `unsubscribed` or `bounced` cannot be set to `not_subscribed`: the request returns `400`. Setting `complained` records a company spam-complaint suppression (visible through the suppressions endpoints), then runs the same unsubscribe workflow; the subscriber then reads as `unsubscribed`. Repeating it is safe. */
|
|
3
3
|
export const UpdateSubscribersRequestStatus = {
|
|
4
4
|
Active: "active",
|
|
5
|
+
NotSubscribed: "not_subscribed",
|
|
5
6
|
Unsubscribed: "unsubscribed",
|
|
6
7
|
Bounced: "bounced",
|
|
7
8
|
Complained: "complained",
|
|
@@ -93,7 +93,7 @@ export declare class WebsitesClient {
|
|
|
93
93
|
list(requestOptions?: WebsitesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListWebsitesResponse>;
|
|
94
94
|
private __list;
|
|
95
95
|
/**
|
|
96
|
-
* Starts moving a verified sending domain onto the current per-domain CNAME record set without removing it. The domain keeps sending on its current records while the upgrade is in progress, and sender profiles
|
|
96
|
+
* Starts moving a verified sending domain onto the current per-domain CNAME record set without removing it. The domain keeps sending on its current records while the upgrade is in progress, and sender profiles and sequences stay as they are. Publish the CNAMEs in website.dnsUpgrade.records next to your current records; remove nothing yet. A workspace without a tracking domain gets links.<domain> (links2 to links5 when that name is in use), as when adding a new domain; publish its CNAME from website.dnsUpgrade.trackingRecord too, which also lists an existing tracking domain in this DNS zone while it is not verified (null otherwise). It is optional and never holds up the switch: until it is verified, links use the shared tracking domains. About an hour after the required ones (DKIM and the return path) are visible on public DNS (Google and Cloudflare resolvers), the domain switches by itself; the wait lets cached "does not exist" answers expire. Sequenzy prepares the sending setup of the domain separately and switches only once it is confirmed, so sending is normally not interrupted and no emails are held. If that is not possible for a domain, emails sent through Amazon SES can be held for a few minutes while SES confirms the new setup, then they go out. The domain also gets a new 2048-bit DKIM key; the key change adds no records of its own. An older SES-only domain needs a working DMARC record first, otherwise the request returns 400. Call POST /websites/{domain}/verify after publishing to check now; it does not skip the wait. After the switch, website.dnsUpgrade lists the old records to delete after deleteOldRecordsAfter; for an older SES-only domain these include the old return path records (MX and TXT at send.<domain>) and the DKIM TXT, and DMARC stays. Requires websites:write.
|
|
97
97
|
*
|
|
98
98
|
* @param {Sequenzy.StartSendingDomainDnsUpgradeRequest} request
|
|
99
99
|
* @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -309,7 +309,7 @@ export class WebsitesClient {
|
|
|
309
309
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/websites");
|
|
310
310
|
}
|
|
311
311
|
/**
|
|
312
|
-
* Starts moving a verified sending domain onto the current per-domain CNAME record set without removing it. The domain keeps sending on its current records while the upgrade is in progress, and sender profiles
|
|
312
|
+
* Starts moving a verified sending domain onto the current per-domain CNAME record set without removing it. The domain keeps sending on its current records while the upgrade is in progress, and sender profiles and sequences stay as they are. Publish the CNAMEs in website.dnsUpgrade.records next to your current records; remove nothing yet. A workspace without a tracking domain gets links.<domain> (links2 to links5 when that name is in use), as when adding a new domain; publish its CNAME from website.dnsUpgrade.trackingRecord too, which also lists an existing tracking domain in this DNS zone while it is not verified (null otherwise). It is optional and never holds up the switch: until it is verified, links use the shared tracking domains. About an hour after the required ones (DKIM and the return path) are visible on public DNS (Google and Cloudflare resolvers), the domain switches by itself; the wait lets cached "does not exist" answers expire. Sequenzy prepares the sending setup of the domain separately and switches only once it is confirmed, so sending is normally not interrupted and no emails are held. If that is not possible for a domain, emails sent through Amazon SES can be held for a few minutes while SES confirms the new setup, then they go out. The domain also gets a new 2048-bit DKIM key; the key change adds no records of its own. An older SES-only domain needs a working DMARC record first, otherwise the request returns 400. Call POST /websites/{domain}/verify after publishing to check now; it does not skip the wait. After the switch, website.dnsUpgrade lists the old records to delete after deleteOldRecordsAfter; for an older SES-only domain these include the old return path records (MX and TXT at send.<domain>) and the DKIM TXT, and DMARC stays. Requires websites:write.
|
|
313
313
|
*
|
|
314
314
|
* @param {Sequenzy.StartSendingDomainDnsUpgradeRequest} request
|
|
315
315
|
* @param {WebsitesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -2,7 +2,7 @@ import type * as Sequenzy from "../index.js";
|
|
|
2
2
|
export interface SequenceCreateResponseSequence {
|
|
3
3
|
/** Whether new subscribers can enter the sequence right now. */
|
|
4
4
|
acceptsNewEnrollments?: boolean;
|
|
5
|
-
/** Whether only active contacts can enter. When `false`, unsubscribed and
|
|
5
|
+
/** Whether only active contacts can enter. When `false`, unsubscribed, bounced and not subscribed contacts still enter. Marketing emails are skipped for unsubscribed and bounced contacts, and for not subscribed contacts unless `sendToNotSubscribed` is `true`. */
|
|
6
6
|
activeSubscribersOnly?: boolean;
|
|
7
7
|
discountCount?: number;
|
|
8
8
|
effectiveStatus?: Sequenzy.SequenceEffectiveStatus;
|
|
@@ -21,6 +21,8 @@ export interface SequenceCreateResponseSequence {
|
|
|
21
21
|
/** Whether subscribers already inside the sequence keep advancing and receiving steps. */
|
|
22
22
|
processesExistingEnrollments?: boolean;
|
|
23
23
|
sendingWindow?: Sequenzy.SequenceSendingWindow | null;
|
|
24
|
+
/** Whether marketing emails in this sequence also go to contacts whose status is `not_subscribed`. This is the value in effect, after the trigger default is applied. */
|
|
25
|
+
sendToNotSubscribed?: boolean;
|
|
24
26
|
status?: Sequenzy.SequenceStatus;
|
|
25
27
|
stopCondition?: Sequenzy.SequenceStopCondition;
|
|
26
28
|
subscriberUpdateCount?: number;
|
|
@@ -10,6 +10,8 @@ export interface SequenceDefinitionSettings {
|
|
|
10
10
|
/** Must be a sender profile in this company. */
|
|
11
11
|
senderProfileId?: string | null;
|
|
12
12
|
sendingWindow?: Record<string, unknown> | null;
|
|
13
|
+
/** Whether marketing emails also go to contacts whose status is `not_subscribed`. `null` uses the default for the trigger (`true` for `ecommerce.checkout_started`, `false` otherwise). Omit it to keep the stored value. */
|
|
14
|
+
sendToNotSubscribed?: boolean | null;
|
|
13
15
|
stopCondition?: Sequenzy.SequenceDefinitionSettingsStopCondition;
|
|
14
16
|
userCancellable?: boolean;
|
|
15
17
|
}
|
|
@@ -2,7 +2,7 @@ import type * as Sequenzy from "../index.js";
|
|
|
2
2
|
export interface SequenceSummary {
|
|
3
3
|
/** Whether new subscribers can enter the sequence right now. */
|
|
4
4
|
acceptsNewEnrollments?: boolean;
|
|
5
|
-
/** Whether only active contacts can enter. When `false`, unsubscribed and
|
|
5
|
+
/** Whether only active contacts can enter. When `false`, unsubscribed, bounced and not subscribed contacts still enter. Marketing emails are skipped for unsubscribed and bounced contacts, and for not subscribed contacts unless `sendToNotSubscribed` is `true`. */
|
|
6
6
|
activeSubscribersOnly?: boolean;
|
|
7
7
|
audienceAutoEnroll?: Sequenzy.SequenceAudienceAutoEnroll | null;
|
|
8
8
|
/** Email addresses blind-copied on every email this sequence sends. */
|
|
@@ -41,6 +41,8 @@ export interface SequenceSummary {
|
|
|
41
41
|
replyToName?: string | null;
|
|
42
42
|
senderProfileId?: string | null;
|
|
43
43
|
sendingWindow?: Sequenzy.SequenceSendingWindow | null;
|
|
44
|
+
/** Whether marketing emails in this sequence also go to contacts whose status is `not_subscribed`. This is the value in effect, after the trigger default is applied. */
|
|
45
|
+
sendToNotSubscribed?: boolean;
|
|
44
46
|
status?: Sequenzy.SequenceStatus;
|
|
45
47
|
trigger?: string | null;
|
|
46
48
|
triggerConfig?: Record<string, unknown> | null;
|
|
@@ -16,6 +16,7 @@ export interface Subscriber {
|
|
|
16
16
|
phoneCountry?: string | null;
|
|
17
17
|
/** SMS marketing consent status, independent of the email status */
|
|
18
18
|
smsStatus?: Sequenzy.SubscriberSmsStatus;
|
|
19
|
+
/** Email status. `not_subscribed` means the contact never opted in to marketing email and never opted out, for example a shopper who started a checkout. Campaigns skip them, transactional email still reaches them, and a sequence sends them marketing email only when its `sendToNotSubscribed` setting is on. */
|
|
19
20
|
status?: Sequenzy.SubscriberStatus;
|
|
20
21
|
tags?: string[];
|
|
21
22
|
/** IANA timezone identifier used for recipient-local campaign delivery. Null when unknown. */
|
|
@@ -13,7 +13,7 @@ export interface SubscriberImportRecord {
|
|
|
13
13
|
lastName?: string;
|
|
14
14
|
/** Phone number. National-format values use the batch defaultPhoneCountry. Required when the record has no email. */
|
|
15
15
|
phone?: string;
|
|
16
|
-
/** Email status from the source platform. Unsubscribed and bounced records are stored with that status, never enroll in sequences and never receive a double opt-in confirmation, whatever optInMode is. An active record never resubscribes an existing unsubscribed or bounced contact. With merge or overwrite, an unsubscribed or bounced record applies that status to an existing active contact; an unsubscribe also stamps its list memberships and cancels its running sequences. With skip, existing contacts are left unchanged. */
|
|
16
|
+
/** Email status from the source platform. Unsubscribed and bounced records are stored with that status, never enroll in sequences and never receive a double opt-in confirmation, whatever optInMode is. An active record never resubscribes an existing unsubscribed or bounced contact. With merge or overwrite, an unsubscribed or bounced record applies that status to an existing active contact; an unsubscribe also stamps its list memberships and cancels its running sequences. With skip, existing contacts are left unchanged. A `not_subscribed` record (a contact who never opted in and never opted out) sets that status on new contacts only and never changes an existing contact's status. It never enrolls in sequences and never receives a double opt-in confirmation. */
|
|
17
17
|
status?: Sequenzy.SubscriberImportRecordStatus;
|
|
18
18
|
tags?: string[];
|
|
19
19
|
/** IANA timezone identifier (e.g. America/New_York) used for recipient-local campaign delivery. Records with an invalid value import without it. */
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
/** Email status from the source platform. Unsubscribed and bounced records are stored with that status, never enroll in sequences and never receive a double opt-in confirmation, whatever optInMode is. An active record never resubscribes an existing unsubscribed or bounced contact. With merge or overwrite, an unsubscribed or bounced record applies that status to an existing active contact; an unsubscribe also stamps its list memberships and cancels its running sequences. With skip, existing contacts are left unchanged. */
|
|
1
|
+
/** Email status from the source platform. Unsubscribed and bounced records are stored with that status, never enroll in sequences and never receive a double opt-in confirmation, whatever optInMode is. An active record never resubscribes an existing unsubscribed or bounced contact. With merge or overwrite, an unsubscribed or bounced record applies that status to an existing active contact; an unsubscribe also stamps its list memberships and cancels its running sequences. With skip, existing contacts are left unchanged. A `not_subscribed` record (a contact who never opted in and never opted out) sets that status on new contacts only and never changes an existing contact's status. It never enrolls in sequences and never receives a double opt-in confirmation. */
|
|
2
2
|
export declare const SubscriberImportRecordStatus: {
|
|
3
3
|
readonly Active: "active";
|
|
4
|
+
readonly NotSubscribed: "not_subscribed";
|
|
4
5
|
readonly Unsubscribed: "unsubscribed";
|
|
5
6
|
readonly Bounced: "bounced";
|
|
6
7
|
};
|