sequenzy 2.1.16 → 2.1.23
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/abTests/client/requests/CreateAbTestsRequest.d.ts +5 -1
- package/dist/cjs/api/resources/abTests/client/requests/UpdateAbTestsRequest.d.ts +7 -1
- package/dist/cjs/api/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.d.ts +4 -1
- package/dist/cjs/api/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.js +4 -1
- package/dist/cjs/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.d.ts +3 -0
- package/dist/cjs/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.d.ts +13 -0
- package/dist/cjs/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.js +3 -0
- package/dist/cjs/api/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.d.ts +4 -1
- package/dist/cjs/api/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.js +4 -1
- package/dist/cjs/api/resources/abTests/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/abTests/types/index.js +1 -0
- package/dist/cjs/api/resources/sequences/client/requests/SequenceCreateRequest.d.ts +2 -0
- package/dist/cjs/api/resources/sequences/client/requests/SequenceUpdateRequest.d.ts +2 -0
- 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/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/types/AbTest.d.ts +6 -2
- package/dist/cjs/api/types/AbTestSignificance.d.ts +1 -1
- package/dist/cjs/api/types/AbTestSignificanceMetric.d.ts +4 -1
- package/dist/cjs/api/types/AbTestSignificanceMetric.js +4 -1
- package/dist/cjs/api/types/AbTestWinnerCriteria.d.ts +8 -0
- package/dist/cjs/api/types/AbTestWinnerCriteria.js +11 -0
- package/dist/cjs/api/types/AccountHealthInsight.d.ts +1 -1
- package/dist/cjs/api/types/SequenceCreateResponseSequence.d.ts +2 -0
- package/dist/cjs/api/types/SequenceSummary.d.ts +2 -0
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- package/dist/cjs/serialization/resources/abTests/client/requests/CreateAbTestsRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/abTests/client/requests/CreateAbTestsRequest.js +2 -0
- package/dist/cjs/serialization/resources/abTests/client/requests/UpdateAbTestsRequest.d.ts +3 -0
- package/dist/cjs/serialization/resources/abTests/client/requests/UpdateAbTestsRequest.js +3 -0
- package/dist/cjs/serialization/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.d.ts +1 -1
- package/dist/cjs/serialization/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.js +1 -1
- package/dist/cjs/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.d.ts +2 -0
- package/dist/cjs/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.js +2 -0
- package/dist/cjs/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.d.ts +13 -0
- package/dist/cjs/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.js +35 -0
- package/dist/cjs/serialization/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.d.ts +1 -1
- package/dist/cjs/serialization/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.js +1 -1
- package/dist/cjs/serialization/resources/abTests/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/abTests/types/index.js +1 -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/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/AbTest.d.ts +4 -1
- package/dist/cjs/serialization/types/AbTest.js +4 -1
- package/dist/cjs/serialization/types/AbTestSignificanceMetric.d.ts +1 -1
- package/dist/cjs/serialization/types/AbTestSignificanceMetric.js +1 -1
- package/dist/cjs/serialization/types/AbTestWinnerCriteria.d.ts +7 -0
- package/dist/cjs/serialization/types/AbTestWinnerCriteria.js +29 -0
- package/dist/cjs/serialization/types/SequenceCreateResponseSequence.d.ts +1 -0
- package/dist/cjs/serialization/types/SequenceCreateResponseSequence.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/index.d.ts +1 -0
- package/dist/cjs/serialization/types/index.js +1 -0
- package/dist/esm/api/resources/abTests/client/requests/CreateAbTestsRequest.d.ts +5 -1
- package/dist/esm/api/resources/abTests/client/requests/UpdateAbTestsRequest.d.ts +7 -1
- package/dist/esm/api/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.d.ts +4 -1
- package/dist/esm/api/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.js +4 -1
- package/dist/esm/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.d.ts +3 -0
- package/dist/esm/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.d.ts +13 -0
- package/dist/esm/api/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.js +2 -0
- package/dist/esm/api/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.d.ts +4 -1
- package/dist/esm/api/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.js +4 -1
- package/dist/esm/api/resources/abTests/types/index.d.ts +1 -0
- package/dist/esm/api/resources/abTests/types/index.js +1 -0
- package/dist/esm/api/resources/sequences/client/requests/SequenceCreateRequest.d.ts +2 -0
- package/dist/esm/api/resources/sequences/client/requests/SequenceUpdateRequest.d.ts +2 -0
- 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/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/types/AbTest.d.ts +6 -2
- package/dist/esm/api/types/AbTestSignificance.d.ts +1 -1
- package/dist/esm/api/types/AbTestSignificanceMetric.d.ts +4 -1
- package/dist/esm/api/types/AbTestSignificanceMetric.js +4 -1
- package/dist/esm/api/types/AbTestWinnerCriteria.d.ts +8 -0
- package/dist/esm/api/types/AbTestWinnerCriteria.js +8 -0
- package/dist/esm/api/types/AccountHealthInsight.d.ts +1 -1
- package/dist/esm/api/types/SequenceCreateResponseSequence.d.ts +2 -0
- package/dist/esm/api/types/SequenceSummary.d.ts +2 -0
- package/dist/esm/api/types/index.d.ts +1 -0
- package/dist/esm/api/types/index.js +1 -0
- package/dist/esm/serialization/resources/abTests/client/requests/CreateAbTestsRequest.d.ts +2 -0
- package/dist/esm/serialization/resources/abTests/client/requests/CreateAbTestsRequest.js +2 -0
- package/dist/esm/serialization/resources/abTests/client/requests/UpdateAbTestsRequest.d.ts +3 -0
- package/dist/esm/serialization/resources/abTests/client/requests/UpdateAbTestsRequest.js +3 -0
- package/dist/esm/serialization/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.d.ts +1 -1
- package/dist/esm/serialization/resources/abTests/types/CreateAbTestsRequestWinnerCriteria.js +1 -1
- package/dist/esm/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.d.ts +2 -0
- package/dist/esm/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItem.js +2 -0
- package/dist/esm/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.d.ts +13 -0
- package/dist/esm/serialization/resources/abTests/types/GetStatsAbTestsResponseVariantsItemOutcome.js +9 -0
- package/dist/esm/serialization/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.d.ts +1 -1
- package/dist/esm/serialization/resources/abTests/types/UpdateAbTestsRequestWinnerCriteria.js +1 -1
- package/dist/esm/serialization/resources/abTests/types/index.d.ts +1 -0
- package/dist/esm/serialization/resources/abTests/types/index.js +1 -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/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/AbTest.d.ts +4 -1
- package/dist/esm/serialization/types/AbTest.js +4 -1
- package/dist/esm/serialization/types/AbTestSignificanceMetric.d.ts +1 -1
- package/dist/esm/serialization/types/AbTestSignificanceMetric.js +1 -1
- package/dist/esm/serialization/types/AbTestWinnerCriteria.d.ts +7 -0
- package/dist/esm/serialization/types/AbTestWinnerCriteria.js +3 -0
- package/dist/esm/serialization/types/SequenceCreateResponseSequence.d.ts +1 -0
- package/dist/esm/serialization/types/SequenceCreateResponseSequence.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/index.d.ts +1 -0
- package/dist/esm/serialization/types/index.js +1 -0
- package/package.json +1 -1
|
@@ -37,6 +37,7 @@ const SequenceCreateRequestEmailStyle_js_1 = require("../../types/SequenceCreate
|
|
|
37
37
|
const SequenceCreateRequestInactivityBaseline_js_1 = require("../../types/SequenceCreateRequestInactivityBaseline.js");
|
|
38
38
|
const SequenceCreateRequestListScope_js_1 = require("../../types/SequenceCreateRequestListScope.js");
|
|
39
39
|
exports.SequenceCreateRequest = core.serialization.object({
|
|
40
|
+
activeSubscribersOnly: core.serialization.boolean().optional(),
|
|
40
41
|
bccEmails: core.serialization.list(core.serialization.string()).optionalNullable(),
|
|
41
42
|
customIntegration: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
|
|
42
43
|
description: core.serialization.string().optional(),
|
package/dist/cjs/serialization/resources/sequences/client/requests/SequenceUpdateRequest.d.ts
CHANGED
|
@@ -20,6 +20,7 @@ import { SequenceUpdateRequestListScope } from "../../types/SequenceUpdateReques
|
|
|
20
20
|
export declare const SequenceUpdateRequest: core.serialization.Schema<serializers.SequenceUpdateRequest.Raw, Omit<Sequenzy.SequenceUpdateRequest, "sequenceId">>;
|
|
21
21
|
export declare namespace SequenceUpdateRequest {
|
|
22
22
|
interface Raw {
|
|
23
|
+
activeSubscribersOnly?: boolean | null;
|
|
23
24
|
audienceAutoEnroll?: (SequenceAudienceAutoEnroll.Raw | null | undefined) | null;
|
|
24
25
|
bccEmails?: (string[] | null | undefined) | null;
|
|
25
26
|
branch?: SequenceBranchInput.Raw | null;
|
|
@@ -43,6 +43,7 @@ const SequenceTriggerType_js_1 = require("../../../../types/SequenceTriggerType.
|
|
|
43
43
|
const SequenceUpdateRequestInactivityBaseline_js_1 = require("../../types/SequenceUpdateRequestInactivityBaseline.js");
|
|
44
44
|
const SequenceUpdateRequestListScope_js_1 = require("../../types/SequenceUpdateRequestListScope.js");
|
|
45
45
|
exports.SequenceUpdateRequest = core.serialization.object({
|
|
46
|
+
activeSubscribersOnly: core.serialization.boolean().optional(),
|
|
46
47
|
audienceAutoEnroll: SequenceAudienceAutoEnroll_js_1.SequenceAudienceAutoEnroll.optionalNullable(),
|
|
47
48
|
bccEmails: core.serialization.list(core.serialization.string()).optionalNullable(),
|
|
48
49
|
branch: SequenceBranchInput_js_1.SequenceBranchInput.optional(),
|
|
@@ -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 UpdateByExternalIdPathSubscribersRequestStatus: core.serialization.Schema<serializers.UpdateByExternalIdPathSubscribersRequestStatus.Raw, Sequenzy.UpdateByExternalIdPathSubscribersRequestStatus>;
|
|
5
5
|
export declare namespace UpdateByExternalIdPathSubscribersRequestStatus {
|
|
6
|
-
type Raw = "active" | "unsubscribed" | "bounced";
|
|
6
|
+
type Raw = "active" | "unsubscribed" | "bounced" | "complained";
|
|
7
7
|
}
|
|
@@ -26,4 +26,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
26
26
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
27
|
exports.UpdateByExternalIdPathSubscribersRequestStatus = void 0;
|
|
28
28
|
const core = __importStar(require("../../../../core/index.js"));
|
|
29
|
-
exports.UpdateByExternalIdPathSubscribersRequestStatus = core.serialization.enum_(["active", "unsubscribed", "bounced"]);
|
|
29
|
+
exports.UpdateByExternalIdPathSubscribersRequestStatus = core.serialization.enum_(["active", "unsubscribed", "bounced", "complained"]);
|
|
@@ -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 UpdateByExternalIdSubscribersRequestStatus: core.serialization.Schema<serializers.UpdateByExternalIdSubscribersRequestStatus.Raw, Sequenzy.UpdateByExternalIdSubscribersRequestStatus>;
|
|
5
5
|
export declare namespace UpdateByExternalIdSubscribersRequestStatus {
|
|
6
|
-
type Raw = "active" | "unsubscribed" | "bounced";
|
|
6
|
+
type Raw = "active" | "unsubscribed" | "bounced" | "complained";
|
|
7
7
|
}
|
|
@@ -26,4 +26,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
26
26
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
27
|
exports.UpdateByExternalIdSubscribersRequestStatus = void 0;
|
|
28
28
|
const core = __importStar(require("../../../../core/index.js"));
|
|
29
|
-
exports.UpdateByExternalIdSubscribersRequestStatus = core.serialization.enum_(["active", "unsubscribed", "bounced"]);
|
|
29
|
+
exports.UpdateByExternalIdSubscribersRequestStatus = core.serialization.enum_(["active", "unsubscribed", "bounced", "complained"]);
|
package/dist/cjs/serialization/resources/subscribers/types/UpdateSubscribersRequestStatus.d.ts
CHANGED
|
@@ -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 UpdateSubscribersRequestStatus: core.serialization.Schema<serializers.UpdateSubscribersRequestStatus.Raw, Sequenzy.UpdateSubscribersRequestStatus>;
|
|
5
5
|
export declare namespace UpdateSubscribersRequestStatus {
|
|
6
|
-
type Raw = "active" | "unsubscribed" | "bounced";
|
|
6
|
+
type Raw = "active" | "unsubscribed" | "bounced" | "complained";
|
|
7
7
|
}
|
package/dist/cjs/serialization/resources/subscribers/types/UpdateSubscribersRequestStatus.js
CHANGED
|
@@ -26,4 +26,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
26
26
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
27
|
exports.UpdateSubscribersRequestStatus = void 0;
|
|
28
28
|
const core = __importStar(require("../../../../core/index.js"));
|
|
29
|
-
exports.UpdateSubscribersRequestStatus = core.serialization.enum_(["active", "unsubscribed", "bounced"]);
|
|
29
|
+
exports.UpdateSubscribersRequestStatus = core.serialization.enum_(["active", "unsubscribed", "bounced", "complained"]);
|
|
@@ -6,6 +6,7 @@ import { AbTestPendingSampleUpdate } from "./AbTestPendingSampleUpdate.js";
|
|
|
6
6
|
import { AbTestProgress } from "./AbTestProgress.js";
|
|
7
7
|
import { AbTestTestType } from "./AbTestTestType.js";
|
|
8
8
|
import { AbTestVariant } from "./AbTestVariant.js";
|
|
9
|
+
import { AbTestWinnerCriteria } from "./AbTestWinnerCriteria.js";
|
|
9
10
|
export declare const AbTest: core.serialization.ObjectSchema<serializers.AbTest.Raw, Sequenzy.AbTest>;
|
|
10
11
|
export declare namespace AbTest {
|
|
11
12
|
interface Raw {
|
|
@@ -28,7 +29,9 @@ export declare namespace AbTest {
|
|
|
28
29
|
testType?: AbTestTestType.Raw | null;
|
|
29
30
|
updatedAt?: string | null;
|
|
30
31
|
variants?: AbTestVariant.Raw[] | null;
|
|
31
|
-
winnerCriteria?:
|
|
32
|
+
winnerCriteria?: AbTestWinnerCriteria.Raw | null;
|
|
33
|
+
winnerEventName?: (string | null | undefined) | null;
|
|
34
|
+
winnerGoalId?: (string | null | undefined) | null;
|
|
32
35
|
winnerSelectedAt?: (string | null | undefined) | null;
|
|
33
36
|
winnerThreshold?: number | null;
|
|
34
37
|
winningVariantId?: (string | null | undefined) | null;
|
|
@@ -31,6 +31,7 @@ const AbTestPendingSampleUpdate_js_1 = require("./AbTestPendingSampleUpdate.js")
|
|
|
31
31
|
const AbTestProgress_js_1 = require("./AbTestProgress.js");
|
|
32
32
|
const AbTestTestType_js_1 = require("./AbTestTestType.js");
|
|
33
33
|
const AbTestVariant_js_1 = require("./AbTestVariant.js");
|
|
34
|
+
const AbTestWinnerCriteria_js_1 = require("./AbTestWinnerCriteria.js");
|
|
34
35
|
exports.AbTest = core.serialization.object({
|
|
35
36
|
automationNodeId: core.serialization.string().optionalNullable(),
|
|
36
37
|
autoSelectWinner: core.serialization.boolean().optional(),
|
|
@@ -51,7 +52,9 @@ exports.AbTest = core.serialization.object({
|
|
|
51
52
|
testType: AbTestTestType_js_1.AbTestTestType.optional(),
|
|
52
53
|
updatedAt: core.serialization.date().optional(),
|
|
53
54
|
variants: core.serialization.list(AbTestVariant_js_1.AbTestVariant).optional(),
|
|
54
|
-
winnerCriteria:
|
|
55
|
+
winnerCriteria: AbTestWinnerCriteria_js_1.AbTestWinnerCriteria.optional(),
|
|
56
|
+
winnerEventName: core.serialization.string().optionalNullable(),
|
|
57
|
+
winnerGoalId: core.serialization.string().optionalNullable(),
|
|
55
58
|
winnerSelectedAt: core.serialization.date().optionalNullable(),
|
|
56
59
|
winnerThreshold: core.serialization.number().optional(),
|
|
57
60
|
winningVariantId: core.serialization.string().optionalNullable(),
|
|
@@ -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 AbTestSignificanceMetric: core.serialization.Schema<serializers.AbTestSignificanceMetric.Raw, Sequenzy.AbTestSignificanceMetric>;
|
|
5
5
|
export declare namespace AbTestSignificanceMetric {
|
|
6
|
-
type Raw = "open_rate" | "click_rate";
|
|
6
|
+
type Raw = "open_rate" | "click_rate" | "goal_conversion_rate" | "goal_value" | "event_rate";
|
|
7
7
|
}
|
|
@@ -26,4 +26,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
26
26
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
27
|
exports.AbTestSignificanceMetric = void 0;
|
|
28
28
|
const core = __importStar(require("../../core/index.js"));
|
|
29
|
-
exports.AbTestSignificanceMetric = core.serialization.enum_(["open_rate", "click_rate"]);
|
|
29
|
+
exports.AbTestSignificanceMetric = core.serialization.enum_(["open_rate", "click_rate", "goal_conversion_rate", "goal_value", "event_rate"]);
|
|
@@ -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 AbTestWinnerCriteria: core.serialization.Schema<serializers.AbTestWinnerCriteria.Raw, Sequenzy.AbTestWinnerCriteria>;
|
|
5
|
+
export declare namespace AbTestWinnerCriteria {
|
|
6
|
+
type Raw = "open_rate" | "click_rate" | "goal_conversion_rate" | "goal_value" | "event_rate";
|
|
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.AbTestWinnerCriteria = void 0;
|
|
28
|
+
const core = __importStar(require("../../core/index.js"));
|
|
29
|
+
exports.AbTestWinnerCriteria = core.serialization.enum_(["open_rate", "click_rate", "goal_conversion_rate", "goal_value", "event_rate"]);
|
|
@@ -10,6 +10,7 @@ export declare const SequenceCreateResponseSequence: core.serialization.ObjectSc
|
|
|
10
10
|
export declare namespace SequenceCreateResponseSequence {
|
|
11
11
|
interface Raw {
|
|
12
12
|
acceptsNewEnrollments?: boolean | null;
|
|
13
|
+
activeSubscribersOnly?: boolean | null;
|
|
13
14
|
discountCount?: number | null;
|
|
14
15
|
effectiveStatus?: SequenceEffectiveStatus.Raw | null;
|
|
15
16
|
effectiveStatusSummary?: string | null;
|
|
@@ -33,6 +33,7 @@ const SequenceStatus_js_1 = require("./SequenceStatus.js");
|
|
|
33
33
|
const SequenceStopCondition_js_1 = require("./SequenceStopCondition.js");
|
|
34
34
|
exports.SequenceCreateResponseSequence = core.serialization.object({
|
|
35
35
|
acceptsNewEnrollments: core.serialization.boolean().optional(),
|
|
36
|
+
activeSubscribersOnly: core.serialization.boolean().optional(),
|
|
36
37
|
discountCount: core.serialization.number().optional(),
|
|
37
38
|
effectiveStatus: SequenceEffectiveStatus_js_1.SequenceEffectiveStatus.optional(),
|
|
38
39
|
effectiveStatusSummary: core.serialization.string().optional(),
|
|
@@ -11,6 +11,7 @@ export declare const SequenceSummary: core.serialization.ObjectSchema<serializer
|
|
|
11
11
|
export declare namespace SequenceSummary {
|
|
12
12
|
interface Raw {
|
|
13
13
|
acceptsNewEnrollments?: boolean | null;
|
|
14
|
+
activeSubscribersOnly?: boolean | null;
|
|
14
15
|
audienceAutoEnroll?: (SequenceAudienceAutoEnroll.Raw | null | undefined) | null;
|
|
15
16
|
bccEmails?: (string[] | null | undefined) | null;
|
|
16
17
|
createdAt?: string | null;
|
|
@@ -34,6 +34,7 @@ const SequenceStatus_js_1 = require("./SequenceStatus.js");
|
|
|
34
34
|
const SequenceSummaryPausedByUser_js_1 = require("./SequenceSummaryPausedByUser.js");
|
|
35
35
|
exports.SequenceSummary = core.serialization.object({
|
|
36
36
|
acceptsNewEnrollments: core.serialization.boolean().optional(),
|
|
37
|
+
activeSubscribersOnly: core.serialization.boolean().optional(),
|
|
37
38
|
audienceAutoEnroll: SequenceAudienceAutoEnroll_js_1.SequenceAudienceAutoEnroll.optionalNullable(),
|
|
38
39
|
bccEmails: core.serialization.list(core.serialization.string()).optionalNullable(),
|
|
39
40
|
createdAt: core.serialization.date().optional(),
|
|
@@ -9,6 +9,7 @@ export * from "./AbTestSignificanceMetric.js";
|
|
|
9
9
|
export * from "./AbTestSignificanceStatus.js";
|
|
10
10
|
export * from "./AbTestTestType.js";
|
|
11
11
|
export * from "./AbTestVariant.js";
|
|
12
|
+
export * from "./AbTestWinnerCriteria.js";
|
|
12
13
|
export * from "./Account.js";
|
|
13
14
|
export * from "./AccountEvent.js";
|
|
14
15
|
export * from "./AccountHealthAction.js";
|
|
@@ -25,6 +25,7 @@ __exportStar(require("./AbTestSignificanceMetric.js"), exports);
|
|
|
25
25
|
__exportStar(require("./AbTestSignificanceStatus.js"), exports);
|
|
26
26
|
__exportStar(require("./AbTestTestType.js"), exports);
|
|
27
27
|
__exportStar(require("./AbTestVariant.js"), exports);
|
|
28
|
+
__exportStar(require("./AbTestWinnerCriteria.js"), exports);
|
|
28
29
|
__exportStar(require("./Account.js"), exports);
|
|
29
30
|
__exportStar(require("./AccountEvent.js"), exports);
|
|
30
31
|
__exportStar(require("./AccountHealthAction.js"), exports);
|
|
@@ -20,8 +20,12 @@ export interface CreateAbTestsRequest {
|
|
|
20
20
|
testType?: Sequenzy.CreateAbTestsRequestTestType;
|
|
21
21
|
/** Extra variants beyond the control. Required (min 1) when converting with automationNodeId. Total variants cannot exceed 5. */
|
|
22
22
|
variants?: Sequenzy.CreateAbTestsRequestVariantsItem[];
|
|
23
|
-
/** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. */
|
|
23
|
+
/** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. `goal_conversion_rate` picks the variant whose recipients convert on `winnerGoalId` most often per delivered email, `goal_value` the one with the most goal value per delivered email, and `event_rate` the one whose recipients most often fire `winnerEventName` after receiving it. Goal conversions count when attributed to the email (an open or click within the goal's attribution window; for campaigns, revenue and campaign goals also credit a recipient who received the email in that window). When no variant converts, campaign tests fall back to click rate and sequence tests keep splitting contacts. */
|
|
24
24
|
winnerCriteria?: Sequenzy.CreateAbTestsRequestWinnerCriteria;
|
|
25
|
+
/** Required for `event_rate`. The event a recipient must fire after receiving the variant. */
|
|
26
|
+
winnerEventName?: string | null;
|
|
27
|
+
/** Required for `goal_conversion_rate` and `goal_value`. A goal ID that is active and company-wide or scoped to this campaign or sequence, or `default-revenue` for built-in purchase revenue (SaaS purchases and commerce orders, in cents). Other goals return 400. */
|
|
28
|
+
winnerGoalId?: string | null;
|
|
25
29
|
/** Number of sequence recipients in the test sample. */
|
|
26
30
|
winnerThreshold?: number;
|
|
27
31
|
}
|
|
@@ -14,6 +14,8 @@ export interface UpdateAbTestsRequest {
|
|
|
14
14
|
cancelSampleUpdate?: boolean;
|
|
15
15
|
/** Required when sequence settings affect an active test or a test with recorded activity. */
|
|
16
16
|
confirmLiveChange?: boolean;
|
|
17
|
+
/** Campaign-only. End a running test now: the winner is picked by winnerCriteria from the results so far and sent to the remaining audience. Requires campaigns:send. Cannot be combined with testDurationMinutes; returns 400 for tests that are not running and 409 while a sample change is pending. */
|
|
18
|
+
endTestNow?: boolean;
|
|
17
19
|
/** Optional campaign revision from GET; stale values return 409. Omit to preserve existing unconditional update behavior. */
|
|
18
20
|
expectedUpdatedAt?: Date;
|
|
19
21
|
name?: string;
|
|
@@ -23,8 +25,12 @@ export interface UpdateAbTestsRequest {
|
|
|
23
25
|
testPercentage?: number;
|
|
24
26
|
/** Sequence-only variant strategy. */
|
|
25
27
|
testType?: Sequenzy.UpdateAbTestsRequestTestType;
|
|
26
|
-
/** Winner metric for campaign or sequence tests; immutable once campaign testing starts. */
|
|
28
|
+
/** Winner metric for campaign or sequence tests; immutable once campaign testing starts, together with winnerGoalId and winnerEventName. Changing the criterion clears a goal or event the new criterion does not use. */
|
|
27
29
|
winnerCriteria?: Sequenzy.UpdateAbTestsRequestWinnerCriteria;
|
|
30
|
+
/** Required for `event_rate`. The event a recipient must fire after receiving the variant. */
|
|
31
|
+
winnerEventName?: string | null;
|
|
32
|
+
/** Required for `goal_conversion_rate` and `goal_value`. A goal ID that is active and company-wide or scoped to this campaign or sequence, or `default-revenue` for built-in purchase revenue (SaaS purchases and commerce orders, in cents). Other goals return 400. */
|
|
33
|
+
winnerGoalId?: string | null;
|
|
28
34
|
/** Sequence-only recipient threshold. */
|
|
29
35
|
winnerThreshold?: number;
|
|
30
36
|
}
|
|
@@ -1,6 +1,9 @@
|
|
|
1
|
-
/** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. */
|
|
1
|
+
/** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. `goal_conversion_rate` picks the variant whose recipients convert on `winnerGoalId` most often per delivered email, `goal_value` the one with the most goal value per delivered email, and `event_rate` the one whose recipients most often fire `winnerEventName` after receiving it. Goal conversions count when attributed to the email (an open or click within the goal's attribution window; for campaigns, revenue and campaign goals also credit a recipient who received the email in that window). When no variant converts, campaign tests fall back to click rate and sequence tests keep splitting contacts. */
|
|
2
2
|
export declare const CreateAbTestsRequestWinnerCriteria: {
|
|
3
3
|
readonly OpenRate: "open_rate";
|
|
4
4
|
readonly ClickRate: "click_rate";
|
|
5
|
+
readonly GoalConversionRate: "goal_conversion_rate";
|
|
6
|
+
readonly GoalValue: "goal_value";
|
|
7
|
+
readonly EventRate: "event_rate";
|
|
5
8
|
};
|
|
6
9
|
export type CreateAbTestsRequestWinnerCriteria = (typeof CreateAbTestsRequestWinnerCriteria)[keyof typeof CreateAbTestsRequestWinnerCriteria];
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. */
|
|
2
|
+
/** Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default. `goal_conversion_rate` picks the variant whose recipients convert on `winnerGoalId` most often per delivered email, `goal_value` the one with the most goal value per delivered email, and `event_rate` the one whose recipients most often fire `winnerEventName` after receiving it. Goal conversions count when attributed to the email (an open or click within the goal's attribution window; for campaigns, revenue and campaign goals also credit a recipient who received the email in that window). When no variant converts, campaign tests fall back to click rate and sequence tests keep splitting contacts. */
|
|
3
3
|
export const CreateAbTestsRequestWinnerCriteria = {
|
|
4
4
|
OpenRate: "open_rate",
|
|
5
5
|
ClickRate: "click_rate",
|
|
6
|
+
GoalConversionRate: "goal_conversion_rate",
|
|
7
|
+
GoalValue: "goal_value",
|
|
8
|
+
EventRate: "event_rate",
|
|
6
9
|
};
|
|
@@ -1,7 +1,10 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../../index.js";
|
|
1
2
|
export interface GetStatsAbTestsResponseVariantsItem {
|
|
2
3
|
id?: string;
|
|
3
4
|
isWinner?: boolean;
|
|
4
5
|
label?: string;
|
|
6
|
+
/** Present when the test is judged on a goal or event. Covers every send of the test, whatever the requested period. */
|
|
7
|
+
outcome?: Sequenzy.GetStatsAbTestsResponseVariantsItemOutcome;
|
|
5
8
|
stats?: Record<string, unknown>;
|
|
6
9
|
subject?: string;
|
|
7
10
|
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Present when the test is judged on a goal or event. Covers every send of the test, whatever the requested period.
|
|
3
|
+
*/
|
|
4
|
+
export interface GetStatsAbTestsResponseVariantsItemOutcome {
|
|
5
|
+
/** convertedRecipients per delivered email, as a percentage. */
|
|
6
|
+
conversionRate?: number;
|
|
7
|
+
/** Recipients with an attributed goal conversion, or who fired the event after their send. */
|
|
8
|
+
convertedRecipients?: number;
|
|
9
|
+
deliveries?: number;
|
|
10
|
+
/** Summed tracked goal value, such as revenue in cents. Refunds lower it. 0 for events. */
|
|
11
|
+
value?: number;
|
|
12
|
+
valuePerDelivery?: number;
|
|
13
|
+
}
|
|
@@ -1,6 +1,9 @@
|
|
|
1
|
-
/** Winner metric for campaign or sequence tests; immutable once campaign testing starts. */
|
|
1
|
+
/** Winner metric for campaign or sequence tests; immutable once campaign testing starts, together with winnerGoalId and winnerEventName. Changing the criterion clears a goal or event the new criterion does not use. */
|
|
2
2
|
export declare const UpdateAbTestsRequestWinnerCriteria: {
|
|
3
3
|
readonly OpenRate: "open_rate";
|
|
4
4
|
readonly ClickRate: "click_rate";
|
|
5
|
+
readonly GoalConversionRate: "goal_conversion_rate";
|
|
6
|
+
readonly GoalValue: "goal_value";
|
|
7
|
+
readonly EventRate: "event_rate";
|
|
5
8
|
};
|
|
6
9
|
export type UpdateAbTestsRequestWinnerCriteria = (typeof UpdateAbTestsRequestWinnerCriteria)[keyof typeof UpdateAbTestsRequestWinnerCriteria];
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/** Winner metric for campaign or sequence tests; immutable once campaign testing starts. */
|
|
2
|
+
/** Winner metric for campaign or sequence tests; immutable once campaign testing starts, together with winnerGoalId and winnerEventName. Changing the criterion clears a goal or event the new criterion does not use. */
|
|
3
3
|
export const UpdateAbTestsRequestWinnerCriteria = {
|
|
4
4
|
OpenRate: "open_rate",
|
|
5
5
|
ClickRate: "click_rate",
|
|
6
|
+
GoalConversionRate: "goal_conversion_rate",
|
|
7
|
+
GoalValue: "goal_value",
|
|
8
|
+
EventRate: "event_rate",
|
|
6
9
|
};
|
|
@@ -9,6 +9,7 @@ export * from "./GetAbTestsResponse.js";
|
|
|
9
9
|
export * from "./GetStatsAbTestsRequestPeriod.js";
|
|
10
10
|
export * from "./GetStatsAbTestsResponse.js";
|
|
11
11
|
export * from "./GetStatsAbTestsResponseVariantsItem.js";
|
|
12
|
+
export * from "./GetStatsAbTestsResponseVariantsItemOutcome.js";
|
|
12
13
|
export * from "./ListAbTestsResponse.js";
|
|
13
14
|
export * from "./RestartAbTestsRequestTestType.js";
|
|
14
15
|
export * from "./RestartAbTestsResponse.js";
|
|
@@ -9,6 +9,7 @@ export * from "./GetAbTestsResponse.js";
|
|
|
9
9
|
export * from "./GetStatsAbTestsRequestPeriod.js";
|
|
10
10
|
export * from "./GetStatsAbTestsResponse.js";
|
|
11
11
|
export * from "./GetStatsAbTestsResponseVariantsItem.js";
|
|
12
|
+
export * from "./GetStatsAbTestsResponseVariantsItemOutcome.js";
|
|
12
13
|
export * from "./ListAbTestsResponse.js";
|
|
13
14
|
export * from "./RestartAbTestsRequestTestType.js";
|
|
14
15
|
export * from "./RestartAbTestsResponse.js";
|
|
@@ -106,6 +106,8 @@ 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 bounced contacts still enter on tag, event, list and contact triggers so non-marketing steps run for them, and their marketing emails are skipped at send time. Pending double opt-in contacts still wait for confirmation. */
|
|
110
|
+
activeSubscribersOnly?: boolean;
|
|
109
111
|
/** Addresses blind-copied on every sequence email. */
|
|
110
112
|
bccEmails?: string[] | null;
|
|
111
113
|
/** Custom inbound-webhook integration metadata. */
|
|
@@ -165,6 +165,8 @@ 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 bounced contacts still enter on tag, event, list and contact triggers so non-marketing steps run for them, and their marketing emails are skipped at send time. Pending double opt-in contacts still wait for confirmation. */
|
|
169
|
+
activeSubscribersOnly?: boolean;
|
|
168
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"). */
|
|
169
171
|
audienceAutoEnroll?: Sequenzy.SequenceAudienceAutoEnroll | null;
|
|
170
172
|
/** Email addresses that receive a blind copy of every email this sequence sends, such as a customer support inbox (max 10). Set to null to remove them. */
|
|
@@ -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 the unsubscribe workflow. */
|
|
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. */
|
|
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 the unsubscribe workflow. */
|
|
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. */
|
|
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. */
|
|
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. */
|
|
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. */
|
package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdPathSubscribersRequestStatus.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
/** Setting `unsubscribed` performs the unsubscribe workflow. */
|
|
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. */
|
|
2
2
|
export declare const UpdateByExternalIdPathSubscribersRequestStatus: {
|
|
3
3
|
readonly Active: "active";
|
|
4
4
|
readonly Unsubscribed: "unsubscribed";
|
|
5
5
|
readonly Bounced: "bounced";
|
|
6
|
+
readonly Complained: "complained";
|
|
6
7
|
};
|
|
7
8
|
export type UpdateByExternalIdPathSubscribersRequestStatus = (typeof UpdateByExternalIdPathSubscribersRequestStatus)[keyof typeof UpdateByExternalIdPathSubscribersRequestStatus];
|
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 the unsubscribe workflow. */
|
|
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. */
|
|
3
3
|
export const UpdateByExternalIdPathSubscribersRequestStatus = {
|
|
4
4
|
Active: "active",
|
|
5
5
|
Unsubscribed: "unsubscribed",
|
|
6
6
|
Bounced: "bounced",
|
|
7
|
+
Complained: "complained",
|
|
7
8
|
};
|
package/dist/esm/api/resources/subscribers/types/UpdateByExternalIdSubscribersRequestStatus.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
/** Setting `unsubscribed` performs the unsubscribe workflow. */
|
|
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. */
|
|
2
2
|
export declare const UpdateByExternalIdSubscribersRequestStatus: {
|
|
3
3
|
readonly Active: "active";
|
|
4
4
|
readonly Unsubscribed: "unsubscribed";
|
|
5
5
|
readonly Bounced: "bounced";
|
|
6
|
+
readonly Complained: "complained";
|
|
6
7
|
};
|
|
7
8
|
export type UpdateByExternalIdSubscribersRequestStatus = (typeof UpdateByExternalIdSubscribersRequestStatus)[keyof typeof UpdateByExternalIdSubscribersRequestStatus];
|
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 the unsubscribe workflow. */
|
|
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. */
|
|
3
3
|
export const UpdateByExternalIdSubscribersRequestStatus = {
|
|
4
4
|
Active: "active",
|
|
5
5
|
Unsubscribed: "unsubscribed",
|
|
6
6
|
Bounced: "bounced",
|
|
7
|
+
Complained: "complained",
|
|
7
8
|
};
|
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
/** Setting `unsubscribed` performs a full global unsubscribe. */
|
|
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. */
|
|
2
2
|
export declare const UpdateSubscribersRequestStatus: {
|
|
3
3
|
readonly Active: "active";
|
|
4
4
|
readonly Unsubscribed: "unsubscribed";
|
|
5
5
|
readonly Bounced: "bounced";
|
|
6
|
+
readonly Complained: "complained";
|
|
6
7
|
};
|
|
7
8
|
export type UpdateSubscribersRequestStatus = (typeof UpdateSubscribersRequestStatus)[keyof typeof UpdateSubscribersRequestStatus];
|
|
@@ -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. */
|
|
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. */
|
|
3
3
|
export const UpdateSubscribersRequestStatus = {
|
|
4
4
|
Active: "active",
|
|
5
5
|
Unsubscribed: "unsubscribed",
|
|
6
6
|
Bounced: "bounced",
|
|
7
|
+
Complained: "complained",
|
|
7
8
|
};
|
|
@@ -14,7 +14,7 @@ export interface AbTest {
|
|
|
14
14
|
pendingSampleUpdate?: Sequenzy.AbTestPendingSampleUpdate | null;
|
|
15
15
|
/** Present on campaign detail and settings responses. Null if the campaign is missing. Counts unique recipient deliveries across retry attempts, excluding separate test emails. */
|
|
16
16
|
progress?: Sequenzy.AbTestProgress | null;
|
|
17
|
-
/** Effective settings for this test kind. Campaign tests return testPercentage, testDurationMinutes, and
|
|
17
|
+
/** Effective settings for this test kind. Campaign tests return testPercentage, testDurationMinutes, winnerCriteria, winnerGoalId, and winnerEventName; sequence tests return testType, winnerThreshold, winnerCriteria, winnerGoalId, and winnerEventName. */
|
|
18
18
|
settings?: Record<string, unknown>;
|
|
19
19
|
status?: string;
|
|
20
20
|
/** Campaign test duration. Sequence tests retain the legacy internal sentinel value 0; use settings instead. */
|
|
@@ -27,7 +27,11 @@ export interface AbTest {
|
|
|
27
27
|
testType?: Sequenzy.AbTestTestType;
|
|
28
28
|
updatedAt?: Date;
|
|
29
29
|
variants?: Sequenzy.AbTestVariant[];
|
|
30
|
-
winnerCriteria?:
|
|
30
|
+
winnerCriteria?: Sequenzy.AbTestWinnerCriteria;
|
|
31
|
+
/** Event judged by `event_rate`. Null for other criteria. */
|
|
32
|
+
winnerEventName?: string | null;
|
|
33
|
+
/** Goal judged by `goal_conversion_rate` or `goal_value` (a goal ID or `default-revenue`). Null for other criteria. */
|
|
34
|
+
winnerGoalId?: string | null;
|
|
31
35
|
winnerSelectedAt?: Date | null;
|
|
32
36
|
/** Effective sequence recipient threshold. Present for sequence tests. */
|
|
33
37
|
winnerThreshold?: number;
|
|
@@ -10,7 +10,7 @@ export interface AbTestSignificance {
|
|
|
10
10
|
/** Variant with the highest rate, or null when the top variants are tied. */
|
|
11
11
|
leaderVariantId: string | null;
|
|
12
12
|
leaderVariantLabel: string | null;
|
|
13
|
-
/** Metric compared, taken from the test's winner criteria. */
|
|
13
|
+
/** Metric compared, taken from the test's winner criteria. Goal and event criteria compare whether recipients converted; `goal_value` does too, since value has no yes/no outcome per recipient. */
|
|
14
14
|
metric: Sequenzy.AbTestSignificanceMetric;
|
|
15
15
|
/** Corrected two-sided p-value of the weakest leader comparison. Very strong results can round to exactly 0. Null while data is insufficient. */
|
|
16
16
|
pValue: number | null;
|
|
@@ -1,6 +1,9 @@
|
|
|
1
|
-
/** Metric compared, taken from the test's winner criteria. */
|
|
1
|
+
/** Metric compared, taken from the test's winner criteria. Goal and event criteria compare whether recipients converted; `goal_value` does too, since value has no yes/no outcome per recipient. */
|
|
2
2
|
export declare const AbTestSignificanceMetric: {
|
|
3
3
|
readonly OpenRate: "open_rate";
|
|
4
4
|
readonly ClickRate: "click_rate";
|
|
5
|
+
readonly GoalConversionRate: "goal_conversion_rate";
|
|
6
|
+
readonly GoalValue: "goal_value";
|
|
7
|
+
readonly EventRate: "event_rate";
|
|
5
8
|
};
|
|
6
9
|
export type AbTestSignificanceMetric = (typeof AbTestSignificanceMetric)[keyof typeof AbTestSignificanceMetric];
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
/** Metric compared, taken from the test's winner criteria. */
|
|
2
|
+
/** Metric compared, taken from the test's winner criteria. Goal and event criteria compare whether recipients converted; `goal_value` does too, since value has no yes/no outcome per recipient. */
|
|
3
3
|
export const AbTestSignificanceMetric = {
|
|
4
4
|
OpenRate: "open_rate",
|
|
5
5
|
ClickRate: "click_rate",
|
|
6
|
+
GoalConversionRate: "goal_conversion_rate",
|
|
7
|
+
GoalValue: "goal_value",
|
|
8
|
+
EventRate: "event_rate",
|
|
6
9
|
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export declare const AbTestWinnerCriteria: {
|
|
2
|
+
readonly OpenRate: "open_rate";
|
|
3
|
+
readonly ClickRate: "click_rate";
|
|
4
|
+
readonly GoalConversionRate: "goal_conversion_rate";
|
|
5
|
+
readonly GoalValue: "goal_value";
|
|
6
|
+
readonly EventRate: "event_rate";
|
|
7
|
+
};
|
|
8
|
+
export type AbTestWinnerCriteria = (typeof AbTestWinnerCriteria)[keyof typeof AbTestWinnerCriteria];
|
|
@@ -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; 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`. */
|
|
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;
|
|
@@ -2,6 +2,8 @@ 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 bounced contacts still enter and only their marketing emails are skipped. */
|
|
6
|
+
activeSubscribersOnly?: boolean;
|
|
5
7
|
discountCount?: number;
|
|
6
8
|
effectiveStatus?: Sequenzy.SequenceEffectiveStatus;
|
|
7
9
|
/** One plain-language sentence describing the run state, safe to show a user verbatim. */
|