hanzoai 8.5.749 → 8.5.755
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/api/marketing-api.d.ts +169 -36
- package/dist/api/marketing-api.js +193 -39
- package/dist/api/pricing-api.d.ts +4 -75
- package/dist/api/pricing-api.js +4 -85
- package/dist/esm/api/marketing-api.d.ts +169 -36
- package/dist/esm/api/marketing-api.js +193 -39
- package/dist/esm/api/pricing-api.d.ts +4 -75
- package/dist/esm/api/pricing-api.js +4 -85
- package/dist/esm/models/ai-model-pricing-info.d.ts +0 -26
- package/dist/esm/models/billing-subscription.d.ts +6 -0
- package/dist/esm/models/index.d.ts +0 -6
- package/dist/esm/models/index.js +0 -6
- package/dist/esm/models/marketing-step.d.ts +1 -1
- package/dist/models/ai-model-pricing-info.d.ts +0 -26
- package/dist/models/billing-subscription.d.ts +6 -0
- package/dist/models/index.d.ts +0 -6
- package/dist/models/index.js +0 -6
- package/dist/models/marketing-step.d.ts +1 -1
- package/package.json +1 -1
- package/src/api/marketing-api.ts +276 -40
- package/src/api/pricing-api.ts +4 -133
- package/src/models/ai-model-pricing-info.ts +0 -30
- package/src/models/billing-subscription.ts +6 -0
- package/src/models/index.ts +0 -6
- package/src/models/marketing-step.ts +1 -1
- package/dist/esm/models/ai-per-million.d.ts +0 -42
- package/dist/esm/models/ai-per-million.js +0 -14
- package/dist/esm/models/pricing-enso-out.d.ts +0 -49
- package/dist/esm/models/pricing-enso-out.js +0 -14
- package/dist/esm/models/pricing-price.d.ts +0 -42
- package/dist/esm/models/pricing-price.js +0 -14
- package/dist/esm/models/pricing-quote.d.ts +0 -75
- package/dist/esm/models/pricing-quote.js +0 -14
- package/dist/esm/models/pricing-rate-arm.d.ts +0 -61
- package/dist/esm/models/pricing-rate-arm.js +0 -14
- package/dist/esm/models/pricing-rate-window.d.ts +0 -42
- package/dist/esm/models/pricing-rate-window.js +0 -14
- package/dist/models/ai-per-million.d.ts +0 -42
- package/dist/models/ai-per-million.js +0 -15
- package/dist/models/pricing-enso-out.d.ts +0 -49
- package/dist/models/pricing-enso-out.js +0 -15
- package/dist/models/pricing-price.d.ts +0 -42
- package/dist/models/pricing-price.js +0 -15
- package/dist/models/pricing-quote.d.ts +0 -75
- package/dist/models/pricing-quote.js +0 -15
- package/dist/models/pricing-rate-arm.d.ts +0 -61
- package/dist/models/pricing-rate-arm.js +0 -15
- package/dist/models/pricing-rate-window.d.ts +0 -42
- package/dist/models/pricing-rate-window.js +0 -15
- package/src/models/ai-per-million.ts +0 -48
- package/src/models/pricing-enso-out.ts +0 -57
- package/src/models/pricing-price.ts +0 -48
- package/src/models/pricing-quote.ts +0 -87
- package/src/models/pricing-rate-arm.ts +0 -69
- package/src/models/pricing-rate-window.ts +0 -48
|
@@ -30,7 +30,7 @@ const base_1 = require("../base");
|
|
|
30
30
|
const MarketingApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
|
-
* Removes one of the caller org\'s audiences and answers 204. It deletes the saved filter only — no customer, event or enrollment is touched.
|
|
33
|
+
* Removes one of the caller org\'s audiences and answers 204. It deletes the saved filter only — no customer, event or enrollment is touched. Org admin or SuperAdmin only; a member of the org is refused.
|
|
34
34
|
* @summary Removes one of the caller org\'s audiences and answers 204.
|
|
35
35
|
* @param {string} id ID is the audience id from the path, as returned by create.
|
|
36
36
|
* @param {*} [options] Override http request option.
|
|
@@ -126,7 +126,7 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
126
126
|
};
|
|
127
127
|
},
|
|
128
128
|
/**
|
|
129
|
-
* Re-subscribes an address on one channel and answers 204. An address that is not on the list reads as not found.
|
|
129
|
+
* Re-subscribes an address on one channel and answers 204. An address that is not on the list reads as not found. Org admin or SuperAdmin only; a member of the org is refused.
|
|
130
130
|
* @summary Re-subscribes an address on one channel and answers 204.
|
|
131
131
|
* @param {string} [channel] Channel is the surface opted out of: email, sms, social, meta, google or tiktok. Empty means email. Opting out of one leaves the others reachable.
|
|
132
132
|
* @param {string} [address] Address is the recipient, normalized (lower-cased, trimmed) so an opt-out cannot be slipped past on a case or whitespace difference. Required.
|
|
@@ -401,6 +401,39 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
401
401
|
options: localVarRequestOptions,
|
|
402
402
|
};
|
|
403
403
|
},
|
|
404
|
+
/**
|
|
405
|
+
* Follows a tracked email link. It is public — the person clicking has no session — and the token is its only authority: a token that verifies, for a sequence of one of Hanzo\'s own orgs that still exists, answers 302 to the destination it signs and records one click (time and user-agent family; no IP address), off the request path so the redirect never waits on storage. A token that is missing, altered, signed under another key, older than a year, or for any other org or a deleted sequence answers 302 to the brand\'s home page (https://hanzo.ai/ on Hanzo\'s deployment). The location is only ever a destination a token signs or that page, never a URL the request names.
|
|
406
|
+
* @summary Follows a tracked email link.
|
|
407
|
+
* @param {string} [userAgent] Agent is the clicker\'s User-Agent header. Only its family (chrome, safari, automated, …) is kept.
|
|
408
|
+
* @param {string} [t] T is the click token the send minted for this link and this recipient: base64url, signed under the deployment\'s KMS key marketing/click-hmac. It is the request\'s only authority.
|
|
409
|
+
* @param {*} [options] Override http request option.
|
|
410
|
+
* @throws {RequiredError}
|
|
411
|
+
*/
|
|
412
|
+
getMarketingClick: async (userAgent, t, options = {}) => {
|
|
413
|
+
const localVarPath = `/v1/marketing/click`;
|
|
414
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
415
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
416
|
+
let baseOptions;
|
|
417
|
+
if (configuration) {
|
|
418
|
+
baseOptions = configuration.baseOptions;
|
|
419
|
+
}
|
|
420
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
421
|
+
const localVarHeaderParameter = {};
|
|
422
|
+
const localVarQueryParameter = {};
|
|
423
|
+
if (t !== undefined) {
|
|
424
|
+
localVarQueryParameter['t'] = t;
|
|
425
|
+
}
|
|
426
|
+
if (userAgent != null) {
|
|
427
|
+
localVarHeaderParameter['User-Agent'] = String(userAgent);
|
|
428
|
+
}
|
|
429
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
430
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
431
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
432
|
+
return {
|
|
433
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
434
|
+
options: localVarRequestOptions,
|
|
435
|
+
};
|
|
436
|
+
},
|
|
404
437
|
/**
|
|
405
438
|
* Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap. The promos are fleet-wide, not per-org — only the counters move.
|
|
406
439
|
* @summary Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap.
|
|
@@ -714,9 +747,6 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
714
747
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
715
748
|
const localVarHeaderParameter = {};
|
|
716
749
|
const localVarQueryParameter = {};
|
|
717
|
-
// authentication bearer required
|
|
718
|
-
// http bearer authentication required
|
|
719
|
-
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
720
750
|
if (org !== undefined) {
|
|
721
751
|
localVarQueryParameter['org'] = org;
|
|
722
752
|
}
|
|
@@ -738,7 +768,7 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
738
768
|
};
|
|
739
769
|
},
|
|
740
770
|
/**
|
|
741
|
-
* Saves a cohort filter for the caller\'s org. Name is required. Omitting event saves the WHOLE-ORG audience — every mailable customer — which needs no analytics warehouse; naming one narrows that roster to the customers who fired it within windowDays.
|
|
771
|
+
* Saves a cohort filter for the caller\'s org. Name is required. Omitting event saves the WHOLE-ORG audience — every mailable customer — which needs no analytics warehouse; naming one narrows that roster to the customers who fired it within windowDays. Org admin or SuperAdmin only; a member of the org is refused.
|
|
742
772
|
* @summary Saves a cohort filter for the caller\'s org.
|
|
743
773
|
* @param {MarketingAudience} marketingAudience
|
|
744
774
|
* @param {*} [options] Override http request option.
|
|
@@ -944,7 +974,7 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
944
974
|
};
|
|
945
975
|
},
|
|
946
976
|
/**
|
|
947
|
-
* Registers a drip sequence in the caller\'s org. Name is required; status defaults to draft, and a sequence must be ACTIVE before it will accept enrollments. The id, createdAt and updatedAt of the input are ignored — the server assigns them.
|
|
977
|
+
* Registers a drip sequence in the caller\'s org. Name is required; status defaults to draft, and a sequence must be ACTIVE before it will accept enrollments. The id, createdAt and updatedAt of the input are ignored — the server assigns them. Org admin or SuperAdmin only; a member of the org is refused.
|
|
948
978
|
* @summary Registers a drip sequence in the caller\'s org.
|
|
949
979
|
* @param {MarketingSequence} marketingSequence
|
|
950
980
|
* @param {*} [options] Override http request option.
|
|
@@ -977,7 +1007,7 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
977
1007
|
};
|
|
978
1008
|
},
|
|
979
1009
|
/**
|
|
980
|
-
* Adds one contact or a whole audience to a sequence and schedules the first step for each. The sequence must be ACTIVE (a draft sends nothing), and the request must name exactly one of address or audienceId. Enrolling is ALL this does: the message itself is sent later by the drip engine, through the suppression gate, so an opted-out customer can be enrolled here and still never be mailed. Re-posting is safe — an address this sequence already took is counted in alreadyEnrolled and never double-dripped — which is what makes retrying a partially-applied announcement a resume rather than a second send.
|
|
1010
|
+
* Adds one contact or a whole audience to a sequence and schedules the first step for each. The sequence must be ACTIVE (a draft sends nothing), and the request must name exactly one of address or audienceId. Enrolling is ALL this does: the message itself is sent later by the drip engine, through the suppression gate, so an opted-out customer can be enrolled here and still never be mailed. Re-posting is safe — an address this sequence already took is counted in alreadyEnrolled and never double-dripped — which is what makes retrying a partially-applied announcement a resume rather than a second send. Org admin or SuperAdmin only; a member of the org is refused.
|
|
981
1011
|
* @summary Adds one contact or a whole audience to a sequence and schedules the first step for each.
|
|
982
1012
|
* @param {string} id ID is the sequence id from the path.
|
|
983
1013
|
* @param {MarketingEnrollInput} marketingEnrollInput
|
|
@@ -1014,7 +1044,7 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
1014
1044
|
};
|
|
1015
1045
|
},
|
|
1016
1046
|
/**
|
|
1017
|
-
* Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled. Only an ACTIVE enrollment can be canceled — one already completed or canceled reads as not found.
|
|
1047
|
+
* Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled. Only an ACTIVE enrollment can be canceled — one already completed or canceled reads as not found. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1018
1048
|
* @summary Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled.
|
|
1019
1049
|
* @param {string} id ID is the sequence id from the path.
|
|
1020
1050
|
* @param {string} eid EID is the enrollment id from the path, as returned by a single-address enroll.
|
|
@@ -1050,7 +1080,7 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
1050
1080
|
};
|
|
1051
1081
|
},
|
|
1052
1082
|
/**
|
|
1053
|
-
* Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments. It does not touch enrollments already walking: archiving stops new ones, not in-flight ones.
|
|
1083
|
+
* Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments. It does not touch enrollments already walking: archiving stops new ones, not in-flight ones. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1054
1084
|
* @summary Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments.
|
|
1055
1085
|
* @param {string} id ID is the sequence id from the path.
|
|
1056
1086
|
* @param {MarketingSequenceStatus} marketingSequenceStatus
|
|
@@ -1087,7 +1117,7 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
1087
1117
|
};
|
|
1088
1118
|
},
|
|
1089
1119
|
/**
|
|
1090
|
-
* Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added. Body is required and delaySeconds must be >= 0. Adding a step does not disturb enrollments already walking — one that has passed this index simply never sees it.
|
|
1120
|
+
* Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added. Body is required and delaySeconds must be >= 0. Adding a step does not disturb enrollments already walking — one that has passed this index simply never sees it. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1091
1121
|
* @summary Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added.
|
|
1092
1122
|
* @param {string} id SequenceID is the sequence id from the path (the route\'s :id).
|
|
1093
1123
|
* @param {MarketingStepInput} marketingStepInput
|
|
@@ -1124,7 +1154,7 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
1124
1154
|
};
|
|
1125
1155
|
},
|
|
1126
1156
|
/**
|
|
1127
|
-
* Records an opt-out for the org (admin / self-service management). Address is required; channel defaults to email. It is idempotent: re-suppressing the same tuple keeps the original record rather than erroring. From here on the ONE send gate refuses that recipient on that channel.
|
|
1157
|
+
* Records an opt-out for the org (admin / self-service management). Address is required; channel defaults to email. It is idempotent: re-suppressing the same tuple keeps the original record rather than erroring. From here on the ONE send gate refuses that recipient on that channel. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1128
1158
|
* @summary Records an opt-out for the org (admin / self-service management).
|
|
1129
1159
|
* @param {MarketingSuppression} marketingSuppression
|
|
1130
1160
|
* @param {*} [options] Override http request option.
|
|
@@ -1156,6 +1186,57 @@ const MarketingApiAxiosParamCreator = function (configuration) {
|
|
|
1156
1186
|
options: localVarRequestOptions,
|
|
1157
1187
|
};
|
|
1158
1188
|
},
|
|
1189
|
+
/**
|
|
1190
|
+
* Is the one-click unsubscribe a mail client sends from the List-Unsubscribe header (RFC 8058): the same signed link the footer carries, POSTed with the form body List-Unsubscribe=One-Click. It opts out exactly what a click on the link does, under the same token check, and is as public.
|
|
1191
|
+
* @summary Is the one-click unsubscribe a mail client sends from the List-Unsubscribe header (RFC 8058): the same signed link the footer carries, POSTed with the form body List-Unsubscribe=One-Click.
|
|
1192
|
+
* @param {string} [org] Org is the org the link was minted for.
|
|
1193
|
+
* @param {string} [channel] Channel is the surface to opt out of.
|
|
1194
|
+
* @param {string} [address] Address is the recipient to opt out.
|
|
1195
|
+
* @param {string} [token] Token is the HMAC over (org, channel, address), the only authority here.
|
|
1196
|
+
* @param {string} [listUnsubscribe] OneClick is the form\\\'s List-Unsubscribe field, \\\"One-Click\\\" from a mail client. The token decides; this field only names the form.
|
|
1197
|
+
* @param {*} [options] Override http request option.
|
|
1198
|
+
* @throws {RequiredError}
|
|
1199
|
+
*/
|
|
1200
|
+
postMarketingUnsubscribe: async (org, channel, address, token, listUnsubscribe, options = {}) => {
|
|
1201
|
+
const localVarPath = `/v1/marketing/unsubscribe`;
|
|
1202
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1203
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1204
|
+
let baseOptions;
|
|
1205
|
+
if (configuration) {
|
|
1206
|
+
baseOptions = configuration.baseOptions;
|
|
1207
|
+
}
|
|
1208
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
1209
|
+
const localVarHeaderParameter = {};
|
|
1210
|
+
const localVarQueryParameter = {};
|
|
1211
|
+
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
|
|
1212
|
+
// authentication bearer required
|
|
1213
|
+
// http bearer authentication required
|
|
1214
|
+
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1215
|
+
if (org !== undefined) {
|
|
1216
|
+
localVarQueryParameter['org'] = org;
|
|
1217
|
+
}
|
|
1218
|
+
if (channel !== undefined) {
|
|
1219
|
+
localVarQueryParameter['channel'] = channel;
|
|
1220
|
+
}
|
|
1221
|
+
if (address !== undefined) {
|
|
1222
|
+
localVarQueryParameter['address'] = address;
|
|
1223
|
+
}
|
|
1224
|
+
if (token !== undefined) {
|
|
1225
|
+
localVarQueryParameter['token'] = token;
|
|
1226
|
+
}
|
|
1227
|
+
if (listUnsubscribe !== undefined) {
|
|
1228
|
+
localVarFormParams.append('List-Unsubscribe', listUnsubscribe);
|
|
1229
|
+
}
|
|
1230
|
+
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
1231
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1232
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1233
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1234
|
+
localVarRequestOptions.data = localVarFormParams;
|
|
1235
|
+
return {
|
|
1236
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1237
|
+
options: localVarRequestOptions,
|
|
1238
|
+
};
|
|
1239
|
+
},
|
|
1159
1240
|
/**
|
|
1160
1241
|
* Replaces a post\'s editable fields. It is a full write, not a patch, and it RESETS the lifecycle from the schedule: a scheduledAt makes the post \"scheduled\" again and none makes it a draft — so editing a failed post requeues it rather than leaving it stuck.
|
|
1161
1242
|
* @summary Replaces a post\'s editable fields.
|
|
@@ -1241,7 +1322,7 @@ const MarketingApiFp = function (configuration) {
|
|
|
1241
1322
|
const localVarAxiosParamCreator = (0, exports.MarketingApiAxiosParamCreator)(configuration);
|
|
1242
1323
|
return {
|
|
1243
1324
|
/**
|
|
1244
|
-
* Removes one of the caller org\'s audiences and answers 204. It deletes the saved filter only — no customer, event or enrollment is touched.
|
|
1325
|
+
* Removes one of the caller org\'s audiences and answers 204. It deletes the saved filter only — no customer, event or enrollment is touched. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1245
1326
|
* @summary Removes one of the caller org\'s audiences and answers 204.
|
|
1246
1327
|
* @param {string} id ID is the audience id from the path, as returned by create.
|
|
1247
1328
|
* @param {*} [options] Override http request option.
|
|
@@ -1280,7 +1361,7 @@ const MarketingApiFp = function (configuration) {
|
|
|
1280
1361
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1281
1362
|
},
|
|
1282
1363
|
/**
|
|
1283
|
-
* Re-subscribes an address on one channel and answers 204. An address that is not on the list reads as not found.
|
|
1364
|
+
* Re-subscribes an address on one channel and answers 204. An address that is not on the list reads as not found. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1284
1365
|
* @summary Re-subscribes an address on one channel and answers 204.
|
|
1285
1366
|
* @param {string} [channel] Channel is the surface opted out of: email, sms, social, meta, google or tiktok. Empty means email. Opting out of one leaves the others reachable.
|
|
1286
1367
|
* @param {string} [address] Address is the recipient, normalized (lower-cased, trimmed) so an opt-out cannot be slipped past on a case or whitespace difference. Required.
|
|
@@ -1388,6 +1469,20 @@ const MarketingApiFp = function (configuration) {
|
|
|
1388
1469
|
const localVarOperationServerBasePath = base_1.operationServerMap['MarketingApi.getMarketingCampaignsById']?.[localVarOperationServerIndex]?.url;
|
|
1389
1470
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1390
1471
|
},
|
|
1472
|
+
/**
|
|
1473
|
+
* Follows a tracked email link. It is public — the person clicking has no session — and the token is its only authority: a token that verifies, for a sequence of one of Hanzo\'s own orgs that still exists, answers 302 to the destination it signs and records one click (time and user-agent family; no IP address), off the request path so the redirect never waits on storage. A token that is missing, altered, signed under another key, older than a year, or for any other org or a deleted sequence answers 302 to the brand\'s home page (https://hanzo.ai/ on Hanzo\'s deployment). The location is only ever a destination a token signs or that page, never a URL the request names.
|
|
1474
|
+
* @summary Follows a tracked email link.
|
|
1475
|
+
* @param {string} [userAgent] Agent is the clicker\'s User-Agent header. Only its family (chrome, safari, automated, …) is kept.
|
|
1476
|
+
* @param {string} [t] T is the click token the send minted for this link and this recipient: base64url, signed under the deployment\'s KMS key marketing/click-hmac. It is the request\'s only authority.
|
|
1477
|
+
* @param {*} [options] Override http request option.
|
|
1478
|
+
* @throws {RequiredError}
|
|
1479
|
+
*/
|
|
1480
|
+
async getMarketingClick(userAgent, t, options) {
|
|
1481
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMarketingClick(userAgent, t, options);
|
|
1482
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1483
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['MarketingApi.getMarketingClick']?.[localVarOperationServerIndex]?.url;
|
|
1484
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1485
|
+
},
|
|
1391
1486
|
/**
|
|
1392
1487
|
* Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap. The promos are fleet-wide, not per-org — only the counters move.
|
|
1393
1488
|
* @summary Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap.
|
|
@@ -1523,7 +1618,7 @@ const MarketingApiFp = function (configuration) {
|
|
|
1523
1618
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1524
1619
|
},
|
|
1525
1620
|
/**
|
|
1526
|
-
* Saves a cohort filter for the caller\'s org. Name is required. Omitting event saves the WHOLE-ORG audience — every mailable customer — which needs no analytics warehouse; naming one narrows that roster to the customers who fired it within windowDays.
|
|
1621
|
+
* Saves a cohort filter for the caller\'s org. Name is required. Omitting event saves the WHOLE-ORG audience — every mailable customer — which needs no analytics warehouse; naming one narrows that roster to the customers who fired it within windowDays. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1527
1622
|
* @summary Saves a cohort filter for the caller\'s org.
|
|
1528
1623
|
* @param {MarketingAudience} marketingAudience
|
|
1529
1624
|
* @param {*} [options] Override http request option.
|
|
@@ -1603,7 +1698,7 @@ const MarketingApiFp = function (configuration) {
|
|
|
1603
1698
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1604
1699
|
},
|
|
1605
1700
|
/**
|
|
1606
|
-
* Registers a drip sequence in the caller\'s org. Name is required; status defaults to draft, and a sequence must be ACTIVE before it will accept enrollments. The id, createdAt and updatedAt of the input are ignored — the server assigns them.
|
|
1701
|
+
* Registers a drip sequence in the caller\'s org. Name is required; status defaults to draft, and a sequence must be ACTIVE before it will accept enrollments. The id, createdAt and updatedAt of the input are ignored — the server assigns them. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1607
1702
|
* @summary Registers a drip sequence in the caller\'s org.
|
|
1608
1703
|
* @param {MarketingSequence} marketingSequence
|
|
1609
1704
|
* @param {*} [options] Override http request option.
|
|
@@ -1616,7 +1711,7 @@ const MarketingApiFp = function (configuration) {
|
|
|
1616
1711
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1617
1712
|
},
|
|
1618
1713
|
/**
|
|
1619
|
-
* Adds one contact or a whole audience to a sequence and schedules the first step for each. The sequence must be ACTIVE (a draft sends nothing), and the request must name exactly one of address or audienceId. Enrolling is ALL this does: the message itself is sent later by the drip engine, through the suppression gate, so an opted-out customer can be enrolled here and still never be mailed. Re-posting is safe — an address this sequence already took is counted in alreadyEnrolled and never double-dripped — which is what makes retrying a partially-applied announcement a resume rather than a second send.
|
|
1714
|
+
* Adds one contact or a whole audience to a sequence and schedules the first step for each. The sequence must be ACTIVE (a draft sends nothing), and the request must name exactly one of address or audienceId. Enrolling is ALL this does: the message itself is sent later by the drip engine, through the suppression gate, so an opted-out customer can be enrolled here and still never be mailed. Re-posting is safe — an address this sequence already took is counted in alreadyEnrolled and never double-dripped — which is what makes retrying a partially-applied announcement a resume rather than a second send. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1620
1715
|
* @summary Adds one contact or a whole audience to a sequence and schedules the first step for each.
|
|
1621
1716
|
* @param {string} id ID is the sequence id from the path.
|
|
1622
1717
|
* @param {MarketingEnrollInput} marketingEnrollInput
|
|
@@ -1630,7 +1725,7 @@ const MarketingApiFp = function (configuration) {
|
|
|
1630
1725
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1631
1726
|
},
|
|
1632
1727
|
/**
|
|
1633
|
-
* Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled. Only an ACTIVE enrollment can be canceled — one already completed or canceled reads as not found.
|
|
1728
|
+
* Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled. Only an ACTIVE enrollment can be canceled — one already completed or canceled reads as not found. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1634
1729
|
* @summary Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled.
|
|
1635
1730
|
* @param {string} id ID is the sequence id from the path.
|
|
1636
1731
|
* @param {string} eid EID is the enrollment id from the path, as returned by a single-address enroll.
|
|
@@ -1644,7 +1739,7 @@ const MarketingApiFp = function (configuration) {
|
|
|
1644
1739
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1645
1740
|
},
|
|
1646
1741
|
/**
|
|
1647
|
-
* Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments. It does not touch enrollments already walking: archiving stops new ones, not in-flight ones.
|
|
1742
|
+
* Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments. It does not touch enrollments already walking: archiving stops new ones, not in-flight ones. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1648
1743
|
* @summary Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments.
|
|
1649
1744
|
* @param {string} id ID is the sequence id from the path.
|
|
1650
1745
|
* @param {MarketingSequenceStatus} marketingSequenceStatus
|
|
@@ -1658,7 +1753,7 @@ const MarketingApiFp = function (configuration) {
|
|
|
1658
1753
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1659
1754
|
},
|
|
1660
1755
|
/**
|
|
1661
|
-
* Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added. Body is required and delaySeconds must be >= 0. Adding a step does not disturb enrollments already walking — one that has passed this index simply never sees it.
|
|
1756
|
+
* Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added. Body is required and delaySeconds must be >= 0. Adding a step does not disturb enrollments already walking — one that has passed this index simply never sees it. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1662
1757
|
* @summary Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added.
|
|
1663
1758
|
* @param {string} id SequenceID is the sequence id from the path (the route\'s :id).
|
|
1664
1759
|
* @param {MarketingStepInput} marketingStepInput
|
|
@@ -1672,7 +1767,7 @@ const MarketingApiFp = function (configuration) {
|
|
|
1672
1767
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1673
1768
|
},
|
|
1674
1769
|
/**
|
|
1675
|
-
* Records an opt-out for the org (admin / self-service management). Address is required; channel defaults to email. It is idempotent: re-suppressing the same tuple keeps the original record rather than erroring. From here on the ONE send gate refuses that recipient on that channel.
|
|
1770
|
+
* Records an opt-out for the org (admin / self-service management). Address is required; channel defaults to email. It is idempotent: re-suppressing the same tuple keeps the original record rather than erroring. From here on the ONE send gate refuses that recipient on that channel. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1676
1771
|
* @summary Records an opt-out for the org (admin / self-service management).
|
|
1677
1772
|
* @param {MarketingSuppression} marketingSuppression
|
|
1678
1773
|
* @param {*} [options] Override http request option.
|
|
@@ -1684,6 +1779,23 @@ const MarketingApiFp = function (configuration) {
|
|
|
1684
1779
|
const localVarOperationServerBasePath = base_1.operationServerMap['MarketingApi.postMarketingSuppressions']?.[localVarOperationServerIndex]?.url;
|
|
1685
1780
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1686
1781
|
},
|
|
1782
|
+
/**
|
|
1783
|
+
* Is the one-click unsubscribe a mail client sends from the List-Unsubscribe header (RFC 8058): the same signed link the footer carries, POSTed with the form body List-Unsubscribe=One-Click. It opts out exactly what a click on the link does, under the same token check, and is as public.
|
|
1784
|
+
* @summary Is the one-click unsubscribe a mail client sends from the List-Unsubscribe header (RFC 8058): the same signed link the footer carries, POSTed with the form body List-Unsubscribe=One-Click.
|
|
1785
|
+
* @param {string} [org] Org is the org the link was minted for.
|
|
1786
|
+
* @param {string} [channel] Channel is the surface to opt out of.
|
|
1787
|
+
* @param {string} [address] Address is the recipient to opt out.
|
|
1788
|
+
* @param {string} [token] Token is the HMAC over (org, channel, address), the only authority here.
|
|
1789
|
+
* @param {string} [listUnsubscribe] OneClick is the form\\\'s List-Unsubscribe field, \\\"One-Click\\\" from a mail client. The token decides; this field only names the form.
|
|
1790
|
+
* @param {*} [options] Override http request option.
|
|
1791
|
+
* @throws {RequiredError}
|
|
1792
|
+
*/
|
|
1793
|
+
async postMarketingUnsubscribe(org, channel, address, token, listUnsubscribe, options) {
|
|
1794
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postMarketingUnsubscribe(org, channel, address, token, listUnsubscribe, options);
|
|
1795
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1796
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['MarketingApi.postMarketingUnsubscribe']?.[localVarOperationServerIndex]?.url;
|
|
1797
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1798
|
+
},
|
|
1687
1799
|
/**
|
|
1688
1800
|
* Replaces a post\'s editable fields. It is a full write, not a patch, and it RESETS the lifecycle from the schedule: a scheduledAt makes the post \"scheduled\" again and none makes it a draft — so editing a failed post requeues it rather than leaving it stuck.
|
|
1689
1801
|
* @summary Replaces a post\'s editable fields.
|
|
@@ -1723,7 +1835,7 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
1723
1835
|
const localVarFp = (0, exports.MarketingApiFp)(configuration);
|
|
1724
1836
|
return {
|
|
1725
1837
|
/**
|
|
1726
|
-
* Removes one of the caller org\'s audiences and answers 204. It deletes the saved filter only — no customer, event or enrollment is touched.
|
|
1838
|
+
* Removes one of the caller org\'s audiences and answers 204. It deletes the saved filter only — no customer, event or enrollment is touched. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1727
1839
|
* @summary Removes one of the caller org\'s audiences and answers 204.
|
|
1728
1840
|
* @param {MarketingApiDeleteMarketingAudiencesByIdRequest} requestParameters Request parameters.
|
|
1729
1841
|
* @param {*} [options] Override http request option.
|
|
@@ -1753,7 +1865,7 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
1753
1865
|
return localVarFp.deleteMarketingCampaignsById(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
1754
1866
|
},
|
|
1755
1867
|
/**
|
|
1756
|
-
* Re-subscribes an address on one channel and answers 204. An address that is not on the list reads as not found.
|
|
1868
|
+
* Re-subscribes an address on one channel and answers 204. An address that is not on the list reads as not found. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1757
1869
|
* @summary Re-subscribes an address on one channel and answers 204.
|
|
1758
1870
|
* @param {MarketingApiDeleteMarketingSuppressionsRequest} requestParameters Request parameters.
|
|
1759
1871
|
* @param {*} [options] Override http request option.
|
|
@@ -1832,6 +1944,16 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
1832
1944
|
getMarketingCampaignsById(requestParameters, options) {
|
|
1833
1945
|
return localVarFp.getMarketingCampaignsById(requestParameters.id, options).then((request) => request(axios, basePath));
|
|
1834
1946
|
},
|
|
1947
|
+
/**
|
|
1948
|
+
* Follows a tracked email link. It is public — the person clicking has no session — and the token is its only authority: a token that verifies, for a sequence of one of Hanzo\'s own orgs that still exists, answers 302 to the destination it signs and records one click (time and user-agent family; no IP address), off the request path so the redirect never waits on storage. A token that is missing, altered, signed under another key, older than a year, or for any other org or a deleted sequence answers 302 to the brand\'s home page (https://hanzo.ai/ on Hanzo\'s deployment). The location is only ever a destination a token signs or that page, never a URL the request names.
|
|
1949
|
+
* @summary Follows a tracked email link.
|
|
1950
|
+
* @param {MarketingApiGetMarketingClickRequest} requestParameters Request parameters.
|
|
1951
|
+
* @param {*} [options] Override http request option.
|
|
1952
|
+
* @throws {RequiredError}
|
|
1953
|
+
*/
|
|
1954
|
+
getMarketingClick(requestParameters = {}, options) {
|
|
1955
|
+
return localVarFp.getMarketingClick(requestParameters.userAgent, requestParameters.t, options).then((request) => request(axios, basePath));
|
|
1956
|
+
},
|
|
1835
1957
|
/**
|
|
1836
1958
|
* Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap. The promos are fleet-wide, not per-org — only the counters move.
|
|
1837
1959
|
* @summary Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap.
|
|
@@ -1931,7 +2053,7 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
1931
2053
|
return localVarFp.getMarketingUnsubscribe(requestParameters.org, requestParameters.channel, requestParameters.address, requestParameters.token, options).then((request) => request(axios, basePath));
|
|
1932
2054
|
},
|
|
1933
2055
|
/**
|
|
1934
|
-
* Saves a cohort filter for the caller\'s org. Name is required. Omitting event saves the WHOLE-ORG audience — every mailable customer — which needs no analytics warehouse; naming one narrows that roster to the customers who fired it within windowDays.
|
|
2056
|
+
* Saves a cohort filter for the caller\'s org. Name is required. Omitting event saves the WHOLE-ORG audience — every mailable customer — which needs no analytics warehouse; naming one narrows that roster to the customers who fired it within windowDays. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1935
2057
|
* @summary Saves a cohort filter for the caller\'s org.
|
|
1936
2058
|
* @param {MarketingApiPostMarketingAudiencesRequest} requestParameters Request parameters.
|
|
1937
2059
|
* @param {*} [options] Override http request option.
|
|
@@ -1991,7 +2113,7 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
1991
2113
|
return localVarFp.postMarketingPromosByCodeRedeem(requestParameters.code, requestParameters.marketingRedeemInput, options).then((request) => request(axios, basePath));
|
|
1992
2114
|
},
|
|
1993
2115
|
/**
|
|
1994
|
-
* Registers a drip sequence in the caller\'s org. Name is required; status defaults to draft, and a sequence must be ACTIVE before it will accept enrollments. The id, createdAt and updatedAt of the input are ignored — the server assigns them.
|
|
2116
|
+
* Registers a drip sequence in the caller\'s org. Name is required; status defaults to draft, and a sequence must be ACTIVE before it will accept enrollments. The id, createdAt and updatedAt of the input are ignored — the server assigns them. Org admin or SuperAdmin only; a member of the org is refused.
|
|
1995
2117
|
* @summary Registers a drip sequence in the caller\'s org.
|
|
1996
2118
|
* @param {MarketingApiPostMarketingSequencesRequest} requestParameters Request parameters.
|
|
1997
2119
|
* @param {*} [options] Override http request option.
|
|
@@ -2001,7 +2123,7 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
2001
2123
|
return localVarFp.postMarketingSequences(requestParameters.marketingSequence, options).then((request) => request(axios, basePath));
|
|
2002
2124
|
},
|
|
2003
2125
|
/**
|
|
2004
|
-
* Adds one contact or a whole audience to a sequence and schedules the first step for each. The sequence must be ACTIVE (a draft sends nothing), and the request must name exactly one of address or audienceId. Enrolling is ALL this does: the message itself is sent later by the drip engine, through the suppression gate, so an opted-out customer can be enrolled here and still never be mailed. Re-posting is safe — an address this sequence already took is counted in alreadyEnrolled and never double-dripped — which is what makes retrying a partially-applied announcement a resume rather than a second send.
|
|
2126
|
+
* Adds one contact or a whole audience to a sequence and schedules the first step for each. The sequence must be ACTIVE (a draft sends nothing), and the request must name exactly one of address or audienceId. Enrolling is ALL this does: the message itself is sent later by the drip engine, through the suppression gate, so an opted-out customer can be enrolled here and still never be mailed. Re-posting is safe — an address this sequence already took is counted in alreadyEnrolled and never double-dripped — which is what makes retrying a partially-applied announcement a resume rather than a second send. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2005
2127
|
* @summary Adds one contact or a whole audience to a sequence and schedules the first step for each.
|
|
2006
2128
|
* @param {MarketingApiPostMarketingSequencesByIdEnrollRequest} requestParameters Request parameters.
|
|
2007
2129
|
* @param {*} [options] Override http request option.
|
|
@@ -2011,7 +2133,7 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
2011
2133
|
return localVarFp.postMarketingSequencesByIdEnroll(requestParameters.id, requestParameters.marketingEnrollInput, options).then((request) => request(axios, basePath));
|
|
2012
2134
|
},
|
|
2013
2135
|
/**
|
|
2014
|
-
* Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled. Only an ACTIVE enrollment can be canceled — one already completed or canceled reads as not found.
|
|
2136
|
+
* Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled. Only an ACTIVE enrollment can be canceled — one already completed or canceled reads as not found. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2015
2137
|
* @summary Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled.
|
|
2016
2138
|
* @param {MarketingApiPostMarketingSequencesByIdEnrollmentsByEidCancelRequest} requestParameters Request parameters.
|
|
2017
2139
|
* @param {*} [options] Override http request option.
|
|
@@ -2021,7 +2143,7 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
2021
2143
|
return localVarFp.postMarketingSequencesByIdEnrollmentsByEidCancel(requestParameters.id, requestParameters.eid, options).then((request) => request(axios, basePath));
|
|
2022
2144
|
},
|
|
2023
2145
|
/**
|
|
2024
|
-
* Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments. It does not touch enrollments already walking: archiving stops new ones, not in-flight ones.
|
|
2146
|
+
* Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments. It does not touch enrollments already walking: archiving stops new ones, not in-flight ones. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2025
2147
|
* @summary Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments.
|
|
2026
2148
|
* @param {MarketingApiPostMarketingSequencesByIdStatusRequest} requestParameters Request parameters.
|
|
2027
2149
|
* @param {*} [options] Override http request option.
|
|
@@ -2031,7 +2153,7 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
2031
2153
|
return localVarFp.postMarketingSequencesByIdStatus(requestParameters.id, requestParameters.marketingSequenceStatus, options).then((request) => request(axios, basePath));
|
|
2032
2154
|
},
|
|
2033
2155
|
/**
|
|
2034
|
-
* Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added. Body is required and delaySeconds must be >= 0. Adding a step does not disturb enrollments already walking — one that has passed this index simply never sees it.
|
|
2156
|
+
* Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added. Body is required and delaySeconds must be >= 0. Adding a step does not disturb enrollments already walking — one that has passed this index simply never sees it. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2035
2157
|
* @summary Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added.
|
|
2036
2158
|
* @param {MarketingApiPostMarketingSequencesByIdStepsRequest} requestParameters Request parameters.
|
|
2037
2159
|
* @param {*} [options] Override http request option.
|
|
@@ -2041,7 +2163,7 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
2041
2163
|
return localVarFp.postMarketingSequencesByIdSteps(requestParameters.id, requestParameters.marketingStepInput, options).then((request) => request(axios, basePath));
|
|
2042
2164
|
},
|
|
2043
2165
|
/**
|
|
2044
|
-
* Records an opt-out for the org (admin / self-service management). Address is required; channel defaults to email. It is idempotent: re-suppressing the same tuple keeps the original record rather than erroring. From here on the ONE send gate refuses that recipient on that channel.
|
|
2166
|
+
* Records an opt-out for the org (admin / self-service management). Address is required; channel defaults to email. It is idempotent: re-suppressing the same tuple keeps the original record rather than erroring. From here on the ONE send gate refuses that recipient on that channel. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2045
2167
|
* @summary Records an opt-out for the org (admin / self-service management).
|
|
2046
2168
|
* @param {MarketingApiPostMarketingSuppressionsRequest} requestParameters Request parameters.
|
|
2047
2169
|
* @param {*} [options] Override http request option.
|
|
@@ -2050,6 +2172,16 @@ const MarketingApiFactory = function (configuration, basePath, axios) {
|
|
|
2050
2172
|
postMarketingSuppressions(requestParameters, options) {
|
|
2051
2173
|
return localVarFp.postMarketingSuppressions(requestParameters.marketingSuppression, options).then((request) => request(axios, basePath));
|
|
2052
2174
|
},
|
|
2175
|
+
/**
|
|
2176
|
+
* Is the one-click unsubscribe a mail client sends from the List-Unsubscribe header (RFC 8058): the same signed link the footer carries, POSTed with the form body List-Unsubscribe=One-Click. It opts out exactly what a click on the link does, under the same token check, and is as public.
|
|
2177
|
+
* @summary Is the one-click unsubscribe a mail client sends from the List-Unsubscribe header (RFC 8058): the same signed link the footer carries, POSTed with the form body List-Unsubscribe=One-Click.
|
|
2178
|
+
* @param {MarketingApiPostMarketingUnsubscribeRequest} requestParameters Request parameters.
|
|
2179
|
+
* @param {*} [options] Override http request option.
|
|
2180
|
+
* @throws {RequiredError}
|
|
2181
|
+
*/
|
|
2182
|
+
postMarketingUnsubscribe(requestParameters = {}, options) {
|
|
2183
|
+
return localVarFp.postMarketingUnsubscribe(requestParameters.org, requestParameters.channel, requestParameters.address, requestParameters.token, requestParameters.listUnsubscribe, options).then((request) => request(axios, basePath));
|
|
2184
|
+
},
|
|
2053
2185
|
/**
|
|
2054
2186
|
* Replaces a post\'s editable fields. It is a full write, not a patch, and it RESETS the lifecycle from the schedule: a scheduledAt makes the post \"scheduled\" again and none makes it a draft — so editing a failed post requeues it rather than leaving it stuck.
|
|
2055
2187
|
* @summary Replaces a post\'s editable fields.
|
|
@@ -2081,7 +2213,7 @@ exports.MarketingApiFactory = MarketingApiFactory;
|
|
|
2081
2213
|
*/
|
|
2082
2214
|
class MarketingApi extends base_1.BaseAPI {
|
|
2083
2215
|
/**
|
|
2084
|
-
* Removes one of the caller org\'s audiences and answers 204. It deletes the saved filter only — no customer, event or enrollment is touched.
|
|
2216
|
+
* Removes one of the caller org\'s audiences and answers 204. It deletes the saved filter only — no customer, event or enrollment is touched. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2085
2217
|
* @summary Removes one of the caller org\'s audiences and answers 204.
|
|
2086
2218
|
* @param {MarketingApiDeleteMarketingAudiencesByIdRequest} requestParameters Request parameters.
|
|
2087
2219
|
* @param {*} [options] Override http request option.
|
|
@@ -2114,7 +2246,7 @@ class MarketingApi extends base_1.BaseAPI {
|
|
|
2114
2246
|
return (0, exports.MarketingApiFp)(this.configuration).deleteMarketingCampaignsById(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
2115
2247
|
}
|
|
2116
2248
|
/**
|
|
2117
|
-
* Re-subscribes an address on one channel and answers 204. An address that is not on the list reads as not found.
|
|
2249
|
+
* Re-subscribes an address on one channel and answers 204. An address that is not on the list reads as not found. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2118
2250
|
* @summary Re-subscribes an address on one channel and answers 204.
|
|
2119
2251
|
* @param {MarketingApiDeleteMarketingSuppressionsRequest} requestParameters Request parameters.
|
|
2120
2252
|
* @param {*} [options] Override http request option.
|
|
@@ -2201,6 +2333,17 @@ class MarketingApi extends base_1.BaseAPI {
|
|
|
2201
2333
|
getMarketingCampaignsById(requestParameters, options) {
|
|
2202
2334
|
return (0, exports.MarketingApiFp)(this.configuration).getMarketingCampaignsById(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
|
|
2203
2335
|
}
|
|
2336
|
+
/**
|
|
2337
|
+
* Follows a tracked email link. It is public — the person clicking has no session — and the token is its only authority: a token that verifies, for a sequence of one of Hanzo\'s own orgs that still exists, answers 302 to the destination it signs and records one click (time and user-agent family; no IP address), off the request path so the redirect never waits on storage. A token that is missing, altered, signed under another key, older than a year, or for any other org or a deleted sequence answers 302 to the brand\'s home page (https://hanzo.ai/ on Hanzo\'s deployment). The location is only ever a destination a token signs or that page, never a URL the request names.
|
|
2338
|
+
* @summary Follows a tracked email link.
|
|
2339
|
+
* @param {MarketingApiGetMarketingClickRequest} requestParameters Request parameters.
|
|
2340
|
+
* @param {*} [options] Override http request option.
|
|
2341
|
+
* @throws {RequiredError}
|
|
2342
|
+
* @memberof MarketingApi
|
|
2343
|
+
*/
|
|
2344
|
+
getMarketingClick(requestParameters = {}, options) {
|
|
2345
|
+
return (0, exports.MarketingApiFp)(this.configuration).getMarketingClick(requestParameters.userAgent, requestParameters.t, options).then((request) => request(this.axios, this.basePath));
|
|
2346
|
+
}
|
|
2204
2347
|
/**
|
|
2205
2348
|
* Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap. The promos are fleet-wide, not per-org — only the counters move.
|
|
2206
2349
|
* @summary Returns every promo the deployment offers with its live counters: how many orgs have redeemed it and how many redemptions remain under the cap.
|
|
@@ -2310,7 +2453,7 @@ class MarketingApi extends base_1.BaseAPI {
|
|
|
2310
2453
|
return (0, exports.MarketingApiFp)(this.configuration).getMarketingUnsubscribe(requestParameters.org, requestParameters.channel, requestParameters.address, requestParameters.token, options).then((request) => request(this.axios, this.basePath));
|
|
2311
2454
|
}
|
|
2312
2455
|
/**
|
|
2313
|
-
* Saves a cohort filter for the caller\'s org. Name is required. Omitting event saves the WHOLE-ORG audience — every mailable customer — which needs no analytics warehouse; naming one narrows that roster to the customers who fired it within windowDays.
|
|
2456
|
+
* Saves a cohort filter for the caller\'s org. Name is required. Omitting event saves the WHOLE-ORG audience — every mailable customer — which needs no analytics warehouse; naming one narrows that roster to the customers who fired it within windowDays. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2314
2457
|
* @summary Saves a cohort filter for the caller\'s org.
|
|
2315
2458
|
* @param {MarketingApiPostMarketingAudiencesRequest} requestParameters Request parameters.
|
|
2316
2459
|
* @param {*} [options] Override http request option.
|
|
@@ -2376,7 +2519,7 @@ class MarketingApi extends base_1.BaseAPI {
|
|
|
2376
2519
|
return (0, exports.MarketingApiFp)(this.configuration).postMarketingPromosByCodeRedeem(requestParameters.code, requestParameters.marketingRedeemInput, options).then((request) => request(this.axios, this.basePath));
|
|
2377
2520
|
}
|
|
2378
2521
|
/**
|
|
2379
|
-
* Registers a drip sequence in the caller\'s org. Name is required; status defaults to draft, and a sequence must be ACTIVE before it will accept enrollments. The id, createdAt and updatedAt of the input are ignored — the server assigns them.
|
|
2522
|
+
* Registers a drip sequence in the caller\'s org. Name is required; status defaults to draft, and a sequence must be ACTIVE before it will accept enrollments. The id, createdAt and updatedAt of the input are ignored — the server assigns them. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2380
2523
|
* @summary Registers a drip sequence in the caller\'s org.
|
|
2381
2524
|
* @param {MarketingApiPostMarketingSequencesRequest} requestParameters Request parameters.
|
|
2382
2525
|
* @param {*} [options] Override http request option.
|
|
@@ -2387,7 +2530,7 @@ class MarketingApi extends base_1.BaseAPI {
|
|
|
2387
2530
|
return (0, exports.MarketingApiFp)(this.configuration).postMarketingSequences(requestParameters.marketingSequence, options).then((request) => request(this.axios, this.basePath));
|
|
2388
2531
|
}
|
|
2389
2532
|
/**
|
|
2390
|
-
* Adds one contact or a whole audience to a sequence and schedules the first step for each. The sequence must be ACTIVE (a draft sends nothing), and the request must name exactly one of address or audienceId. Enrolling is ALL this does: the message itself is sent later by the drip engine, through the suppression gate, so an opted-out customer can be enrolled here and still never be mailed. Re-posting is safe — an address this sequence already took is counted in alreadyEnrolled and never double-dripped — which is what makes retrying a partially-applied announcement a resume rather than a second send.
|
|
2533
|
+
* Adds one contact or a whole audience to a sequence and schedules the first step for each. The sequence must be ACTIVE (a draft sends nothing), and the request must name exactly one of address or audienceId. Enrolling is ALL this does: the message itself is sent later by the drip engine, through the suppression gate, so an opted-out customer can be enrolled here and still never be mailed. Re-posting is safe — an address this sequence already took is counted in alreadyEnrolled and never double-dripped — which is what makes retrying a partially-applied announcement a resume rather than a second send. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2391
2534
|
* @summary Adds one contact or a whole audience to a sequence and schedules the first step for each.
|
|
2392
2535
|
* @param {MarketingApiPostMarketingSequencesByIdEnrollRequest} requestParameters Request parameters.
|
|
2393
2536
|
* @param {*} [options] Override http request option.
|
|
@@ -2398,7 +2541,7 @@ class MarketingApi extends base_1.BaseAPI {
|
|
|
2398
2541
|
return (0, exports.MarketingApiFp)(this.configuration).postMarketingSequencesByIdEnroll(requestParameters.id, requestParameters.marketingEnrollInput, options).then((request) => request(this.axios, this.basePath));
|
|
2399
2542
|
}
|
|
2400
2543
|
/**
|
|
2401
|
-
* Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled. Only an ACTIVE enrollment can be canceled — one already completed or canceled reads as not found.
|
|
2544
|
+
* Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled. Only an ACTIVE enrollment can be canceled — one already completed or canceled reads as not found. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2402
2545
|
* @summary Stops one walk mid-sequence and answers 204: no further step is sent, and steps already delivered are not recalled.
|
|
2403
2546
|
* @param {MarketingApiPostMarketingSequencesByIdEnrollmentsByEidCancelRequest} requestParameters Request parameters.
|
|
2404
2547
|
* @param {*} [options] Override http request option.
|
|
@@ -2409,7 +2552,7 @@ class MarketingApi extends base_1.BaseAPI {
|
|
|
2409
2552
|
return (0, exports.MarketingApiFp)(this.configuration).postMarketingSequencesByIdEnrollmentsByEidCancel(requestParameters.id, requestParameters.eid, options).then((request) => request(this.axios, this.basePath));
|
|
2410
2553
|
}
|
|
2411
2554
|
/**
|
|
2412
|
-
* Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments. It does not touch enrollments already walking: archiving stops new ones, not in-flight ones.
|
|
2555
|
+
* Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments. It does not touch enrollments already walking: archiving stops new ones, not in-flight ones. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2413
2556
|
* @summary Flips draft/active/archived — the activation gate for sending, since only an active sequence accepts enrollments.
|
|
2414
2557
|
* @param {MarketingApiPostMarketingSequencesByIdStatusRequest} requestParameters Request parameters.
|
|
2415
2558
|
* @param {*} [options] Override http request option.
|
|
@@ -2420,7 +2563,7 @@ class MarketingApi extends base_1.BaseAPI {
|
|
|
2420
2563
|
return (0, exports.MarketingApiFp)(this.configuration).postMarketingSequencesByIdStatus(requestParameters.id, requestParameters.marketingSequenceStatus, options).then((request) => request(this.axios, this.basePath));
|
|
2421
2564
|
}
|
|
2422
2565
|
/**
|
|
2423
|
-
* Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added. Body is required and delaySeconds must be >= 0. Adding a step does not disturb enrollments already walking — one that has passed this index simply never sees it.
|
|
2566
|
+
* Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added. Body is required and delaySeconds must be >= 0. Adding a step does not disturb enrollments already walking — one that has passed this index simply never sees it. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2424
2567
|
* @summary Appends a message to the END of a sequence: the new step\'s idx is one past the last, so steps arrive in the order they are added.
|
|
2425
2568
|
* @param {MarketingApiPostMarketingSequencesByIdStepsRequest} requestParameters Request parameters.
|
|
2426
2569
|
* @param {*} [options] Override http request option.
|
|
@@ -2431,7 +2574,7 @@ class MarketingApi extends base_1.BaseAPI {
|
|
|
2431
2574
|
return (0, exports.MarketingApiFp)(this.configuration).postMarketingSequencesByIdSteps(requestParameters.id, requestParameters.marketingStepInput, options).then((request) => request(this.axios, this.basePath));
|
|
2432
2575
|
}
|
|
2433
2576
|
/**
|
|
2434
|
-
* Records an opt-out for the org (admin / self-service management). Address is required; channel defaults to email. It is idempotent: re-suppressing the same tuple keeps the original record rather than erroring. From here on the ONE send gate refuses that recipient on that channel.
|
|
2577
|
+
* Records an opt-out for the org (admin / self-service management). Address is required; channel defaults to email. It is idempotent: re-suppressing the same tuple keeps the original record rather than erroring. From here on the ONE send gate refuses that recipient on that channel. Org admin or SuperAdmin only; a member of the org is refused.
|
|
2435
2578
|
* @summary Records an opt-out for the org (admin / self-service management).
|
|
2436
2579
|
* @param {MarketingApiPostMarketingSuppressionsRequest} requestParameters Request parameters.
|
|
2437
2580
|
* @param {*} [options] Override http request option.
|
|
@@ -2441,6 +2584,17 @@ class MarketingApi extends base_1.BaseAPI {
|
|
|
2441
2584
|
postMarketingSuppressions(requestParameters, options) {
|
|
2442
2585
|
return (0, exports.MarketingApiFp)(this.configuration).postMarketingSuppressions(requestParameters.marketingSuppression, options).then((request) => request(this.axios, this.basePath));
|
|
2443
2586
|
}
|
|
2587
|
+
/**
|
|
2588
|
+
* Is the one-click unsubscribe a mail client sends from the List-Unsubscribe header (RFC 8058): the same signed link the footer carries, POSTed with the form body List-Unsubscribe=One-Click. It opts out exactly what a click on the link does, under the same token check, and is as public.
|
|
2589
|
+
* @summary Is the one-click unsubscribe a mail client sends from the List-Unsubscribe header (RFC 8058): the same signed link the footer carries, POSTed with the form body List-Unsubscribe=One-Click.
|
|
2590
|
+
* @param {MarketingApiPostMarketingUnsubscribeRequest} requestParameters Request parameters.
|
|
2591
|
+
* @param {*} [options] Override http request option.
|
|
2592
|
+
* @throws {RequiredError}
|
|
2593
|
+
* @memberof MarketingApi
|
|
2594
|
+
*/
|
|
2595
|
+
postMarketingUnsubscribe(requestParameters = {}, options) {
|
|
2596
|
+
return (0, exports.MarketingApiFp)(this.configuration).postMarketingUnsubscribe(requestParameters.org, requestParameters.channel, requestParameters.address, requestParameters.token, requestParameters.listUnsubscribe, options).then((request) => request(this.axios, this.basePath));
|
|
2597
|
+
}
|
|
2444
2598
|
/**
|
|
2445
2599
|
* Replaces a post\'s editable fields. It is a full write, not a patch, and it RESETS the lifecycle from the schedule: a scheduledAt makes the post \"scheduled\" again and none makes it a draft — so editing a failed post requeues it rather than leaving it stuck.
|
|
2446
2600
|
* @summary Replaces a post\'s editable fields.
|