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.
Files changed (169) hide show
  1. package/dist/cjs/api/resources/inApp/client/Client.d.ts +36 -0
  2. package/dist/cjs/api/resources/inApp/client/Client.js +138 -0
  3. package/dist/cjs/api/resources/inApp/client/requests/WriteInAppCopyRequest.d.ts +13 -0
  4. package/dist/cjs/api/resources/inApp/client/requests/WriteInAppCopyRequest.js +3 -0
  5. package/dist/cjs/api/resources/inApp/client/requests/index.d.ts +1 -0
  6. package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponse.d.ts +5 -0
  7. package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponse.js +3 -0
  8. package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.d.ts +9 -0
  9. package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.js +3 -0
  10. package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.d.ts +7 -0
  11. package/dist/cjs/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.js +10 -0
  12. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyRequestFormat.d.ts +6 -0
  13. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyRequestFormat.js +9 -0
  14. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyRequestKind.d.ts +5 -0
  15. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyRequestKind.js +8 -0
  16. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponse.d.ts +5 -0
  17. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponse.js +3 -0
  18. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopy.d.ts +7 -0
  19. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopy.js +3 -0
  20. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.d.ts +5 -0
  21. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.js +3 -0
  22. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.d.ts +5 -0
  23. package/dist/cjs/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.js +8 -0
  24. package/dist/cjs/api/resources/inApp/types/index.d.ts +9 -0
  25. package/dist/cjs/api/resources/inApp/types/index.js +9 -0
  26. package/dist/cjs/api/resources/sequences/types/SimulateSequencesResponse.d.ts +1 -1
  27. package/dist/cjs/api/resources/sequences/types/SimulateSequencesResponseReadiness.d.ts +1 -1
  28. package/dist/cjs/api/resources/webTrackingKeys/client/Client.d.ts +2 -2
  29. package/dist/cjs/api/resources/webTrackingKeys/client/Client.js +2 -2
  30. package/dist/cjs/api/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.d.ts +3 -1
  31. package/dist/cjs/api/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.d.ts +3 -1
  32. package/dist/cjs/api/types/Company.d.ts +1 -0
  33. package/dist/cjs/api/types/InAppMessage.d.ts +5 -1
  34. package/dist/cjs/api/types/InAppMessageImagePlacement.d.ts +6 -0
  35. package/dist/cjs/api/types/InAppMessageImagePlacement.js +9 -0
  36. package/dist/cjs/api/types/InAppMessagePosition.d.ts +2 -1
  37. package/dist/cjs/api/types/InAppMessagePosition.js +2 -1
  38. package/dist/cjs/api/types/PushDevice.d.ts +1 -0
  39. package/dist/cjs/api/types/PushDeviceSource.d.ts +2 -0
  40. package/dist/cjs/api/types/PushDeviceSource.js +2 -0
  41. package/dist/cjs/api/types/SequenceActionResponse.d.ts +1 -1
  42. package/dist/cjs/api/types/WebTrackingKey.d.ts +5 -3
  43. package/dist/cjs/api/types/index.d.ts +1 -0
  44. package/dist/cjs/api/types/index.js +1 -0
  45. package/dist/cjs/serialization/resources/inApp/client/requests/WriteInAppCopyRequest.d.ts +14 -0
  46. package/dist/cjs/serialization/resources/inApp/client/requests/WriteInAppCopyRequest.js +36 -0
  47. package/dist/cjs/serialization/resources/inApp/client/requests/index.d.ts +1 -0
  48. package/dist/cjs/serialization/resources/inApp/client/requests/index.js +3 -1
  49. package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponse.d.ts +11 -0
  50. package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponse.js +33 -0
  51. package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.d.ts +14 -0
  52. package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.js +36 -0
  53. package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.d.ts +7 -0
  54. package/dist/cjs/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.js +29 -0
  55. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyRequestFormat.d.ts +7 -0
  56. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyRequestFormat.js +29 -0
  57. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyRequestKind.d.ts +7 -0
  58. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyRequestKind.js +29 -0
  59. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponse.d.ts +11 -0
  60. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponse.js +33 -0
  61. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopy.d.ts +13 -0
  62. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopy.js +35 -0
  63. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.d.ts +11 -0
  64. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.js +33 -0
  65. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.d.ts +7 -0
  66. package/dist/cjs/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.js +29 -0
  67. package/dist/cjs/serialization/resources/inApp/types/index.d.ts +9 -0
  68. package/dist/cjs/serialization/resources/inApp/types/index.js +9 -0
  69. package/dist/cjs/serialization/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.d.ts +1 -0
  70. package/dist/cjs/serialization/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.js +1 -0
  71. package/dist/cjs/serialization/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.d.ts +1 -0
  72. package/dist/cjs/serialization/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.js +1 -0
  73. package/dist/cjs/serialization/types/InAppMessage.d.ts +3 -0
  74. package/dist/cjs/serialization/types/InAppMessage.js +3 -0
  75. package/dist/cjs/serialization/types/InAppMessageImagePlacement.d.ts +7 -0
  76. package/dist/cjs/serialization/types/InAppMessageImagePlacement.js +29 -0
  77. package/dist/cjs/serialization/types/InAppMessagePosition.d.ts +1 -1
  78. package/dist/cjs/serialization/types/InAppMessagePosition.js +1 -1
  79. package/dist/cjs/serialization/types/PushDeviceSource.d.ts +1 -1
  80. package/dist/cjs/serialization/types/PushDeviceSource.js +1 -1
  81. package/dist/cjs/serialization/types/WebTrackingKey.d.ts +1 -0
  82. package/dist/cjs/serialization/types/WebTrackingKey.js +1 -0
  83. package/dist/cjs/serialization/types/index.d.ts +1 -0
  84. package/dist/cjs/serialization/types/index.js +1 -0
  85. package/dist/esm/api/resources/inApp/client/Client.d.ts +36 -0
  86. package/dist/esm/api/resources/inApp/client/Client.js +138 -0
  87. package/dist/esm/api/resources/inApp/client/requests/WriteInAppCopyRequest.d.ts +13 -0
  88. package/dist/esm/api/resources/inApp/client/requests/WriteInAppCopyRequest.js +2 -0
  89. package/dist/esm/api/resources/inApp/client/requests/index.d.ts +1 -0
  90. package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponse.d.ts +5 -0
  91. package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponse.js +2 -0
  92. package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.d.ts +9 -0
  93. package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.js +2 -0
  94. package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.d.ts +7 -0
  95. package/dist/esm/api/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.js +7 -0
  96. package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestFormat.d.ts +6 -0
  97. package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestFormat.js +6 -0
  98. package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestKind.d.ts +5 -0
  99. package/dist/esm/api/resources/inApp/types/WriteInAppCopyRequestKind.js +5 -0
  100. package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponse.d.ts +5 -0
  101. package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponse.js +2 -0
  102. package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopy.d.ts +7 -0
  103. package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopy.js +2 -0
  104. package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.d.ts +5 -0
  105. package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.js +2 -0
  106. package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.d.ts +5 -0
  107. package/dist/esm/api/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.js +5 -0
  108. package/dist/esm/api/resources/inApp/types/index.d.ts +9 -0
  109. package/dist/esm/api/resources/inApp/types/index.js +9 -0
  110. package/dist/esm/api/resources/sequences/types/SimulateSequencesResponse.d.ts +1 -1
  111. package/dist/esm/api/resources/sequences/types/SimulateSequencesResponseReadiness.d.ts +1 -1
  112. package/dist/esm/api/resources/webTrackingKeys/client/Client.d.ts +2 -2
  113. package/dist/esm/api/resources/webTrackingKeys/client/Client.js +2 -2
  114. package/dist/esm/api/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.d.ts +3 -1
  115. package/dist/esm/api/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.d.ts +3 -1
  116. package/dist/esm/api/types/Company.d.ts +1 -0
  117. package/dist/esm/api/types/InAppMessage.d.ts +5 -1
  118. package/dist/esm/api/types/InAppMessageImagePlacement.d.ts +6 -0
  119. package/dist/esm/api/types/InAppMessageImagePlacement.js +6 -0
  120. package/dist/esm/api/types/InAppMessagePosition.d.ts +2 -1
  121. package/dist/esm/api/types/InAppMessagePosition.js +2 -1
  122. package/dist/esm/api/types/PushDevice.d.ts +1 -0
  123. package/dist/esm/api/types/PushDeviceSource.d.ts +2 -0
  124. package/dist/esm/api/types/PushDeviceSource.js +2 -0
  125. package/dist/esm/api/types/SequenceActionResponse.d.ts +1 -1
  126. package/dist/esm/api/types/WebTrackingKey.d.ts +5 -3
  127. package/dist/esm/api/types/index.d.ts +1 -0
  128. package/dist/esm/api/types/index.js +1 -0
  129. package/dist/esm/serialization/resources/inApp/client/requests/WriteInAppCopyRequest.d.ts +14 -0
  130. package/dist/esm/serialization/resources/inApp/client/requests/WriteInAppCopyRequest.js +10 -0
  131. package/dist/esm/serialization/resources/inApp/client/requests/index.d.ts +1 -0
  132. package/dist/esm/serialization/resources/inApp/client/requests/index.js +1 -0
  133. package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponse.d.ts +11 -0
  134. package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponse.js +7 -0
  135. package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.d.ts +14 -0
  136. package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItem.js +10 -0
  137. package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.d.ts +7 -0
  138. package/dist/esm/serialization/resources/inApp/types/ListInAppTemplatesResponseTemplatesItemCategory.js +3 -0
  139. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyRequestFormat.d.ts +7 -0
  140. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyRequestFormat.js +3 -0
  141. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyRequestKind.d.ts +7 -0
  142. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyRequestKind.js +3 -0
  143. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponse.d.ts +11 -0
  144. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponse.js +7 -0
  145. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopy.d.ts +13 -0
  146. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopy.js +9 -0
  147. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.d.ts +11 -0
  148. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItem.js +7 -0
  149. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.d.ts +7 -0
  150. package/dist/esm/serialization/resources/inApp/types/WriteInAppCopyResponseCopyButtonsItemAction.js +3 -0
  151. package/dist/esm/serialization/resources/inApp/types/index.d.ts +9 -0
  152. package/dist/esm/serialization/resources/inApp/types/index.js +9 -0
  153. package/dist/esm/serialization/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.d.ts +1 -0
  154. package/dist/esm/serialization/resources/webTrackingKeys/client/requests/CreateWebTrackingKeysRequest.js +1 -0
  155. package/dist/esm/serialization/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.d.ts +1 -0
  156. package/dist/esm/serialization/resources/webTrackingKeys/client/requests/UpdateWebTrackingKeysRequest.js +1 -0
  157. package/dist/esm/serialization/types/InAppMessage.d.ts +3 -0
  158. package/dist/esm/serialization/types/InAppMessage.js +3 -0
  159. package/dist/esm/serialization/types/InAppMessageImagePlacement.d.ts +7 -0
  160. package/dist/esm/serialization/types/InAppMessageImagePlacement.js +3 -0
  161. package/dist/esm/serialization/types/InAppMessagePosition.d.ts +1 -1
  162. package/dist/esm/serialization/types/InAppMessagePosition.js +1 -1
  163. package/dist/esm/serialization/types/PushDeviceSource.d.ts +1 -1
  164. package/dist/esm/serialization/types/PushDeviceSource.js +1 -1
  165. package/dist/esm/serialization/types/WebTrackingKey.d.ts +1 -0
  166. package/dist/esm/serialization/types/WebTrackingKey.js +1 -0
  167. package/dist/esm/serialization/types/index.d.ts +1 -0
  168. package/dist/esm/serialization/types/index.js +1 -0
  169. package/package.json +1 -1
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || function (mod) {
20
+ if (mod && mod.__esModule) return mod;
21
+ var result = {};
22
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
23
+ __setModuleDefault(result, mod);
24
+ return result;
25
+ };
26
+ Object.defineProperty(exports, "__esModule", { value: true });
27
+ exports.InAppMessageImagePlacement = void 0;
28
+ const core = __importStar(require("../../core/index.js"));
29
+ exports.InAppMessageImagePlacement = core.serialization.enum_(["top", "background"]);
@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
3
3
  import type * as serializers from "../index.js";
4
4
  export declare const InAppMessagePosition: core.serialization.Schema<serializers.InAppMessagePosition.Raw, Sequenzy.InAppMessagePosition>;
5
5
  export declare namespace InAppMessagePosition {
6
- type Raw = "top" | "bottom";
6
+ type Raw = "top" | "bottom" | "center";
7
7
  }
@@ -26,4 +26,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
26
26
  Object.defineProperty(exports, "__esModule", { value: true });
27
27
  exports.InAppMessagePosition = void 0;
28
28
  const core = __importStar(require("../../core/index.js"));
29
- exports.InAppMessagePosition = core.serialization.enum_(["top", "bottom"]);
29
+ exports.InAppMessagePosition = core.serialization.enum_(["top", "bottom", "center"]);
@@ -3,5 +3,5 @@ import * as core from "../../core/index.js";
3
3
  import type * as serializers from "../index.js";
4
4
  export declare const PushDeviceSource: core.serialization.Schema<serializers.PushDeviceSource.Raw, Sequenzy.PushDeviceSource>;
5
5
  export declare namespace PushDeviceSource {
6
- type Raw = "web_sdk" | "api";
6
+ type Raw = "web_sdk" | "mobile_sdk" | "api";
7
7
  }
@@ -26,4 +26,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
26
26
  Object.defineProperty(exports, "__esModule", { value: true });
27
27
  exports.PushDeviceSource = void 0;
28
28
  const core = __importStar(require("../../core/index.js"));
29
- exports.PushDeviceSource = core.serialization.enum_(["web_sdk", "api"]);
29
+ exports.PushDeviceSource = core.serialization.enum_(["web_sdk", "mobile_sdk", "api"]);
@@ -4,6 +4,7 @@ import type * as serializers from "../index.js";
4
4
  export declare const WebTrackingKey: core.serialization.ObjectSchema<serializers.WebTrackingKey.Raw, Sequenzy.WebTrackingKey>;
5
5
  export declare namespace WebTrackingKey {
6
6
  interface Raw {
7
+ allowedAppIds?: string[] | null;
7
8
  allowedOrigins?: string[] | null;
8
9
  createdAt?: string | null;
9
10
  endpoint?: string | null;
@@ -27,6 +27,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
27
27
  exports.WebTrackingKey = void 0;
28
28
  const core = __importStar(require("../../core/index.js"));
29
29
  exports.WebTrackingKey = core.serialization.object({
30
+ allowedAppIds: core.serialization.list(core.serialization.string()).optional(),
30
31
  allowedOrigins: core.serialization.list(core.serialization.string()).optional(),
31
32
  createdAt: core.serialization.date().optional(),
32
33
  endpoint: core.serialization.string().optional(),
@@ -311,6 +311,7 @@ export * from "./InAppMessage.js";
311
311
  export * from "./InAppMessageButtonsItem.js";
312
312
  export * from "./InAppMessageButtonsItemAction.js";
313
313
  export * from "./InAppMessageFormat.js";
314
+ export * from "./InAppMessageImagePlacement.js";
314
315
  export * from "./InAppMessageKind.js";
315
316
  export * from "./InAppMessagePosition.js";
316
317
  export * from "./InAppStyle.js";
@@ -327,6 +327,7 @@ __exportStar(require("./InAppMessage.js"), exports);
327
327
  __exportStar(require("./InAppMessageButtonsItem.js"), exports);
328
328
  __exportStar(require("./InAppMessageButtonsItemAction.js"), exports);
329
329
  __exportStar(require("./InAppMessageFormat.js"), exports);
330
+ __exportStar(require("./InAppMessageImagePlacement.js"), exports);
330
331
  __exportStar(require("./InAppMessageKind.js"), exports);
331
332
  __exportStar(require("./InAppMessagePosition.js"), exports);
332
333
  __exportStar(require("./InAppStyle.js"), exports);
@@ -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
  }
@@ -248,6 +248,66 @@ export class InAppClient {
248
248
  }
249
249
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/in-app/messages");
250
250
  }
251
+ /**
252
+ * 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.
253
+ *
254
+ * @param {InAppClient.RequestOptions} requestOptions - Request-specific configuration.
255
+ *
256
+ * @throws {@link Sequenzy.UnauthorizedError}
257
+ * @throws {@link Sequenzy.ForbiddenError}
258
+ * @throws {@link errors.SequenzyError}
259
+ * @throws {@link errors.SequenzyTimeoutError}
260
+ *
261
+ * @example
262
+ * await client.inApp.listInAppTemplates()
263
+ */
264
+ listInAppTemplates(requestOptions) {
265
+ return core.HttpResponsePromise.fromPromise(this.__listInAppTemplates(requestOptions));
266
+ }
267
+ async __listInAppTemplates(requestOptions) {
268
+ const _authRequest = await this._options.authProvider.getAuthRequest();
269
+ const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
270
+ const _response = await core.fetcher({
271
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
272
+ (await core.Supplier.get(this._options.environment)) ??
273
+ environments.SequenzyEnvironment.Default, "in-app/templates"),
274
+ method: "GET",
275
+ headers: _headers,
276
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
277
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
278
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
279
+ abortSignal: requestOptions?.abortSignal,
280
+ fetchFn: this._options?.fetch,
281
+ logging: this._options.logging,
282
+ });
283
+ if (_response.ok) {
284
+ return {
285
+ data: serializers.ListInAppTemplatesResponse.parseOrThrow(_response.body, {
286
+ unrecognizedObjectKeys: "passthrough",
287
+ allowUnrecognizedUnionMembers: true,
288
+ allowUnrecognizedEnumValues: true,
289
+ skipValidation: true,
290
+ breadcrumbsPrefix: ["response"],
291
+ }),
292
+ rawResponse: _response.rawResponse,
293
+ };
294
+ }
295
+ if (_response.error.reason === "status-code") {
296
+ switch (_response.error.statusCode) {
297
+ case 401:
298
+ throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
299
+ case 403:
300
+ throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
301
+ default:
302
+ throw new errors.SequenzyError({
303
+ statusCode: _response.error.statusCode,
304
+ body: _response.error.body,
305
+ rawResponse: _response.rawResponse,
306
+ });
307
+ }
308
+ }
309
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/in-app/templates");
310
+ }
251
311
  /**
252
312
  * 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.
253
313
  *
@@ -328,4 +388,82 @@ export class InAppClient {
328
388
  }
329
389
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/in-app/messages/{messageId}/events");
330
390
  }
391
+ /**
392
+ * 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.
393
+ *
394
+ * @param {Sequenzy.WriteInAppCopyRequest} request
395
+ * @param {InAppClient.RequestOptions} requestOptions - Request-specific configuration.
396
+ *
397
+ * @throws {@link Sequenzy.UnauthorizedError}
398
+ * @throws {@link Sequenzy.ForbiddenError}
399
+ * @throws {@link Sequenzy.UnprocessableEntityError}
400
+ * @throws {@link Sequenzy.TooManyRequestsError}
401
+ * @throws {@link Sequenzy.InternalServerError}
402
+ * @throws {@link errors.SequenzyError}
403
+ * @throws {@link errors.SequenzyTimeoutError}
404
+ *
405
+ * @example
406
+ * await client.inApp.writeInAppCopy({
407
+ * brief: "brief"
408
+ * })
409
+ */
410
+ writeInAppCopy(request, requestOptions) {
411
+ return core.HttpResponsePromise.fromPromise(this.__writeInAppCopy(request, requestOptions));
412
+ }
413
+ async __writeInAppCopy(request, requestOptions) {
414
+ const _authRequest = await this._options.authProvider.getAuthRequest();
415
+ const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
416
+ const _response = await core.fetcher({
417
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
418
+ (await core.Supplier.get(this._options.environment)) ??
419
+ environments.SequenzyEnvironment.Default, "in-app/copy"),
420
+ method: "POST",
421
+ headers: _headers,
422
+ contentType: "application/json",
423
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
424
+ requestType: "json",
425
+ body: mergeAdditionalBodyParameters(serializers.WriteInAppCopyRequest.jsonOrThrow(request, {
426
+ unrecognizedObjectKeys: "strip",
427
+ omitUndefined: true,
428
+ }), requestOptions?.additionalBodyParameters),
429
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
430
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
431
+ abortSignal: requestOptions?.abortSignal,
432
+ fetchFn: this._options?.fetch,
433
+ logging: this._options.logging,
434
+ });
435
+ if (_response.ok) {
436
+ return {
437
+ data: serializers.WriteInAppCopyResponse.parseOrThrow(_response.body, {
438
+ unrecognizedObjectKeys: "passthrough",
439
+ allowUnrecognizedUnionMembers: true,
440
+ allowUnrecognizedEnumValues: true,
441
+ skipValidation: true,
442
+ breadcrumbsPrefix: ["response"],
443
+ }),
444
+ rawResponse: _response.rawResponse,
445
+ };
446
+ }
447
+ if (_response.error.reason === "status-code") {
448
+ switch (_response.error.statusCode) {
449
+ case 401:
450
+ throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
451
+ case 403:
452
+ throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
453
+ case 422:
454
+ throw new Sequenzy.UnprocessableEntityError(_response.error.body, _response.rawResponse);
455
+ case 429:
456
+ throw new Sequenzy.TooManyRequestsError(_response.error.body, _response.rawResponse);
457
+ case 500:
458
+ throw new Sequenzy.InternalServerError(_response.error.body, _response.rawResponse);
459
+ default:
460
+ throw new errors.SequenzyError({
461
+ statusCode: _response.error.statusCode,
462
+ body: _response.error.body,
463
+ rawResponse: _response.rawResponse,
464
+ });
465
+ }
466
+ }
467
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/in-app/copy");
468
+ }
331
469
  }
@@ -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
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -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,5 @@
1
+ import type * as Sequenzy from "../../../index.js";
2
+ export interface ListInAppTemplatesResponse {
3
+ success?: boolean;
4
+ templates?: Sequenzy.ListInAppTemplatesResponseTemplatesItem[];
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -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
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -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,7 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export const ListInAppTemplatesResponseTemplatesItemCategory = {
3
+ Conversion: "Conversion",
4
+ Onboarding: "Onboarding",
5
+ Announcement: "Announcement",
6
+ Engagement: "Engagement",
7
+ };
@@ -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,6 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export const WriteInAppCopyRequestFormat = {
3
+ Modal: "modal",
4
+ Banner: "banner",
5
+ Fullscreen: "fullscreen",
6
+ };
@@ -0,0 +1,5 @@
1
+ export declare const WriteInAppCopyRequestKind: {
2
+ readonly Message: "message";
3
+ readonly Card: "card";
4
+ };
5
+ export type WriteInAppCopyRequestKind = (typeof WriteInAppCopyRequestKind)[keyof typeof WriteInAppCopyRequestKind];
@@ -0,0 +1,5 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export const WriteInAppCopyRequestKind = {
3
+ Message: "message",
4
+ Card: "card",
5
+ };
@@ -0,0 +1,5 @@
1
+ import type * as Sequenzy from "../../../index.js";
2
+ export interface WriteInAppCopyResponse {
3
+ copy?: Sequenzy.WriteInAppCopyResponseCopy;
4
+ success?: boolean;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ import type * as Sequenzy from "../../../index.js";
2
+ export interface WriteInAppCopyResponseCopy {
3
+ body?: string;
4
+ buttons?: Sequenzy.WriteInAppCopyResponseCopyButtonsItem[];
5
+ eyebrow?: string;
6
+ title?: string;
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ import type * as Sequenzy from "../../../index.js";
2
+ export interface WriteInAppCopyResponseCopyButtonsItem {
3
+ action?: Sequenzy.WriteInAppCopyResponseCopyButtonsItemAction;
4
+ label?: string;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -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,5 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export const WriteInAppCopyResponseCopyButtonsItemAction = {
3
+ OpenUrl: "open_url",
4
+ Dismiss: "dismiss",
5
+ };
@@ -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";
@@ -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";
@@ -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 - an empty allowlist accepts events from any site. Requires the integrations:manage scope.
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 replaces 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.
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.
@@ -16,7 +16,7 @@ export class WebTrackingKeysClient {
16
16
  this._options = normalizeClientOptionsWithAuth(options);
17
17
  }
18
18
  /**
19
- * 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 - an empty allowlist accepts events from any site. Requires the integrations:manage scope.
19
+ * 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.
20
20
  *
21
21
  * @param {Sequenzy.CreateWebTrackingKeysRequest} request
22
22
  * @param {WebTrackingKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -357,7 +357,7 @@ export class WebTrackingKeysClient {
357
357
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/web-tracking-identities");
358
358
  }
359
359
  /**
360
- * Renames a key, replaces its allowed origins, or revokes it. allowedOrigins replaces 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.
360
+ * 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.
361
361
  *
362
362
  * @param {Sequenzy.UpdateWebTrackingKeysRequest} request
363
363
  * @param {WebTrackingKeysClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -5,7 +5,9 @@
5
5
  * }
6
6
  */
7
7
  export interface CreateWebTrackingKeysRequest {
8
- /** 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 leaves the key unrestricted. */
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;
@@ -7,7 +7,9 @@
7
7
  export interface UpdateWebTrackingKeysRequest {
8
8
  /** Web tracking key ID. */
9
9
  id: string;
10
- /** Replacement allowlist. Pass an empty array to make the key unrestricted. */
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
- /** Banner position; null for other formats and cards. */
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,6 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ /** 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. */
3
+ export const InAppMessageImagePlacement = {
4
+ Top: "top",
5
+ Background: "background",
6
+ };
@@ -1,6 +1,7 @@
1
- /** Banner position; null for other formats and cards. */
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];