@seekora-ai/admin-api 1.0.47 → 1.0.48

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 CHANGED
@@ -1,4 +1,4 @@
1
- ## @seekora-ai/admin-api@1.0.47
1
+ ## @seekora-ai/admin-api@1.0.48
2
2
 
3
3
  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:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @seekora-ai/admin-api@1.0.47 --save
39
+ npm install @seekora-ai/admin-api@1.0.48 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -325,6 +325,7 @@ Class | Method | HTTP request | Description
325
325
  - [AnalyticsItemTrendData](docs/AnalyticsItemTrendData.md)
326
326
  - [AnalyticsKPIMetrics](docs/AnalyticsKPIMetrics.md)
327
327
  - [AnalyticsKPIPointExtended](docs/AnalyticsKPIPointExtended.md)
328
+ - [AnalyticsPaginationMeta](docs/AnalyticsPaginationMeta.md)
328
329
  - [AnalyticsQueryAnalytic](docs/AnalyticsQueryAnalytic.md)
329
330
  - [AnalyticsQueryFilterAnalytics](docs/AnalyticsQueryFilterAnalytics.md)
330
331
  - [AnalyticsQueryFilterCombination](docs/AnalyticsQueryFilterCombination.md)
@@ -334,7 +335,9 @@ Class | Method | HTTP request | Description
334
335
  - [AnalyticsQueryInsights](docs/AnalyticsQueryInsights.md)
335
336
  - [AnalyticsQueryPerformanceAnalytics](docs/AnalyticsQueryPerformanceAnalytics.md)
336
337
  - [AnalyticsQueryPopularFilter](docs/AnalyticsQueryPopularFilter.md)
337
- - [AnalyticsQueryPopularResult](docs/AnalyticsQueryPopularResult.md)
338
+ - [AnalyticsQueryPopularFiltersSection](docs/AnalyticsQueryPopularFiltersSection.md)
339
+ - [AnalyticsQueryPopularResultWithWidget](docs/AnalyticsQueryPopularResultWithWidget.md)
340
+ - [AnalyticsQueryPopularResultsSection](docs/AnalyticsQueryPopularResultsSection.md)
338
341
  - [AnalyticsQueryResponse](docs/AnalyticsQueryResponse.md)
339
342
  - [AnalyticsTimeSeriesPoint](docs/AnalyticsTimeSeriesPoint.md)
340
343
  - [AnalyticsWidgetData](docs/AnalyticsWidgetData.md)
package/api.ts CHANGED
@@ -2485,6 +2485,49 @@ export interface AnalyticsKPIPointExtended {
2485
2485
  */
2486
2486
  'unique_users'?: number;
2487
2487
  }
2488
+ /**
2489
+ *
2490
+ * @export
2491
+ * @interface AnalyticsPaginationMeta
2492
+ */
2493
+ export interface AnalyticsPaginationMeta {
2494
+ /**
2495
+ *
2496
+ * @type {boolean}
2497
+ * @memberof AnalyticsPaginationMeta
2498
+ */
2499
+ 'has_next'?: boolean;
2500
+ /**
2501
+ *
2502
+ * @type {boolean}
2503
+ * @memberof AnalyticsPaginationMeta
2504
+ */
2505
+ 'has_previous'?: boolean;
2506
+ /**
2507
+ *
2508
+ * @type {number}
2509
+ * @memberof AnalyticsPaginationMeta
2510
+ */
2511
+ 'page'?: number;
2512
+ /**
2513
+ *
2514
+ * @type {number}
2515
+ * @memberof AnalyticsPaginationMeta
2516
+ */
2517
+ 'page_size'?: number;
2518
+ /**
2519
+ *
2520
+ * @type {number}
2521
+ * @memberof AnalyticsPaginationMeta
2522
+ */
2523
+ 'total_items'?: number;
2524
+ /**
2525
+ *
2526
+ * @type {number}
2527
+ * @memberof AnalyticsPaginationMeta
2528
+ */
2529
+ 'total_pages'?: number;
2530
+ }
2488
2531
  /**
2489
2532
  *
2490
2533
  * @export
@@ -2805,16 +2848,16 @@ export interface AnalyticsQueryInsights {
2805
2848
  'no_results_rate'?: number;
2806
2849
  /**
2807
2850
  *
2808
- * @type {Array<AnalyticsQueryPopularFilter>}
2851
+ * @type {AnalyticsQueryPopularFiltersSection}
2809
2852
  * @memberof AnalyticsQueryInsights
2810
2853
  */
2811
- 'popular_filters'?: Array<AnalyticsQueryPopularFilter>;
2854
+ 'popular_filters'?: AnalyticsQueryPopularFiltersSection;
2812
2855
  /**
2813
2856
  *
2814
- * @type {Array<AnalyticsQueryPopularResult>}
2857
+ * @type {AnalyticsQueryPopularResultsSection}
2815
2858
  * @memberof AnalyticsQueryInsights
2816
2859
  */
2817
- 'popular_results'?: Array<AnalyticsQueryPopularResult>;
2860
+ 'popular_results'?: AnalyticsQueryPopularResultsSection;
2818
2861
  /**
2819
2862
  *
2820
2863
  * @type {string}
@@ -2965,51 +3008,95 @@ export interface AnalyticsQueryPopularFilter {
2965
3008
  /**
2966
3009
  *
2967
3010
  * @export
2968
- * @interface AnalyticsQueryPopularResult
3011
+ * @interface AnalyticsQueryPopularFiltersSection
2969
3012
  */
2970
- export interface AnalyticsQueryPopularResult {
3013
+ export interface AnalyticsQueryPopularFiltersSection {
3014
+ /**
3015
+ *
3016
+ * @type {Array<AnalyticsQueryPopularFilter>}
3017
+ * @memberof AnalyticsQueryPopularFiltersSection
3018
+ */
3019
+ 'items'?: Array<AnalyticsQueryPopularFilter>;
3020
+ /**
3021
+ *
3022
+ * @type {AnalyticsPaginationMeta}
3023
+ * @memberof AnalyticsQueryPopularFiltersSection
3024
+ */
3025
+ 'meta'?: AnalyticsPaginationMeta;
3026
+ }
3027
+ /**
3028
+ *
3029
+ * @export
3030
+ * @interface AnalyticsQueryPopularResultWithWidget
3031
+ */
3032
+ export interface AnalyticsQueryPopularResultWithWidget {
2971
3033
  /**
2972
3034
  *
2973
3035
  * @type {number}
2974
- * @memberof AnalyticsQueryPopularResult
3036
+ * @memberof AnalyticsQueryPopularResultWithWidget
2975
3037
  */
2976
3038
  'avg_position'?: number;
2977
3039
  /**
2978
3040
  *
2979
3041
  * @type {number}
2980
- * @memberof AnalyticsQueryPopularResult
3042
+ * @memberof AnalyticsQueryPopularResultWithWidget
2981
3043
  */
2982
3044
  'click_through_rate'?: number;
2983
3045
  /**
2984
3046
  *
2985
3047
  * @type {number}
2986
- * @memberof AnalyticsQueryPopularResult
3048
+ * @memberof AnalyticsQueryPopularResultWithWidget
2987
3049
  */
2988
3050
  'clicks'?: number;
2989
3051
  /**
2990
3052
  *
2991
3053
  * @type {number}
2992
- * @memberof AnalyticsQueryPopularResult
3054
+ * @memberof AnalyticsQueryPopularResultWithWidget
2993
3055
  */
2994
3056
  'impressions'?: number;
2995
3057
  /**
2996
3058
  *
2997
3059
  * @type {string}
2998
- * @memberof AnalyticsQueryPopularResult
3060
+ * @memberof AnalyticsQueryPopularResultWithWidget
2999
3061
  */
3000
3062
  'item_id'?: string;
3001
3063
  /**
3002
3064
  *
3003
3065
  * @type {string}
3004
- * @memberof AnalyticsQueryPopularResult
3066
+ * @memberof AnalyticsQueryPopularResultWithWidget
3005
3067
  */
3006
3068
  'item_name'?: string;
3007
3069
  /**
3008
3070
  * percentage of total impressions for this query
3009
3071
  * @type {number}
3010
- * @memberof AnalyticsQueryPopularResult
3072
+ * @memberof AnalyticsQueryPopularResultWithWidget
3011
3073
  */
3012
3074
  'share'?: number;
3075
+ /**
3076
+ * Widget display fields
3077
+ * @type {AnalyticsWidgetData}
3078
+ * @memberof AnalyticsQueryPopularResultWithWidget
3079
+ */
3080
+ 'widget'?: AnalyticsWidgetData;
3081
+ }
3082
+ /**
3083
+ *
3084
+ * @export
3085
+ * @interface AnalyticsQueryPopularResultsSection
3086
+ */
3087
+ export interface AnalyticsQueryPopularResultsSection {
3088
+ /**
3089
+ *
3090
+ * @type {Array<AnalyticsQueryPopularResultWithWidget>}
3091
+ * @memberof AnalyticsQueryPopularResultsSection
3092
+ */
3093
+ 'items'?: Array<AnalyticsQueryPopularResultWithWidget>;
3094
+ /**
3095
+ *
3096
+ * @type {AnalyticsPaginationMeta}
3097
+ * @memberof AnalyticsQueryPopularResultsSection
3098
+ */
3099
+ 'meta'?: AnalyticsPaginationMeta;
3013
3100
  }
3014
3101
  /**
3015
3102
  *
@@ -14593,16 +14680,21 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
14593
14680
  };
14594
14681
  },
14595
14682
  /**
14596
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
14683
+ * 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
14597
14684
  * @summary Get Query Insights
14598
14685
  * @param {string} xStoreID Store ID
14599
14686
  * @param {string} query Search query to analyze
14600
14687
  * @param {string} [startTime] Start time in RFC3339 format
14601
14688
  * @param {string} [endTime] End time in RFC3339 format
14689
+ * @param {number} [resultsPage] Page number for popular results pagination
14690
+ * @param {number} [resultsPageSize] Number of results per page for popular results
14691
+ * @param {number} [filtersPage] Page number for popular filters pagination
14692
+ * @param {number} [filtersPageSize] Number of filters per page for popular filters
14693
+ * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
14602
14694
  * @param {*} [options] Override http request option.
14603
14695
  * @throws {RequiredError}
14604
14696
  */
14605
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14697
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet: async (xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14606
14698
  // verify required parameter 'xStoreID' is not null or undefined
14607
14699
  assertParamExists('adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet', 'xStoreID', xStoreID)
14608
14700
  // verify required parameter 'query' is not null or undefined
@@ -14632,6 +14724,26 @@ export const AnalyticsApiAxiosParamCreator = function (configuration?: Configura
14632
14724
  localVarQueryParameter['end_time'] = endTime;
14633
14725
  }
14634
14726
 
14727
+ if (resultsPage !== undefined) {
14728
+ localVarQueryParameter['results_page'] = resultsPage;
14729
+ }
14730
+
14731
+ if (resultsPageSize !== undefined) {
14732
+ localVarQueryParameter['results_page_size'] = resultsPageSize;
14733
+ }
14734
+
14735
+ if (filtersPage !== undefined) {
14736
+ localVarQueryParameter['filters_page'] = filtersPage;
14737
+ }
14738
+
14739
+ if (filtersPageSize !== undefined) {
14740
+ localVarQueryParameter['filters_page_size'] = filtersPageSize;
14741
+ }
14742
+
14743
+ if (includeWidget !== undefined) {
14744
+ localVarQueryParameter['include_widget'] = includeWidget;
14745
+ }
14746
+
14635
14747
 
14636
14748
 
14637
14749
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -15327,17 +15439,22 @@ export const AnalyticsApiFp = function(configuration?: Configuration) {
15327
15439
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
15328
15440
  },
15329
15441
  /**
15330
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
15442
+ * 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
15331
15443
  * @summary Get Query Insights
15332
15444
  * @param {string} xStoreID Store ID
15333
15445
  * @param {string} query Search query to analyze
15334
15446
  * @param {string} [startTime] Start time in RFC3339 format
15335
15447
  * @param {string} [endTime] End time in RFC3339 format
15448
+ * @param {number} [resultsPage] Page number for popular results pagination
15449
+ * @param {number} [resultsPageSize] Number of results per page for popular results
15450
+ * @param {number} [filtersPage] Page number for popular filters pagination
15451
+ * @param {number} [filtersPageSize] Number of filters per page for popular filters
15452
+ * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
15336
15453
  * @param {*} [options] Override http request option.
15337
15454
  * @throws {RequiredError}
15338
15455
  */
15339
- async adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response>> {
15340
- const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options);
15456
+ 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>> {
15457
+ const localVarAxiosArgs = await localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options);
15341
15458
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
15342
15459
  const localVarOperationServerBasePath = operationServerMap['AnalyticsApi.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet']?.[localVarOperationServerIndex]?.url;
15343
15460
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -15729,17 +15846,22 @@ export const AnalyticsApiFactory = function (configuration?: Configuration, base
15729
15846
  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));
15730
15847
  },
15731
15848
  /**
15732
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
15849
+ * 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
15733
15850
  * @summary Get Query Insights
15734
15851
  * @param {string} xStoreID Store ID
15735
15852
  * @param {string} query Search query to analyze
15736
15853
  * @param {string} [startTime] Start time in RFC3339 format
15737
15854
  * @param {string} [endTime] End time in RFC3339 format
15855
+ * @param {number} [resultsPage] Page number for popular results pagination
15856
+ * @param {number} [resultsPageSize] Number of results per page for popular results
15857
+ * @param {number} [filtersPage] Page number for popular filters pagination
15858
+ * @param {number} [filtersPageSize] Number of filters per page for popular filters
15859
+ * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
15738
15860
  * @param {*} [options] Override http request option.
15739
15861
  * @throws {RequiredError}
15740
15862
  */
15741
- adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
15742
- return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(axios, basePath));
15863
+ adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<AdminAnalyticsStoreXStoreIDQueriesQueryInsightsGet200Response> {
15864
+ return localVarFp.adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(axios, basePath));
15743
15865
  },
15744
15866
  /**
15745
15867
  * 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.
@@ -16145,18 +16267,23 @@ export class AnalyticsApi extends BaseAPI {
16145
16267
  }
16146
16268
 
16147
16269
  /**
16148
- * Retrieve comprehensive analytics for a specific search query including popular results, filters, click position histogram, and performance metrics
16270
+ * 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
16149
16271
  * @summary Get Query Insights
16150
16272
  * @param {string} xStoreID Store ID
16151
16273
  * @param {string} query Search query to analyze
16152
16274
  * @param {string} [startTime] Start time in RFC3339 format
16153
16275
  * @param {string} [endTime] End time in RFC3339 format
16276
+ * @param {number} [resultsPage] Page number for popular results pagination
16277
+ * @param {number} [resultsPageSize] Number of results per page for popular results
16278
+ * @param {number} [filtersPage] Page number for popular filters pagination
16279
+ * @param {number} [filtersPageSize] Number of filters per page for popular filters
16280
+ * @param {boolean} [includeWidget] Whether to include widget display fields for popular results
16154
16281
  * @param {*} [options] Override http request option.
16155
16282
  * @throws {RequiredError}
16156
16283
  * @memberof AnalyticsApi
16157
16284
  */
16158
- public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) {
16159
- return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, options).then((request) => request(this.axios, this.basePath));
16285
+ public adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID: string, query: string, startTime?: string, endTime?: string, resultsPage?: number, resultsPageSize?: number, filtersPage?: number, filtersPageSize?: number, includeWidget?: boolean, options?: RawAxiosRequestConfig) {
16286
+ return AnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDQueriesQueryInsightsGet(xStoreID, query, startTime, endTime, resultsPage, resultsPageSize, filtersPage, filtersPageSize, includeWidget, options).then((request) => request(this.axios, this.basePath));
16160
16287
  }
16161
16288
 
16162
16289
  /**