@contentful/optimization-api-client 2.2.1 → 2.2.2
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/README.md +6 -6
- package/THIRD_PARTY_NOTICES.txt +1 -1
- package/dist/api-schemas.cjs +4 -2
- package/dist/api-schemas.cjs.map +1 -1
- package/dist/api-schemas.d.cts +17 -492
- package/dist/api-schemas.d.mts +17 -492
- package/dist/api-schemas.d.ts +17 -492
- package/dist/api-schemas.mjs +4 -2
- package/dist/api-schemas.mjs.map +1 -1
- package/dist/guards.d.cts +0 -30
- package/dist/guards.d.mts +0 -30
- package/dist/guards.d.ts +0 -30
- package/dist/index.d.cts +4 -125
- package/dist/index.d.mts +4 -125
- package/dist/index.d.ts +4 -125
- package/package.json +2 -2
package/dist/api-schemas.d.mts
CHANGED
|
@@ -12,13 +12,7 @@ import * as z from 'zod/mini';
|
|
|
12
12
|
* @public
|
|
13
13
|
*/
|
|
14
14
|
export declare const App: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
15
|
-
/**
|
|
16
|
-
* Name of the application.
|
|
17
|
-
*/
|
|
18
15
|
name: z.ZodMiniString<string>;
|
|
19
|
-
/**
|
|
20
|
-
* Version of the application.
|
|
21
|
-
*/
|
|
22
16
|
version: z.ZodMiniString<string>;
|
|
23
17
|
}, z.core.$strip>>;
|
|
24
18
|
|
|
@@ -168,7 +162,7 @@ export declare const BatchExperienceEvent: z.ZodMiniDiscriminatedUnion<[z.ZodMin
|
|
|
168
162
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
169
163
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
170
164
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
171
|
-
viewDurationMs: z.
|
|
165
|
+
viewDurationMs: z.ZodMiniInt;
|
|
172
166
|
viewId: z.ZodMiniString<string>;
|
|
173
167
|
anonymousId: z.ZodMiniString<string>;
|
|
174
168
|
}, z.core.$strip>, z.ZodMiniObject<{
|
|
@@ -542,7 +536,7 @@ export declare const BatchExperienceEventArray: z.ZodMiniArray<z.ZodMiniDiscrimi
|
|
|
542
536
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
543
537
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
544
538
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
545
|
-
viewDurationMs: z.
|
|
539
|
+
viewDurationMs: z.ZodMiniInt;
|
|
546
540
|
viewId: z.ZodMiniString<string>;
|
|
547
541
|
anonymousId: z.ZodMiniString<string>;
|
|
548
542
|
}, z.core.$strip>, z.ZodMiniObject<{
|
|
@@ -789,12 +783,6 @@ export declare type BatchExperienceEventArray = z.infer<typeof BatchExperienceEv
|
|
|
789
783
|
* least one event.
|
|
790
784
|
*/
|
|
791
785
|
export declare const BatchExperienceRequestData: z.ZodMiniObject<{
|
|
792
|
-
/**
|
|
793
|
-
* Batch experience events for the Experience API to evaluate.
|
|
794
|
-
*
|
|
795
|
-
* @remarks
|
|
796
|
-
* Must contain at least one event.
|
|
797
|
-
*/
|
|
798
786
|
events: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
799
787
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
800
788
|
context: z.ZodMiniObject<{
|
|
@@ -925,7 +913,7 @@ export declare const BatchExperienceRequestData: z.ZodMiniObject<{
|
|
|
925
913
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
926
914
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
927
915
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
928
|
-
viewDurationMs: z.
|
|
916
|
+
viewDurationMs: z.ZodMiniInt;
|
|
929
917
|
viewId: z.ZodMiniString<string>;
|
|
930
918
|
anonymousId: z.ZodMiniString<string>;
|
|
931
919
|
}, z.core.$strip>, z.ZodMiniObject<{
|
|
@@ -1156,9 +1144,6 @@ export declare const BatchExperienceRequestData: z.ZodMiniObject<{
|
|
|
1156
1144
|
properties: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>;
|
|
1157
1145
|
anonymousId: z.ZodMiniString<string>;
|
|
1158
1146
|
}, z.core.$strip>], "type">>;
|
|
1159
|
-
/**
|
|
1160
|
-
* Optional feature configuration. Batch locations belong in each event's `context.location`.
|
|
1161
|
-
*/
|
|
1162
1147
|
options: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
1163
1148
|
features: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
|
|
1164
1149
|
}, z.core.$strip>>;
|
|
@@ -1184,9 +1169,6 @@ export declare const BatchExperienceResponse: z.ZodMiniObject<{
|
|
|
1184
1169
|
code: z.ZodMiniString<string>;
|
|
1185
1170
|
}, z.core.$strip>>;
|
|
1186
1171
|
data: z.ZodMiniObject<{
|
|
1187
|
-
/**
|
|
1188
|
-
* Profiles evaluated or affected by the batch experience request.
|
|
1189
|
-
*/
|
|
1190
1172
|
profiles: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
|
|
1191
1173
|
id: z.ZodMiniString<string>;
|
|
1192
1174
|
stableId: z.ZodMiniString<string>;
|
|
@@ -1243,9 +1225,6 @@ export declare type BatchExperienceResponse = z.infer<typeof BatchExperienceResp
|
|
|
1243
1225
|
* @public
|
|
1244
1226
|
*/
|
|
1245
1227
|
export declare const BatchExperienceResponseData: z.ZodMiniObject<{
|
|
1246
|
-
/**
|
|
1247
|
-
* Profiles evaluated or affected by the batch experience request.
|
|
1248
|
-
*/
|
|
1249
1228
|
profiles: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
|
|
1250
1229
|
id: z.ZodMiniString<string>;
|
|
1251
1230
|
stableId: z.ZodMiniString<string>;
|
|
@@ -1301,19 +1280,9 @@ export declare type BatchExperienceResponseData = z.infer<typeof BatchExperience
|
|
|
1301
1280
|
* @public
|
|
1302
1281
|
*/
|
|
1303
1282
|
export declare const BatchInsightsEvent: z.ZodMiniObject<{
|
|
1304
|
-
/**
|
|
1305
|
-
* Partial profile information used to associate events with a user.
|
|
1306
|
-
*
|
|
1307
|
-
* @see {@link PartialProfile}
|
|
1308
|
-
*/
|
|
1309
1283
|
profile: z.ZodMiniObject<{
|
|
1310
1284
|
id: z.ZodMiniString<string>;
|
|
1311
1285
|
}, z.core.$catchall<z.ZodMiniJSONSchema>>;
|
|
1312
|
-
/**
|
|
1313
|
-
* Insights events to record for this profile.
|
|
1314
|
-
*
|
|
1315
|
-
* @see {@link InsightsEventArray}
|
|
1316
|
-
*/
|
|
1317
1286
|
events: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
1318
1287
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
1319
1288
|
context: z.ZodMiniObject<{
|
|
@@ -1563,7 +1532,7 @@ export declare const BatchInsightsEvent: z.ZodMiniObject<{
|
|
|
1563
1532
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
1564
1533
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
1565
1534
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
1566
|
-
viewDurationMs: z.
|
|
1535
|
+
viewDurationMs: z.ZodMiniInt;
|
|
1567
1536
|
viewId: z.ZodMiniString<string>;
|
|
1568
1537
|
}, z.core.$strip>, z.ZodMiniObject<{
|
|
1569
1538
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
@@ -1701,7 +1670,7 @@ export declare const BatchInsightsEvent: z.ZodMiniObject<{
|
|
|
1701
1670
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
1702
1671
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
1703
1672
|
type: z.ZodMiniLiteral<"exo_node_hover">;
|
|
1704
|
-
hoverDurationMs: z.
|
|
1673
|
+
hoverDurationMs: z.ZodMiniInt;
|
|
1705
1674
|
hoverId: z.ZodMiniString<string>;
|
|
1706
1675
|
}, z.core.$strip>], "type">>;
|
|
1707
1676
|
}, z.core.$strip>;
|
|
@@ -1722,19 +1691,9 @@ export declare type BatchInsightsEvent = z.infer<typeof BatchInsightsEvent>;
|
|
|
1722
1691
|
* @public
|
|
1723
1692
|
*/
|
|
1724
1693
|
export declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
|
|
1725
|
-
/**
|
|
1726
|
-
* Partial profile information used to associate events with a user.
|
|
1727
|
-
*
|
|
1728
|
-
* @see {@link PartialProfile}
|
|
1729
|
-
*/
|
|
1730
1694
|
profile: z.ZodMiniObject<{
|
|
1731
1695
|
id: z.ZodMiniString<string>;
|
|
1732
1696
|
}, z.core.$catchall<z.ZodMiniJSONSchema>>;
|
|
1733
|
-
/**
|
|
1734
|
-
* Insights events to record for this profile.
|
|
1735
|
-
*
|
|
1736
|
-
* @see {@link InsightsEventArray}
|
|
1737
|
-
*/
|
|
1738
1697
|
events: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
1739
1698
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
1740
1699
|
context: z.ZodMiniObject<{
|
|
@@ -1984,7 +1943,7 @@ export declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
|
|
|
1984
1943
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
1985
1944
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
1986
1945
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
1987
|
-
viewDurationMs: z.
|
|
1946
|
+
viewDurationMs: z.ZodMiniInt;
|
|
1988
1947
|
viewId: z.ZodMiniString<string>;
|
|
1989
1948
|
}, z.core.$strip>, z.ZodMiniObject<{
|
|
1990
1949
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
@@ -2122,7 +2081,7 @@ export declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
|
|
|
2122
2081
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
2123
2082
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
2124
2083
|
type: z.ZodMiniLiteral<"exo_node_hover">;
|
|
2125
|
-
hoverDurationMs: z.
|
|
2084
|
+
hoverDurationMs: z.ZodMiniInt;
|
|
2126
2085
|
hoverId: z.ZodMiniString<string>;
|
|
2127
2086
|
}, z.core.$strip>], "type">>;
|
|
2128
2087
|
}, z.core.$strip>>;
|
|
@@ -2143,25 +2102,10 @@ export declare type BatchInsightsEventArray = z.infer<typeof BatchInsightsEventA
|
|
|
2143
2102
|
* @public
|
|
2144
2103
|
*/
|
|
2145
2104
|
export declare const Campaign: z.ZodMiniObject<{
|
|
2146
|
-
/**
|
|
2147
|
-
* Name of the campaign (e.g., `utm_campaign`).
|
|
2148
|
-
*/
|
|
2149
2105
|
name: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
2150
|
-
/**
|
|
2151
|
-
* Campaign source (e.g., `utm_source`).
|
|
2152
|
-
*/
|
|
2153
2106
|
source: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
2154
|
-
/**
|
|
2155
|
-
* Campaign medium (e.g., `utm_medium`).
|
|
2156
|
-
*/
|
|
2157
2107
|
medium: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
2158
|
-
/**
|
|
2159
|
-
* Campaign term (e.g., `utm_term`).
|
|
2160
|
-
*/
|
|
2161
2108
|
term: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
2162
|
-
/**
|
|
2163
|
-
* Campaign content (e.g., `utm_content`).
|
|
2164
|
-
*/
|
|
2165
2109
|
content: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
2166
2110
|
}, z.core.$strip>;
|
|
2167
2111
|
|
|
@@ -2180,16 +2124,7 @@ export declare type Campaign = z.infer<typeof Campaign>;
|
|
|
2180
2124
|
export declare const Change: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
2181
2125
|
key: z.ZodMiniString<string>;
|
|
2182
2126
|
meta: z.ZodMiniObject<{
|
|
2183
|
-
/**
|
|
2184
|
-
* Identifier of the personalization or experiment experience.
|
|
2185
|
-
*/
|
|
2186
2127
|
experienceId: z.ZodMiniString<string>;
|
|
2187
|
-
/**
|
|
2188
|
-
* Index of the variant within the experience configuration.
|
|
2189
|
-
*
|
|
2190
|
-
* @remarks
|
|
2191
|
-
* Typically corresponds to the array index in the experience's distribution.
|
|
2192
|
-
*/
|
|
2193
2128
|
variantIndex: z.ZodMiniNumber<number>;
|
|
2194
2129
|
}, z.core.$strip>;
|
|
2195
2130
|
type: z.ZodMiniLiteral<"Variable">;
|
|
@@ -2198,13 +2133,7 @@ export declare const Change: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
|
2198
2133
|
id: z.ZodMiniString<string>;
|
|
2199
2134
|
variantId: z.ZodMiniString<string>;
|
|
2200
2135
|
meta: z.ZodMiniObject<{
|
|
2201
|
-
/**
|
|
2202
|
-
* Identifier of the optimization that produced this change.
|
|
2203
|
-
*/
|
|
2204
2136
|
optimizationId: z.ZodMiniString<string>;
|
|
2205
|
-
/**
|
|
2206
|
-
* Index of the variant within the optimization's distribution.
|
|
2207
|
-
*/
|
|
2208
2137
|
variantIndex: z.ZodMiniNumber<number>;
|
|
2209
2138
|
}, z.core.$strip>;
|
|
2210
2139
|
type: z.ZodMiniLiteral<"Experience">;
|
|
@@ -2212,13 +2141,7 @@ export declare const Change: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
|
2212
2141
|
id: z.ZodMiniString<string>;
|
|
2213
2142
|
variantId: z.ZodMiniString<string>;
|
|
2214
2143
|
meta: z.ZodMiniObject<{
|
|
2215
|
-
/**
|
|
2216
|
-
* Identifier of the optimization that produced this change.
|
|
2217
|
-
*/
|
|
2218
2144
|
optimizationId: z.ZodMiniString<string>;
|
|
2219
|
-
/**
|
|
2220
|
-
* Index of the variant within the optimization's distribution.
|
|
2221
|
-
*/
|
|
2222
2145
|
variantIndex: z.ZodMiniNumber<number>;
|
|
2223
2146
|
}, z.core.$strip>;
|
|
2224
2147
|
type: z.ZodMiniLiteral<"Fragment">;
|
|
@@ -2239,16 +2162,7 @@ export declare type Change = z.infer<typeof Change>;
|
|
|
2239
2162
|
export declare const ChangeArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
2240
2163
|
key: z.ZodMiniString<string>;
|
|
2241
2164
|
meta: z.ZodMiniObject<{
|
|
2242
|
-
/**
|
|
2243
|
-
* Identifier of the personalization or experiment experience.
|
|
2244
|
-
*/
|
|
2245
2165
|
experienceId: z.ZodMiniString<string>;
|
|
2246
|
-
/**
|
|
2247
|
-
* Index of the variant within the experience configuration.
|
|
2248
|
-
*
|
|
2249
|
-
* @remarks
|
|
2250
|
-
* Typically corresponds to the array index in the experience's distribution.
|
|
2251
|
-
*/
|
|
2252
2166
|
variantIndex: z.ZodMiniNumber<number>;
|
|
2253
2167
|
}, z.core.$strip>;
|
|
2254
2168
|
type: z.ZodMiniLiteral<"Variable">;
|
|
@@ -2257,13 +2171,7 @@ export declare const ChangeArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.
|
|
|
2257
2171
|
id: z.ZodMiniString<string>;
|
|
2258
2172
|
variantId: z.ZodMiniString<string>;
|
|
2259
2173
|
meta: z.ZodMiniObject<{
|
|
2260
|
-
/**
|
|
2261
|
-
* Identifier of the optimization that produced this change.
|
|
2262
|
-
*/
|
|
2263
2174
|
optimizationId: z.ZodMiniString<string>;
|
|
2264
|
-
/**
|
|
2265
|
-
* Index of the variant within the optimization's distribution.
|
|
2266
|
-
*/
|
|
2267
2175
|
variantIndex: z.ZodMiniNumber<number>;
|
|
2268
2176
|
}, z.core.$strip>;
|
|
2269
2177
|
type: z.ZodMiniLiteral<"Experience">;
|
|
@@ -2271,13 +2179,7 @@ export declare const ChangeArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.
|
|
|
2271
2179
|
id: z.ZodMiniString<string>;
|
|
2272
2180
|
variantId: z.ZodMiniString<string>;
|
|
2273
2181
|
meta: z.ZodMiniObject<{
|
|
2274
|
-
/**
|
|
2275
|
-
* Identifier of the optimization that produced this change.
|
|
2276
|
-
*/
|
|
2277
2182
|
optimizationId: z.ZodMiniString<string>;
|
|
2278
|
-
/**
|
|
2279
|
-
* Index of the variant within the optimization's distribution.
|
|
2280
|
-
*/
|
|
2281
2183
|
variantIndex: z.ZodMiniNumber<number>;
|
|
2282
2184
|
}, z.core.$strip>;
|
|
2283
2185
|
type: z.ZodMiniLiteral<"Fragment">;
|
|
@@ -2299,35 +2201,14 @@ export declare type ChangeArray = z.infer<typeof ChangeArray>;
|
|
|
2299
2201
|
* @internal
|
|
2300
2202
|
*/
|
|
2301
2203
|
export declare const ChangeBase: z.ZodMiniObject<{
|
|
2302
|
-
/**
|
|
2303
|
-
* Key identifying the subject of the change.
|
|
2304
|
-
*/
|
|
2305
2204
|
key: z.ZodMiniString<string>;
|
|
2306
|
-
/**
|
|
2307
|
-
* Discriminator for the change type.
|
|
2308
|
-
*
|
|
2309
|
-
* @remarks
|
|
2310
|
-
* Can be one of {@link ChangeType} or an arbitrary string for unknown types.
|
|
2311
|
-
*/
|
|
2312
2205
|
type: z.ZodMiniUnion<readonly [z.ZodMiniEnum<{
|
|
2313
2206
|
Experience: "Experience";
|
|
2314
2207
|
Variable: "Variable";
|
|
2315
2208
|
Fragment: "Fragment";
|
|
2316
2209
|
}>, z.ZodMiniString<string>]>;
|
|
2317
|
-
/**
|
|
2318
|
-
* Metadata describing the originating experience and variant index.
|
|
2319
|
-
*/
|
|
2320
2210
|
meta: z.ZodMiniObject<{
|
|
2321
|
-
/**
|
|
2322
|
-
* Identifier of the personalization or experiment experience.
|
|
2323
|
-
*/
|
|
2324
2211
|
experienceId: z.ZodMiniString<string>;
|
|
2325
|
-
/**
|
|
2326
|
-
* Index of the variant within the experience configuration.
|
|
2327
|
-
*
|
|
2328
|
-
* @remarks
|
|
2329
|
-
* Typically corresponds to the array index in the experience's distribution.
|
|
2330
|
-
*/
|
|
2331
2212
|
variantIndex: z.ZodMiniNumber<number>;
|
|
2332
2213
|
}, z.core.$strip>;
|
|
2333
2214
|
}, z.core.$strip>;
|
|
@@ -2463,25 +2344,10 @@ export declare type Dictionary = z.infer<typeof Dictionary>;
|
|
|
2463
2344
|
* @internal
|
|
2464
2345
|
*/
|
|
2465
2346
|
export declare const EntityChangeBase: z.ZodMiniObject<{
|
|
2466
|
-
/**
|
|
2467
|
-
* Identifier of the entity affected by the change.
|
|
2468
|
-
*/
|
|
2469
2347
|
id: z.ZodMiniString<string>;
|
|
2470
|
-
/**
|
|
2471
|
-
* Identifier of the selected variant.
|
|
2472
|
-
*/
|
|
2473
2348
|
variantId: z.ZodMiniString<string>;
|
|
2474
|
-
/**
|
|
2475
|
-
* Metadata describing the originating optimization and variant index.
|
|
2476
|
-
*/
|
|
2477
2349
|
meta: z.ZodMiniObject<{
|
|
2478
|
-
/**
|
|
2479
|
-
* Identifier of the optimization that produced this change.
|
|
2480
|
-
*/
|
|
2481
2350
|
optimizationId: z.ZodMiniString<string>;
|
|
2482
|
-
/**
|
|
2483
|
-
* Index of the variant within the optimization's distribution.
|
|
2484
|
-
*/
|
|
2485
2351
|
variantIndex: z.ZodMiniNumber<number>;
|
|
2486
2352
|
}, z.core.$strip>;
|
|
2487
2353
|
}, z.core.$strip>;
|
|
@@ -2739,7 +2605,7 @@ export declare const ExoHoverEvent: z.ZodMiniObject<{
|
|
|
2739
2605
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
2740
2606
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
2741
2607
|
type: z.ZodMiniLiteral<"exo_node_hover">;
|
|
2742
|
-
hoverDurationMs: z.
|
|
2608
|
+
hoverDurationMs: z.ZodMiniInt;
|
|
2743
2609
|
hoverId: z.ZodMiniString<string>;
|
|
2744
2610
|
}, z.core.$strip>;
|
|
2745
2611
|
|
|
@@ -2823,7 +2689,7 @@ export declare const ExoViewEvent: z.ZodMiniObject<{
|
|
|
2823
2689
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
2824
2690
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
2825
2691
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
2826
|
-
viewDurationMs: z.
|
|
2692
|
+
viewDurationMs: z.ZodMiniInt;
|
|
2827
2693
|
viewId: z.ZodMiniString<string>;
|
|
2828
2694
|
}, z.core.$strip>;
|
|
2829
2695
|
|
|
@@ -2843,13 +2709,7 @@ export declare const ExperienceChange: z.ZodMiniObject<{
|
|
|
2843
2709
|
id: z.ZodMiniString<string>;
|
|
2844
2710
|
variantId: z.ZodMiniString<string>;
|
|
2845
2711
|
meta: z.ZodMiniObject<{
|
|
2846
|
-
/**
|
|
2847
|
-
* Identifier of the optimization that produced this change.
|
|
2848
|
-
*/
|
|
2849
2712
|
optimizationId: z.ZodMiniString<string>;
|
|
2850
|
-
/**
|
|
2851
|
-
* Index of the variant within the optimization's distribution.
|
|
2852
|
-
*/
|
|
2853
2713
|
variantIndex: z.ZodMiniNumber<number>;
|
|
2854
2714
|
}, z.core.$strip>;
|
|
2855
2715
|
type: z.ZodMiniLiteral<"Experience">;
|
|
@@ -2872,9 +2732,6 @@ export declare type ExperienceChange = z.infer<typeof ExperienceChange>;
|
|
|
2872
2732
|
* @public
|
|
2873
2733
|
*/
|
|
2874
2734
|
export declare const ExperienceData: z.ZodMiniObject<{
|
|
2875
|
-
/**
|
|
2876
|
-
* Profile associated with the evaluated events.
|
|
2877
|
-
*/
|
|
2878
2735
|
profile: z.ZodMiniObject<{
|
|
2879
2736
|
id: z.ZodMiniString<string>;
|
|
2880
2737
|
stableId: z.ZodMiniString<string>;
|
|
@@ -2911,22 +2768,12 @@ export declare const ExperienceData: z.ZodMiniObject<{
|
|
|
2911
2768
|
averageSessionLength: z.ZodMiniNumber<number>;
|
|
2912
2769
|
}, z.core.$strip>;
|
|
2913
2770
|
}, z.core.$strip>;
|
|
2914
|
-
/**
|
|
2915
|
-
* Selected experiences and variants for the profile.
|
|
2916
|
-
*
|
|
2917
|
-
* @see {@link SelectedOptimizationArray}
|
|
2918
|
-
*/
|
|
2919
2771
|
experiences: z.ZodMiniArray<z.ZodMiniObject<{
|
|
2920
2772
|
experienceId: z.ZodMiniString<string>;
|
|
2921
2773
|
variantIndex: z.ZodMiniNumber<number>;
|
|
2922
2774
|
variants: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
|
|
2923
2775
|
sticky: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>>;
|
|
2924
2776
|
}, z.core.$strip>>;
|
|
2925
|
-
/**
|
|
2926
|
-
* Used for Custom Flags.
|
|
2927
|
-
*
|
|
2928
|
-
* @see {@link ChangeArray}
|
|
2929
|
-
*/
|
|
2930
2777
|
changes: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
2931
2778
|
key: z.ZodMiniString<string>;
|
|
2932
2779
|
meta: z.ZodMiniObject<{
|
|
@@ -3099,7 +2946,7 @@ export declare const ExperienceEvent: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObje
|
|
|
3099
2946
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
3100
2947
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
3101
2948
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
3102
|
-
viewDurationMs: z.
|
|
2949
|
+
viewDurationMs: z.ZodMiniInt;
|
|
3103
2950
|
viewId: z.ZodMiniString<string>;
|
|
3104
2951
|
}, z.core.$strip>, z.ZodMiniObject<{
|
|
3105
2952
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
@@ -3467,7 +3314,7 @@ export declare const ExperienceEventArray: z.ZodMiniArray<z.ZodMiniDiscriminated
|
|
|
3467
3314
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
3468
3315
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
3469
3316
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
3470
|
-
viewDurationMs: z.
|
|
3317
|
+
viewDurationMs: z.ZodMiniInt;
|
|
3471
3318
|
viewId: z.ZodMiniString<string>;
|
|
3472
3319
|
}, z.core.$strip>, z.ZodMiniObject<{
|
|
3473
3320
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
@@ -3718,12 +3565,6 @@ export declare type ExperienceEventType = ExperienceEvent['type'];
|
|
|
3718
3565
|
* @public
|
|
3719
3566
|
*/
|
|
3720
3567
|
export declare const ExperienceRequestData: z.ZodMiniObject<{
|
|
3721
|
-
/**
|
|
3722
|
-
* Experience events for the Experience API to evaluate.
|
|
3723
|
-
*
|
|
3724
|
-
* @remarks
|
|
3725
|
-
* Must contain at least one event.
|
|
3726
|
-
*/
|
|
3727
3568
|
events: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
3728
3569
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
3729
3570
|
context: z.ZodMiniObject<{
|
|
@@ -3853,7 +3694,7 @@ export declare const ExperienceRequestData: z.ZodMiniObject<{
|
|
|
3853
3694
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
3854
3695
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
3855
3696
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
3856
|
-
viewDurationMs: z.
|
|
3697
|
+
viewDurationMs: z.ZodMiniInt;
|
|
3857
3698
|
viewId: z.ZodMiniString<string>;
|
|
3858
3699
|
}, z.core.$strip>, z.ZodMiniObject<{
|
|
3859
3700
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
@@ -4079,17 +3920,8 @@ export declare const ExperienceRequestData: z.ZodMiniObject<{
|
|
|
4079
3920
|
event: z.ZodMiniString<string>;
|
|
4080
3921
|
properties: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>;
|
|
4081
3922
|
}, z.core.$strip>], "type">>;
|
|
4082
|
-
/**
|
|
4083
|
-
* Optional configuration for this experience request.
|
|
4084
|
-
*/
|
|
4085
3923
|
options: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
4086
|
-
/**
|
|
4087
|
-
* Features or capabilities to enable for this request.
|
|
4088
|
-
*/
|
|
4089
3924
|
features: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
|
|
4090
|
-
/**
|
|
4091
|
-
* Location default for singular profile requests. Event `context.location` fields override it.
|
|
4092
|
-
*/
|
|
4093
3925
|
location: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
4094
3926
|
coordinates: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
4095
3927
|
latitude: z.ZodMiniNumber<number>;
|
|
@@ -4124,13 +3956,7 @@ export declare type ExperienceRequestData = z.infer<typeof ExperienceRequestData
|
|
|
4124
3956
|
* @public
|
|
4125
3957
|
*/
|
|
4126
3958
|
export declare const ExperienceRequestOptions: z.ZodMiniObject<{
|
|
4127
|
-
/**
|
|
4128
|
-
* Features or capabilities to enable for this request.
|
|
4129
|
-
*/
|
|
4130
3959
|
features: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
|
|
4131
|
-
/**
|
|
4132
|
-
* Location default for singular profile requests. Event `context.location` fields override it.
|
|
4133
|
-
*/
|
|
4134
3960
|
location: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
4135
3961
|
coordinates: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
4136
3962
|
latitude: z.ZodMiniNumber<number>;
|
|
@@ -4168,9 +3994,6 @@ export declare const ExperienceResponse: z.ZodMiniObject<{
|
|
|
4168
3994
|
code: z.ZodMiniString<string>;
|
|
4169
3995
|
}, z.core.$strip>>;
|
|
4170
3996
|
data: z.ZodMiniObject<{
|
|
4171
|
-
/**
|
|
4172
|
-
* Profile associated with the evaluated events.
|
|
4173
|
-
*/
|
|
4174
3997
|
profile: z.ZodMiniObject<{
|
|
4175
3998
|
id: z.ZodMiniString<string>;
|
|
4176
3999
|
stableId: z.ZodMiniString<string>;
|
|
@@ -4207,22 +4030,12 @@ export declare const ExperienceResponse: z.ZodMiniObject<{
|
|
|
4207
4030
|
averageSessionLength: z.ZodMiniNumber<number>;
|
|
4208
4031
|
}, z.core.$strip>;
|
|
4209
4032
|
}, z.core.$strip>;
|
|
4210
|
-
/**
|
|
4211
|
-
* Selected experiences and variants for the profile.
|
|
4212
|
-
*
|
|
4213
|
-
* @see {@link SelectedOptimizationArray}
|
|
4214
|
-
*/
|
|
4215
4033
|
experiences: z.ZodMiniArray<z.ZodMiniObject<{
|
|
4216
4034
|
experienceId: z.ZodMiniString<string>;
|
|
4217
4035
|
variantIndex: z.ZodMiniNumber<number>;
|
|
4218
4036
|
variants: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
|
|
4219
4037
|
sticky: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>>;
|
|
4220
4038
|
}, z.core.$strip>>;
|
|
4221
|
-
/**
|
|
4222
|
-
* Used for Custom Flags.
|
|
4223
|
-
*
|
|
4224
|
-
* @see {@link ChangeArray}
|
|
4225
|
-
*/
|
|
4226
4039
|
changes: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
4227
4040
|
key: z.ZodMiniString<string>;
|
|
4228
4041
|
meta: z.ZodMiniObject<{
|
|
@@ -4274,13 +4087,7 @@ export declare const FragmentChange: z.ZodMiniObject<{
|
|
|
4274
4087
|
id: z.ZodMiniString<string>;
|
|
4275
4088
|
variantId: z.ZodMiniString<string>;
|
|
4276
4089
|
meta: z.ZodMiniObject<{
|
|
4277
|
-
/**
|
|
4278
|
-
* Identifier of the optimization that produced this change.
|
|
4279
|
-
*/
|
|
4280
4090
|
optimizationId: z.ZodMiniString<string>;
|
|
4281
|
-
/**
|
|
4282
|
-
* Index of the variant within the optimization's distribution.
|
|
4283
|
-
*/
|
|
4284
4091
|
variantIndex: z.ZodMiniNumber<number>;
|
|
4285
4092
|
}, z.core.$strip>;
|
|
4286
4093
|
type: z.ZodMiniLiteral<"Fragment">;
|
|
@@ -4302,57 +4109,17 @@ export declare type FragmentChange = z.infer<typeof FragmentChange>;
|
|
|
4302
4109
|
* @public
|
|
4303
4110
|
*/
|
|
4304
4111
|
export declare const GeoLocation: z.ZodMiniObject<{
|
|
4305
|
-
/**
|
|
4306
|
-
* Geographical coordinates for the location.
|
|
4307
|
-
*/
|
|
4308
4112
|
coordinates: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
4309
|
-
/**
|
|
4310
|
-
* Latitude component of the coordinates.
|
|
4311
|
-
*/
|
|
4312
4113
|
latitude: z.ZodMiniNumber<number>;
|
|
4313
|
-
/**
|
|
4314
|
-
* Longitude component of the coordinates.
|
|
4315
|
-
*/
|
|
4316
4114
|
longitude: z.ZodMiniNumber<number>;
|
|
4317
4115
|
}, z.core.$strip>>;
|
|
4318
|
-
/**
|
|
4319
|
-
* City name associated with the location.
|
|
4320
|
-
*/
|
|
4321
4116
|
city: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
4322
|
-
/**
|
|
4323
|
-
* Postal or ZIP code associated with the location.
|
|
4324
|
-
*/
|
|
4325
4117
|
postalCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
4326
|
-
/**
|
|
4327
|
-
* Region or state name associated with the location.
|
|
4328
|
-
*/
|
|
4329
4118
|
region: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
4330
|
-
/**
|
|
4331
|
-
* Region or state code associated with the location.
|
|
4332
|
-
*/
|
|
4333
4119
|
regionCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
4334
|
-
/**
|
|
4335
|
-
* Country name associated with the location.
|
|
4336
|
-
*/
|
|
4337
4120
|
country: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
4338
|
-
/**
|
|
4339
|
-
* Country code associated with the location.
|
|
4340
|
-
*
|
|
4341
|
-
* @remarks
|
|
4342
|
-
* Validated to exactly COUNTRY_CODE_LENGTH characters, typically
|
|
4343
|
-
* an ISO 3166-1 alpha-2 code.
|
|
4344
|
-
*/
|
|
4345
4121
|
countryCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
4346
|
-
/**
|
|
4347
|
-
* Continent name associated with the location.
|
|
4348
|
-
*/
|
|
4349
4122
|
continent: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
4350
|
-
/**
|
|
4351
|
-
* Time zone identifier associated with the location.
|
|
4352
|
-
*
|
|
4353
|
-
* @remarks
|
|
4354
|
-
* Typically an IANA time zone string (e.g., `"Europe/Berlin"`).
|
|
4355
|
-
*/
|
|
4356
4123
|
timezone: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
4357
4124
|
}, z.core.$strip>;
|
|
4358
4125
|
|
|
@@ -4777,7 +4544,7 @@ export declare const InsightsEvent: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject
|
|
|
4777
4544
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
4778
4545
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
4779
4546
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
4780
|
-
viewDurationMs: z.
|
|
4547
|
+
viewDurationMs: z.ZodMiniInt;
|
|
4781
4548
|
viewId: z.ZodMiniString<string>;
|
|
4782
4549
|
}, z.core.$strip>, z.ZodMiniObject<{
|
|
4783
4550
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
@@ -4915,7 +4682,7 @@ export declare const InsightsEvent: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject
|
|
|
4915
4682
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
4916
4683
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
4917
4684
|
type: z.ZodMiniLiteral<"exo_node_hover">;
|
|
4918
|
-
hoverDurationMs: z.
|
|
4685
|
+
hoverDurationMs: z.ZodMiniInt;
|
|
4919
4686
|
hoverId: z.ZodMiniString<string>;
|
|
4920
4687
|
}, z.core.$strip>], "type">;
|
|
4921
4688
|
|
|
@@ -5180,7 +4947,7 @@ export declare const InsightsEventArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUn
|
|
|
5180
4947
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
5181
4948
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
5182
4949
|
type: z.ZodMiniLiteral<"exo_node_view">;
|
|
5183
|
-
viewDurationMs: z.
|
|
4950
|
+
viewDurationMs: z.ZodMiniInt;
|
|
5184
4951
|
viewId: z.ZodMiniString<string>;
|
|
5185
4952
|
}, z.core.$strip>, z.ZodMiniObject<{
|
|
5186
4953
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
@@ -5318,7 +5085,7 @@ export declare const InsightsEventArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUn
|
|
|
5318
5085
|
variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
5319
5086
|
variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
5320
5087
|
type: z.ZodMiniLiteral<"exo_node_hover">;
|
|
5321
|
-
hoverDurationMs: z.
|
|
5088
|
+
hoverDurationMs: z.ZodMiniInt;
|
|
5322
5089
|
hoverId: z.ZodMiniString<string>;
|
|
5323
5090
|
}, z.core.$strip>], "type">>;
|
|
5324
5091
|
|
|
@@ -5434,13 +5201,7 @@ export declare type Json = z.infer<typeof z.json>;
|
|
|
5434
5201
|
* @public
|
|
5435
5202
|
*/
|
|
5436
5203
|
export declare const Library: z.ZodMiniObject<{
|
|
5437
|
-
/**
|
|
5438
|
-
* Name of the SDK/library (e.g., `"@contentful/optimization-web"`).
|
|
5439
|
-
*/
|
|
5440
5204
|
name: z.ZodMiniString<string>;
|
|
5441
|
-
/**
|
|
5442
|
-
* Version of the analytics library.
|
|
5443
|
-
*/
|
|
5444
5205
|
version: z.ZodMiniString<string>;
|
|
5445
5206
|
}, z.core.$strip>;
|
|
5446
5207
|
|
|
@@ -5477,29 +5238,11 @@ export declare type OptimizationData = Omit<ExperienceData, 'experiences'> & {
|
|
|
5477
5238
|
* @public
|
|
5478
5239
|
*/
|
|
5479
5240
|
export declare const Page: z.ZodMiniObject<{
|
|
5480
|
-
/**
|
|
5481
|
-
* Path component of the page URL (e.g., `/products/123`).
|
|
5482
|
-
*/
|
|
5483
5241
|
path: z.ZodMiniString<string>;
|
|
5484
|
-
/**
|
|
5485
|
-
* Parsed query parameters for the page.
|
|
5486
|
-
*/
|
|
5487
5242
|
query: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
|
|
5488
|
-
/**
|
|
5489
|
-
* Referrer URL that led to the current page.
|
|
5490
|
-
*/
|
|
5491
5243
|
referrer: z.ZodMiniString<string>;
|
|
5492
|
-
/**
|
|
5493
|
-
* Raw search string including the leading `?` (e.g., `"?q=test"`).
|
|
5494
|
-
*/
|
|
5495
5244
|
search: z.ZodMiniString<string>;
|
|
5496
|
-
/**
|
|
5497
|
-
* Title of the page as seen by the user.
|
|
5498
|
-
*/
|
|
5499
5245
|
title: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
5500
|
-
/**
|
|
5501
|
-
* Full URL of the page.
|
|
5502
|
-
*/
|
|
5503
5246
|
url: z.ZodMiniString<string>;
|
|
5504
5247
|
}, z.core.$catchall<z.ZodMiniJSONSchema>>;
|
|
5505
5248
|
|
|
@@ -5661,12 +5404,6 @@ export declare function parseWithFriendlyError<T extends z.ZodMiniType>(schema:
|
|
|
5661
5404
|
* @public
|
|
5662
5405
|
*/
|
|
5663
5406
|
export declare const PartialProfile: z.ZodMiniObject<{
|
|
5664
|
-
/**
|
|
5665
|
-
* Identifier of the profile.
|
|
5666
|
-
*
|
|
5667
|
-
* @remarks
|
|
5668
|
-
* Used to associate events with an existing profile.
|
|
5669
|
-
*/
|
|
5670
5407
|
id: z.ZodMiniString<string>;
|
|
5671
5408
|
}, z.core.$catchall<z.ZodMiniJSONSchema>>;
|
|
5672
5409
|
|
|
@@ -5687,40 +5424,11 @@ export declare type PartialProfile = z.infer<typeof PartialProfile>;
|
|
|
5687
5424
|
* @public
|
|
5688
5425
|
*/
|
|
5689
5426
|
export declare const Profile: z.ZodMiniObject<{
|
|
5690
|
-
/**
|
|
5691
|
-
* Primary identifier of the profile.
|
|
5692
|
-
*/
|
|
5693
5427
|
id: z.ZodMiniString<string>;
|
|
5694
|
-
/**
|
|
5695
|
-
* Stable, long-lived identifier of the profile.
|
|
5696
|
-
*
|
|
5697
|
-
* @remarks
|
|
5698
|
-
* Intended to remain constant across sessions and devices when possible.
|
|
5699
|
-
* Usually equal to `id`.
|
|
5700
|
-
*/
|
|
5701
5428
|
stableId: z.ZodMiniString<string>;
|
|
5702
|
-
/**
|
|
5703
|
-
* Random value associated with the profile.
|
|
5704
|
-
*
|
|
5705
|
-
* @remarks
|
|
5706
|
-
* Often used for deterministic bucketing (e.g., in experiments).
|
|
5707
|
-
*/
|
|
5708
5429
|
random: z.ZodMiniNumber<number>;
|
|
5709
|
-
/**
|
|
5710
|
-
* List of audience identifiers that this profile belongs to.
|
|
5711
|
-
*/
|
|
5712
5430
|
audiences: z.ZodMiniArray<z.ZodMiniString<string>>;
|
|
5713
|
-
/**
|
|
5714
|
-
* Traits describing the profile (user-level attributes).
|
|
5715
|
-
*
|
|
5716
|
-
* @see {@link Traits}
|
|
5717
|
-
*/
|
|
5718
5431
|
traits: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>;
|
|
5719
|
-
/**
|
|
5720
|
-
* Geo-location information associated with the profile.
|
|
5721
|
-
*
|
|
5722
|
-
* @see {@link GeoLocation}
|
|
5723
|
-
*/
|
|
5724
5432
|
location: z.ZodMiniObject<{
|
|
5725
5433
|
coordinates: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
5726
5434
|
latitude: z.ZodMiniNumber<number>;
|
|
@@ -5735,11 +5443,6 @@ export declare const Profile: z.ZodMiniObject<{
|
|
|
5735
5443
|
continent: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
5736
5444
|
timezone: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
5737
5445
|
}, z.core.$strip>;
|
|
5738
|
-
/**
|
|
5739
|
-
* Aggregated session statistics for the profile.
|
|
5740
|
-
*
|
|
5741
|
-
* @see {@link SessionStatistics}
|
|
5742
|
-
*/
|
|
5743
5446
|
session: z.ZodMiniObject<{
|
|
5744
5447
|
id: z.ZodMiniString<string>;
|
|
5745
5448
|
isReturningVisitor: z.ZodMiniBoolean<boolean>;
|
|
@@ -5792,21 +5495,8 @@ export declare type Properties = z.infer<typeof Properties>;
|
|
|
5792
5495
|
* @public
|
|
5793
5496
|
*/
|
|
5794
5497
|
export declare const ResponseEnvelope: z.ZodMiniObject<{
|
|
5795
|
-
|
|
5796
|
-
* Response payload.
|
|
5797
|
-
*
|
|
5798
|
-
* @remarks
|
|
5799
|
-
* The base schema uses an empty object; specific responses extend this
|
|
5800
|
-
* with more detailed structures.
|
|
5801
|
-
*/
|
|
5802
|
-
data: z.ZodMiniObject<Record<never, z.core.SomeType>, z.core.$strip>;
|
|
5803
|
-
/**
|
|
5804
|
-
* Human-readable message accompanying the response.
|
|
5805
|
-
*/
|
|
5498
|
+
data: z.ZodMiniObject<{}, z.core.$strip>;
|
|
5806
5499
|
message: z.ZodMiniString<string>;
|
|
5807
|
-
/**
|
|
5808
|
-
* Error details, or `null` when the request succeeded.
|
|
5809
|
-
*/
|
|
5810
5500
|
error: z.ZodMiniNullable<z.ZodMiniObject<{
|
|
5811
5501
|
code: z.ZodMiniString<string>;
|
|
5812
5502
|
}, z.core.$strip>>;
|
|
@@ -5829,9 +5519,6 @@ export declare type ResponseEnvelope = z.infer<typeof ResponseEnvelope>;
|
|
|
5829
5519
|
* @public
|
|
5830
5520
|
*/
|
|
5831
5521
|
declare const Screen_2: z.ZodMiniObject<{
|
|
5832
|
-
/**
|
|
5833
|
-
* Name or label for the screen.
|
|
5834
|
-
*/
|
|
5835
5522
|
name: z.ZodMiniString<string>;
|
|
5836
5523
|
}, z.core.$catchall<z.ZodMiniJSONSchema>>;
|
|
5837
5524
|
|
|
@@ -5975,34 +5662,9 @@ export declare type ScreenViewEvent = z.infer<typeof ScreenViewEvent>;
|
|
|
5975
5662
|
* @public
|
|
5976
5663
|
*/
|
|
5977
5664
|
export declare const SelectedOptimization: z.ZodMiniObject<{
|
|
5978
|
-
/**
|
|
5979
|
-
* Identifier of the personalization or experiment experience.
|
|
5980
|
-
*/
|
|
5981
5665
|
experienceId: z.ZodMiniString<string>;
|
|
5982
|
-
/**
|
|
5983
|
-
* Index of the selected variant within the experience configuration.
|
|
5984
|
-
*
|
|
5985
|
-
* @remarks
|
|
5986
|
-
* Typically corresponds to the index of the selected `OptimizationConfig` entry.
|
|
5987
|
-
*/
|
|
5988
5666
|
variantIndex: z.ZodMiniNumber<number>;
|
|
5989
|
-
/**
|
|
5990
|
-
* Mapping of baseline entry IDs to their selected variant entry IDs.
|
|
5991
|
-
*
|
|
5992
|
-
* @remarks
|
|
5993
|
-
* The keys are component identifiers and the values are the
|
|
5994
|
-
* identifiers of the selected variant for that component.
|
|
5995
|
-
*/
|
|
5996
5667
|
variants: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
|
|
5997
|
-
/**
|
|
5998
|
-
* Indicates whether this optimization selection is sticky for the user.
|
|
5999
|
-
*
|
|
6000
|
-
* @defaultValue false
|
|
6001
|
-
*
|
|
6002
|
-
* @remarks
|
|
6003
|
-
* Reuse sticky selections on subsequent requests for the same user rather
|
|
6004
|
-
* than re-allocating a new variant.
|
|
6005
|
-
*/
|
|
6006
5668
|
sticky: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>>;
|
|
6007
5669
|
}, z.core.$strip>;
|
|
6008
5670
|
|
|
@@ -6022,34 +5684,9 @@ export declare type SelectedOptimization = z.infer<typeof SelectedOptimization>;
|
|
|
6022
5684
|
* @public
|
|
6023
5685
|
*/
|
|
6024
5686
|
export declare const SelectedOptimizationArray: z.ZodMiniArray<z.ZodMiniObject<{
|
|
6025
|
-
/**
|
|
6026
|
-
* Identifier of the personalization or experiment experience.
|
|
6027
|
-
*/
|
|
6028
5687
|
experienceId: z.ZodMiniString<string>;
|
|
6029
|
-
/**
|
|
6030
|
-
* Index of the selected variant within the experience configuration.
|
|
6031
|
-
*
|
|
6032
|
-
* @remarks
|
|
6033
|
-
* Typically corresponds to the index of the selected `OptimizationConfig` entry.
|
|
6034
|
-
*/
|
|
6035
5688
|
variantIndex: z.ZodMiniNumber<number>;
|
|
6036
|
-
/**
|
|
6037
|
-
* Mapping of baseline entry IDs to their selected variant entry IDs.
|
|
6038
|
-
*
|
|
6039
|
-
* @remarks
|
|
6040
|
-
* The keys are component identifiers and the values are the
|
|
6041
|
-
* identifiers of the selected variant for that component.
|
|
6042
|
-
*/
|
|
6043
5689
|
variants: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
|
|
6044
|
-
/**
|
|
6045
|
-
* Indicates whether this optimization selection is sticky for the user.
|
|
6046
|
-
*
|
|
6047
|
-
* @defaultValue false
|
|
6048
|
-
*
|
|
6049
|
-
* @remarks
|
|
6050
|
-
* Reuse sticky selections on subsequent requests for the same user rather
|
|
6051
|
-
* than re-allocating a new variant.
|
|
6052
|
-
*/
|
|
6053
5690
|
sticky: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>>;
|
|
6054
5691
|
}, z.core.$strip>>;
|
|
6055
5692
|
|
|
@@ -6070,25 +5707,8 @@ export declare type SelectedOptimizationArray = z.infer<typeof SelectedOptimizat
|
|
|
6070
5707
|
* @public
|
|
6071
5708
|
*/
|
|
6072
5709
|
export declare const SessionStatistics: z.ZodMiniObject<{
|
|
6073
|
-
/**
|
|
6074
|
-
* Unique identifier for this session statistics record.
|
|
6075
|
-
*/
|
|
6076
5710
|
id: z.ZodMiniString<string>;
|
|
6077
|
-
/**
|
|
6078
|
-
* Indicates whether the visitor has been seen before.
|
|
6079
|
-
*
|
|
6080
|
-
* @remarks
|
|
6081
|
-
* `true` typically means the visitor has at least one prior session.
|
|
6082
|
-
*/
|
|
6083
5711
|
isReturningVisitor: z.ZodMiniBoolean<boolean>;
|
|
6084
|
-
/**
|
|
6085
|
-
* Landing page for the session.
|
|
6086
|
-
*
|
|
6087
|
-
* @remarks
|
|
6088
|
-
* Represents the first page the user visited in this session.
|
|
6089
|
-
*
|
|
6090
|
-
* @see {@link Page}
|
|
6091
|
-
*/
|
|
6092
5712
|
landingPage: z.ZodMiniObject<{
|
|
6093
5713
|
path: z.ZodMiniString<string>;
|
|
6094
5714
|
query: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
|
|
@@ -6097,23 +5717,8 @@ export declare const SessionStatistics: z.ZodMiniObject<{
|
|
|
6097
5717
|
title: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
6098
5718
|
url: z.ZodMiniString<string>;
|
|
6099
5719
|
}, z.core.$catchall<z.ZodMiniJSONSchema>>;
|
|
6100
|
-
/**
|
|
6101
|
-
* Number of sessions associated with this profile or identifier.
|
|
6102
|
-
*
|
|
6103
|
-
* @remarks
|
|
6104
|
-
* Often used in combination with `SessionStatistics.averageSessionLength`.
|
|
6105
|
-
*/
|
|
6106
5720
|
count: z.ZodMiniNumber<number>;
|
|
6107
|
-
/**
|
|
6108
|
-
* Duration of the active session.
|
|
6109
|
-
*/
|
|
6110
5721
|
activeSessionLength: z.ZodMiniNumber<number>;
|
|
6111
|
-
/**
|
|
6112
|
-
* Average session duration across all sessions represented by this record.
|
|
6113
|
-
*
|
|
6114
|
-
* @remarks
|
|
6115
|
-
* The unit must match `SessionStatistics.activeSessionLength`.
|
|
6116
|
-
*/
|
|
6117
5722
|
averageSessionLength: z.ZodMiniNumber<number>;
|
|
6118
5723
|
}, z.core.$strip>;
|
|
6119
5724
|
|
|
@@ -6231,16 +5836,10 @@ export declare type Traits = z.infer<typeof Traits>;
|
|
|
6231
5836
|
* @public
|
|
6232
5837
|
*/
|
|
6233
5838
|
export declare const UniversalEventContext: z.ZodMiniObject<{
|
|
6234
|
-
/**
|
|
6235
|
-
* Application-level metadata.
|
|
6236
|
-
*/
|
|
6237
5839
|
app: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
6238
5840
|
name: z.ZodMiniString<string>;
|
|
6239
5841
|
version: z.ZodMiniString<string>;
|
|
6240
5842
|
}, z.core.$strip>>;
|
|
6241
|
-
/**
|
|
6242
|
-
* Campaign attribution metadata.
|
|
6243
|
-
*/
|
|
6244
5843
|
campaign: z.ZodMiniObject<{
|
|
6245
5844
|
name: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
6246
5845
|
source: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
@@ -6248,29 +5847,14 @@ export declare const UniversalEventContext: z.ZodMiniObject<{
|
|
|
6248
5847
|
term: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
6249
5848
|
content: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
6250
5849
|
}, z.core.$strip>;
|
|
6251
|
-
/**
|
|
6252
|
-
* GDPR-related consent information.
|
|
6253
|
-
*/
|
|
6254
5850
|
gdpr: z.ZodMiniObject<{
|
|
6255
|
-
/**
|
|
6256
|
-
* Indicates whether the user has given consent.
|
|
6257
|
-
*/
|
|
6258
5851
|
isConsentGiven: z.ZodMiniBoolean<boolean>;
|
|
6259
5852
|
}, z.core.$strip>;
|
|
6260
|
-
/**
|
|
6261
|
-
* Analytics library metadata.
|
|
6262
|
-
*/
|
|
6263
5853
|
library: z.ZodMiniObject<{
|
|
6264
5854
|
name: z.ZodMiniString<string>;
|
|
6265
5855
|
version: z.ZodMiniString<string>;
|
|
6266
5856
|
}, z.core.$strip>;
|
|
6267
|
-
/**
|
|
6268
|
-
* Locale identifier of the event (e.g., `"en-US"`).
|
|
6269
|
-
*/
|
|
6270
5857
|
locale: z.ZodMiniString<string>;
|
|
6271
|
-
/**
|
|
6272
|
-
* Optional geo-location information associated with the event.
|
|
6273
|
-
*/
|
|
6274
5858
|
location: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
6275
5859
|
coordinates: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
6276
5860
|
latitude: z.ZodMiniNumber<number>;
|
|
@@ -6285,9 +5869,6 @@ export declare const UniversalEventContext: z.ZodMiniObject<{
|
|
|
6285
5869
|
continent: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
6286
5870
|
timezone: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
6287
5871
|
}, z.core.$strip>>;
|
|
6288
|
-
/**
|
|
6289
|
-
* User agent string of the client, if available.
|
|
6290
|
-
*/
|
|
6291
5872
|
userAgent: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
6292
5873
|
}, z.core.$strip>;
|
|
6293
5874
|
|
|
@@ -6308,15 +5889,7 @@ export declare type UniversalEventContext = z.infer<typeof UniversalEventContext
|
|
|
6308
5889
|
* @public
|
|
6309
5890
|
*/
|
|
6310
5891
|
export declare const UniversalEventProperties: z.ZodMiniObject<{
|
|
6311
|
-
/**
|
|
6312
|
-
* Channel from which the event originated.
|
|
6313
|
-
*
|
|
6314
|
-
* @see {@link Channel}
|
|
6315
|
-
*/
|
|
6316
5892
|
channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
|
|
6317
|
-
/**
|
|
6318
|
-
* Context object carrying environment and client metadata.
|
|
6319
|
-
*/
|
|
6320
5893
|
context: z.ZodMiniObject<{
|
|
6321
5894
|
app: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
6322
5895
|
name: z.ZodMiniString<string>;
|
|
@@ -6330,9 +5903,6 @@ export declare const UniversalEventProperties: z.ZodMiniObject<{
|
|
|
6330
5903
|
content: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
6331
5904
|
}, z.core.$strip>;
|
|
6332
5905
|
gdpr: z.ZodMiniObject<{
|
|
6333
|
-
/**
|
|
6334
|
-
* Indicates whether the user has given consent.
|
|
6335
|
-
*/
|
|
6336
5906
|
isConsentGiven: z.ZodMiniBoolean<boolean>;
|
|
6337
5907
|
}, z.core.$strip>;
|
|
6338
5908
|
library: z.ZodMiniObject<{
|
|
@@ -6367,37 +5937,10 @@ export declare const UniversalEventProperties: z.ZodMiniObject<{
|
|
|
6367
5937
|
name: z.ZodMiniString<string>;
|
|
6368
5938
|
}, z.core.$catchall<z.ZodMiniJSONSchema>>>;
|
|
6369
5939
|
}, z.core.$strip>;
|
|
6370
|
-
/**
|
|
6371
|
-
* Unique identifier for this message.
|
|
6372
|
-
*
|
|
6373
|
-
* @remarks
|
|
6374
|
-
* Used to deduplicate events across retries and transports.
|
|
6375
|
-
*/
|
|
6376
5940
|
messageId: z.ZodMiniString<string>;
|
|
6377
|
-
/**
|
|
6378
|
-
* Timestamp when the event originally occurred.
|
|
6379
|
-
*
|
|
6380
|
-
* @remarks
|
|
6381
|
-
* ISO 8601 datetime string.
|
|
6382
|
-
*/
|
|
6383
5941
|
originalTimestamp: z.iso.ZodMiniISODateTime;
|
|
6384
|
-
/**
|
|
6385
|
-
* Timestamp when the event payload was sent.
|
|
6386
|
-
*
|
|
6387
|
-
* @remarks
|
|
6388
|
-
* ISO 8601 datetime string.
|
|
6389
|
-
*/
|
|
6390
5942
|
sentAt: z.iso.ZodMiniISODateTime;
|
|
6391
|
-
/**
|
|
6392
|
-
* Timestamp when the event was recorded or processed.
|
|
6393
|
-
*
|
|
6394
|
-
* @remarks
|
|
6395
|
-
* ISO 8601 datetime string.
|
|
6396
|
-
*/
|
|
6397
5943
|
timestamp: z.iso.ZodMiniISODateTime;
|
|
6398
|
-
/**
|
|
6399
|
-
* Identifier of the authenticated user, if known.
|
|
6400
|
-
*/
|
|
6401
5944
|
userId: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
6402
5945
|
}, z.core.$strip>;
|
|
6403
5946
|
|
|
@@ -6420,16 +5963,7 @@ export declare type UniversalEventProperties = z.infer<typeof UniversalEventProp
|
|
|
6420
5963
|
export declare const UnknownChange: z.ZodMiniObject<{
|
|
6421
5964
|
key: z.ZodMiniString<string>;
|
|
6422
5965
|
meta: z.ZodMiniObject<{
|
|
6423
|
-
/**
|
|
6424
|
-
* Identifier of the personalization or experiment experience.
|
|
6425
|
-
*/
|
|
6426
5966
|
experienceId: z.ZodMiniString<string>;
|
|
6427
|
-
/**
|
|
6428
|
-
* Index of the variant within the experience configuration.
|
|
6429
|
-
*
|
|
6430
|
-
* @remarks
|
|
6431
|
-
* Typically corresponds to the array index in the experience's distribution.
|
|
6432
|
-
*/
|
|
6433
5967
|
variantIndex: z.ZodMiniNumber<number>;
|
|
6434
5968
|
}, z.core.$strip>;
|
|
6435
5969
|
type: z.ZodMiniString<string>;
|
|
@@ -6454,16 +5988,7 @@ export declare type UnknownChange = z.infer<typeof UnknownChange>;
|
|
|
6454
5988
|
export declare const VariableChange: z.ZodMiniObject<{
|
|
6455
5989
|
key: z.ZodMiniString<string>;
|
|
6456
5990
|
meta: z.ZodMiniObject<{
|
|
6457
|
-
/**
|
|
6458
|
-
* Identifier of the personalization or experiment experience.
|
|
6459
|
-
*/
|
|
6460
5991
|
experienceId: z.ZodMiniString<string>;
|
|
6461
|
-
/**
|
|
6462
|
-
* Index of the variant within the experience configuration.
|
|
6463
|
-
*
|
|
6464
|
-
* @remarks
|
|
6465
|
-
* Typically corresponds to the array index in the experience's distribution.
|
|
6466
|
-
*/
|
|
6467
5992
|
variantIndex: z.ZodMiniNumber<number>;
|
|
6468
5993
|
}, z.core.$strip>;
|
|
6469
5994
|
type: z.ZodMiniLiteral<"Variable">;
|