@contentful/optimization-api-client 2.0.1 → 2.2.0

package/dist/index.d.mts

@@ -352,6 +352,7 @@ declare const BatchExperienceEventArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUn
     optimizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     parameters: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
     parentExperienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    parentVariantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
     type: z.ZodMiniLiteral<"exo_node_view">;
@@ -921,6 +922,7 @@ declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
         optimizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         parameters: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
         parentExperienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        parentVariantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
         type: z.ZodMiniLiteral<"exo_node_view">;
@@ -992,6 +994,7 @@ declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
         optimizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         parameters: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
         parentExperienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        parentVariantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
         type: z.ZodMiniLiteral<"exo_node_click">;
@@ -1061,6 +1064,7 @@ declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
         optimizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         parameters: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
         parentExperienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        parentVariantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
         type: z.ZodMiniLiteral<"exo_node_hover">;
@@ -1289,6 +1293,7 @@ export declare class ExperienceApiClient extends ApiClientBase {
     private readonly enabledFeatures?;
     private readonly ip?;
     private locale?;
+    private readonly location?;
     private readonly plainText?;
     private readonly preflight?;
     /**
@@ -1309,7 +1314,8 @@ export declare class ExperienceApiClient extends ApiClientBase {
      * Retrieves a profile by ID.
      *
      * @param id - The profile ID to retrieve.
-     * @param options - Optional request options. `preflight` and `plainText` are not allowed here.
+     * @param options - Optional request options. `location`, `preflight`, and `plainText`
+     * are not allowed here.
      * @returns The current optimization data for the profile.
      *
      * @throws Error
@@ -1322,7 +1328,7 @@ export declare class ExperienceApiClient extends ApiClientBase {
      * })
      * ```
      */
-    getProfile(id: string, options?: Omit<ExperienceApiClientRequestOptions, 'preflight' | 'plainText'>): Promise<OptimizationData>;
+    getProfile(id: string, options?: Omit<ExperienceApiClientRequestOptions, 'location' | 'preflight' | 'plainText'>): Promise<OptimizationData>;
     /**
      * Sends a POST request to mutate a profile or profiles.
      *
@@ -1488,6 +1494,19 @@ export declare interface ExperienceApiClientRequestOptions {
      * When omitted, the API can use a server-side default.
      */
     locale?: string;
+    /**
+     * Request location for `createProfile()`, `updateProfile()`, and `upsertProfile()`.
+     *
+     * @remarks
+     * A per-request value replaces the constructor default as a whole object.
+     * The API merges each event's `context.location` over this request location.
+     * An explicit `{}` overrides the constructor default and supplies an empty
+     * request-location default instead of Cloudflare geolocation. When omitted
+     * from both sources, existing API fallback behavior applies.
+     * This affects evaluation and profile updates; it is not a permanent location lock.
+     * For `upsertManyProfiles()`, use each event's `context.location` instead.
+     */
+    location?: GeoLocation;
     /**
      * When `true`, sends performance-critical endpoints in plain text.
      *
@@ -1737,6 +1756,7 @@ declare const ExperienceEventArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[
     optimizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     parameters: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
     parentExperienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    parentVariantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
     type: z.ZodMiniLiteral<"exo_node_view">;
@@ -2032,6 +2052,76 @@ export declare interface FetchMethodCallbackOptions {
     retriesLeft?: number;
 }
 
+/**
+ * Zod schema describing geo-location properties for an event or singular profile request.
+ *
+ * @remarks
+ * All properties are optional and can be derived from IP or device data.
+ *
+ * @public
+ */
+declare const GeoLocation: z.ZodMiniObject<{
+    /**
+     * Geographical coordinates for the location.
+     */
+    coordinates: z.ZodMiniOptional<z.ZodMiniObject<{
+        /**
+         * Latitude component of the coordinates.
+         */
+        latitude: z.ZodMiniNumber<number>;
+        /**
+         * Longitude component of the coordinates.
+         */
+        longitude: z.ZodMiniNumber<number>;
+    }, z.core.$strip>>;
+    /**
+     * City name associated with the location.
+     */
+    city: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Postal or ZIP code associated with the location.
+     */
+    postalCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Region or state name associated with the location.
+     */
+    region: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Region or state code associated with the location.
+     */
+    regionCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Country name associated with the location.
+     */
+    country: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Country code associated with the location.
+     *
+     * @remarks
+     * Validated to exactly COUNTRY_CODE_LENGTH characters, typically
+     * an ISO 3166-1 alpha-2 code.
+     */
+    countryCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Continent name associated with the location.
+     */
+    continent: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Time zone identifier associated with the location.
+     *
+     * @remarks
+     * Typically an IANA time zone string (e.g., `"Europe/Berlin"`).
+     */
+    timezone: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+
+/**
+ * TypeScript type inferred from {@link GeoLocation}.
+ *
+ * @public
+ */
+declare type GeoLocation = z.infer<typeof GeoLocation>;
+
 /**
  * Properties that can be shared between global and per-client API configuration.
  *

package/dist/index.d.ts

@@ -352,6 +352,7 @@ declare const BatchExperienceEventArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUn
     optimizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     parameters: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
     parentExperienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    parentVariantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
     type: z.ZodMiniLiteral<"exo_node_view">;
@@ -921,6 +922,7 @@ declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
         optimizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         parameters: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
         parentExperienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        parentVariantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
         type: z.ZodMiniLiteral<"exo_node_view">;
@@ -992,6 +994,7 @@ declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
         optimizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         parameters: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
         parentExperienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        parentVariantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
         type: z.ZodMiniLiteral<"exo_node_click">;
@@ -1061,6 +1064,7 @@ declare const BatchInsightsEventArray: z.ZodMiniArray<z.ZodMiniObject<{
         optimizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         parameters: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
         parentExperienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        parentVariantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
         variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
         type: z.ZodMiniLiteral<"exo_node_hover">;
@@ -1289,6 +1293,7 @@ export declare class ExperienceApiClient extends ApiClientBase {
     private readonly enabledFeatures?;
     private readonly ip?;
     private locale?;
+    private readonly location?;
     private readonly plainText?;
     private readonly preflight?;
     /**
@@ -1309,7 +1314,8 @@ export declare class ExperienceApiClient extends ApiClientBase {
      * Retrieves a profile by ID.
      *
      * @param id - The profile ID to retrieve.
-     * @param options - Optional request options. `preflight` and `plainText` are not allowed here.
+     * @param options - Optional request options. `location`, `preflight`, and `plainText`
+     * are not allowed here.
      * @returns The current optimization data for the profile.
      *
      * @throws Error
@@ -1322,7 +1328,7 @@ export declare class ExperienceApiClient extends ApiClientBase {
      * })
      * ```
      */
-    getProfile(id: string, options?: Omit<ExperienceApiClientRequestOptions, 'preflight' | 'plainText'>): Promise<OptimizationData>;
+    getProfile(id: string, options?: Omit<ExperienceApiClientRequestOptions, 'location' | 'preflight' | 'plainText'>): Promise<OptimizationData>;
     /**
      * Sends a POST request to mutate a profile or profiles.
      *
@@ -1488,6 +1494,19 @@ export declare interface ExperienceApiClientRequestOptions {
      * When omitted, the API can use a server-side default.
      */
     locale?: string;
+    /**
+     * Request location for `createProfile()`, `updateProfile()`, and `upsertProfile()`.
+     *
+     * @remarks
+     * A per-request value replaces the constructor default as a whole object.
+     * The API merges each event's `context.location` over this request location.
+     * An explicit `{}` overrides the constructor default and supplies an empty
+     * request-location default instead of Cloudflare geolocation. When omitted
+     * from both sources, existing API fallback behavior applies.
+     * This affects evaluation and profile updates; it is not a permanent location lock.
+     * For `upsertManyProfiles()`, use each event's `context.location` instead.
+     */
+    location?: GeoLocation;
     /**
      * When `true`, sends performance-critical endpoints in plain text.
      *
@@ -1737,6 +1756,7 @@ declare const ExperienceEventArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[
     optimizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     parameters: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
     parentExperienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    parentVariantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     variantId: z.ZodMiniOptional<z.ZodMiniString<string>>;
     variantIndex: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
     type: z.ZodMiniLiteral<"exo_node_view">;
@@ -2032,6 +2052,76 @@ export declare interface FetchMethodCallbackOptions {
     retriesLeft?: number;
 }
 
+/**
+ * Zod schema describing geo-location properties for an event or singular profile request.
+ *
+ * @remarks
+ * All properties are optional and can be derived from IP or device data.
+ *
+ * @public
+ */
+declare const GeoLocation: z.ZodMiniObject<{
+    /**
+     * Geographical coordinates for the location.
+     */
+    coordinates: z.ZodMiniOptional<z.ZodMiniObject<{
+        /**
+         * Latitude component of the coordinates.
+         */
+        latitude: z.ZodMiniNumber<number>;
+        /**
+         * Longitude component of the coordinates.
+         */
+        longitude: z.ZodMiniNumber<number>;
+    }, z.core.$strip>>;
+    /**
+     * City name associated with the location.
+     */
+    city: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Postal or ZIP code associated with the location.
+     */
+    postalCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Region or state name associated with the location.
+     */
+    region: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Region or state code associated with the location.
+     */
+    regionCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Country name associated with the location.
+     */
+    country: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Country code associated with the location.
+     *
+     * @remarks
+     * Validated to exactly COUNTRY_CODE_LENGTH characters, typically
+     * an ISO 3166-1 alpha-2 code.
+     */
+    countryCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Continent name associated with the location.
+     */
+    continent: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Time zone identifier associated with the location.
+     *
+     * @remarks
+     * Typically an IANA time zone string (e.g., `"Europe/Berlin"`).
+     */
+    timezone: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+
+/**
+ * TypeScript type inferred from {@link GeoLocation}.
+ *
+ * @public
+ */
+declare type GeoLocation = z.infer<typeof GeoLocation>;
+
 /**
  * Properties that can be shared between global and per-client API configuration.
  *

package/dist/index.mjs

@@ -159,15 +159,17 @@ class ExperienceApiClient extends src_ApiClientBase {
     enabledFeatures;
     ip;
     locale;
+    location;
     plainText;
     preflight;
     constructor(config){
         super('Experience', config);
-        const { baseUrl, enabledFeatures, ip, locale, plainText, preflight } = config;
+        const { baseUrl, enabledFeatures, ip, locale, location, plainText, preflight } = config;
         this.baseUrl = baseUrl || EXPERIENCE_BASE_URL;
         this.enabledFeatures = enabledFeatures;
         this.ip = ip;
         this.locale = locale;
+        this.location = location;
         this.plainText = plainText;
         this.preflight = preflight;
     }
@@ -319,9 +321,12 @@ class ExperienceApiClient extends src_ApiClientBase {
         return bodyOptions;
     };
     constructExperienceRequestBody(events, options) {
+        const bodyOptions = this.constructBodyOptions(options);
+        const location = options.location ?? this.location;
+        if (void 0 !== location) bodyOptions.location = location;
         return ExperienceRequestData.parse({
             events: parseWithFriendlyError(ExperienceEventArray, events),
-            options: this.constructBodyOptions(options)
+            options: bodyOptions
         });
     }
 }