sequenzy 2.1.2 → 2.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api/resources/inApp/client/Client.d.ts +36 -0
- package/dist/cjs/api/resources/inApp/client/Client.js +138 -0
- package/dist/cjs/api/resources/inApp/client/requests/WriteInAppCopyRequest.d.ts +13 -0
- package/dist/cjs/api/resources/inApp/client/requests/WriteInAppCopyRequest.js +3 -0
- package/dist/cjs/api/resources/inApp/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponse.d.ts +5 -0
- package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponse.js +3 -0
- package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.d.ts +9 -0
- package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.js +3 -0
- package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.d.ts +7 -0
- package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.js +10 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyRequestFormat.d.ts +6 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyRequestFormat.js +9 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyRequestKind.d.ts +5 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyRequestKind.js +8 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponse.d.ts +5 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponse.js +3 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopy.d.ts +7 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopy.js +3 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.d.ts +5 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.js +3 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.d.ts +5 -0
- package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.js +8 -0
- package/dist/cjs/api/resources/inApp/types/index.d.ts +9 -0
- package/dist/cjs/api/resources/inApp/types/index.js +9 -0
- package/dist/cjs/api/resources/sequences/types/SimulateSequencesResponse.d.ts +1 -1
- package/dist/cjs/api/resources/sequences/types/SimulateSequencesResponseReadiness.d.ts +1 -1
- package/dist/cjs/api/resources/webTrackingKeys/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/webTrackingKeys/client/Client.js +2 -2
- package/dist/cjs/api/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.d.ts +3 -1
- package/dist/cjs/api/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.d.ts +3 -1
- package/dist/cjs/api/types/Company.d.ts +1 -0
- package/dist/cjs/api/types/InAppMessage.d.ts +5 -1
- package/dist/cjs/api/types/InAppMessageImagePlacement.d.ts +6 -0
- package/dist/cjs/api/types/InAppMessageImagePlacement.js +9 -0
- package/dist/cjs/api/types/InAppMessagePosition.d.ts +2 -1
- package/dist/cjs/api/types/InAppMessagePosition.js +2 -1
- package/dist/cjs/api/types/PushDevice.d.ts +1 -0
- package/dist/cjs/api/types/PushDeviceSource.d.ts +2 -0
- package/dist/cjs/api/types/PushDeviceSource.js +2 -0
- package/dist/cjs/api/types/SequenceActionResponse.d.ts +1 -1
- package/dist/cjs/api/types/WebTrackingKey.d.ts +5 -3
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- package/dist/cjs/serialization/resources/inApp/client/requests/WriteInAppCopyRequest.d.ts +14 -0
- package/dist/cjs/serialization/resources/inApp/client/requests/WriteInAppCopyRequest.js +36 -0
- package/dist/cjs/serialization/resources/inApp/client/requests/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/inApp/client/requests/index.js +3 -1
- package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponse.d.ts +11 -0
- package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponse.js +33 -0
- package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.d.ts +14 -0
- package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.js +36 -0
- package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.d.ts +7 -0
- package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.js +29 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyRequestFormat.d.ts +7 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyRequestFormat.js +29 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyRequestKind.d.ts +7 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyRequestKind.js +29 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponse.d.ts +11 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponse.js +33 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopy.d.ts +13 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopy.js +35 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.d.ts +11 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.js +33 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.d.ts +7 -0
- package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.js +29 -0
- package/dist/cjs/serialization/resources/inApp/types/index.d.ts +9 -0
- package/dist/cjs/serialization/resources/inApp/types/index.js +9 -0
- package/dist/cjs/serialization/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.js +1 -0
- package/dist/cjs/serialization/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.d.ts +1 -0
- package/dist/cjs/serialization/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.js +1 -0
- package/dist/cjs/serialization/types/InAppMessage.d.ts +3 -0
- package/dist/cjs/serialization/types/InAppMessage.js +3 -0
- package/dist/cjs/serialization/types/InAppMessageImagePlacement.d.ts +7 -0
- package/dist/cjs/serialization/types/InAppMessageImagePlacement.js +29 -0
- package/dist/cjs/serialization/types/InAppMessagePosition.d.ts +1 -1
- package/dist/cjs/serialization/types/InAppMessagePosition.js +1 -1
- package/dist/cjs/serialization/types/PushDeviceSource.d.ts +1 -1
- package/dist/cjs/serialization/types/PushDeviceSource.js +1 -1
- package/dist/cjs/serialization/types/WebTrackingKey.d.ts +1 -0
- package/dist/cjs/serialization/types/WebTrackingKey.js +1 -0
- package/dist/cjs/serialization/types/index.d.ts +1 -0
- package/dist/cjs/serialization/types/index.js +1 -0
- package/dist/esm/api/resources/inApp/client/Client.d.ts +36 -0
- package/dist/esm/api/resources/inApp/client/Client.js +138 -0
- package/dist/esm/api/resources/inApp/client/requests/WriteInAppCopyRequest.d.ts +13 -0
- package/dist/esm/api/resources/inApp/client/requests/WriteInAppCopyRequest.js +2 -0
- package/dist/esm/api/resources/inApp/client/requests/index.d.ts +1 -0
- package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponse.d.ts +5 -0
- package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponse.js +2 -0
- package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.d.ts +9 -0
- package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.js +2 -0
- package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.d.ts +7 -0
- package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.js +7 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestFormat.d.ts +6 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestFormat.js +6 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestKind.d.ts +5 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestKind.js +5 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponse.d.ts +5 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponse.js +2 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopy.d.ts +7 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopy.js +2 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.d.ts +5 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.js +2 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.d.ts +5 -0
- package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.js +5 -0
- package/dist/esm/api/resources/inApp/types/index.d.ts +9 -0
- package/dist/esm/api/resources/inApp/types/index.js +9 -0
- package/dist/esm/api/resources/sequences/types/SimulateSequencesResponse.d.ts +1 -1
- package/dist/esm/api/resources/sequences/types/SimulateSequencesResponseReadiness.d.ts +1 -1
- package/dist/esm/api/resources/webTrackingKeys/client/Client.d.ts +2 -2
- package/dist/esm/api/resources/webTrackingKeys/client/Client.js +2 -2
- package/dist/esm/api/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.d.ts +3 -1
- package/dist/esm/api/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.d.ts +3 -1
- package/dist/esm/api/types/Company.d.ts +1 -0
- package/dist/esm/api/types/InAppMessage.d.ts +5 -1
- package/dist/esm/api/types/InAppMessageImagePlacement.d.ts +6 -0
- package/dist/esm/api/types/InAppMessageImagePlacement.js +6 -0
- package/dist/esm/api/types/InAppMessagePosition.d.ts +2 -1
- package/dist/esm/api/types/InAppMessagePosition.js +2 -1
- package/dist/esm/api/types/PushDevice.d.ts +1 -0
- package/dist/esm/api/types/PushDeviceSource.d.ts +2 -0
- package/dist/esm/api/types/PushDeviceSource.js +2 -0
- package/dist/esm/api/types/SequenceActionResponse.d.ts +1 -1
- package/dist/esm/api/types/WebTrackingKey.d.ts +5 -3
- package/dist/esm/api/types/index.d.ts +1 -0
- package/dist/esm/api/types/index.js +1 -0
- package/dist/esm/serialization/resources/inApp/client/requests/WriteInAppCopyRequest.d.ts +14 -0
- package/dist/esm/serialization/resources/inApp/client/requests/WriteInAppCopyRequest.js +10 -0
- package/dist/esm/serialization/resources/inApp/client/requests/index.d.ts +1 -0
- package/dist/esm/serialization/resources/inApp/client/requests/index.js +1 -0
- package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponse.d.ts +11 -0
- package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponse.js +7 -0
- package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.d.ts +14 -0
- package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.js +10 -0
- package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.d.ts +7 -0
- package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.js +3 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyRequestFormat.d.ts +7 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyRequestFormat.js +3 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyRequestKind.d.ts +7 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyRequestKind.js +3 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponse.d.ts +11 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponse.js +7 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopy.d.ts +13 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopy.js +9 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.d.ts +11 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.js +7 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.d.ts +7 -0
- package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.js +3 -0
- package/dist/esm/serialization/resources/inApp/types/index.d.ts +9 -0
- package/dist/esm/serialization/resources/inApp/types/index.js +9 -0
- package/dist/esm/serialization/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.d.ts +1 -0
- package/dist/esm/serialization/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.js +1 -0
- package/dist/esm/serialization/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.d.ts +1 -0
- package/dist/esm/serialization/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.js +1 -0
- package/dist/esm/serialization/types/InAppMessage.d.ts +3 -0
- package/dist/esm/serialization/types/InAppMessage.js +3 -0
- package/dist/esm/serialization/types/InAppMessageImagePlacement.d.ts +7 -0
- package/dist/esm/serialization/types/InAppMessageImagePlacement.js +3 -0
- package/dist/esm/serialization/types/InAppMessagePosition.d.ts +1 -1
- package/dist/esm/serialization/types/InAppMessagePosition.js +1 -1
- package/dist/esm/serialization/types/PushDeviceSource.d.ts +1 -1
- package/dist/esm/serialization/types/PushDeviceSource.js +1 -1
- package/dist/esm/serialization/types/WebTrackingKey.d.ts +1 -0
- package/dist/esm/serialization/types/WebTrackingKey.js +1 -0
- package/dist/esm/serialization/types/index.d.ts +1 -0
- package/dist/esm/serialization/types/index.js +1 -0
- package/package.json +1 -1
|
@@ -72,6 +72,21 @@ export declare class InAppClient {
|
|
|
72
72
|
*/
|
|
73
73
|
listInAppMessages(request?: Sequenzy.ListInAppMessagesRequest, requestOptions?: InAppClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListInAppMessagesResponse>;
|
|
74
74
|
private __listInAppMessages;
|
|
75
|
+
/**
|
|
76
|
+
* Built-in starting points for in_app sequence steps. Each config is a complete step without a label; link buttons have no url until you add one. Requires the sequences:read scope.
|
|
77
|
+
*
|
|
78
|
+
* @param {InAppClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
81
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
82
|
+
* @throws {@link errors.SequenzyError}
|
|
83
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* await client.inApp.listInAppTemplates()
|
|
87
|
+
*/
|
|
88
|
+
listInAppTemplates(requestOptions?: InAppClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListInAppTemplatesResponse>;
|
|
89
|
+
private __listInAppTemplates;
|
|
75
90
|
/**
|
|
76
91
|
* Records that the app displayed, clicked, dismissed or read an item. The first report of each type sets its timestamp; repeats change nothing except clickCount, and recorded is false. Clicks, dismissals and reads also mark the item displayed. Messages leave the open feed once displayed, clicked or dismissed; cards once dismissed. Requires the subscribers:write scope.
|
|
77
92
|
*
|
|
@@ -94,4 +109,25 @@ export declare class InAppClient {
|
|
|
94
109
|
*/
|
|
95
110
|
recordInAppEvent(request: Sequenzy.RecordInAppEventRequest, requestOptions?: InAppClient.RequestOptions): core.HttpResponsePromise<Sequenzy.RecordInAppEventResponse>;
|
|
96
111
|
private __recordInAppEvent;
|
|
112
|
+
/**
|
|
113
|
+
* Writes an in-app message's eyebrow, title, message and button labels with AI from a brief. Nothing is saved. Requires the sequences:write scope; limited to 20 requests a minute per workspace.
|
|
114
|
+
*
|
|
115
|
+
* @param {Sequenzy.WriteInAppCopyRequest} request
|
|
116
|
+
* @param {InAppClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
119
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
120
|
+
* @throws {@link Sequenzy.UnprocessableEntityError}
|
|
121
|
+
* @throws {@link Sequenzy.TooManyRequestsError}
|
|
122
|
+
* @throws {@link Sequenzy.InternalServerError}
|
|
123
|
+
* @throws {@link errors.SequenzyError}
|
|
124
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
125
|
+
*
|
|
126
|
+
* @example
|
|
127
|
+
* await client.inApp.writeInAppCopy({
|
|
128
|
+
* brief: "brief"
|
|
129
|
+
* })
|
|
130
|
+
*/
|
|
131
|
+
writeInAppCopy(request: Sequenzy.WriteInAppCopyRequest, requestOptions?: InAppClient.RequestOptions): core.HttpResponsePromise<Sequenzy.WriteInAppCopyResponse>;
|
|
132
|
+
private __writeInAppCopy;
|
|
97
133
|
}
|
|
@@ -274,6 +274,66 @@ class InAppClient {
|
|
|
274
274
|
}
|
|
275
275
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/in-app/messages");
|
|
276
276
|
}
|
|
277
|
+
/**
|
|
278
|
+
* Built-in starting points for in_app sequence steps. Each config is a complete step without a label; link buttons have no url until you add one. Requires the sequences:read scope.
|
|
279
|
+
*
|
|
280
|
+
* @param {InAppClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
281
|
+
*
|
|
282
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
283
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
284
|
+
* @throws {@link errors.SequenzyError}
|
|
285
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
286
|
+
*
|
|
287
|
+
* @example
|
|
288
|
+
* await client.inApp.listInAppTemplates()
|
|
289
|
+
*/
|
|
290
|
+
listInAppTemplates(requestOptions) {
|
|
291
|
+
return core.HttpResponsePromise.fromPromise(this.__listInAppTemplates(requestOptions));
|
|
292
|
+
}
|
|
293
|
+
async __listInAppTemplates(requestOptions) {
|
|
294
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
295
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
|
|
296
|
+
const _response = await core.fetcher({
|
|
297
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
298
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
299
|
+
environments.SequenzyEnvironment.Default, "in-app/templates"),
|
|
300
|
+
method: "GET",
|
|
301
|
+
headers: _headers,
|
|
302
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
303
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
304
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
305
|
+
abortSignal: requestOptions?.abortSignal,
|
|
306
|
+
fetchFn: this._options?.fetch,
|
|
307
|
+
logging: this._options.logging,
|
|
308
|
+
});
|
|
309
|
+
if (_response.ok) {
|
|
310
|
+
return {
|
|
311
|
+
data: serializers.ListInAppTemplatesResponse.parseOrThrow(_response.body, {
|
|
312
|
+
unrecognizedObjectKeys: "passthrough",
|
|
313
|
+
allowUnrecognizedUnionMembers: true,
|
|
314
|
+
allowUnrecognizedEnumValues: true,
|
|
315
|
+
skipValidation: true,
|
|
316
|
+
breadcrumbsPrefix: ["response"],
|
|
317
|
+
}),
|
|
318
|
+
rawResponse: _response.rawResponse,
|
|
319
|
+
};
|
|
320
|
+
}
|
|
321
|
+
if (_response.error.reason === "status-code") {
|
|
322
|
+
switch (_response.error.statusCode) {
|
|
323
|
+
case 401:
|
|
324
|
+
throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
325
|
+
case 403:
|
|
326
|
+
throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
327
|
+
default:
|
|
328
|
+
throw new errors.SequenzyError({
|
|
329
|
+
statusCode: _response.error.statusCode,
|
|
330
|
+
body: _response.error.body,
|
|
331
|
+
rawResponse: _response.rawResponse,
|
|
332
|
+
});
|
|
333
|
+
}
|
|
334
|
+
}
|
|
335
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/in-app/templates");
|
|
336
|
+
}
|
|
277
337
|
/**
|
|
278
338
|
* Records that the app displayed, clicked, dismissed or read an item. The first report of each type sets its timestamp; repeats change nothing except clickCount, and recorded is false. Clicks, dismissals and reads also mark the item displayed. Messages leave the open feed once displayed, clicked or dismissed; cards once dismissed. Requires the subscribers:write scope.
|
|
279
339
|
*
|
|
@@ -354,5 +414,83 @@ class InAppClient {
|
|
|
354
414
|
}
|
|
355
415
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/in-app/messages/{messageId}/events");
|
|
356
416
|
}
|
|
417
|
+
/**
|
|
418
|
+
* Writes an in-app message's eyebrow, title, message and button labels with AI from a brief. Nothing is saved. Requires the sequences:write scope; limited to 20 requests a minute per workspace.
|
|
419
|
+
*
|
|
420
|
+
* @param {Sequenzy.WriteInAppCopyRequest} request
|
|
421
|
+
* @param {InAppClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
422
|
+
*
|
|
423
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
424
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
425
|
+
* @throws {@link Sequenzy.UnprocessableEntityError}
|
|
426
|
+
* @throws {@link Sequenzy.TooManyRequestsError}
|
|
427
|
+
* @throws {@link Sequenzy.InternalServerError}
|
|
428
|
+
* @throws {@link errors.SequenzyError}
|
|
429
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
430
|
+
*
|
|
431
|
+
* @example
|
|
432
|
+
* await client.inApp.writeInAppCopy({
|
|
433
|
+
* brief: "brief"
|
|
434
|
+
* })
|
|
435
|
+
*/
|
|
436
|
+
writeInAppCopy(request, requestOptions) {
|
|
437
|
+
return core.HttpResponsePromise.fromPromise(this.__writeInAppCopy(request, requestOptions));
|
|
438
|
+
}
|
|
439
|
+
async __writeInAppCopy(request, requestOptions) {
|
|
440
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
441
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
|
|
442
|
+
const _response = await core.fetcher({
|
|
443
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
444
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
445
|
+
environments.SequenzyEnvironment.Default, "in-app/copy"),
|
|
446
|
+
method: "POST",
|
|
447
|
+
headers: _headers,
|
|
448
|
+
contentType: "application/json",
|
|
449
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
450
|
+
requestType: "json",
|
|
451
|
+
body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(serializers.WriteInAppCopyRequest.jsonOrThrow(request, {
|
|
452
|
+
unrecognizedObjectKeys: "strip",
|
|
453
|
+
omitUndefined: true,
|
|
454
|
+
}), requestOptions?.additionalBodyParameters),
|
|
455
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
456
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
457
|
+
abortSignal: requestOptions?.abortSignal,
|
|
458
|
+
fetchFn: this._options?.fetch,
|
|
459
|
+
logging: this._options.logging,
|
|
460
|
+
});
|
|
461
|
+
if (_response.ok) {
|
|
462
|
+
return {
|
|
463
|
+
data: serializers.WriteInAppCopyResponse.parseOrThrow(_response.body, {
|
|
464
|
+
unrecognizedObjectKeys: "passthrough",
|
|
465
|
+
allowUnrecognizedUnionMembers: true,
|
|
466
|
+
allowUnrecognizedEnumValues: true,
|
|
467
|
+
skipValidation: true,
|
|
468
|
+
breadcrumbsPrefix: ["response"],
|
|
469
|
+
}),
|
|
470
|
+
rawResponse: _response.rawResponse,
|
|
471
|
+
};
|
|
472
|
+
}
|
|
473
|
+
if (_response.error.reason === "status-code") {
|
|
474
|
+
switch (_response.error.statusCode) {
|
|
475
|
+
case 401:
|
|
476
|
+
throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
477
|
+
case 403:
|
|
478
|
+
throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
479
|
+
case 422:
|
|
480
|
+
throw new Sequenzy.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
481
|
+
case 429:
|
|
482
|
+
throw new Sequenzy.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
483
|
+
case 500:
|
|
484
|
+
throw new Sequenzy.InternalServerError(_response.error.body, _response.rawResponse);
|
|
485
|
+
default:
|
|
486
|
+
throw new errors.SequenzyError({
|
|
487
|
+
statusCode: _response.error.statusCode,
|
|
488
|
+
body: _response.error.body,
|
|
489
|
+
rawResponse: _response.rawResponse,
|
|
490
|
+
});
|
|
491
|
+
}
|
|
492
|
+
}
|
|
493
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/in-app/copy");
|
|
494
|
+
}
|
|
357
495
|
}
|
|
358
496
|
exports.InAppClient = InAppClient;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* brief: "brief"
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface WriteInAppCopyRequest {
|
|
9
|
+
brief: string;
|
|
10
|
+
format?: Sequenzy.WriteInAppCopyRequestFormat;
|
|
11
|
+
hasImage?: boolean;
|
|
12
|
+
kind?: Sequenzy.WriteInAppCopyRequestKind;
|
|
13
|
+
}
|
|
@@ -2,3 +2,4 @@ export type { DeleteInAppMessageRequest } from "./DeleteInAppMessageRequest.js";
|
|
|
2
2
|
export type { GetInAppStepStatsRequest } from "./GetInAppStepStatsRequest.js";
|
|
3
3
|
export type { ListInAppMessagesRequest } from "./ListInAppMessagesRequest.js";
|
|
4
4
|
export type { RecordInAppEventRequest } from "./RecordInAppEventRequest.js";
|
|
5
|
+
export type { WriteInAppCopyRequest } from "./WriteInAppCopyRequest.js";
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../../index.js";
|
|
2
|
+
export interface ListInAppTemplatesResponseTemplatesItem {
|
|
3
|
+
category?: Sequenzy.ListInAppTemplatesResponseTemplatesItemCategory;
|
|
4
|
+
/** An in_app step config without a label. */
|
|
5
|
+
config?: Record<string, unknown>;
|
|
6
|
+
description?: string;
|
|
7
|
+
id?: string;
|
|
8
|
+
name?: string;
|
|
9
|
+
}
|
package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.d.ts
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export declare const ListInAppTemplatesResponseTemplatesItemCategory: {
|
|
2
|
+
readonly Conversion: "Conversion";
|
|
3
|
+
readonly Onboarding: "Onboarding";
|
|
4
|
+
readonly Announcement: "Announcement";
|
|
5
|
+
readonly Engagement: "Engagement";
|
|
6
|
+
};
|
|
7
|
+
export type ListInAppTemplatesResponseTemplatesItemCategory = (typeof ListInAppTemplatesResponseTemplatesItemCategory)[keyof typeof ListInAppTemplatesResponseTemplatesItemCategory];
|
|
@@ -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.ListInAppTemplatesResponseTemplatesItemCategory = void 0;
|
|
5
|
+
exports.ListInAppTemplatesResponseTemplatesItemCategory = {
|
|
6
|
+
Conversion: "Conversion",
|
|
7
|
+
Onboarding: "Onboarding",
|
|
8
|
+
Announcement: "Announcement",
|
|
9
|
+
Engagement: "Engagement",
|
|
10
|
+
};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export declare const WriteInAppCopyRequestFormat: {
|
|
2
|
+
readonly Modal: "modal";
|
|
3
|
+
readonly Banner: "banner";
|
|
4
|
+
readonly Fullscreen: "fullscreen";
|
|
5
|
+
};
|
|
6
|
+
export type WriteInAppCopyRequestFormat = (typeof WriteInAppCopyRequestFormat)[keyof typeof WriteInAppCopyRequestFormat];
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.WriteInAppCopyRequestFormat = void 0;
|
|
5
|
+
exports.WriteInAppCopyRequestFormat = {
|
|
6
|
+
Modal: "modal",
|
|
7
|
+
Banner: "banner",
|
|
8
|
+
Fullscreen: "fullscreen",
|
|
9
|
+
};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.WriteInAppCopyRequestKind = void 0;
|
|
5
|
+
exports.WriteInAppCopyRequestKind = {
|
|
6
|
+
Message: "message",
|
|
7
|
+
Card: "card",
|
|
8
|
+
};
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export declare const WriteInAppCopyResponseCopyButtonsItemAction: {
|
|
2
|
+
readonly OpenUrl: "open_url";
|
|
3
|
+
readonly Dismiss: "dismiss";
|
|
4
|
+
};
|
|
5
|
+
export type WriteInAppCopyResponseCopyButtonsItemAction = (typeof WriteInAppCopyResponseCopyButtonsItemAction)[keyof typeof WriteInAppCopyResponseCopyButtonsItemAction];
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.WriteInAppCopyResponseCopyButtonsItemAction = void 0;
|
|
5
|
+
exports.WriteInAppCopyResponseCopyButtonsItemAction = {
|
|
6
|
+
OpenUrl: "open_url",
|
|
7
|
+
Dismiss: "dismiss",
|
|
8
|
+
};
|
|
@@ -5,5 +5,14 @@ export * from "./ListInAppMessagesRequestKind.js";
|
|
|
5
5
|
export * from "./ListInAppMessagesRequestStatus.js";
|
|
6
6
|
export * from "./ListInAppMessagesResponse.js";
|
|
7
7
|
export * from "./ListInAppMessagesResponseStatus.js";
|
|
8
|
+
export * from "./ListInAppTemplatesResponse.js";
|
|
9
|
+
export * from "./ListInAppTemplatesResponseTemplatesItem.js";
|
|
10
|
+
export * from "./ListInAppTemplatesResponseTemplatesItemCategory.js";
|
|
8
11
|
export * from "./RecordInAppEventRequestType.js";
|
|
9
12
|
export * from "./RecordInAppEventResponse.js";
|
|
13
|
+
export * from "./WriteInAppCopyRequestFormat.js";
|
|
14
|
+
export * from "./WriteInAppCopyRequestKind.js";
|
|
15
|
+
export * from "./WriteInAppCopyResponse.js";
|
|
16
|
+
export * from "./WriteInAppCopyResponseCopy.js";
|
|
17
|
+
export * from "./WriteInAppCopyResponseCopyButtonsItem.js";
|
|
18
|
+
export * from "./WriteInAppCopyResponseCopyButtonsItemAction.js";
|
|
@@ -21,5 +21,14 @@ __exportStar(require("./ListInAppMessagesRequestKind.js"), exports);
|
|
|
21
21
|
__exportStar(require("./ListInAppMessagesRequestStatus.js"), exports);
|
|
22
22
|
__exportStar(require("./ListInAppMessagesResponse.js"), exports);
|
|
23
23
|
__exportStar(require("./ListInAppMessagesResponseStatus.js"), exports);
|
|
24
|
+
__exportStar(require("./ListInAppTemplatesResponse.js"), exports);
|
|
25
|
+
__exportStar(require("./ListInAppTemplatesResponseTemplatesItem.js"), exports);
|
|
26
|
+
__exportStar(require("./ListInAppTemplatesResponseTemplatesItemCategory.js"), exports);
|
|
24
27
|
__exportStar(require("./RecordInAppEventRequestType.js"), exports);
|
|
25
28
|
__exportStar(require("./RecordInAppEventResponse.js"), exports);
|
|
29
|
+
__exportStar(require("./WriteInAppCopyRequestFormat.js"), exports);
|
|
30
|
+
__exportStar(require("./WriteInAppCopyRequestKind.js"), exports);
|
|
31
|
+
__exportStar(require("./WriteInAppCopyResponse.js"), exports);
|
|
32
|
+
__exportStar(require("./WriteInAppCopyResponseCopy.js"), exports);
|
|
33
|
+
__exportStar(require("./WriteInAppCopyResponseCopyButtonsItem.js"), exports);
|
|
34
|
+
__exportStar(require("./WriteInAppCopyResponseCopyButtonsItemAction.js"), exports);
|
|
@@ -4,7 +4,7 @@ export interface SimulateSequencesResponse {
|
|
|
4
4
|
enrollment: Record<string, unknown>;
|
|
5
5
|
/** Walked graph for the optional stored subscriber. emailStepsOnPath counts traversed email nodes; emailsOnPath counts those deliverable for the subscriber's current email and status. Null when none was passed. */
|
|
6
6
|
path?: Record<string, unknown> | null;
|
|
7
|
-
/** Activation blockers and warnings. */
|
|
7
|
+
/** Activation blockers and warnings. Warnings never block activation; they include empty branch paths and emails that use `{{webhooks.KEY...}}` or `{{ai.KEY...}}` when no earlier step saves that key. */
|
|
8
8
|
readiness: Sequenzy.SimulateSequencesResponseReadiness;
|
|
9
9
|
sendsMail: boolean;
|
|
10
10
|
sequenceId: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Activation blockers and warnings.
|
|
2
|
+
* Activation blockers and warnings. Warnings never block activation; they include empty branch paths and emails that use `{{webhooks.KEY...}}` or `{{ai.KEY...}}` when no earlier step saves that key.
|
|
3
3
|
*/
|
|
4
4
|
export interface SimulateSequencesResponseReadiness {
|
|
5
5
|
errors?: string[];
|
|
@@ -14,7 +14,7 @@ export declare class WebTrackingKeysClient {
|
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<WebTrackingKeysClient.Options>;
|
|
15
15
|
constructor(options?: WebTrackingKeysClient.Options);
|
|
16
16
|
/**
|
|
17
|
-
* Creates a publishable key for the browser tracking SDK and returns the script tag to install. The key ships in page source by design and authorizes storefront events only, never the rest of the API. Events start flowing once the snippet is deployed and nothing is backfilled for the period before that. Always pass allowedOrigins
|
|
17
|
+
* Creates a publishable key for the browser tracking SDK and returns the script tag to install. The key ships in page source by design and authorizes storefront events only, never the rest of the API. Events start flowing once the snippet is deployed and nothing is backfilled for the period before that. Always pass allowedOrigins for a website or allowedAppIds for an iOS or Android app - a key with neither accepts events from any site or app. Requires the integrations:manage scope.
|
|
18
18
|
*
|
|
19
19
|
* @param {Sequenzy.CreateWebTrackingKeysRequest} request
|
|
20
20
|
* @param {WebTrackingKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -106,7 +106,7 @@ export declare class WebTrackingKeysClient {
|
|
|
106
106
|
mintIdentity(request: Sequenzy.MintIdentityWebTrackingKeysRequest, requestOptions?: WebTrackingKeysClient.RequestOptions): core.HttpResponsePromise<Sequenzy.MintIdentityWebTrackingKeysResponse>;
|
|
107
107
|
private __mintIdentity;
|
|
108
108
|
/**
|
|
109
|
-
* Renames a key, replaces its allowed origins, or revokes it. allowedOrigins
|
|
109
|
+
* Renames a key, replaces its allowed origins or app IDs, or revokes it. allowedOrigins and allowedAppIds each replace the whole list rather than appending. Revoking stops events within about a minute while preserving the key value, so the matching snippet can still be found and removed from the site. Requires the integrations:manage scope.
|
|
110
110
|
*
|
|
111
111
|
* @param {Sequenzy.UpdateWebTrackingKeysRequest} request
|
|
112
112
|
* @param {WebTrackingKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -42,7 +42,7 @@ class WebTrackingKeysClient {
|
|
|
42
42
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
|
-
* Creates a publishable key for the browser tracking SDK and returns the script tag to install. The key ships in page source by design and authorizes storefront events only, never the rest of the API. Events start flowing once the snippet is deployed and nothing is backfilled for the period before that. Always pass allowedOrigins
|
|
45
|
+
* Creates a publishable key for the browser tracking SDK and returns the script tag to install. The key ships in page source by design and authorizes storefront events only, never the rest of the API. Events start flowing once the snippet is deployed and nothing is backfilled for the period before that. Always pass allowedOrigins for a website or allowedAppIds for an iOS or Android app - a key with neither accepts events from any site or app. Requires the integrations:manage scope.
|
|
46
46
|
*
|
|
47
47
|
* @param {Sequenzy.CreateWebTrackingKeysRequest} request
|
|
48
48
|
* @param {WebTrackingKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -383,7 +383,7 @@ class WebTrackingKeysClient {
|
|
|
383
383
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/web-tracking-identities");
|
|
384
384
|
}
|
|
385
385
|
/**
|
|
386
|
-
* Renames a key, replaces its allowed origins, or revokes it. allowedOrigins
|
|
386
|
+
* Renames a key, replaces its allowed origins or app IDs, or revokes it. allowedOrigins and allowedAppIds each replace the whole list rather than appending. Revoking stops events within about a minute while preserving the key value, so the matching snippet can still be found and removed from the site. Requires the integrations:manage scope.
|
|
387
387
|
*
|
|
388
388
|
* @param {Sequenzy.UpdateWebTrackingKeysRequest} request
|
|
389
389
|
* @param {WebTrackingKeysClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/cjs/api/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.d.ts
CHANGED
|
@@ -5,7 +5,9 @@
|
|
|
5
5
|
* }
|
|
6
6
|
*/
|
|
7
7
|
export interface CreateWebTrackingKeysRequest {
|
|
8
|
-
/**
|
|
8
|
+
/** iOS bundle IDs and Android package names allowed to use this key from the mobile SDKs, e.g. com.example.app. Duplicates are dropped case-insensitively. */
|
|
9
|
+
allowedAppIds?: string[];
|
|
10
|
+
/** Origins allowed to use this key. A bare domain is read as https. A leading *. matches subdomains at any depth but not the apex. Omitting this and allowedAppIds leaves the key unrestricted. */
|
|
9
11
|
allowedOrigins?: string[];
|
|
10
12
|
/** Human-readable label, e.g. Storefront. */
|
|
11
13
|
name: string;
|
package/dist/cjs/api/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.d.ts
CHANGED
|
@@ -7,7 +7,9 @@
|
|
|
7
7
|
export interface UpdateWebTrackingKeysRequest {
|
|
8
8
|
/** Web tracking key ID. */
|
|
9
9
|
id: string;
|
|
10
|
-
/** Replacement
|
|
10
|
+
/** Replacement list of iOS bundle IDs and Android package names. */
|
|
11
|
+
allowedAppIds?: string[];
|
|
12
|
+
/** Replacement origin allowlist. The key becomes unrestricted when both this and allowedAppIds are empty. */
|
|
11
13
|
allowedOrigins?: string[];
|
|
12
14
|
/** Set false to revoke the key, true to re-enable a revoked one. */
|
|
13
15
|
isActive?: boolean;
|
|
@@ -45,6 +45,7 @@ export interface Company {
|
|
|
45
45
|
replyTrackingDomainMode?: Sequenzy.CompanyReplyTrackingDomainMode;
|
|
46
46
|
/** Whether inbound reply capture is enabled for this company. */
|
|
47
47
|
replyTrackingEnabled?: boolean;
|
|
48
|
+
/** Profile URL per platform. Bare hosts (`x.com/acme`) and mistyped web schemes (`ttps://`, `https:/`) are saved as `https://` URLs. */
|
|
48
49
|
socialLinks?: Record<string, string | null> | null;
|
|
49
50
|
status?: string;
|
|
50
51
|
termsUrl?: string | null;
|
|
@@ -15,15 +15,19 @@ export interface InAppMessage {
|
|
|
15
15
|
displayedAt?: Date | null;
|
|
16
16
|
/** After this the item leaves the open feed. Messages default to 30 days; cards never expire unless the step sets it. */
|
|
17
17
|
expiresAt?: Date | null;
|
|
18
|
+
/** Short line above the title, such as "3 days left"; empty when the step has none. */
|
|
19
|
+
eyebrow?: string;
|
|
18
20
|
/** How a message is shown; null for cards. */
|
|
19
21
|
format?: Sequenzy.InAppMessageFormat | null;
|
|
20
22
|
id?: string;
|
|
23
|
+
/** Modals and full screens with an image: top (image above the text) or background (image fills the message, text on a dark scrim over it). Null otherwise. */
|
|
24
|
+
imagePlacement?: Sequenzy.InAppMessageImagePlacement | null;
|
|
21
25
|
imageUrl?: string | null;
|
|
22
26
|
/** message: modal, banner or fullscreen, shown once. card: stays in the card feed until dismissed. */
|
|
23
27
|
kind?: Sequenzy.InAppMessageKind;
|
|
24
28
|
/** Cards only. Pinned cards sort first. */
|
|
25
29
|
pinned?: boolean;
|
|
26
|
-
/**
|
|
30
|
+
/** Banners: top or bottom. Modals: bottom (a sheet rising from the bottom edge) or center. Null for full screens and cards. */
|
|
27
31
|
position?: Sequenzy.InAppMessagePosition | null;
|
|
28
32
|
readAt?: Date | null;
|
|
29
33
|
sequenceId?: string | null;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/** Modals and full screens with an image: top (image above the text) or background (image fills the message, text on a dark scrim over it). Null otherwise. */
|
|
2
|
+
export declare const InAppMessageImagePlacement: {
|
|
3
|
+
readonly Top: "top";
|
|
4
|
+
readonly Background: "background";
|
|
5
|
+
};
|
|
6
|
+
export type InAppMessageImagePlacement = (typeof InAppMessageImagePlacement)[keyof typeof InAppMessageImagePlacement];
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.InAppMessageImagePlacement = void 0;
|
|
5
|
+
/** Modals and full screens with an image: top (image above the text) or background (image fills the message, text on a dark scrim over it). Null otherwise. */
|
|
6
|
+
exports.InAppMessageImagePlacement = {
|
|
7
|
+
Top: "top",
|
|
8
|
+
Background: "background",
|
|
9
|
+
};
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
/**
|
|
1
|
+
/** Banners: top or bottom. Modals: bottom (a sheet rising from the bottom edge) or center. Null for full screens and cards. */
|
|
2
2
|
export declare const InAppMessagePosition: {
|
|
3
3
|
readonly Top: "top";
|
|
4
4
|
readonly Bottom: "bottom";
|
|
5
|
+
readonly Center: "center";
|
|
5
6
|
};
|
|
6
7
|
export type InAppMessagePosition = (typeof InAppMessagePosition)[keyof typeof InAppMessagePosition];
|
|
@@ -2,8 +2,9 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.InAppMessagePosition = void 0;
|
|
5
|
-
/**
|
|
5
|
+
/** Banners: top or bottom. Modals: bottom (a sheet rising from the bottom edge) or center. Null for full screens and cards. */
|
|
6
6
|
exports.InAppMessagePosition = {
|
|
7
7
|
Top: "top",
|
|
8
8
|
Bottom: "bottom",
|
|
9
|
+
Center: "center",
|
|
9
10
|
};
|
|
@@ -10,6 +10,7 @@ export interface PushDevice {
|
|
|
10
10
|
locale?: string | null;
|
|
11
11
|
osVersion?: string | null;
|
|
12
12
|
platform?: Sequenzy.PushDevicePlatform;
|
|
13
|
+
/** web_sdk for browsers, mobile_sdk for devices the iOS, Android, React Native and Flutter SDKs registered, api for devices registered with a secret key. */
|
|
13
14
|
source?: Sequenzy.PushDeviceSource;
|
|
14
15
|
status?: Sequenzy.PushDeviceStatus;
|
|
15
16
|
/** Linked contact, or null for anonymous browsers. */
|
|
@@ -1,5 +1,7 @@
|
|
|
1
|
+
/** web_sdk for browsers, mobile_sdk for devices the iOS, Android, React Native and Flutter SDKs registered, api for devices registered with a secret key. */
|
|
1
2
|
export declare const PushDeviceSource: {
|
|
2
3
|
readonly WebSdk: "web_sdk";
|
|
4
|
+
readonly MobileSdk: "mobile_sdk";
|
|
3
5
|
readonly Api: "api";
|
|
4
6
|
};
|
|
5
7
|
export type PushDeviceSource = (typeof PushDeviceSource)[keyof typeof PushDeviceSource];
|
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.PushDeviceSource = void 0;
|
|
5
|
+
/** web_sdk for browsers, mobile_sdk for devices the iOS, Android, React Native and Flutter SDKs registered, api for devices registered with a secret key. */
|
|
5
6
|
exports.PushDeviceSource = {
|
|
6
7
|
WebSdk: "web_sdk",
|
|
8
|
+
MobileSdk: "mobile_sdk",
|
|
7
9
|
Api: "api",
|
|
8
10
|
};
|
|
@@ -13,6 +13,6 @@ export interface SequenceActionResponse {
|
|
|
13
13
|
sequenceId?: string;
|
|
14
14
|
status?: Sequenzy.SequenceStatus;
|
|
15
15
|
success?: boolean;
|
|
16
|
-
/** Enable only. Non-blocking readiness warnings, such as empty branch paths
|
|
16
|
+
/** Enable only. Non-blocking readiness warnings, such as empty branch paths, a `contact_added` trigger with no list, which enrolls every contact added to the company, or an email that uses `{{webhooks.KEY...}}` or `{{ai.KEY...}}` when no earlier step saves a result under that key, so those tags send empty. Absent when there is nothing to report. */
|
|
17
17
|
warnings?: string[];
|
|
18
18
|
}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* A publishable key for the browser tracking SDK. The key ships in the customer's page source by design, so it is not a secret; it authorizes
|
|
2
|
+
* A publishable key for the browser tracking SDK and the mobile SDKs. The key ships in the customer's page source or app by design, so it is not a secret; it authorizes client events only and carries origin and app ID allowlists instead of scopes.
|
|
3
3
|
*/
|
|
4
4
|
export interface WebTrackingKey {
|
|
5
|
-
/**
|
|
5
|
+
/** iOS bundle IDs and Android package names allowed to use this key from the mobile SDKs, matched case-insensitively against the x-sequenzy-app-id header on requests without an Origin header. A key with app IDs and no origins is rejected from browsers. */
|
|
6
|
+
allowedAppIds?: string[];
|
|
7
|
+
/** Normalized origins allowed to use this key from a browser. */
|
|
6
8
|
allowedOrigins?: string[];
|
|
7
9
|
createdAt?: Date;
|
|
8
10
|
/** Ingest URL the SDK posts events to. */
|
|
@@ -17,7 +19,7 @@ export interface WebTrackingKey {
|
|
|
17
19
|
name?: string;
|
|
18
20
|
/** The publishable key, prefixed seq_pk_. */
|
|
19
21
|
publicKey?: string;
|
|
20
|
-
/** True when
|
|
22
|
+
/** True when both allowedOrigins and allowedAppIds are empty, so any site or app can send events with this key. */
|
|
21
23
|
unrestricted?: boolean;
|
|
22
24
|
updatedAt?: Date;
|
|
23
25
|
/** Present only when the key is unrestricted. */
|