@seekora-ai/admin-api 1.0.48 → 1.0.49

package/README.md

@@ -1,4 +1,4 @@
-## @seekora-ai/admin-api@1.0.48
+## @seekora-ai/admin-api@1.0.49
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @seekora-ai/admin-api@1.0.48 --save
+npm install @seekora-ai/admin-api@1.0.49 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -1068,11 +1068,11 @@ export interface AnalyticsExtendedKPIResponse {
      */
     'compare_summary'?: AnalyticsKPIMetrics;
     /**
-     * 
-     * @type {Array<AnalyticsKPIPointExtended>}
+     * Can be []KPIPointExtended or []ComparisonMetrics
+     * @type {object}
      * @memberof AnalyticsExtendedKPIResponse
      */
-    'data'?: Array<AnalyticsKPIPointExtended>;
+    'data'?: object;
     /**
      * 
      * @type {string}
@@ -1140,12 +1140,24 @@ export interface AnalyticsFilterAnalyticsResponse {
      * @memberof AnalyticsFilterAnalyticsResponse
      */
     'filter_key'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AnalyticsFilterAnalyticsResponse
+     */
+    'limit'?: number;
     /**
      * 
      * @type {string}
      * @memberof AnalyticsFilterAnalyticsResponse
      */
     'org_id'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AnalyticsFilterAnalyticsResponse
+     */
+    'page'?: number;
     /**
      * 
      * @type {string}
@@ -1176,6 +1188,12 @@ export interface AnalyticsFilterAnalyticsResponse {
      * @memberof AnalyticsFilterAnalyticsResponse
      */
     'store_id'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AnalyticsFilterAnalyticsResponse
+     */
+    'total'?: number;
 }
 /**
  * 
@@ -1411,12 +1429,24 @@ export interface AnalyticsFilterTrendsResponse {
      * @memberof AnalyticsFilterTrendsResponse
      */
     'granularity'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AnalyticsFilterTrendsResponse
+     */
+    'limit'?: number;
     /**
      * 
      * @type {string}
      * @memberof AnalyticsFilterTrendsResponse
      */
     'org_id'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AnalyticsFilterTrendsResponse
+     */
+    'page'?: number;
     /**
      * 
      * @type {string}
@@ -1447,6 +1477,12 @@ export interface AnalyticsFilterTrendsResponse {
      * @memberof AnalyticsFilterTrendsResponse
      */
     'top_filters'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof AnalyticsFilterTrendsResponse
+     */
+    'total'?: number;
     /**
      * 
      * @type {{ [key: string]: Array<AnalyticsTimeSeriesPoint>; }}
@@ -6002,11 +6038,17 @@ export interface DataTypesErrorMetaResponse {
  */
 export interface DataTypesEventPayload {
     /**
-     * 
+     * Journey Tracking & Analytics
      * @type {Array<string>}
      * @memberof DataTypesEventPayload
      */
     'analytics_tags'?: Array<string>;
+    /**
+     * Anonymous user identifier
+     * @type {string}
+     * @memberof DataTypesEventPayload
+     */
+    'anon_id'?: string;
     /**
      * 
      * @type {string}
@@ -6014,13 +6056,13 @@ export interface DataTypesEventPayload {
      */
     'city'?: string;
     /**
-     * 
+     * Click/Interaction Event Fields
      * @type {string}
      * @memberof DataTypesEventPayload
      */
     'clicked_product_id'?: string;
     /**
-     * Geo data fields for direct submission
+     * Enhanced Geo data fields for direct submission
      * @type {string}
      * @memberof DataTypesEventPayload
      */
@@ -6031,6 +6073,12 @@ export interface DataTypesEventPayload {
      * @memberof DataTypesEventPayload
      */
     'country_code'?: string;
+    /**
+     * Currency for value
+     * @type {string}
+     * @memberof DataTypesEventPayload
+     */
+    'currency'?: string;
     /**
      * 
      * @type {string}
@@ -6038,7 +6086,7 @@ export interface DataTypesEventPayload {
      */
     'device_type'?: string;
     /**
-     * 
+     * Core Event Information
      * @type {string}
      * @memberof DataTypesEventPayload
      */
@@ -6050,25 +6098,25 @@ export interface DataTypesEventPayload {
      */
     'event_name'?: string;
     /**
-     * 
+     * Device & Location Context
      * @type {string}
      * @memberof DataTypesEventPayload
      */
     'ip'?: string;
     /**
-     * 
+     * Performance
      * @type {number}
      * @memberof DataTypesEventPayload
      */
     'latency_ms'?: number;
     /**
-     * 
+     * Legacy field
      * @type {string}
      * @memberof DataTypesEventPayload
      */
     'location'?: string;
     /**
-     * 
+     * Flexible metadata including search_id, position, etc.
      * @type {{ [key: string]: any; }}
      * @memberof DataTypesEventPayload
      */
@@ -6080,7 +6128,13 @@ export interface DataTypesEventPayload {
      */
     'org_id'?: string;
     /**
-     * 
+     * web, ios, android
+     * @type {string}
+     * @memberof DataTypesEventPayload
+     */
+    'platform'?: string;
+    /**
+     * Search Event Fields
      * @type {string}
      * @memberof DataTypesEventPayload
      */
@@ -6098,7 +6152,13 @@ export interface DataTypesEventPayload {
      */
     'results_count'?: number;
     /**
-     * 
+     * Session identifier for journey tracking
+     * @type {string}
+     * @memberof DataTypesEventPayload
+     */
+    'session_id'?: string;
+    /**
+     * Organization Context
      * @type {string}
      * @memberof DataTypesEventPayload
      */
@@ -6110,11 +6170,17 @@ export interface DataTypesEventPayload {
      */
     'timestamp'?: string;
     /**
-     * 
+     * User Context
      * @type {string}
      * @memberof DataTypesEventPayload
      */
     'user_id'?: string;
+    /**
+     * Business Context
+     * @type {number}
+     * @memberof DataTypesEventPayload
+     */
+    'value'?: number;
 }
 /**
  * 
@@ -14680,12 +14746,20 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
             };
         },
         /**
-         * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
+         * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
          * @summary Get Query Insights
          * @param {string} xStoreID Store ID
          * @param {string} query Search query to analyze
          * @param {string} [startTime] Start time in RFC3339 format
          * @param {string} [endTime] End time in RFC3339 format
+         * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
+         * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
+         * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
+         * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
+         * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
+         * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
+         * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
+         * @param {string} [compareTagValueFilter] Tag value filter for comparison period
          * @param {number} [resultsPage] Page number for popular results pagination
          * @param {number} [resultsPageSize] Number of results per page for popular results
          * @param {number} [filtersPage] Page number for popular filters pagination
@@ -14694,7 +14768,7 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'xStoreID' is not null or undefined
             assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID)
             // verify required parameter 'query' is not null or undefined
@@ -14724,6 +14798,38 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
                 localVarQueryParameter['end_time'] = endTime;
             }
 
+            if (compareMode !== undefined) {
+                localVarQueryParameter['compare_mode'] = compareMode;
+            }
+
+            if (compareStartTime !== undefined) {
+                localVarQueryParameter['compare_start_time'] = compareStartTime;
+            }
+
+            if (compareEndTime !== undefined) {
+                localVarQueryParameter['compare_end_time'] = compareEndTime;
+            }
+
+            if (compareAnalyticsTags !== undefined) {
+                localVarQueryParameter['compare_analytics_tags'] = compareAnalyticsTags;
+            }
+
+            if (compareTagsMatchMode !== undefined) {
+                localVarQueryParameter['compare_tags_match_mode'] = compareTagsMatchMode;
+            }
+
+            if (compareTagsExclude !== undefined) {
+                localVarQueryParameter['compare_tags_exclude'] = compareTagsExclude;
+            }
+
+            if (compareTagKeyFilter !== undefined) {
+                localVarQueryParameter['compare_tag_key_filter'] = compareTagKeyFilter;
+            }
+
+            if (compareTagValueFilter !== undefined) {
+                localVarQueryParameter['compare_tag_value_filter'] = compareTagValueFilter;
+            }
+
             if (resultsPage !== undefined) {
                 localVarQueryParameter['results_page'] = resultsPage;
             }
@@ -15439,12 +15545,20 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
+         * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
          * @summary Get Query Insights
          * @param {string} xStoreID Store ID
          * @param {string} query Search query to analyze
          * @param {string} [startTime] Start time in RFC3339 format
          * @param {string} [endTime] End time in RFC3339 format
+         * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
+         * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
+         * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
+         * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
+         * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
+         * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
+         * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
+         * @param {string} [compareTagValueFilter] Tag value filter for comparison period
          * @param {number} [resultsPage] Page number for popular results pagination
          * @param {number} [resultsPageSize] Number of results per page for popular results
          * @param {number} [filtersPage] Page number for popular filters pagination
@@ -15453,8 +15567,8 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
+        async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -15846,12 +15960,20 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
             return localVarFp.adminAnalyticsStoreXStoreIDQueriesNoResultsGet(xStoreID, startTime, endTime, search, analyticsTags, tagsMatchMode, tagsExclude, tagKeyFilter, tagValueFilter, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, limit, offset, page, pageSize, sortBy, sortOrder, sort, options).then((request) => request(axios, basePath));
         },
         /**
-         * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
+         * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
          * @summary Get Query Insights
          * @param {string} xStoreID Store ID
          * @param {string} query Search query to analyze
          * @param {string} [startTime] Start time in RFC3339 format
          * @param {string} [endTime] End time in RFC3339 format
+         * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
+         * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
+         * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
+         * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
+         * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
+         * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
+         * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
+         * @param {string} [compareTagValueFilter] Tag value filter for comparison period
          * @param {number} [resultsPage] Page number for popular results pagination
          * @param {number} [resultsPageSize] Number of results per page for popular results
          * @param {number} [filtersPage] Page number for popular filters pagination
@@ -15860,8 +15982,8 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
-            return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
+        adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
+            return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
         },
         /**
          * Retrieve analytics for top performing search results with optional enrichment. By default returns widget display fields for UI presentation. Use include_documents=true for full document data (heavier response). Supports lightweight widget-only mode for dashboards with analytics tags filtering and comparison mode support.
@@ -16267,12 +16389,20 @@ export class AnalyticsApi extends BaseAPI {
     }
 
     /**
-     * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with independent pagination for popular results and filters
+     * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics with deep comparison mode support and independent pagination for popular results and filters
      * @summary Get Query Insights
      * @param {string} xStoreID Store ID
      * @param {string} query Search query to analyze
      * @param {string} [startTime] Start time in RFC3339 format
      * @param {string} [endTime] End time in RFC3339 format
+     * @param {boolean} [compareMode] Enable comparison mode to compare with another time period/tag set
+     * @param {string} [compareStartTime] Comparison period start time in RFC3339 format
+     * @param {string} [compareEndTime] Comparison period end time in RFC3339 format
+     * @param {string} [compareAnalyticsTags] Comma-separated analytics tags for comparison period
+     * @param {AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum} [compareTagsMatchMode] How to match comparison analytics tags
+     * @param {string} [compareTagsExclude] Comma-separated analytics tags to exclude in comparison
+     * @param {string} [compareTagKeyFilter] Tag key filter for comparison period
+     * @param {string} [compareTagValueFilter] Tag value filter for comparison period
      * @param {number} [resultsPage] Page number for popular results pagination
      * @param {number} [resultsPageSize] Number of results per page for popular results
      * @param {number} [filtersPage] Page number for popular filters pagination
@@ -16282,8 +16412,8 @@ export class AnalyticsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof AnalyticsApi
      */
-    public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
-        return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
+    public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, compareMode?: boolean, compareStartTime?: string, compareEndTime?: string, compareAnalyticsTags?: string, compareTagsMatchMode?: AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum, compareTagsExclude?: string, compareTagKeyFilter?: string, compareTagValueFilter?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
+        return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, compareMode, compareStartTime, compareEndTime, compareAnalyticsTags, compareTagsMatchMode, compareTagsExclude, compareTagKeyFilter, compareTagValueFilter, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -16660,6 +16790,14 @@ export const AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = {
     Desc: 'desc'
 } as const;
 export type AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum = typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesNoResultsGetSortOrderEnum];
+/**
+ * @export
+ */
+export const AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = {
+    Any: 'any',
+    All: 'all'
+} as const;
+export type AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum = typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum[keyof typeof AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGetCompareTagsMatchModeEnum];
 /**
  * @export
  */