sequenzy 2.1.80 → 2.1.82
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/types/SequenceInboundWebhook.d.ts +2 -0
- package/dist/cjs/api/types/SequenceInboundWebhookFieldMapping.d.ts +1 -1
- package/dist/cjs/api/types/SequenceInboundWebhookMappingCheck.d.ts +7 -0
- package/dist/cjs/api/types/SequenceInboundWebhookMappingCheck.js +3 -0
- package/dist/cjs/api/types/SequenceInboundWebhookMappingCheckMissingFieldsItem.d.ts +5 -0
- package/dist/cjs/api/types/SequenceInboundWebhookMappingCheckMissingFieldsItem.js +3 -0
- package/dist/cjs/api/types/SequenceInboundWebhookMappingCheckStatus.d.ts +7 -0
- package/dist/cjs/api/types/SequenceInboundWebhookMappingCheckStatus.js +10 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -0
- package/dist/cjs/serialization/types/SequenceInboundWebhook.d.ts +2 -0
- package/dist/cjs/serialization/types/SequenceInboundWebhook.js +2 -0
- package/dist/cjs/serialization/types/SequenceInboundWebhookMappingCheck.d.ts +12 -0
- package/dist/cjs/serialization/types/SequenceInboundWebhookMappingCheck.js +34 -0
- package/dist/cjs/serialization/types/SequenceInboundWebhookMappingCheckMissingFieldsItem.d.ts +10 -0
- package/dist/cjs/serialization/types/SequenceInboundWebhookMappingCheckMissingFieldsItem.js +32 -0
- package/dist/cjs/serialization/types/SequenceInboundWebhookMappingCheckStatus.d.ts +7 -0
- package/dist/cjs/serialization/types/SequenceInboundWebhookMappingCheckStatus.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/types/SequenceInboundWebhook.d.ts +2 -0
- package/dist/esm/api/types/SequenceInboundWebhookFieldMapping.d.ts +1 -1
- package/dist/esm/api/types/SequenceInboundWebhookMappingCheck.d.ts +7 -0
- package/dist/esm/api/types/SequenceInboundWebhookMappingCheck.js +2 -0
- package/dist/esm/api/types/SequenceInboundWebhookMappingCheckMissingFieldsItem.d.ts +5 -0
- package/dist/esm/api/types/SequenceInboundWebhookMappingCheckMissingFieldsItem.js +2 -0
- package/dist/esm/api/types/SequenceInboundWebhookMappingCheckStatus.d.ts +7 -0
- package/dist/esm/api/types/SequenceInboundWebhookMappingCheckStatus.js +7 -0
- package/dist/esm/api/types/index.d.ts +3 -0
- package/dist/esm/api/types/index.js +3 -0
- package/dist/esm/serialization/types/SequenceInboundWebhook.d.ts +2 -0
- package/dist/esm/serialization/types/SequenceInboundWebhook.js +2 -0
- package/dist/esm/serialization/types/SequenceInboundWebhookMappingCheck.d.ts +12 -0
- package/dist/esm/serialization/types/SequenceInboundWebhookMappingCheck.js +8 -0
- package/dist/esm/serialization/types/SequenceInboundWebhookMappingCheckMissingFieldsItem.d.ts +10 -0
- package/dist/esm/serialization/types/SequenceInboundWebhookMappingCheckMissingFieldsItem.js +6 -0
- package/dist/esm/serialization/types/SequenceInboundWebhookMappingCheckStatus.d.ts +7 -0
- package/dist/esm/serialization/types/SequenceInboundWebhookMappingCheckStatus.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
|
@@ -4,6 +4,8 @@ export interface SequenceInboundWebhook {
|
|
|
4
4
|
eventName?: string;
|
|
5
5
|
fieldMapping?: Sequenzy.SequenceInboundWebhookFieldMapping | null;
|
|
6
6
|
id?: string;
|
|
7
|
+
/** Whether the field mapping finds an email in the last payload received, or in a sample saved through this endpoint. An example sample applied from the integration catalog on first setup is not checked. The endpoint answers 200 to every payload it can parse, but skips one without a valid email and creates no subscriber, so a mapping with status email_not_found means received webhooks are being skipped. Null when no mapping is saved. */
|
|
8
|
+
mappingCheck?: Sequenzy.SequenceInboundWebhookMappingCheck | null;
|
|
7
9
|
sampleCapturedAt?: Date | null;
|
|
8
10
|
samplePayload?: Record<string, unknown> | null;
|
|
9
11
|
/** Secret URL token. Treat it as a credential. */
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export interface SequenceInboundWebhookFieldMapping {
|
|
2
|
-
/** Dot path to the subscriber email in the webhook payload. */
|
|
2
|
+
/** Dot path to the subscriber email in the webhook payload. A key that itself contains dots, such as `data.user_email`, is matched as one key, so `properties.data.user_email` reads `{"properties": {"data.user_email": "..."}}`. */
|
|
3
3
|
email: string;
|
|
4
4
|
firstName?: string;
|
|
5
5
|
lastName?: string;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as Sequenzy from "../index.js";
|
|
2
|
+
export interface SequenceInboundWebhookMappingCheck {
|
|
3
|
+
/** Mapped fields whose path does not exist in the saved sample. */
|
|
4
|
+
missingFields: Sequenzy.SequenceInboundWebhookMappingCheckMissingFieldsItem[];
|
|
5
|
+
/** `ok`: the email path holds a valid address. `email_not_found`: it is missing or not a valid address. `no_sample`: no payload has been received or saved yet. */
|
|
6
|
+
status: Sequenzy.SequenceInboundWebhookMappingCheckStatus;
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** `ok`: the email path holds a valid address. `email_not_found`: it is missing or not a valid address. `no_sample`: no payload has been received or saved yet. */
|
|
2
|
+
export declare const SequenceInboundWebhookMappingCheckStatus: {
|
|
3
|
+
readonly Ok: "ok";
|
|
4
|
+
readonly EmailNotFound: "email_not_found";
|
|
5
|
+
readonly NoSample: "no_sample";
|
|
6
|
+
};
|
|
7
|
+
export type SequenceInboundWebhookMappingCheckStatus = (typeof SequenceInboundWebhookMappingCheckStatus)[keyof typeof SequenceInboundWebhookMappingCheckStatus];
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.SequenceInboundWebhookMappingCheckStatus = void 0;
|
|
5
|
+
/** `ok`: the email path holds a valid address. `email_not_found`: it is missing or not a valid address. `no_sample`: no payload has been received or saved yet. */
|
|
6
|
+
exports.SequenceInboundWebhookMappingCheckStatus = {
|
|
7
|
+
Ok: "ok",
|
|
8
|
+
EmailNotFound: "email_not_found",
|
|
9
|
+
NoSample: "no_sample",
|
|
10
|
+
};
|
|
@@ -774,6 +774,9 @@ export * from "./SequenceGraphEditInput.js";
|
|
|
774
774
|
export * from "./SequenceGraphEditInputAction.js";
|
|
775
775
|
export * from "./SequenceInboundWebhook.js";
|
|
776
776
|
export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
777
|
+
export * from "./SequenceInboundWebhookMappingCheck.js";
|
|
778
|
+
export * from "./SequenceInboundWebhookMappingCheckMissingFieldsItem.js";
|
|
779
|
+
export * from "./SequenceInboundWebhookMappingCheckStatus.js";
|
|
777
780
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
778
781
|
export * from "./SequenceKeyDate.js";
|
|
779
782
|
export * from "./SequenceKeyDates.js";
|
|
@@ -790,6 +790,9 @@ __exportStar(require("./SequenceGraphEditInput.js"), exports);
|
|
|
790
790
|
__exportStar(require("./SequenceGraphEditInputAction.js"), exports);
|
|
791
791
|
__exportStar(require("./SequenceInboundWebhook.js"), exports);
|
|
792
792
|
__exportStar(require("./SequenceInboundWebhookFieldMapping.js"), exports);
|
|
793
|
+
__exportStar(require("./SequenceInboundWebhookMappingCheck.js"), exports);
|
|
794
|
+
__exportStar(require("./SequenceInboundWebhookMappingCheckMissingFieldsItem.js"), exports);
|
|
795
|
+
__exportStar(require("./SequenceInboundWebhookMappingCheckStatus.js"), exports);
|
|
793
796
|
__exportStar(require("./SequenceInboundWebhookStatus.js"), exports);
|
|
794
797
|
__exportStar(require("./SequenceKeyDate.js"), exports);
|
|
795
798
|
__exportStar(require("./SequenceKeyDates.js"), exports);
|
|
@@ -2,6 +2,7 @@ import type * as Sequenzy from "../../api/index.js";
|
|
|
2
2
|
import * as core from "../../core/index.js";
|
|
3
3
|
import type * as serializers from "../index.js";
|
|
4
4
|
import { SequenceInboundWebhookFieldMapping } from "./SequenceInboundWebhookFieldMapping.js";
|
|
5
|
+
import { SequenceInboundWebhookMappingCheck } from "./SequenceInboundWebhookMappingCheck.js";
|
|
5
6
|
import { SequenceInboundWebhookStatus } from "./SequenceInboundWebhookStatus.js";
|
|
6
7
|
export declare const SequenceInboundWebhook: core.serialization.ObjectSchema<serializers.SequenceInboundWebhook.Raw, Sequenzy.SequenceInboundWebhook>;
|
|
7
8
|
export declare namespace SequenceInboundWebhook {
|
|
@@ -10,6 +11,7 @@ export declare namespace SequenceInboundWebhook {
|
|
|
10
11
|
eventName?: string | null;
|
|
11
12
|
fieldMapping?: (SequenceInboundWebhookFieldMapping.Raw | null | undefined) | null;
|
|
12
13
|
id?: string | null;
|
|
14
|
+
mappingCheck?: (SequenceInboundWebhookMappingCheck.Raw | null | undefined) | null;
|
|
13
15
|
sampleCapturedAt?: (string | null | undefined) | null;
|
|
14
16
|
samplePayload?: (Record<string, unknown> | null | undefined) | null;
|
|
15
17
|
secret?: string | null;
|
|
@@ -27,12 +27,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
27
27
|
exports.SequenceInboundWebhook = void 0;
|
|
28
28
|
const core = __importStar(require("../../core/index.js"));
|
|
29
29
|
const SequenceInboundWebhookFieldMapping_js_1 = require("./SequenceInboundWebhookFieldMapping.js");
|
|
30
|
+
const SequenceInboundWebhookMappingCheck_js_1 = require("./SequenceInboundWebhookMappingCheck.js");
|
|
30
31
|
const SequenceInboundWebhookStatus_js_1 = require("./SequenceInboundWebhookStatus.js");
|
|
31
32
|
exports.SequenceInboundWebhook = core.serialization.object({
|
|
32
33
|
createdAt: core.serialization.date().optional(),
|
|
33
34
|
eventName: core.serialization.string().optional(),
|
|
34
35
|
fieldMapping: SequenceInboundWebhookFieldMapping_js_1.SequenceInboundWebhookFieldMapping.optionalNullable(),
|
|
35
36
|
id: core.serialization.string().optional(),
|
|
37
|
+
mappingCheck: SequenceInboundWebhookMappingCheck_js_1.SequenceInboundWebhookMappingCheck.optionalNullable(),
|
|
36
38
|
sampleCapturedAt: core.serialization.date().optionalNullable(),
|
|
37
39
|
samplePayload: core.serialization
|
|
38
40
|
.record(core.serialization.string(), core.serialization.unknown())
|
|
@@ -0,0 +1,12 @@
|
|
|
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 { SequenceInboundWebhookMappingCheckMissingFieldsItem } from "./SequenceInboundWebhookMappingCheckMissingFieldsItem.js";
|
|
5
|
+
import { SequenceInboundWebhookMappingCheckStatus } from "./SequenceInboundWebhookMappingCheckStatus.js";
|
|
6
|
+
export declare const SequenceInboundWebhookMappingCheck: core.serialization.ObjectSchema<serializers.SequenceInboundWebhookMappingCheck.Raw, Sequenzy.SequenceInboundWebhookMappingCheck>;
|
|
7
|
+
export declare namespace SequenceInboundWebhookMappingCheck {
|
|
8
|
+
interface Raw {
|
|
9
|
+
missingFields: SequenceInboundWebhookMappingCheckMissingFieldsItem.Raw[];
|
|
10
|
+
status: SequenceInboundWebhookMappingCheckStatus.Raw;
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
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.SequenceInboundWebhookMappingCheck = void 0;
|
|
28
|
+
const core = __importStar(require("../../core/index.js"));
|
|
29
|
+
const SequenceInboundWebhookMappingCheckMissingFieldsItem_js_1 = require("./SequenceInboundWebhookMappingCheckMissingFieldsItem.js");
|
|
30
|
+
const SequenceInboundWebhookMappingCheckStatus_js_1 = require("./SequenceInboundWebhookMappingCheckStatus.js");
|
|
31
|
+
exports.SequenceInboundWebhookMappingCheck = core.serialization.object({
|
|
32
|
+
missingFields: core.serialization.list(SequenceInboundWebhookMappingCheckMissingFieldsItem_js_1.SequenceInboundWebhookMappingCheckMissingFieldsItem),
|
|
33
|
+
status: SequenceInboundWebhookMappingCheckStatus_js_1.SequenceInboundWebhookMappingCheckStatus,
|
|
34
|
+
});
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../api/index.js";
|
|
2
|
+
import * as core from "../../core/index.js";
|
|
3
|
+
import type * as serializers from "../index.js";
|
|
4
|
+
export declare const SequenceInboundWebhookMappingCheckMissingFieldsItem: core.serialization.ObjectSchema<serializers.SequenceInboundWebhookMappingCheckMissingFieldsItem.Raw, Sequenzy.SequenceInboundWebhookMappingCheckMissingFieldsItem>;
|
|
5
|
+
export declare namespace SequenceInboundWebhookMappingCheckMissingFieldsItem {
|
|
6
|
+
interface Raw {
|
|
7
|
+
field: string;
|
|
8
|
+
path: string;
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
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.SequenceInboundWebhookMappingCheckMissingFieldsItem = void 0;
|
|
28
|
+
const core = __importStar(require("../../core/index.js"));
|
|
29
|
+
exports.SequenceInboundWebhookMappingCheckMissingFieldsItem = core.serialization.object({
|
|
30
|
+
field: core.serialization.string(),
|
|
31
|
+
path: core.serialization.string(),
|
|
32
|
+
});
|
|
@@ -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 SequenceInboundWebhookMappingCheckStatus: core.serialization.Schema<serializers.SequenceInboundWebhookMappingCheckStatus.Raw, Sequenzy.SequenceInboundWebhookMappingCheckStatus>;
|
|
5
|
+
export declare namespace SequenceInboundWebhookMappingCheckStatus {
|
|
6
|
+
type Raw = "ok" | "email_not_found" | "no_sample";
|
|
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.SequenceInboundWebhookMappingCheckStatus = void 0;
|
|
28
|
+
const core = __importStar(require("../../core/index.js"));
|
|
29
|
+
exports.SequenceInboundWebhookMappingCheckStatus = core.serialization.enum_(["ok", "email_not_found", "no_sample"]);
|
|
@@ -774,6 +774,9 @@ export * from "./SequenceGraphEditInput.js";
|
|
|
774
774
|
export * from "./SequenceGraphEditInputAction.js";
|
|
775
775
|
export * from "./SequenceInboundWebhook.js";
|
|
776
776
|
export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
777
|
+
export * from "./SequenceInboundWebhookMappingCheck.js";
|
|
778
|
+
export * from "./SequenceInboundWebhookMappingCheckMissingFieldsItem.js";
|
|
779
|
+
export * from "./SequenceInboundWebhookMappingCheckStatus.js";
|
|
777
780
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
778
781
|
export * from "./SequenceKeyDate.js";
|
|
779
782
|
export * from "./SequenceKeyDates.js";
|
|
@@ -790,6 +790,9 @@ __exportStar(require("./SequenceGraphEditInput.js"), exports);
|
|
|
790
790
|
__exportStar(require("./SequenceGraphEditInputAction.js"), exports);
|
|
791
791
|
__exportStar(require("./SequenceInboundWebhook.js"), exports);
|
|
792
792
|
__exportStar(require("./SequenceInboundWebhookFieldMapping.js"), exports);
|
|
793
|
+
__exportStar(require("./SequenceInboundWebhookMappingCheck.js"), exports);
|
|
794
|
+
__exportStar(require("./SequenceInboundWebhookMappingCheckMissingFieldsItem.js"), exports);
|
|
795
|
+
__exportStar(require("./SequenceInboundWebhookMappingCheckStatus.js"), exports);
|
|
793
796
|
__exportStar(require("./SequenceInboundWebhookStatus.js"), exports);
|
|
794
797
|
__exportStar(require("./SequenceKeyDate.js"), exports);
|
|
795
798
|
__exportStar(require("./SequenceKeyDates.js"), exports);
|
|
@@ -4,6 +4,8 @@ export interface SequenceInboundWebhook {
|
|
|
4
4
|
eventName?: string;
|
|
5
5
|
fieldMapping?: Sequenzy.SequenceInboundWebhookFieldMapping | null;
|
|
6
6
|
id?: string;
|
|
7
|
+
/** Whether the field mapping finds an email in the last payload received, or in a sample saved through this endpoint. An example sample applied from the integration catalog on first setup is not checked. The endpoint answers 200 to every payload it can parse, but skips one without a valid email and creates no subscriber, so a mapping with status email_not_found means received webhooks are being skipped. Null when no mapping is saved. */
|
|
8
|
+
mappingCheck?: Sequenzy.SequenceInboundWebhookMappingCheck | null;
|
|
7
9
|
sampleCapturedAt?: Date | null;
|
|
8
10
|
samplePayload?: Record<string, unknown> | null;
|
|
9
11
|
/** Secret URL token. Treat it as a credential. */
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export interface SequenceInboundWebhookFieldMapping {
|
|
2
|
-
/** Dot path to the subscriber email in the webhook payload. */
|
|
2
|
+
/** Dot path to the subscriber email in the webhook payload. A key that itself contains dots, such as `data.user_email`, is matched as one key, so `properties.data.user_email` reads `{"properties": {"data.user_email": "..."}}`. */
|
|
3
3
|
email: string;
|
|
4
4
|
firstName?: string;
|
|
5
5
|
lastName?: string;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as Sequenzy from "../index.js";
|
|
2
|
+
export interface SequenceInboundWebhookMappingCheck {
|
|
3
|
+
/** Mapped fields whose path does not exist in the saved sample. */
|
|
4
|
+
missingFields: Sequenzy.SequenceInboundWebhookMappingCheckMissingFieldsItem[];
|
|
5
|
+
/** `ok`: the email path holds a valid address. `email_not_found`: it is missing or not a valid address. `no_sample`: no payload has been received or saved yet. */
|
|
6
|
+
status: Sequenzy.SequenceInboundWebhookMappingCheckStatus;
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** `ok`: the email path holds a valid address. `email_not_found`: it is missing or not a valid address. `no_sample`: no payload has been received or saved yet. */
|
|
2
|
+
export declare const SequenceInboundWebhookMappingCheckStatus: {
|
|
3
|
+
readonly Ok: "ok";
|
|
4
|
+
readonly EmailNotFound: "email_not_found";
|
|
5
|
+
readonly NoSample: "no_sample";
|
|
6
|
+
};
|
|
7
|
+
export type SequenceInboundWebhookMappingCheckStatus = (typeof SequenceInboundWebhookMappingCheckStatus)[keyof typeof SequenceInboundWebhookMappingCheckStatus];
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
/** `ok`: the email path holds a valid address. `email_not_found`: it is missing or not a valid address. `no_sample`: no payload has been received or saved yet. */
|
|
3
|
+
export const SequenceInboundWebhookMappingCheckStatus = {
|
|
4
|
+
Ok: "ok",
|
|
5
|
+
EmailNotFound: "email_not_found",
|
|
6
|
+
NoSample: "no_sample",
|
|
7
|
+
};
|
|
@@ -774,6 +774,9 @@ export * from "./SequenceGraphEditInput.js";
|
|
|
774
774
|
export * from "./SequenceGraphEditInputAction.js";
|
|
775
775
|
export * from "./SequenceInboundWebhook.js";
|
|
776
776
|
export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
777
|
+
export * from "./SequenceInboundWebhookMappingCheck.js";
|
|
778
|
+
export * from "./SequenceInboundWebhookMappingCheckMissingFieldsItem.js";
|
|
779
|
+
export * from "./SequenceInboundWebhookMappingCheckStatus.js";
|
|
777
780
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
778
781
|
export * from "./SequenceKeyDate.js";
|
|
779
782
|
export * from "./SequenceKeyDates.js";
|
|
@@ -774,6 +774,9 @@ export * from "./SequenceGraphEditInput.js";
|
|
|
774
774
|
export * from "./SequenceGraphEditInputAction.js";
|
|
775
775
|
export * from "./SequenceInboundWebhook.js";
|
|
776
776
|
export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
777
|
+
export * from "./SequenceInboundWebhookMappingCheck.js";
|
|
778
|
+
export * from "./SequenceInboundWebhookMappingCheckMissingFieldsItem.js";
|
|
779
|
+
export * from "./SequenceInboundWebhookMappingCheckStatus.js";
|
|
777
780
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
778
781
|
export * from "./SequenceKeyDate.js";
|
|
779
782
|
export * from "./SequenceKeyDates.js";
|
|
@@ -2,6 +2,7 @@ import type * as Sequenzy from "../../api/index.js";
|
|
|
2
2
|
import * as core from "../../core/index.js";
|
|
3
3
|
import type * as serializers from "../index.js";
|
|
4
4
|
import { SequenceInboundWebhookFieldMapping } from "./SequenceInboundWebhookFieldMapping.js";
|
|
5
|
+
import { SequenceInboundWebhookMappingCheck } from "./SequenceInboundWebhookMappingCheck.js";
|
|
5
6
|
import { SequenceInboundWebhookStatus } from "./SequenceInboundWebhookStatus.js";
|
|
6
7
|
export declare const SequenceInboundWebhook: core.serialization.ObjectSchema<serializers.SequenceInboundWebhook.Raw, Sequenzy.SequenceInboundWebhook>;
|
|
7
8
|
export declare namespace SequenceInboundWebhook {
|
|
@@ -10,6 +11,7 @@ export declare namespace SequenceInboundWebhook {
|
|
|
10
11
|
eventName?: string | null;
|
|
11
12
|
fieldMapping?: (SequenceInboundWebhookFieldMapping.Raw | null | undefined) | null;
|
|
12
13
|
id?: string | null;
|
|
14
|
+
mappingCheck?: (SequenceInboundWebhookMappingCheck.Raw | null | undefined) | null;
|
|
13
15
|
sampleCapturedAt?: (string | null | undefined) | null;
|
|
14
16
|
samplePayload?: (Record<string, unknown> | null | undefined) | null;
|
|
15
17
|
secret?: string | null;
|
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
2
|
import * as core from "../../core/index.js";
|
|
3
3
|
import { SequenceInboundWebhookFieldMapping } from "./SequenceInboundWebhookFieldMapping.js";
|
|
4
|
+
import { SequenceInboundWebhookMappingCheck } from "./SequenceInboundWebhookMappingCheck.js";
|
|
4
5
|
import { SequenceInboundWebhookStatus } from "./SequenceInboundWebhookStatus.js";
|
|
5
6
|
export const SequenceInboundWebhook = core.serialization.object({
|
|
6
7
|
createdAt: core.serialization.date().optional(),
|
|
7
8
|
eventName: core.serialization.string().optional(),
|
|
8
9
|
fieldMapping: SequenceInboundWebhookFieldMapping.optionalNullable(),
|
|
9
10
|
id: core.serialization.string().optional(),
|
|
11
|
+
mappingCheck: SequenceInboundWebhookMappingCheck.optionalNullable(),
|
|
10
12
|
sampleCapturedAt: core.serialization.date().optionalNullable(),
|
|
11
13
|
samplePayload: core.serialization
|
|
12
14
|
.record(core.serialization.string(), core.serialization.unknown())
|
|
@@ -0,0 +1,12 @@
|
|
|
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 { SequenceInboundWebhookMappingCheckMissingFieldsItem } from "./SequenceInboundWebhookMappingCheckMissingFieldsItem.js";
|
|
5
|
+
import { SequenceInboundWebhookMappingCheckStatus } from "./SequenceInboundWebhookMappingCheckStatus.js";
|
|
6
|
+
export declare const SequenceInboundWebhookMappingCheck: core.serialization.ObjectSchema<serializers.SequenceInboundWebhookMappingCheck.Raw, Sequenzy.SequenceInboundWebhookMappingCheck>;
|
|
7
|
+
export declare namespace SequenceInboundWebhookMappingCheck {
|
|
8
|
+
interface Raw {
|
|
9
|
+
missingFields: SequenceInboundWebhookMappingCheckMissingFieldsItem.Raw[];
|
|
10
|
+
status: SequenceInboundWebhookMappingCheckStatus.Raw;
|
|
11
|
+
}
|
|
12
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../core/index.js";
|
|
3
|
+
import { SequenceInboundWebhookMappingCheckMissingFieldsItem } from "./SequenceInboundWebhookMappingCheckMissingFieldsItem.js";
|
|
4
|
+
import { SequenceInboundWebhookMappingCheckStatus } from "./SequenceInboundWebhookMappingCheckStatus.js";
|
|
5
|
+
export const SequenceInboundWebhookMappingCheck = core.serialization.object({
|
|
6
|
+
missingFields: core.serialization.list(SequenceInboundWebhookMappingCheckMissingFieldsItem),
|
|
7
|
+
status: SequenceInboundWebhookMappingCheckStatus,
|
|
8
|
+
});
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../api/index.js";
|
|
2
|
+
import * as core from "../../core/index.js";
|
|
3
|
+
import type * as serializers from "../index.js";
|
|
4
|
+
export declare const SequenceInboundWebhookMappingCheckMissingFieldsItem: core.serialization.ObjectSchema<serializers.SequenceInboundWebhookMappingCheckMissingFieldsItem.Raw, Sequenzy.SequenceInboundWebhookMappingCheckMissingFieldsItem>;
|
|
5
|
+
export declare namespace SequenceInboundWebhookMappingCheckMissingFieldsItem {
|
|
6
|
+
interface Raw {
|
|
7
|
+
field: string;
|
|
8
|
+
path: string;
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import * as core from "../../core/index.js";
|
|
3
|
+
export const SequenceInboundWebhookMappingCheckMissingFieldsItem = core.serialization.object({
|
|
4
|
+
field: core.serialization.string(),
|
|
5
|
+
path: core.serialization.string(),
|
|
6
|
+
});
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../api/index.js";
|
|
2
|
+
import * as core from "../../core/index.js";
|
|
3
|
+
import type * as serializers from "../index.js";
|
|
4
|
+
export declare const SequenceInboundWebhookMappingCheckStatus: core.serialization.Schema<serializers.SequenceInboundWebhookMappingCheckStatus.Raw, Sequenzy.SequenceInboundWebhookMappingCheckStatus>;
|
|
5
|
+
export declare namespace SequenceInboundWebhookMappingCheckStatus {
|
|
6
|
+
type Raw = "ok" | "email_not_found" | "no_sample";
|
|
7
|
+
}
|
|
@@ -774,6 +774,9 @@ export * from "./SequenceGraphEditInput.js";
|
|
|
774
774
|
export * from "./SequenceGraphEditInputAction.js";
|
|
775
775
|
export * from "./SequenceInboundWebhook.js";
|
|
776
776
|
export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
777
|
+
export * from "./SequenceInboundWebhookMappingCheck.js";
|
|
778
|
+
export * from "./SequenceInboundWebhookMappingCheckMissingFieldsItem.js";
|
|
779
|
+
export * from "./SequenceInboundWebhookMappingCheckStatus.js";
|
|
777
780
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
778
781
|
export * from "./SequenceKeyDate.js";
|
|
779
782
|
export * from "./SequenceKeyDates.js";
|
|
@@ -774,6 +774,9 @@ export * from "./SequenceGraphEditInput.js";
|
|
|
774
774
|
export * from "./SequenceGraphEditInputAction.js";
|
|
775
775
|
export * from "./SequenceInboundWebhook.js";
|
|
776
776
|
export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
777
|
+
export * from "./SequenceInboundWebhookMappingCheck.js";
|
|
778
|
+
export * from "./SequenceInboundWebhookMappingCheckMissingFieldsItem.js";
|
|
779
|
+
export * from "./SequenceInboundWebhookMappingCheckStatus.js";
|
|
777
780
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
778
781
|
export * from "./SequenceKeyDate.js";
|
|
779
782
|
export * from "./SequenceKeyDates.js";
|