@seekora-ai/admin-api 1.1.58 → 1.1.60
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 +25 -3
- package/api.ts +1559 -56
- package/dist/api.d.ts +1013 -54
- package/dist/api.js +1064 -18
- package/dist/esm/api.d.ts +1013 -54
- package/dist/esm/api.js +1100 -58
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.60.tgz +0 -0
- package/seekora-ai-admin-api-1.1.58.tgz +0 -0
package/dist/esm/api.js
CHANGED
|
@@ -2698,6 +2698,170 @@ export class AdminNotificationsApi extends BaseAPI {
|
|
|
2698
2698
|
*/
|
|
2699
2699
|
export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
2700
2700
|
return {
|
|
2701
|
+
/**
|
|
2702
|
+
* Retrieve geographic analytics aggregated across all stores for the organization.
|
|
2703
|
+
* @summary Get Organization Geographic Analytics
|
|
2704
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
2705
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
2706
|
+
* @param {number} [limit] Maximum number of results
|
|
2707
|
+
* @param {*} [options] Override http request option.
|
|
2708
|
+
* @throws {RequiredError}
|
|
2709
|
+
*/
|
|
2710
|
+
adminAnalyticsOrgGeoGet: (startTime_1, endTime_1, limit_1, ...args_1) => __awaiter(this, [startTime_1, endTime_1, limit_1, ...args_1], void 0, function* (startTime, endTime, limit, options = {}) {
|
|
2711
|
+
const localVarPath = `/admin/analytics/org/geo`;
|
|
2712
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2713
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2714
|
+
let baseOptions;
|
|
2715
|
+
if (configuration) {
|
|
2716
|
+
baseOptions = configuration.baseOptions;
|
|
2717
|
+
}
|
|
2718
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2719
|
+
const localVarHeaderParameter = {};
|
|
2720
|
+
const localVarQueryParameter = {};
|
|
2721
|
+
// authentication BearerAuth required
|
|
2722
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2723
|
+
if (startTime !== undefined) {
|
|
2724
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
2725
|
+
}
|
|
2726
|
+
if (endTime !== undefined) {
|
|
2727
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
2728
|
+
}
|
|
2729
|
+
if (limit !== undefined) {
|
|
2730
|
+
localVarQueryParameter['limit'] = limit;
|
|
2731
|
+
}
|
|
2732
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2733
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2734
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2735
|
+
return {
|
|
2736
|
+
url: toPathString(localVarUrlObj),
|
|
2737
|
+
options: localVarRequestOptions,
|
|
2738
|
+
};
|
|
2739
|
+
}),
|
|
2740
|
+
/**
|
|
2741
|
+
* Retrieve comprehensive KPI metrics aggregated across all stores for the organization including searches, clicks, conversions, and revenue data with time series and summary.
|
|
2742
|
+
* @summary Get Organization KPI Analytics
|
|
2743
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
2744
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
2745
|
+
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
2746
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
2747
|
+
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
2748
|
+
* @param {boolean} [compareMode] Enable comparison mode
|
|
2749
|
+
* @param {*} [options] Override http request option.
|
|
2750
|
+
* @throws {RequiredError}
|
|
2751
|
+
*/
|
|
2752
|
+
adminAnalyticsOrgKpiGet: (startTime_1, endTime_1, granularity_1, analyticsTags_1, tagsMatchMode_1, compareMode_1, ...args_1) => __awaiter(this, [startTime_1, endTime_1, granularity_1, analyticsTags_1, tagsMatchMode_1, compareMode_1, ...args_1], void 0, function* (startTime, endTime, granularity, analyticsTags, tagsMatchMode, compareMode, options = {}) {
|
|
2753
|
+
const localVarPath = `/admin/analytics/org/kpi`;
|
|
2754
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2755
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2756
|
+
let baseOptions;
|
|
2757
|
+
if (configuration) {
|
|
2758
|
+
baseOptions = configuration.baseOptions;
|
|
2759
|
+
}
|
|
2760
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2761
|
+
const localVarHeaderParameter = {};
|
|
2762
|
+
const localVarQueryParameter = {};
|
|
2763
|
+
// authentication BearerAuth required
|
|
2764
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2765
|
+
if (startTime !== undefined) {
|
|
2766
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
2767
|
+
}
|
|
2768
|
+
if (endTime !== undefined) {
|
|
2769
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
2770
|
+
}
|
|
2771
|
+
if (granularity !== undefined) {
|
|
2772
|
+
localVarQueryParameter['granularity'] = granularity;
|
|
2773
|
+
}
|
|
2774
|
+
if (analyticsTags !== undefined) {
|
|
2775
|
+
localVarQueryParameter['analytics_tags'] = analyticsTags;
|
|
2776
|
+
}
|
|
2777
|
+
if (tagsMatchMode !== undefined) {
|
|
2778
|
+
localVarQueryParameter['tags_match_mode'] = tagsMatchMode;
|
|
2779
|
+
}
|
|
2780
|
+
if (compareMode !== undefined) {
|
|
2781
|
+
localVarQueryParameter['compare_mode'] = compareMode;
|
|
2782
|
+
}
|
|
2783
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2784
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2785
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2786
|
+
return {
|
|
2787
|
+
url: toPathString(localVarUrlObj),
|
|
2788
|
+
options: localVarRequestOptions,
|
|
2789
|
+
};
|
|
2790
|
+
}),
|
|
2791
|
+
/**
|
|
2792
|
+
* Retrieve real-time KPI metrics aggregated across all stores for the organization for the last hour.
|
|
2793
|
+
* @summary Get Organization Real-time KPI Analytics
|
|
2794
|
+
* @param {*} [options] Override http request option.
|
|
2795
|
+
* @throws {RequiredError}
|
|
2796
|
+
*/
|
|
2797
|
+
adminAnalyticsOrgKpiRealtimeGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
2798
|
+
const localVarPath = `/admin/analytics/org/kpi/realtime`;
|
|
2799
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2800
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2801
|
+
let baseOptions;
|
|
2802
|
+
if (configuration) {
|
|
2803
|
+
baseOptions = configuration.baseOptions;
|
|
2804
|
+
}
|
|
2805
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2806
|
+
const localVarHeaderParameter = {};
|
|
2807
|
+
const localVarQueryParameter = {};
|
|
2808
|
+
// authentication BearerAuth required
|
|
2809
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2810
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2811
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2812
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2813
|
+
return {
|
|
2814
|
+
url: toPathString(localVarUrlObj),
|
|
2815
|
+
options: localVarRequestOptions,
|
|
2816
|
+
};
|
|
2817
|
+
}),
|
|
2818
|
+
/**
|
|
2819
|
+
* Retrieve per-query performance analytics aggregated across all stores for the organization.
|
|
2820
|
+
* @summary Get Organization Query Analytics
|
|
2821
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
2822
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
2823
|
+
* @param {number} [limit] Maximum number of results
|
|
2824
|
+
* @param {number} [offset] Offset for pagination
|
|
2825
|
+
* @param {string} [orderBy] Column to order by
|
|
2826
|
+
* @param {*} [options] Override http request option.
|
|
2827
|
+
* @throws {RequiredError}
|
|
2828
|
+
*/
|
|
2829
|
+
adminAnalyticsOrgQueriesGet: (startTime_1, endTime_1, limit_1, offset_1, orderBy_1, ...args_1) => __awaiter(this, [startTime_1, endTime_1, limit_1, offset_1, orderBy_1, ...args_1], void 0, function* (startTime, endTime, limit, offset, orderBy, options = {}) {
|
|
2830
|
+
const localVarPath = `/admin/analytics/org/queries`;
|
|
2831
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2832
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2833
|
+
let baseOptions;
|
|
2834
|
+
if (configuration) {
|
|
2835
|
+
baseOptions = configuration.baseOptions;
|
|
2836
|
+
}
|
|
2837
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2838
|
+
const localVarHeaderParameter = {};
|
|
2839
|
+
const localVarQueryParameter = {};
|
|
2840
|
+
// authentication BearerAuth required
|
|
2841
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2842
|
+
if (startTime !== undefined) {
|
|
2843
|
+
localVarQueryParameter['start_time'] = startTime;
|
|
2844
|
+
}
|
|
2845
|
+
if (endTime !== undefined) {
|
|
2846
|
+
localVarQueryParameter['end_time'] = endTime;
|
|
2847
|
+
}
|
|
2848
|
+
if (limit !== undefined) {
|
|
2849
|
+
localVarQueryParameter['limit'] = limit;
|
|
2850
|
+
}
|
|
2851
|
+
if (offset !== undefined) {
|
|
2852
|
+
localVarQueryParameter['offset'] = offset;
|
|
2853
|
+
}
|
|
2854
|
+
if (orderBy !== undefined) {
|
|
2855
|
+
localVarQueryParameter['order_by'] = orderBy;
|
|
2856
|
+
}
|
|
2857
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2858
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2859
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2860
|
+
return {
|
|
2861
|
+
url: toPathString(localVarUrlObj),
|
|
2862
|
+
options: localVarRequestOptions,
|
|
2863
|
+
};
|
|
2864
|
+
}),
|
|
2701
2865
|
/**
|
|
2702
2866
|
* Retrieve analytics API configuration including supported granularities, limits, and available features
|
|
2703
2867
|
* @summary Get Analytics Configuration
|
|
@@ -4455,6 +4619,80 @@ export const AnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
4455
4619
|
export const AnalyticsApiFp = function (configuration) {
|
|
4456
4620
|
const localVarAxiosParamCreator = AnalyticsApiAxiosParamCreator(configuration);
|
|
4457
4621
|
return {
|
|
4622
|
+
/**
|
|
4623
|
+
* Retrieve geographic analytics aggregated across all stores for the organization.
|
|
4624
|
+
* @summary Get Organization Geographic Analytics
|
|
4625
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
4626
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
4627
|
+
* @param {number} [limit] Maximum number of results
|
|
4628
|
+
* @param {*} [options] Override http request option.
|
|
4629
|
+
* @throws {RequiredError}
|
|
4630
|
+
*/
|
|
4631
|
+
adminAnalyticsOrgGeoGet(startTime, endTime, limit, options) {
|
|
4632
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4633
|
+
var _a, _b, _c;
|
|
4634
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsOrgGeoGet(startTime, endTime, limit, options);
|
|
4635
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4636
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsOrgGeoGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4637
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4638
|
+
});
|
|
4639
|
+
},
|
|
4640
|
+
/**
|
|
4641
|
+
* Retrieve comprehensive KPI metrics aggregated across all stores for the organization including searches, clicks, conversions, and revenue data with time series and summary.
|
|
4642
|
+
* @summary Get Organization KPI Analytics
|
|
4643
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
4644
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
4645
|
+
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
4646
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
4647
|
+
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
4648
|
+
* @param {boolean} [compareMode] Enable comparison mode
|
|
4649
|
+
* @param {*} [options] Override http request option.
|
|
4650
|
+
* @throws {RequiredError}
|
|
4651
|
+
*/
|
|
4652
|
+
adminAnalyticsOrgKpiGet(startTime, endTime, granularity, analyticsTags, tagsMatchMode, compareMode, options) {
|
|
4653
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4654
|
+
var _a, _b, _c;
|
|
4655
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsOrgKpiGet(startTime, endTime, granularity, analyticsTags, tagsMatchMode, compareMode, options);
|
|
4656
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4657
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsOrgKpiGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4658
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4659
|
+
});
|
|
4660
|
+
},
|
|
4661
|
+
/**
|
|
4662
|
+
* Retrieve real-time KPI metrics aggregated across all stores for the organization for the last hour.
|
|
4663
|
+
* @summary Get Organization Real-time KPI Analytics
|
|
4664
|
+
* @param {*} [options] Override http request option.
|
|
4665
|
+
* @throws {RequiredError}
|
|
4666
|
+
*/
|
|
4667
|
+
adminAnalyticsOrgKpiRealtimeGet(options) {
|
|
4668
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4669
|
+
var _a, _b, _c;
|
|
4670
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsOrgKpiRealtimeGet(options);
|
|
4671
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4672
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsOrgKpiRealtimeGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4673
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4674
|
+
});
|
|
4675
|
+
},
|
|
4676
|
+
/**
|
|
4677
|
+
* Retrieve per-query performance analytics aggregated across all stores for the organization.
|
|
4678
|
+
* @summary Get Organization Query Analytics
|
|
4679
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
4680
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
4681
|
+
* @param {number} [limit] Maximum number of results
|
|
4682
|
+
* @param {number} [offset] Offset for pagination
|
|
4683
|
+
* @param {string} [orderBy] Column to order by
|
|
4684
|
+
* @param {*} [options] Override http request option.
|
|
4685
|
+
* @throws {RequiredError}
|
|
4686
|
+
*/
|
|
4687
|
+
adminAnalyticsOrgQueriesGet(startTime, endTime, limit, offset, orderBy, options) {
|
|
4688
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
4689
|
+
var _a, _b, _c;
|
|
4690
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsOrgQueriesGet(startTime, endTime, limit, offset, orderBy, options);
|
|
4691
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4692
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AnalyticsApi.adminAnalyticsOrgQueriesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4693
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4694
|
+
});
|
|
4695
|
+
},
|
|
4458
4696
|
/**
|
|
4459
4697
|
* Retrieve analytics API configuration including supported granularities, limits, and available features
|
|
4460
4698
|
* @summary Get Analytics Configuration
|
|
@@ -5075,6 +5313,56 @@ export const AnalyticsApiFp = function (configuration) {
|
|
|
5075
5313
|
export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
5076
5314
|
const localVarFp = AnalyticsApiFp(configuration);
|
|
5077
5315
|
return {
|
|
5316
|
+
/**
|
|
5317
|
+
* Retrieve geographic analytics aggregated across all stores for the organization.
|
|
5318
|
+
* @summary Get Organization Geographic Analytics
|
|
5319
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
5320
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
5321
|
+
* @param {number} [limit] Maximum number of results
|
|
5322
|
+
* @param {*} [options] Override http request option.
|
|
5323
|
+
* @throws {RequiredError}
|
|
5324
|
+
*/
|
|
5325
|
+
adminAnalyticsOrgGeoGet(startTime, endTime, limit, options) {
|
|
5326
|
+
return localVarFp.adminAnalyticsOrgGeoGet(startTime, endTime, limit, options).then((request) => request(axios, basePath));
|
|
5327
|
+
},
|
|
5328
|
+
/**
|
|
5329
|
+
* Retrieve comprehensive KPI metrics aggregated across all stores for the organization including searches, clicks, conversions, and revenue data with time series and summary.
|
|
5330
|
+
* @summary Get Organization KPI Analytics
|
|
5331
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
5332
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
5333
|
+
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
5334
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
5335
|
+
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
5336
|
+
* @param {boolean} [compareMode] Enable comparison mode
|
|
5337
|
+
* @param {*} [options] Override http request option.
|
|
5338
|
+
* @throws {RequiredError}
|
|
5339
|
+
*/
|
|
5340
|
+
adminAnalyticsOrgKpiGet(startTime, endTime, granularity, analyticsTags, tagsMatchMode, compareMode, options) {
|
|
5341
|
+
return localVarFp.adminAnalyticsOrgKpiGet(startTime, endTime, granularity, analyticsTags, tagsMatchMode, compareMode, options).then((request) => request(axios, basePath));
|
|
5342
|
+
},
|
|
5343
|
+
/**
|
|
5344
|
+
* Retrieve real-time KPI metrics aggregated across all stores for the organization for the last hour.
|
|
5345
|
+
* @summary Get Organization Real-time KPI Analytics
|
|
5346
|
+
* @param {*} [options] Override http request option.
|
|
5347
|
+
* @throws {RequiredError}
|
|
5348
|
+
*/
|
|
5349
|
+
adminAnalyticsOrgKpiRealtimeGet(options) {
|
|
5350
|
+
return localVarFp.adminAnalyticsOrgKpiRealtimeGet(options).then((request) => request(axios, basePath));
|
|
5351
|
+
},
|
|
5352
|
+
/**
|
|
5353
|
+
* Retrieve per-query performance analytics aggregated across all stores for the organization.
|
|
5354
|
+
* @summary Get Organization Query Analytics
|
|
5355
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
5356
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
5357
|
+
* @param {number} [limit] Maximum number of results
|
|
5358
|
+
* @param {number} [offset] Offset for pagination
|
|
5359
|
+
* @param {string} [orderBy] Column to order by
|
|
5360
|
+
* @param {*} [options] Override http request option.
|
|
5361
|
+
* @throws {RequiredError}
|
|
5362
|
+
*/
|
|
5363
|
+
adminAnalyticsOrgQueriesGet(startTime, endTime, limit, offset, orderBy, options) {
|
|
5364
|
+
return localVarFp.adminAnalyticsOrgQueriesGet(startTime, endTime, limit, offset, orderBy, options).then((request) => request(axios, basePath));
|
|
5365
|
+
},
|
|
5078
5366
|
/**
|
|
5079
5367
|
* Retrieve analytics API configuration including supported granularities, limits, and available features
|
|
5080
5368
|
* @summary Get Analytics Configuration
|
|
@@ -5569,6 +5857,60 @@ export const AnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
5569
5857
|
* @extends {BaseAPI}
|
|
5570
5858
|
*/
|
|
5571
5859
|
export class AnalyticsApi extends BaseAPI {
|
|
5860
|
+
/**
|
|
5861
|
+
* Retrieve geographic analytics aggregated across all stores for the organization.
|
|
5862
|
+
* @summary Get Organization Geographic Analytics
|
|
5863
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
5864
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
5865
|
+
* @param {number} [limit] Maximum number of results
|
|
5866
|
+
* @param {*} [options] Override http request option.
|
|
5867
|
+
* @throws {RequiredError}
|
|
5868
|
+
* @memberof AnalyticsApi
|
|
5869
|
+
*/
|
|
5870
|
+
adminAnalyticsOrgGeoGet(startTime, endTime, limit, options) {
|
|
5871
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsOrgGeoGet(startTime, endTime, limit, options).then((request) => request(this.axios, this.basePath));
|
|
5872
|
+
}
|
|
5873
|
+
/**
|
|
5874
|
+
* Retrieve comprehensive KPI metrics aggregated across all stores for the organization including searches, clicks, conversions, and revenue data with time series and summary.
|
|
5875
|
+
* @summary Get Organization KPI Analytics
|
|
5876
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
5877
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
5878
|
+
* @param {AdminAnalyticsOrgKpiGetGranularityEnum} [granularity] Time granularity
|
|
5879
|
+
* @param {string} [analyticsTags] Comma-separated analytics tags to filter
|
|
5880
|
+
* @param {AdminAnalyticsOrgKpiGetTagsMatchModeEnum} [tagsMatchMode] How to match multiple analytics tags
|
|
5881
|
+
* @param {boolean} [compareMode] Enable comparison mode
|
|
5882
|
+
* @param {*} [options] Override http request option.
|
|
5883
|
+
* @throws {RequiredError}
|
|
5884
|
+
* @memberof AnalyticsApi
|
|
5885
|
+
*/
|
|
5886
|
+
adminAnalyticsOrgKpiGet(startTime, endTime, granularity, analyticsTags, tagsMatchMode, compareMode, options) {
|
|
5887
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsOrgKpiGet(startTime, endTime, granularity, analyticsTags, tagsMatchMode, compareMode, options).then((request) => request(this.axios, this.basePath));
|
|
5888
|
+
}
|
|
5889
|
+
/**
|
|
5890
|
+
* Retrieve real-time KPI metrics aggregated across all stores for the organization for the last hour.
|
|
5891
|
+
* @summary Get Organization Real-time KPI Analytics
|
|
5892
|
+
* @param {*} [options] Override http request option.
|
|
5893
|
+
* @throws {RequiredError}
|
|
5894
|
+
* @memberof AnalyticsApi
|
|
5895
|
+
*/
|
|
5896
|
+
adminAnalyticsOrgKpiRealtimeGet(options) {
|
|
5897
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsOrgKpiRealtimeGet(options).then((request) => request(this.axios, this.basePath));
|
|
5898
|
+
}
|
|
5899
|
+
/**
|
|
5900
|
+
* Retrieve per-query performance analytics aggregated across all stores for the organization.
|
|
5901
|
+
* @summary Get Organization Query Analytics
|
|
5902
|
+
* @param {string} [startTime] Start time in RFC3339 format
|
|
5903
|
+
* @param {string} [endTime] End time in RFC3339 format
|
|
5904
|
+
* @param {number} [limit] Maximum number of results
|
|
5905
|
+
* @param {number} [offset] Offset for pagination
|
|
5906
|
+
* @param {string} [orderBy] Column to order by
|
|
5907
|
+
* @param {*} [options] Override http request option.
|
|
5908
|
+
* @throws {RequiredError}
|
|
5909
|
+
* @memberof AnalyticsApi
|
|
5910
|
+
*/
|
|
5911
|
+
adminAnalyticsOrgQueriesGet(startTime, endTime, limit, offset, orderBy, options) {
|
|
5912
|
+
return AnalyticsApiFp(this.configuration).adminAnalyticsOrgQueriesGet(startTime, endTime, limit, offset, orderBy, options).then((request) => request(this.axios, this.basePath));
|
|
5913
|
+
}
|
|
5572
5914
|
/**
|
|
5573
5915
|
* Retrieve analytics API configuration including supported granularities, limits, and available features
|
|
5574
5916
|
* @summary Get Analytics Configuration
|
|
@@ -6079,17 +6421,36 @@ export class AnalyticsApi extends BaseAPI {
|
|
|
6079
6421
|
/**
|
|
6080
6422
|
* @export
|
|
6081
6423
|
*/
|
|
6082
|
-
export const
|
|
6083
|
-
|
|
6084
|
-
|
|
6085
|
-
|
|
6086
|
-
|
|
6424
|
+
export const AdminAnalyticsOrgKpiGetGranularityEnum = {
|
|
6425
|
+
Minute: 'minute',
|
|
6426
|
+
_5minute: '5minute',
|
|
6427
|
+
_15minute: '15minute',
|
|
6428
|
+
Hour: 'hour',
|
|
6429
|
+
Day: 'day',
|
|
6430
|
+
Week: 'week',
|
|
6431
|
+
Month: 'month'
|
|
6087
6432
|
};
|
|
6088
6433
|
/**
|
|
6089
6434
|
* @export
|
|
6090
6435
|
*/
|
|
6091
|
-
export const
|
|
6092
|
-
|
|
6436
|
+
export const AdminAnalyticsOrgKpiGetTagsMatchModeEnum = {
|
|
6437
|
+
Any: 'any',
|
|
6438
|
+
All: 'all'
|
|
6439
|
+
};
|
|
6440
|
+
/**
|
|
6441
|
+
* @export
|
|
6442
|
+
*/
|
|
6443
|
+
export const AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortByEnum = {
|
|
6444
|
+
UsageCount: 'usage_count',
|
|
6445
|
+
ConversionRate: 'conversion_rate',
|
|
6446
|
+
SuccessRate: 'success_rate',
|
|
6447
|
+
CombinationScore: 'combination_score'
|
|
6448
|
+
};
|
|
6449
|
+
/**
|
|
6450
|
+
* @export
|
|
6451
|
+
*/
|
|
6452
|
+
export const AdminAnalyticsStoreXStoreIDFiltersCombinationsGetSortOrderEnum = {
|
|
6453
|
+
Asc: 'asc',
|
|
6093
6454
|
Desc: 'desc'
|
|
6094
6455
|
};
|
|
6095
6456
|
/**
|
|
@@ -12900,6 +13261,37 @@ export class CompanyConfigApi extends BaseAPI {
|
|
|
12900
13261
|
*/
|
|
12901
13262
|
export const ConnectorsApiAxiosParamCreator = function (configuration) {
|
|
12902
13263
|
return {
|
|
13264
|
+
/**
|
|
13265
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
13266
|
+
* @summary Get validation errors for a job
|
|
13267
|
+
* @param {string} jobid Job ID
|
|
13268
|
+
* @param {*} [options] Override http request option.
|
|
13269
|
+
* @throws {RequiredError}
|
|
13270
|
+
*/
|
|
13271
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet: (jobid_1, ...args_1) => __awaiter(this, [jobid_1, ...args_1], void 0, function* (jobid, options = {}) {
|
|
13272
|
+
// verify required parameter 'jobid' is not null or undefined
|
|
13273
|
+
assertParamExists('v1ConnectorsJobstatusJobidValidationErrorsGet', 'jobid', jobid);
|
|
13274
|
+
const localVarPath = `/v1/connectors/jobstatus/{jobid}/validation-errors`
|
|
13275
|
+
.replace(`{${"jobid"}}`, encodeURIComponent(String(jobid)));
|
|
13276
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
13277
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13278
|
+
let baseOptions;
|
|
13279
|
+
if (configuration) {
|
|
13280
|
+
baseOptions = configuration.baseOptions;
|
|
13281
|
+
}
|
|
13282
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
13283
|
+
const localVarHeaderParameter = {};
|
|
13284
|
+
const localVarQueryParameter = {};
|
|
13285
|
+
// authentication BearerAuth required
|
|
13286
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
13287
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13288
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13289
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
13290
|
+
return {
|
|
13291
|
+
url: toPathString(localVarUrlObj),
|
|
13292
|
+
options: localVarRequestOptions,
|
|
13293
|
+
};
|
|
13294
|
+
}),
|
|
12903
13295
|
/**
|
|
12904
13296
|
* Test search
|
|
12905
13297
|
* @summary Test search
|
|
@@ -13186,6 +13578,22 @@ export const ConnectorsApiAxiosParamCreator = function (configuration) {
|
|
|
13186
13578
|
export const ConnectorsApiFp = function (configuration) {
|
|
13187
13579
|
const localVarAxiosParamCreator = ConnectorsApiAxiosParamCreator(configuration);
|
|
13188
13580
|
return {
|
|
13581
|
+
/**
|
|
13582
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
13583
|
+
* @summary Get validation errors for a job
|
|
13584
|
+
* @param {string} jobid Job ID
|
|
13585
|
+
* @param {*} [options] Override http request option.
|
|
13586
|
+
* @throws {RequiredError}
|
|
13587
|
+
*/
|
|
13588
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid, options) {
|
|
13589
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
13590
|
+
var _a, _b, _c;
|
|
13591
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1ConnectorsJobstatusJobidValidationErrorsGet(jobid, options);
|
|
13592
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
13593
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ConnectorsApi.v1ConnectorsJobstatusJobidValidationErrorsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
13594
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
13595
|
+
});
|
|
13596
|
+
},
|
|
13189
13597
|
/**
|
|
13190
13598
|
* Test search
|
|
13191
13599
|
* @summary Test search
|
|
@@ -13341,6 +13749,16 @@ export const ConnectorsApiFp = function (configuration) {
|
|
|
13341
13749
|
export const ConnectorsApiFactory = function (configuration, basePath, axios) {
|
|
13342
13750
|
const localVarFp = ConnectorsApiFp(configuration);
|
|
13343
13751
|
return {
|
|
13752
|
+
/**
|
|
13753
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
13754
|
+
* @summary Get validation errors for a job
|
|
13755
|
+
* @param {string} jobid Job ID
|
|
13756
|
+
* @param {*} [options] Override http request option.
|
|
13757
|
+
* @throws {RequiredError}
|
|
13758
|
+
*/
|
|
13759
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid, options) {
|
|
13760
|
+
return localVarFp.v1ConnectorsJobstatusJobidValidationErrorsGet(jobid, options).then((request) => request(axios, basePath));
|
|
13761
|
+
},
|
|
13344
13762
|
/**
|
|
13345
13763
|
* Test search
|
|
13346
13764
|
* @summary Test search
|
|
@@ -13442,6 +13860,17 @@ export const ConnectorsApiFactory = function (configuration, basePath, axios) {
|
|
|
13442
13860
|
* @extends {BaseAPI}
|
|
13443
13861
|
*/
|
|
13444
13862
|
export class ConnectorsApi extends BaseAPI {
|
|
13863
|
+
/**
|
|
13864
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
13865
|
+
* @summary Get validation errors for a job
|
|
13866
|
+
* @param {string} jobid Job ID
|
|
13867
|
+
* @param {*} [options] Override http request option.
|
|
13868
|
+
* @throws {RequiredError}
|
|
13869
|
+
* @memberof ConnectorsApi
|
|
13870
|
+
*/
|
|
13871
|
+
v1ConnectorsJobstatusJobidValidationErrorsGet(jobid, options) {
|
|
13872
|
+
return ConnectorsApiFp(this.configuration).v1ConnectorsJobstatusJobidValidationErrorsGet(jobid, options).then((request) => request(this.axios, this.basePath));
|
|
13873
|
+
}
|
|
13445
13874
|
/**
|
|
13446
13875
|
* Test search
|
|
13447
13876
|
* @summary Test search
|
|
@@ -14932,96 +15361,484 @@ export const DefaultMenuManagementApiFp = function (configuration) {
|
|
|
14932
15361
|
const localVarAxiosParamCreator = DefaultMenuManagementApiAxiosParamCreator(configuration);
|
|
14933
15362
|
return {
|
|
14934
15363
|
/**
|
|
14935
|
-
* Retrieve all default menus with their global visibility settings
|
|
14936
|
-
* @summary Get all default menus with visibility flags
|
|
14937
|
-
* @param {string} [menuLevel] Filter by menu level (org/store)
|
|
15364
|
+
* Retrieve all default menus with their global visibility settings
|
|
15365
|
+
* @summary Get all default menus with visibility flags
|
|
15366
|
+
* @param {string} [menuLevel] Filter by menu level (org/store)
|
|
15367
|
+
* @param {*} [options] Override http request option.
|
|
15368
|
+
* @throws {RequiredError}
|
|
15369
|
+
*/
|
|
15370
|
+
adminDefaultMenusGet(menuLevel, options) {
|
|
15371
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15372
|
+
var _a, _b, _c;
|
|
15373
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminDefaultMenusGet(menuLevel, options);
|
|
15374
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15375
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultMenuManagementApi.adminDefaultMenusGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15376
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15377
|
+
});
|
|
15378
|
+
},
|
|
15379
|
+
/**
|
|
15380
|
+
* Update the global visibility flag for a default menu
|
|
15381
|
+
* @summary Update menu global visibility
|
|
15382
|
+
* @param {DefaultMenuRoutesUpdateMenuVisibilityRequest} defaultMenuRoutesUpdateMenuVisibilityRequest Visibility update details
|
|
15383
|
+
* @param {*} [options] Override http request option.
|
|
15384
|
+
* @throws {RequiredError}
|
|
15385
|
+
*/
|
|
15386
|
+
adminDefaultMenusVisibilityPut(defaultMenuRoutesUpdateMenuVisibilityRequest, options) {
|
|
15387
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15388
|
+
var _a, _b, _c;
|
|
15389
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminDefaultMenusVisibilityPut(defaultMenuRoutesUpdateMenuVisibilityRequest, options);
|
|
15390
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15391
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultMenuManagementApi.adminDefaultMenusVisibilityPut']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15392
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15393
|
+
});
|
|
15394
|
+
},
|
|
15395
|
+
};
|
|
15396
|
+
};
|
|
15397
|
+
/**
|
|
15398
|
+
* DefaultMenuManagementApi - factory interface
|
|
15399
|
+
* @export
|
|
15400
|
+
*/
|
|
15401
|
+
export const DefaultMenuManagementApiFactory = function (configuration, basePath, axios) {
|
|
15402
|
+
const localVarFp = DefaultMenuManagementApiFp(configuration);
|
|
15403
|
+
return {
|
|
15404
|
+
/**
|
|
15405
|
+
* Retrieve all default menus with their global visibility settings
|
|
15406
|
+
* @summary Get all default menus with visibility flags
|
|
15407
|
+
* @param {string} [menuLevel] Filter by menu level (org/store)
|
|
15408
|
+
* @param {*} [options] Override http request option.
|
|
15409
|
+
* @throws {RequiredError}
|
|
15410
|
+
*/
|
|
15411
|
+
adminDefaultMenusGet(menuLevel, options) {
|
|
15412
|
+
return localVarFp.adminDefaultMenusGet(menuLevel, options).then((request) => request(axios, basePath));
|
|
15413
|
+
},
|
|
15414
|
+
/**
|
|
15415
|
+
* Update the global visibility flag for a default menu
|
|
15416
|
+
* @summary Update menu global visibility
|
|
15417
|
+
* @param {DefaultMenuRoutesUpdateMenuVisibilityRequest} defaultMenuRoutesUpdateMenuVisibilityRequest Visibility update details
|
|
15418
|
+
* @param {*} [options] Override http request option.
|
|
15419
|
+
* @throws {RequiredError}
|
|
15420
|
+
*/
|
|
15421
|
+
adminDefaultMenusVisibilityPut(defaultMenuRoutesUpdateMenuVisibilityRequest, options) {
|
|
15422
|
+
return localVarFp.adminDefaultMenusVisibilityPut(defaultMenuRoutesUpdateMenuVisibilityRequest, options).then((request) => request(axios, basePath));
|
|
15423
|
+
},
|
|
15424
|
+
};
|
|
15425
|
+
};
|
|
15426
|
+
/**
|
|
15427
|
+
* DefaultMenuManagementApi - object-oriented interface
|
|
15428
|
+
* @export
|
|
15429
|
+
* @class DefaultMenuManagementApi
|
|
15430
|
+
* @extends {BaseAPI}
|
|
15431
|
+
*/
|
|
15432
|
+
export class DefaultMenuManagementApi extends BaseAPI {
|
|
15433
|
+
/**
|
|
15434
|
+
* Retrieve all default menus with their global visibility settings
|
|
15435
|
+
* @summary Get all default menus with visibility flags
|
|
15436
|
+
* @param {string} [menuLevel] Filter by menu level (org/store)
|
|
15437
|
+
* @param {*} [options] Override http request option.
|
|
15438
|
+
* @throws {RequiredError}
|
|
15439
|
+
* @memberof DefaultMenuManagementApi
|
|
15440
|
+
*/
|
|
15441
|
+
adminDefaultMenusGet(menuLevel, options) {
|
|
15442
|
+
return DefaultMenuManagementApiFp(this.configuration).adminDefaultMenusGet(menuLevel, options).then((request) => request(this.axios, this.basePath));
|
|
15443
|
+
}
|
|
15444
|
+
/**
|
|
15445
|
+
* Update the global visibility flag for a default menu
|
|
15446
|
+
* @summary Update menu global visibility
|
|
15447
|
+
* @param {DefaultMenuRoutesUpdateMenuVisibilityRequest} defaultMenuRoutesUpdateMenuVisibilityRequest Visibility update details
|
|
15448
|
+
* @param {*} [options] Override http request option.
|
|
15449
|
+
* @throws {RequiredError}
|
|
15450
|
+
* @memberof DefaultMenuManagementApi
|
|
15451
|
+
*/
|
|
15452
|
+
adminDefaultMenusVisibilityPut(defaultMenuRoutesUpdateMenuVisibilityRequest, options) {
|
|
15453
|
+
return DefaultMenuManagementApiFp(this.configuration).adminDefaultMenusVisibilityPut(defaultMenuRoutesUpdateMenuVisibilityRequest, options).then((request) => request(this.axios, this.basePath));
|
|
15454
|
+
}
|
|
15455
|
+
}
|
|
15456
|
+
/**
|
|
15457
|
+
* DocumentationApi - axios parameter creator
|
|
15458
|
+
* @export
|
|
15459
|
+
*/
|
|
15460
|
+
export const DocumentationApiAxiosParamCreator = function (configuration) {
|
|
15461
|
+
return {
|
|
15462
|
+
/**
|
|
15463
|
+
* Deletes all documents from the Typesense collection. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15464
|
+
* @summary Clear all indexed documentation
|
|
15465
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
15466
|
+
* @param {*} [options] Override http request option.
|
|
15467
|
+
* @throws {RequiredError}
|
|
15468
|
+
*/
|
|
15469
|
+
v1DocsClearDelete: (xDocsAPIKey_1, ...args_1) => __awaiter(this, [xDocsAPIKey_1, ...args_1], void 0, function* (xDocsAPIKey, options = {}) {
|
|
15470
|
+
// verify required parameter 'xDocsAPIKey' is not null or undefined
|
|
15471
|
+
assertParamExists('v1DocsClearDelete', 'xDocsAPIKey', xDocsAPIKey);
|
|
15472
|
+
const localVarPath = `/v1/docs/clear`;
|
|
15473
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15474
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15475
|
+
let baseOptions;
|
|
15476
|
+
if (configuration) {
|
|
15477
|
+
baseOptions = configuration.baseOptions;
|
|
15478
|
+
}
|
|
15479
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
15480
|
+
const localVarHeaderParameter = {};
|
|
15481
|
+
const localVarQueryParameter = {};
|
|
15482
|
+
if (xDocsAPIKey != null) {
|
|
15483
|
+
localVarHeaderParameter['X-Docs-API-Key'] = String(xDocsAPIKey);
|
|
15484
|
+
}
|
|
15485
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15486
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15487
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15488
|
+
return {
|
|
15489
|
+
url: toPathString(localVarUrlObj),
|
|
15490
|
+
options: localVarRequestOptions,
|
|
15491
|
+
};
|
|
15492
|
+
}),
|
|
15493
|
+
/**
|
|
15494
|
+
* Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15495
|
+
* @summary Scrape and index documentation
|
|
15496
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
15497
|
+
* @param {*} [options] Override http request option.
|
|
15498
|
+
* @throws {RequiredError}
|
|
15499
|
+
*/
|
|
15500
|
+
v1DocsScrapePost: (xDocsAPIKey_1, ...args_1) => __awaiter(this, [xDocsAPIKey_1, ...args_1], void 0, function* (xDocsAPIKey, options = {}) {
|
|
15501
|
+
// verify required parameter 'xDocsAPIKey' is not null or undefined
|
|
15502
|
+
assertParamExists('v1DocsScrapePost', 'xDocsAPIKey', xDocsAPIKey);
|
|
15503
|
+
const localVarPath = `/v1/docs/scrape`;
|
|
15504
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15505
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15506
|
+
let baseOptions;
|
|
15507
|
+
if (configuration) {
|
|
15508
|
+
baseOptions = configuration.baseOptions;
|
|
15509
|
+
}
|
|
15510
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15511
|
+
const localVarHeaderParameter = {};
|
|
15512
|
+
const localVarQueryParameter = {};
|
|
15513
|
+
if (xDocsAPIKey != null) {
|
|
15514
|
+
localVarHeaderParameter['X-Docs-API-Key'] = String(xDocsAPIKey);
|
|
15515
|
+
}
|
|
15516
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15517
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15518
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15519
|
+
return {
|
|
15520
|
+
url: toPathString(localVarUrlObj),
|
|
15521
|
+
options: localVarRequestOptions,
|
|
15522
|
+
};
|
|
15523
|
+
}),
|
|
15524
|
+
/**
|
|
15525
|
+
* Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
|
|
15526
|
+
* @summary Search documentation
|
|
15527
|
+
* @param {string} query Search query
|
|
15528
|
+
* @param {number} [limit] Maximum number of results (default: 10, max: 100)
|
|
15529
|
+
* @param {*} [options] Override http request option.
|
|
15530
|
+
* @throws {RequiredError}
|
|
15531
|
+
*/
|
|
15532
|
+
v1DocsSearchPost: (query_1, limit_1, ...args_1) => __awaiter(this, [query_1, limit_1, ...args_1], void 0, function* (query, limit, options = {}) {
|
|
15533
|
+
// verify required parameter 'query' is not null or undefined
|
|
15534
|
+
assertParamExists('v1DocsSearchPost', 'query', query);
|
|
15535
|
+
const localVarPath = `/v1/docs/search`;
|
|
15536
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15537
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15538
|
+
let baseOptions;
|
|
15539
|
+
if (configuration) {
|
|
15540
|
+
baseOptions = configuration.baseOptions;
|
|
15541
|
+
}
|
|
15542
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
15543
|
+
const localVarHeaderParameter = {};
|
|
15544
|
+
const localVarQueryParameter = {};
|
|
15545
|
+
if (query !== undefined) {
|
|
15546
|
+
localVarQueryParameter['query'] = query;
|
|
15547
|
+
}
|
|
15548
|
+
if (limit !== undefined) {
|
|
15549
|
+
localVarQueryParameter['limit'] = limit;
|
|
15550
|
+
}
|
|
15551
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15552
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15553
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15554
|
+
return {
|
|
15555
|
+
url: toPathString(localVarUrlObj),
|
|
15556
|
+
options: localVarRequestOptions,
|
|
15557
|
+
};
|
|
15558
|
+
}),
|
|
15559
|
+
/**
|
|
15560
|
+
* Returns dropdown-style suggestions with one result per URL, organized by hierarchy. No authentication required.
|
|
15561
|
+
* @summary Get search suggestions
|
|
15562
|
+
* @param {string} query Search query
|
|
15563
|
+
* @param {number} [limit] Number of suggestions (default: 6, max: 20)
|
|
15564
|
+
* @param {*} [options] Override http request option.
|
|
15565
|
+
* @throws {RequiredError}
|
|
15566
|
+
*/
|
|
15567
|
+
v1DocsSuggestionsGet: (query_1, limit_1, ...args_1) => __awaiter(this, [query_1, limit_1, ...args_1], void 0, function* (query, limit, options = {}) {
|
|
15568
|
+
// verify required parameter 'query' is not null or undefined
|
|
15569
|
+
assertParamExists('v1DocsSuggestionsGet', 'query', query);
|
|
15570
|
+
const localVarPath = `/v1/docs/suggestions`;
|
|
15571
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15572
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15573
|
+
let baseOptions;
|
|
15574
|
+
if (configuration) {
|
|
15575
|
+
baseOptions = configuration.baseOptions;
|
|
15576
|
+
}
|
|
15577
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15578
|
+
const localVarHeaderParameter = {};
|
|
15579
|
+
const localVarQueryParameter = {};
|
|
15580
|
+
if (query !== undefined) {
|
|
15581
|
+
localVarQueryParameter['query'] = query;
|
|
15582
|
+
}
|
|
15583
|
+
if (limit !== undefined) {
|
|
15584
|
+
localVarQueryParameter['limit'] = limit;
|
|
15585
|
+
}
|
|
15586
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15587
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15588
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15589
|
+
return {
|
|
15590
|
+
url: toPathString(localVarUrlObj),
|
|
15591
|
+
options: localVarRequestOptions,
|
|
15592
|
+
};
|
|
15593
|
+
}),
|
|
15594
|
+
/**
|
|
15595
|
+
* Re-scrapes and re-indexes the documentation. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15596
|
+
* @summary Update documentation
|
|
15597
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
15598
|
+
* @param {*} [options] Override http request option.
|
|
15599
|
+
* @throws {RequiredError}
|
|
15600
|
+
*/
|
|
15601
|
+
v1DocsUpdatePut: (xDocsAPIKey_1, ...args_1) => __awaiter(this, [xDocsAPIKey_1, ...args_1], void 0, function* (xDocsAPIKey, options = {}) {
|
|
15602
|
+
// verify required parameter 'xDocsAPIKey' is not null or undefined
|
|
15603
|
+
assertParamExists('v1DocsUpdatePut', 'xDocsAPIKey', xDocsAPIKey);
|
|
15604
|
+
const localVarPath = `/v1/docs/update`;
|
|
15605
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15606
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15607
|
+
let baseOptions;
|
|
15608
|
+
if (configuration) {
|
|
15609
|
+
baseOptions = configuration.baseOptions;
|
|
15610
|
+
}
|
|
15611
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
15612
|
+
const localVarHeaderParameter = {};
|
|
15613
|
+
const localVarQueryParameter = {};
|
|
15614
|
+
if (xDocsAPIKey != null) {
|
|
15615
|
+
localVarHeaderParameter['X-Docs-API-Key'] = String(xDocsAPIKey);
|
|
15616
|
+
}
|
|
15617
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15618
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15619
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
15620
|
+
return {
|
|
15621
|
+
url: toPathString(localVarUrlObj),
|
|
15622
|
+
options: localVarRequestOptions,
|
|
15623
|
+
};
|
|
15624
|
+
}),
|
|
15625
|
+
};
|
|
15626
|
+
};
|
|
15627
|
+
/**
|
|
15628
|
+
* DocumentationApi - functional programming interface
|
|
15629
|
+
* @export
|
|
15630
|
+
*/
|
|
15631
|
+
export const DocumentationApiFp = function (configuration) {
|
|
15632
|
+
const localVarAxiosParamCreator = DocumentationApiAxiosParamCreator(configuration);
|
|
15633
|
+
return {
|
|
15634
|
+
/**
|
|
15635
|
+
* Deletes all documents from the Typesense collection. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15636
|
+
* @summary Clear all indexed documentation
|
|
15637
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
14938
15638
|
* @param {*} [options] Override http request option.
|
|
14939
15639
|
* @throws {RequiredError}
|
|
14940
15640
|
*/
|
|
14941
|
-
|
|
15641
|
+
v1DocsClearDelete(xDocsAPIKey, options) {
|
|
14942
15642
|
return __awaiter(this, void 0, void 0, function* () {
|
|
14943
15643
|
var _a, _b, _c;
|
|
14944
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
15644
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DocsClearDelete(xDocsAPIKey, options);
|
|
14945
15645
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14946
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['
|
|
15646
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentationApi.v1DocsClearDelete']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14947
15647
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14948
15648
|
});
|
|
14949
15649
|
},
|
|
14950
15650
|
/**
|
|
14951
|
-
*
|
|
14952
|
-
* @summary
|
|
14953
|
-
* @param {
|
|
15651
|
+
* Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15652
|
+
* @summary Scrape and index documentation
|
|
15653
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
14954
15654
|
* @param {*} [options] Override http request option.
|
|
14955
15655
|
* @throws {RequiredError}
|
|
14956
15656
|
*/
|
|
14957
|
-
|
|
15657
|
+
v1DocsScrapePost(xDocsAPIKey, options) {
|
|
14958
15658
|
return __awaiter(this, void 0, void 0, function* () {
|
|
14959
15659
|
var _a, _b, _c;
|
|
14960
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
15660
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DocsScrapePost(xDocsAPIKey, options);
|
|
14961
15661
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
14962
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['
|
|
15662
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentationApi.v1DocsScrapePost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15663
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15664
|
+
});
|
|
15665
|
+
},
|
|
15666
|
+
/**
|
|
15667
|
+
* Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
|
|
15668
|
+
* @summary Search documentation
|
|
15669
|
+
* @param {string} query Search query
|
|
15670
|
+
* @param {number} [limit] Maximum number of results (default: 10, max: 100)
|
|
15671
|
+
* @param {*} [options] Override http request option.
|
|
15672
|
+
* @throws {RequiredError}
|
|
15673
|
+
*/
|
|
15674
|
+
v1DocsSearchPost(query, limit, options) {
|
|
15675
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15676
|
+
var _a, _b, _c;
|
|
15677
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DocsSearchPost(query, limit, options);
|
|
15678
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15679
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentationApi.v1DocsSearchPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15680
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15681
|
+
});
|
|
15682
|
+
},
|
|
15683
|
+
/**
|
|
15684
|
+
* Returns dropdown-style suggestions with one result per URL, organized by hierarchy. No authentication required.
|
|
15685
|
+
* @summary Get search suggestions
|
|
15686
|
+
* @param {string} query Search query
|
|
15687
|
+
* @param {number} [limit] Number of suggestions (default: 6, max: 20)
|
|
15688
|
+
* @param {*} [options] Override http request option.
|
|
15689
|
+
* @throws {RequiredError}
|
|
15690
|
+
*/
|
|
15691
|
+
v1DocsSuggestionsGet(query, limit, options) {
|
|
15692
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15693
|
+
var _a, _b, _c;
|
|
15694
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DocsSuggestionsGet(query, limit, options);
|
|
15695
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15696
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentationApi.v1DocsSuggestionsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15697
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15698
|
+
});
|
|
15699
|
+
},
|
|
15700
|
+
/**
|
|
15701
|
+
* Re-scrapes and re-indexes the documentation. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15702
|
+
* @summary Update documentation
|
|
15703
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
15704
|
+
* @param {*} [options] Override http request option.
|
|
15705
|
+
* @throws {RequiredError}
|
|
15706
|
+
*/
|
|
15707
|
+
v1DocsUpdatePut(xDocsAPIKey, options) {
|
|
15708
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15709
|
+
var _a, _b, _c;
|
|
15710
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DocsUpdatePut(xDocsAPIKey, options);
|
|
15711
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15712
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentationApi.v1DocsUpdatePut']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
14963
15713
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14964
15714
|
});
|
|
14965
15715
|
},
|
|
14966
15716
|
};
|
|
14967
15717
|
};
|
|
14968
15718
|
/**
|
|
14969
|
-
*
|
|
15719
|
+
* DocumentationApi - factory interface
|
|
14970
15720
|
* @export
|
|
14971
15721
|
*/
|
|
14972
|
-
export const
|
|
14973
|
-
const localVarFp =
|
|
15722
|
+
export const DocumentationApiFactory = function (configuration, basePath, axios) {
|
|
15723
|
+
const localVarFp = DocumentationApiFp(configuration);
|
|
14974
15724
|
return {
|
|
14975
15725
|
/**
|
|
14976
|
-
*
|
|
14977
|
-
* @summary
|
|
14978
|
-
* @param {string}
|
|
15726
|
+
* Deletes all documents from the Typesense collection. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15727
|
+
* @summary Clear all indexed documentation
|
|
15728
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
14979
15729
|
* @param {*} [options] Override http request option.
|
|
14980
15730
|
* @throws {RequiredError}
|
|
14981
15731
|
*/
|
|
14982
|
-
|
|
14983
|
-
return localVarFp.
|
|
15732
|
+
v1DocsClearDelete(xDocsAPIKey, options) {
|
|
15733
|
+
return localVarFp.v1DocsClearDelete(xDocsAPIKey, options).then((request) => request(axios, basePath));
|
|
14984
15734
|
},
|
|
14985
15735
|
/**
|
|
14986
|
-
*
|
|
14987
|
-
* @summary
|
|
14988
|
-
* @param {
|
|
15736
|
+
* Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15737
|
+
* @summary Scrape and index documentation
|
|
15738
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
14989
15739
|
* @param {*} [options] Override http request option.
|
|
14990
15740
|
* @throws {RequiredError}
|
|
14991
15741
|
*/
|
|
14992
|
-
|
|
14993
|
-
return localVarFp.
|
|
15742
|
+
v1DocsScrapePost(xDocsAPIKey, options) {
|
|
15743
|
+
return localVarFp.v1DocsScrapePost(xDocsAPIKey, options).then((request) => request(axios, basePath));
|
|
15744
|
+
},
|
|
15745
|
+
/**
|
|
15746
|
+
* Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
|
|
15747
|
+
* @summary Search documentation
|
|
15748
|
+
* @param {string} query Search query
|
|
15749
|
+
* @param {number} [limit] Maximum number of results (default: 10, max: 100)
|
|
15750
|
+
* @param {*} [options] Override http request option.
|
|
15751
|
+
* @throws {RequiredError}
|
|
15752
|
+
*/
|
|
15753
|
+
v1DocsSearchPost(query, limit, options) {
|
|
15754
|
+
return localVarFp.v1DocsSearchPost(query, limit, options).then((request) => request(axios, basePath));
|
|
15755
|
+
},
|
|
15756
|
+
/**
|
|
15757
|
+
* Returns dropdown-style suggestions with one result per URL, organized by hierarchy. No authentication required.
|
|
15758
|
+
* @summary Get search suggestions
|
|
15759
|
+
* @param {string} query Search query
|
|
15760
|
+
* @param {number} [limit] Number of suggestions (default: 6, max: 20)
|
|
15761
|
+
* @param {*} [options] Override http request option.
|
|
15762
|
+
* @throws {RequiredError}
|
|
15763
|
+
*/
|
|
15764
|
+
v1DocsSuggestionsGet(query, limit, options) {
|
|
15765
|
+
return localVarFp.v1DocsSuggestionsGet(query, limit, options).then((request) => request(axios, basePath));
|
|
15766
|
+
},
|
|
15767
|
+
/**
|
|
15768
|
+
* Re-scrapes and re-indexes the documentation. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15769
|
+
* @summary Update documentation
|
|
15770
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
15771
|
+
* @param {*} [options] Override http request option.
|
|
15772
|
+
* @throws {RequiredError}
|
|
15773
|
+
*/
|
|
15774
|
+
v1DocsUpdatePut(xDocsAPIKey, options) {
|
|
15775
|
+
return localVarFp.v1DocsUpdatePut(xDocsAPIKey, options).then((request) => request(axios, basePath));
|
|
14994
15776
|
},
|
|
14995
15777
|
};
|
|
14996
15778
|
};
|
|
14997
15779
|
/**
|
|
14998
|
-
*
|
|
15780
|
+
* DocumentationApi - object-oriented interface
|
|
14999
15781
|
* @export
|
|
15000
|
-
* @class
|
|
15782
|
+
* @class DocumentationApi
|
|
15001
15783
|
* @extends {BaseAPI}
|
|
15002
15784
|
*/
|
|
15003
|
-
export class
|
|
15785
|
+
export class DocumentationApi extends BaseAPI {
|
|
15004
15786
|
/**
|
|
15005
|
-
*
|
|
15006
|
-
* @summary
|
|
15007
|
-
* @param {string}
|
|
15787
|
+
* Deletes all documents from the Typesense collection. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15788
|
+
* @summary Clear all indexed documentation
|
|
15789
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
15008
15790
|
* @param {*} [options] Override http request option.
|
|
15009
15791
|
* @throws {RequiredError}
|
|
15010
|
-
* @memberof
|
|
15792
|
+
* @memberof DocumentationApi
|
|
15011
15793
|
*/
|
|
15012
|
-
|
|
15013
|
-
return
|
|
15794
|
+
v1DocsClearDelete(xDocsAPIKey, options) {
|
|
15795
|
+
return DocumentationApiFp(this.configuration).v1DocsClearDelete(xDocsAPIKey, options).then((request) => request(this.axios, this.basePath));
|
|
15014
15796
|
}
|
|
15015
15797
|
/**
|
|
15016
|
-
*
|
|
15017
|
-
* @summary
|
|
15018
|
-
* @param {
|
|
15798
|
+
* Scrapes the documentation site and indexes all pages in Typesense. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15799
|
+
* @summary Scrape and index documentation
|
|
15800
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
15019
15801
|
* @param {*} [options] Override http request option.
|
|
15020
15802
|
* @throws {RequiredError}
|
|
15021
|
-
* @memberof
|
|
15803
|
+
* @memberof DocumentationApi
|
|
15022
15804
|
*/
|
|
15023
|
-
|
|
15024
|
-
return
|
|
15805
|
+
v1DocsScrapePost(xDocsAPIKey, options) {
|
|
15806
|
+
return DocumentationApiFp(this.configuration).v1DocsScrapePost(xDocsAPIKey, options).then((request) => request(this.axios, this.basePath));
|
|
15807
|
+
}
|
|
15808
|
+
/**
|
|
15809
|
+
* Searches the indexed documentation using Typesense. This is a public endpoint that does not require authentication.
|
|
15810
|
+
* @summary Search documentation
|
|
15811
|
+
* @param {string} query Search query
|
|
15812
|
+
* @param {number} [limit] Maximum number of results (default: 10, max: 100)
|
|
15813
|
+
* @param {*} [options] Override http request option.
|
|
15814
|
+
* @throws {RequiredError}
|
|
15815
|
+
* @memberof DocumentationApi
|
|
15816
|
+
*/
|
|
15817
|
+
v1DocsSearchPost(query, limit, options) {
|
|
15818
|
+
return DocumentationApiFp(this.configuration).v1DocsSearchPost(query, limit, options).then((request) => request(this.axios, this.basePath));
|
|
15819
|
+
}
|
|
15820
|
+
/**
|
|
15821
|
+
* Returns dropdown-style suggestions with one result per URL, organized by hierarchy. No authentication required.
|
|
15822
|
+
* @summary Get search suggestions
|
|
15823
|
+
* @param {string} query Search query
|
|
15824
|
+
* @param {number} [limit] Number of suggestions (default: 6, max: 20)
|
|
15825
|
+
* @param {*} [options] Override http request option.
|
|
15826
|
+
* @throws {RequiredError}
|
|
15827
|
+
* @memberof DocumentationApi
|
|
15828
|
+
*/
|
|
15829
|
+
v1DocsSuggestionsGet(query, limit, options) {
|
|
15830
|
+
return DocumentationApiFp(this.configuration).v1DocsSuggestionsGet(query, limit, options).then((request) => request(this.axios, this.basePath));
|
|
15831
|
+
}
|
|
15832
|
+
/**
|
|
15833
|
+
* Re-scrapes and re-indexes the documentation. Requires X-Docs-API-Key header. Returns 404 if API key is missing or invalid.
|
|
15834
|
+
* @summary Update documentation
|
|
15835
|
+
* @param {string} xDocsAPIKey Documentation API Secret Key
|
|
15836
|
+
* @param {*} [options] Override http request option.
|
|
15837
|
+
* @throws {RequiredError}
|
|
15838
|
+
* @memberof DocumentationApi
|
|
15839
|
+
*/
|
|
15840
|
+
v1DocsUpdatePut(xDocsAPIKey, options) {
|
|
15841
|
+
return DocumentationApiFp(this.configuration).v1DocsUpdatePut(xDocsAPIKey, options).then((request) => request(this.axios, this.basePath));
|
|
15025
15842
|
}
|
|
15026
15843
|
}
|
|
15027
15844
|
/**
|
|
@@ -15224,16 +16041,18 @@ export const DropdownRecommendationsApiAxiosParamCreator = function (configurati
|
|
|
15224
16041
|
};
|
|
15225
16042
|
}),
|
|
15226
16043
|
/**
|
|
15227
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown
|
|
16044
|
+
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
15228
16045
|
* @summary Get Dropdown Recommendations
|
|
15229
16046
|
* @param {string} xStoreid Store ID
|
|
15230
16047
|
* @param {string} xStoresecret Store Secret
|
|
15231
16048
|
* @param {string} [xUserId] User ID for personalization
|
|
15232
16049
|
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
16050
|
+
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
16051
|
+
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
15233
16052
|
* @param {*} [options] Override http request option.
|
|
15234
16053
|
* @throws {RequiredError}
|
|
15235
16054
|
*/
|
|
15236
|
-
v1DropdownRecommendationsGet: (xStoreid_1, xStoresecret_1, xUserId_1, xAnonId_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, xUserId_1, xAnonId_1, ...args_1], void 0, function* (xStoreid, xStoresecret, xUserId, xAnonId, options = {}) {
|
|
16055
|
+
v1DropdownRecommendationsGet: (xStoreid_1, xStoresecret_1, xUserId_1, xAnonId_1, q_1, query_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, xUserId_1, xAnonId_1, q_1, query_1, ...args_1], void 0, function* (xStoreid, xStoresecret, xUserId, xAnonId, q, query, options = {}) {
|
|
15237
16056
|
// verify required parameter 'xStoreid' is not null or undefined
|
|
15238
16057
|
assertParamExists('v1DropdownRecommendationsGet', 'xStoreid', xStoreid);
|
|
15239
16058
|
// verify required parameter 'xStoresecret' is not null or undefined
|
|
@@ -15248,6 +16067,12 @@ export const DropdownRecommendationsApiAxiosParamCreator = function (configurati
|
|
|
15248
16067
|
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
15249
16068
|
const localVarHeaderParameter = {};
|
|
15250
16069
|
const localVarQueryParameter = {};
|
|
16070
|
+
if (q !== undefined) {
|
|
16071
|
+
localVarQueryParameter['q'] = q;
|
|
16072
|
+
}
|
|
16073
|
+
if (query !== undefined) {
|
|
16074
|
+
localVarQueryParameter['query'] = query;
|
|
16075
|
+
}
|
|
15251
16076
|
if (xStoreid != null) {
|
|
15252
16077
|
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
15253
16078
|
}
|
|
@@ -15313,19 +16138,21 @@ export const DropdownRecommendationsApiFp = function (configuration) {
|
|
|
15313
16138
|
});
|
|
15314
16139
|
},
|
|
15315
16140
|
/**
|
|
15316
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown
|
|
16141
|
+
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
15317
16142
|
* @summary Get Dropdown Recommendations
|
|
15318
16143
|
* @param {string} xStoreid Store ID
|
|
15319
16144
|
* @param {string} xStoresecret Store Secret
|
|
15320
16145
|
* @param {string} [xUserId] User ID for personalization
|
|
15321
16146
|
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
16147
|
+
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
16148
|
+
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
15322
16149
|
* @param {*} [options] Override http request option.
|
|
15323
16150
|
* @throws {RequiredError}
|
|
15324
16151
|
*/
|
|
15325
|
-
v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
16152
|
+
v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, q, query, options) {
|
|
15326
16153
|
return __awaiter(this, void 0, void 0, function* () {
|
|
15327
16154
|
var _a, _b, _c;
|
|
15328
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, options);
|
|
16155
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, q, query, options);
|
|
15329
16156
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15330
16157
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DropdownRecommendationsApi.v1DropdownRecommendationsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15331
16158
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -15364,17 +16191,19 @@ export const DropdownRecommendationsApiFactory = function (configuration, basePa
|
|
|
15364
16191
|
return localVarFp.v1DropdownRecommendationsConfigPut(xStoreid, xStoresecret, dropdownRecommendationsServiceUpdateDropdownConfigRequest, options).then((request) => request(axios, basePath));
|
|
15365
16192
|
},
|
|
15366
16193
|
/**
|
|
15367
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown
|
|
16194
|
+
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
15368
16195
|
* @summary Get Dropdown Recommendations
|
|
15369
16196
|
* @param {string} xStoreid Store ID
|
|
15370
16197
|
* @param {string} xStoresecret Store Secret
|
|
15371
16198
|
* @param {string} [xUserId] User ID for personalization
|
|
15372
16199
|
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
16200
|
+
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
16201
|
+
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
15373
16202
|
* @param {*} [options] Override http request option.
|
|
15374
16203
|
* @throws {RequiredError}
|
|
15375
16204
|
*/
|
|
15376
|
-
v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
15377
|
-
return localVarFp.v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, options).then((request) => request(axios, basePath));
|
|
16205
|
+
v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, q, query, options) {
|
|
16206
|
+
return localVarFp.v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, q, query, options).then((request) => request(axios, basePath));
|
|
15378
16207
|
},
|
|
15379
16208
|
};
|
|
15380
16209
|
};
|
|
@@ -15411,18 +16240,20 @@ export class DropdownRecommendationsApi extends BaseAPI {
|
|
|
15411
16240
|
return DropdownRecommendationsApiFp(this.configuration).v1DropdownRecommendationsConfigPut(xStoreid, xStoresecret, dropdownRecommendationsServiceUpdateDropdownConfigRequest, options).then((request) => request(this.axios, this.basePath));
|
|
15412
16241
|
}
|
|
15413
16242
|
/**
|
|
15414
|
-
* Retrieve trending search categories, trending products, and popular brands for the dropdown
|
|
16243
|
+
* Retrieve trending search categories, trending products, and popular brands for the dropdown. Supports query-based filtering for suggestions.
|
|
15415
16244
|
* @summary Get Dropdown Recommendations
|
|
15416
16245
|
* @param {string} xStoreid Store ID
|
|
15417
16246
|
* @param {string} xStoresecret Store Secret
|
|
15418
16247
|
* @param {string} [xUserId] User ID for personalization
|
|
15419
16248
|
* @param {string} [xAnonId] Anonymous ID for personalization
|
|
16249
|
+
* @param {string} [q] Query string for filtering suggestions (prefix match)
|
|
16250
|
+
* @param {string} [query] Alternative query parameter for filtering suggestions
|
|
15420
16251
|
* @param {*} [options] Override http request option.
|
|
15421
16252
|
* @throws {RequiredError}
|
|
15422
16253
|
* @memberof DropdownRecommendationsApi
|
|
15423
16254
|
*/
|
|
15424
|
-
v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
15425
|
-
return DropdownRecommendationsApiFp(this.configuration).v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, options).then((request) => request(this.axios, this.basePath));
|
|
16255
|
+
v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, q, query, options) {
|
|
16256
|
+
return DropdownRecommendationsApiFp(this.configuration).v1DropdownRecommendationsGet(xStoreid, xStoresecret, xUserId, xAnonId, q, query, options).then((request) => request(this.axios, this.basePath));
|
|
15426
16257
|
}
|
|
15427
16258
|
}
|
|
15428
16259
|
/**
|
|
@@ -21251,6 +22082,41 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
21251
22082
|
options: localVarRequestOptions,
|
|
21252
22083
|
};
|
|
21253
22084
|
}),
|
|
22085
|
+
/**
|
|
22086
|
+
* Generates a fresh presigned URL for notification attachments (invoice or receipt). This is useful when the original presigned URL has expired.
|
|
22087
|
+
* @summary Get notification attachment URL
|
|
22088
|
+
* @param {number} id Notification ID
|
|
22089
|
+
* @param {string} type Attachment type (invoice or receipt)
|
|
22090
|
+
* @param {*} [options] Override http request option.
|
|
22091
|
+
* @throws {RequiredError}
|
|
22092
|
+
*/
|
|
22093
|
+
v1NotificationsIdAttachmentsTypeUrlGet: (id_1, type_1, ...args_1) => __awaiter(this, [id_1, type_1, ...args_1], void 0, function* (id, type, options = {}) {
|
|
22094
|
+
// verify required parameter 'id' is not null or undefined
|
|
22095
|
+
assertParamExists('v1NotificationsIdAttachmentsTypeUrlGet', 'id', id);
|
|
22096
|
+
// verify required parameter 'type' is not null or undefined
|
|
22097
|
+
assertParamExists('v1NotificationsIdAttachmentsTypeUrlGet', 'type', type);
|
|
22098
|
+
const localVarPath = `/v1/notifications/{id}/attachments/{type}/url`
|
|
22099
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
22100
|
+
.replace(`{${"type"}}`, encodeURIComponent(String(type)));
|
|
22101
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22102
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22103
|
+
let baseOptions;
|
|
22104
|
+
if (configuration) {
|
|
22105
|
+
baseOptions = configuration.baseOptions;
|
|
22106
|
+
}
|
|
22107
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
22108
|
+
const localVarHeaderParameter = {};
|
|
22109
|
+
const localVarQueryParameter = {};
|
|
22110
|
+
// authentication BearerAuth required
|
|
22111
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
22112
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22113
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22114
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
22115
|
+
return {
|
|
22116
|
+
url: toPathString(localVarUrlObj),
|
|
22117
|
+
options: localVarRequestOptions,
|
|
22118
|
+
};
|
|
22119
|
+
}),
|
|
21254
22120
|
/**
|
|
21255
22121
|
* Deletes a specific notification for the authenticated user
|
|
21256
22122
|
* @summary Delete notification
|
|
@@ -21448,6 +22314,23 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
21448
22314
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21449
22315
|
});
|
|
21450
22316
|
},
|
|
22317
|
+
/**
|
|
22318
|
+
* Generates a fresh presigned URL for notification attachments (invoice or receipt). This is useful when the original presigned URL has expired.
|
|
22319
|
+
* @summary Get notification attachment URL
|
|
22320
|
+
* @param {number} id Notification ID
|
|
22321
|
+
* @param {string} type Attachment type (invoice or receipt)
|
|
22322
|
+
* @param {*} [options] Override http request option.
|
|
22323
|
+
* @throws {RequiredError}
|
|
22324
|
+
*/
|
|
22325
|
+
v1NotificationsIdAttachmentsTypeUrlGet(id, type, options) {
|
|
22326
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
22327
|
+
var _a, _b, _c;
|
|
22328
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1NotificationsIdAttachmentsTypeUrlGet(id, type, options);
|
|
22329
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
22330
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NotificationsApi.v1NotificationsIdAttachmentsTypeUrlGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
22331
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22332
|
+
});
|
|
22333
|
+
},
|
|
21451
22334
|
/**
|
|
21452
22335
|
* Deletes a specific notification for the authenticated user
|
|
21453
22336
|
* @summary Delete notification
|
|
@@ -21564,6 +22447,17 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
21564
22447
|
v1NotificationsGet(page, pageSize, limit, offset, search, type, isRead, priority, sortBy, sortOrder, options) {
|
|
21565
22448
|
return localVarFp.v1NotificationsGet(page, pageSize, limit, offset, search, type, isRead, priority, sortBy, sortOrder, options).then((request) => request(axios, basePath));
|
|
21566
22449
|
},
|
|
22450
|
+
/**
|
|
22451
|
+
* Generates a fresh presigned URL for notification attachments (invoice or receipt). This is useful when the original presigned URL has expired.
|
|
22452
|
+
* @summary Get notification attachment URL
|
|
22453
|
+
* @param {number} id Notification ID
|
|
22454
|
+
* @param {string} type Attachment type (invoice or receipt)
|
|
22455
|
+
* @param {*} [options] Override http request option.
|
|
22456
|
+
* @throws {RequiredError}
|
|
22457
|
+
*/
|
|
22458
|
+
v1NotificationsIdAttachmentsTypeUrlGet(id, type, options) {
|
|
22459
|
+
return localVarFp.v1NotificationsIdAttachmentsTypeUrlGet(id, type, options).then((request) => request(axios, basePath));
|
|
22460
|
+
},
|
|
21567
22461
|
/**
|
|
21568
22462
|
* Deletes a specific notification for the authenticated user
|
|
21569
22463
|
* @summary Delete notification
|
|
@@ -21652,6 +22546,18 @@ export class NotificationsApi extends BaseAPI {
|
|
|
21652
22546
|
v1NotificationsGet(page, pageSize, limit, offset, search, type, isRead, priority, sortBy, sortOrder, options) {
|
|
21653
22547
|
return NotificationsApiFp(this.configuration).v1NotificationsGet(page, pageSize, limit, offset, search, type, isRead, priority, sortBy, sortOrder, options).then((request) => request(this.axios, this.basePath));
|
|
21654
22548
|
}
|
|
22549
|
+
/**
|
|
22550
|
+
* Generates a fresh presigned URL for notification attachments (invoice or receipt). This is useful when the original presigned URL has expired.
|
|
22551
|
+
* @summary Get notification attachment URL
|
|
22552
|
+
* @param {number} id Notification ID
|
|
22553
|
+
* @param {string} type Attachment type (invoice or receipt)
|
|
22554
|
+
* @param {*} [options] Override http request option.
|
|
22555
|
+
* @throws {RequiredError}
|
|
22556
|
+
* @memberof NotificationsApi
|
|
22557
|
+
*/
|
|
22558
|
+
v1NotificationsIdAttachmentsTypeUrlGet(id, type, options) {
|
|
22559
|
+
return NotificationsApiFp(this.configuration).v1NotificationsIdAttachmentsTypeUrlGet(id, type, options).then((request) => request(this.axios, this.basePath));
|
|
22560
|
+
}
|
|
21655
22561
|
/**
|
|
21656
22562
|
* Deletes a specific notification for the authenticated user
|
|
21657
22563
|
* @summary Delete notification
|
|
@@ -21823,6 +22729,37 @@ export const OnboardingApiAxiosParamCreator = function (configuration) {
|
|
|
21823
22729
|
options: localVarRequestOptions,
|
|
21824
22730
|
};
|
|
21825
22731
|
}),
|
|
22732
|
+
/**
|
|
22733
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
22734
|
+
* @summary Get validation errors for a job
|
|
22735
|
+
* @param {string} jobid Job ID
|
|
22736
|
+
* @param {*} [options] Override http request option.
|
|
22737
|
+
* @throws {RequiredError}
|
|
22738
|
+
*/
|
|
22739
|
+
adminV1UsersOnboardingJobstatusJobidValidationErrorsGet: (jobid_1, ...args_1) => __awaiter(this, [jobid_1, ...args_1], void 0, function* (jobid, options = {}) {
|
|
22740
|
+
// verify required parameter 'jobid' is not null or undefined
|
|
22741
|
+
assertParamExists('adminV1UsersOnboardingJobstatusJobidValidationErrorsGet', 'jobid', jobid);
|
|
22742
|
+
const localVarPath = `/admin/v1/users/onboarding/jobstatus/{jobid}/validation-errors`
|
|
22743
|
+
.replace(`{${"jobid"}}`, encodeURIComponent(String(jobid)));
|
|
22744
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
22745
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
22746
|
+
let baseOptions;
|
|
22747
|
+
if (configuration) {
|
|
22748
|
+
baseOptions = configuration.baseOptions;
|
|
22749
|
+
}
|
|
22750
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
22751
|
+
const localVarHeaderParameter = {};
|
|
22752
|
+
const localVarQueryParameter = {};
|
|
22753
|
+
// authentication BearerAuth required
|
|
22754
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
22755
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
22756
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
22757
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
22758
|
+
return {
|
|
22759
|
+
url: toPathString(localVarUrlObj),
|
|
22760
|
+
options: localVarRequestOptions,
|
|
22761
|
+
};
|
|
22762
|
+
}),
|
|
21826
22763
|
/**
|
|
21827
22764
|
* Updates onboardingstep and merges new data into onboardingdata JSON
|
|
21828
22765
|
* @summary Update user onboarding step
|
|
@@ -22081,6 +23018,22 @@ export const OnboardingApiFp = function (configuration) {
|
|
|
22081
23018
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
22082
23019
|
});
|
|
22083
23020
|
},
|
|
23021
|
+
/**
|
|
23022
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
23023
|
+
* @summary Get validation errors for a job
|
|
23024
|
+
* @param {string} jobid Job ID
|
|
23025
|
+
* @param {*} [options] Override http request option.
|
|
23026
|
+
* @throws {RequiredError}
|
|
23027
|
+
*/
|
|
23028
|
+
adminV1UsersOnboardingJobstatusJobidValidationErrorsGet(jobid, options) {
|
|
23029
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23030
|
+
var _a, _b, _c;
|
|
23031
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminV1UsersOnboardingJobstatusJobidValidationErrorsGet(jobid, options);
|
|
23032
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23033
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OnboardingApi.adminV1UsersOnboardingJobstatusJobidValidationErrorsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23034
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23035
|
+
});
|
|
23036
|
+
},
|
|
22084
23037
|
/**
|
|
22085
23038
|
* Updates onboardingstep and merges new data into onboardingdata JSON
|
|
22086
23039
|
* @summary Update user onboarding step
|
|
@@ -22218,6 +23171,16 @@ export const OnboardingApiFactory = function (configuration, basePath, axios) {
|
|
|
22218
23171
|
adminV1UsersOnboardingJobstatusJobidGet(jobid, options) {
|
|
22219
23172
|
return localVarFp.adminV1UsersOnboardingJobstatusJobidGet(jobid, options).then((request) => request(axios, basePath));
|
|
22220
23173
|
},
|
|
23174
|
+
/**
|
|
23175
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
23176
|
+
* @summary Get validation errors for a job
|
|
23177
|
+
* @param {string} jobid Job ID
|
|
23178
|
+
* @param {*} [options] Override http request option.
|
|
23179
|
+
* @throws {RequiredError}
|
|
23180
|
+
*/
|
|
23181
|
+
adminV1UsersOnboardingJobstatusJobidValidationErrorsGet(jobid, options) {
|
|
23182
|
+
return localVarFp.adminV1UsersOnboardingJobstatusJobidValidationErrorsGet(jobid, options).then((request) => request(axios, basePath));
|
|
23183
|
+
},
|
|
22221
23184
|
/**
|
|
22222
23185
|
* Updates onboardingstep and merges new data into onboardingdata JSON
|
|
22223
23186
|
* @summary Update user onboarding step
|
|
@@ -22315,6 +23278,17 @@ export class OnboardingApi extends BaseAPI {
|
|
|
22315
23278
|
adminV1UsersOnboardingJobstatusJobidGet(jobid, options) {
|
|
22316
23279
|
return OnboardingApiFp(this.configuration).adminV1UsersOnboardingJobstatusJobidGet(jobid, options).then((request) => request(this.axios, this.basePath));
|
|
22317
23280
|
}
|
|
23281
|
+
/**
|
|
23282
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
23283
|
+
* @summary Get validation errors for a job
|
|
23284
|
+
* @param {string} jobid Job ID
|
|
23285
|
+
* @param {*} [options] Override http request option.
|
|
23286
|
+
* @throws {RequiredError}
|
|
23287
|
+
* @memberof OnboardingApi
|
|
23288
|
+
*/
|
|
23289
|
+
adminV1UsersOnboardingJobstatusJobidValidationErrorsGet(jobid, options) {
|
|
23290
|
+
return OnboardingApiFp(this.configuration).adminV1UsersOnboardingJobstatusJobidValidationErrorsGet(jobid, options).then((request) => request(this.axios, this.basePath));
|
|
23291
|
+
}
|
|
22318
23292
|
/**
|
|
22319
23293
|
* Updates onboardingstep and merges new data into onboardingdata JSON
|
|
22320
23294
|
* @summary Update user onboarding step
|
|
@@ -32791,6 +33765,37 @@ export class StopwordsApi extends BaseAPI {
|
|
|
32791
33765
|
*/
|
|
32792
33766
|
export const StoreCreationApiAxiosParamCreator = function (configuration) {
|
|
32793
33767
|
return {
|
|
33768
|
+
/**
|
|
33769
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
33770
|
+
* @summary Get validation errors for a job
|
|
33771
|
+
* @param {string} jobid Job ID
|
|
33772
|
+
* @param {*} [options] Override http request option.
|
|
33773
|
+
* @throws {RequiredError}
|
|
33774
|
+
*/
|
|
33775
|
+
adminV1StoreCreationJobstatusJobidValidationErrorsGet: (jobid_1, ...args_1) => __awaiter(this, [jobid_1, ...args_1], void 0, function* (jobid, options = {}) {
|
|
33776
|
+
// verify required parameter 'jobid' is not null or undefined
|
|
33777
|
+
assertParamExists('adminV1StoreCreationJobstatusJobidValidationErrorsGet', 'jobid', jobid);
|
|
33778
|
+
const localVarPath = `/admin/v1/store-creation/jobstatus/{jobid}/validation-errors`
|
|
33779
|
+
.replace(`{${"jobid"}}`, encodeURIComponent(String(jobid)));
|
|
33780
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
33781
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
33782
|
+
let baseOptions;
|
|
33783
|
+
if (configuration) {
|
|
33784
|
+
baseOptions = configuration.baseOptions;
|
|
33785
|
+
}
|
|
33786
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
33787
|
+
const localVarHeaderParameter = {};
|
|
33788
|
+
const localVarQueryParameter = {};
|
|
33789
|
+
// authentication BearerAuth required
|
|
33790
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
33791
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
33792
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
33793
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
33794
|
+
return {
|
|
33795
|
+
url: toPathString(localVarUrlObj),
|
|
33796
|
+
options: localVarRequestOptions,
|
|
33797
|
+
};
|
|
33798
|
+
}),
|
|
32794
33799
|
/**
|
|
32795
33800
|
* Deletes (soft delete) the current store creation progress
|
|
32796
33801
|
* @summary Delete store creation progress
|
|
@@ -33060,6 +34065,22 @@ export const StoreCreationApiAxiosParamCreator = function (configuration) {
|
|
|
33060
34065
|
export const StoreCreationApiFp = function (configuration) {
|
|
33061
34066
|
const localVarAxiosParamCreator = StoreCreationApiAxiosParamCreator(configuration);
|
|
33062
34067
|
return {
|
|
34068
|
+
/**
|
|
34069
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
34070
|
+
* @summary Get validation errors for a job
|
|
34071
|
+
* @param {string} jobid Job ID
|
|
34072
|
+
* @param {*} [options] Override http request option.
|
|
34073
|
+
* @throws {RequiredError}
|
|
34074
|
+
*/
|
|
34075
|
+
adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid, options) {
|
|
34076
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
34077
|
+
var _a, _b, _c;
|
|
34078
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid, options);
|
|
34079
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
34080
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StoreCreationApi.adminV1StoreCreationJobstatusJobidValidationErrorsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
34081
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34082
|
+
});
|
|
34083
|
+
},
|
|
33063
34084
|
/**
|
|
33064
34085
|
* Deletes (soft delete) the current store creation progress
|
|
33065
34086
|
* @summary Delete store creation progress
|
|
@@ -33197,6 +34218,16 @@ export const StoreCreationApiFp = function (configuration) {
|
|
|
33197
34218
|
export const StoreCreationApiFactory = function (configuration, basePath, axios) {
|
|
33198
34219
|
const localVarFp = StoreCreationApiFp(configuration);
|
|
33199
34220
|
return {
|
|
34221
|
+
/**
|
|
34222
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
34223
|
+
* @summary Get validation errors for a job
|
|
34224
|
+
* @param {string} jobid Job ID
|
|
34225
|
+
* @param {*} [options] Override http request option.
|
|
34226
|
+
* @throws {RequiredError}
|
|
34227
|
+
*/
|
|
34228
|
+
adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid, options) {
|
|
34229
|
+
return localVarFp.adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid, options).then((request) => request(axios, basePath));
|
|
34230
|
+
},
|
|
33200
34231
|
/**
|
|
33201
34232
|
* Deletes (soft delete) the current store creation progress
|
|
33202
34233
|
* @summary Delete store creation progress
|
|
@@ -33286,6 +34317,17 @@ export const StoreCreationApiFactory = function (configuration, basePath, axios)
|
|
|
33286
34317
|
* @extends {BaseAPI}
|
|
33287
34318
|
*/
|
|
33288
34319
|
export class StoreCreationApi extends BaseAPI {
|
|
34320
|
+
/**
|
|
34321
|
+
* Retrieves validation errors for a specific job ID if any invalid records were found during data upload
|
|
34322
|
+
* @summary Get validation errors for a job
|
|
34323
|
+
* @param {string} jobid Job ID
|
|
34324
|
+
* @param {*} [options] Override http request option.
|
|
34325
|
+
* @throws {RequiredError}
|
|
34326
|
+
* @memberof StoreCreationApi
|
|
34327
|
+
*/
|
|
34328
|
+
adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid, options) {
|
|
34329
|
+
return StoreCreationApiFp(this.configuration).adminV1StoreCreationJobstatusJobidValidationErrorsGet(jobid, options).then((request) => request(this.axios, this.basePath));
|
|
34330
|
+
}
|
|
33289
34331
|
/**
|
|
33290
34332
|
* Deletes (soft delete) the current store creation progress
|
|
33291
34333
|
* @summary Delete store creation progress
|