@seekora-ai/admin-api 1.1.84 → 1.1.86
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 +63 -2
- package/api.ts +5235 -1581
- package/dist/api.d.ts +2629 -4
- package/dist/api.js +1900 -14
- package/dist/esm/api.d.ts +2629 -4
- package/dist/esm/api.js +1874 -4
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.86.tgz +0 -0
- package/seekora-ai-admin-api-1.1.84.tgz +0 -0
package/dist/esm/api.js
CHANGED
|
@@ -104,6 +104,32 @@ export const DataTypesCreateTaskRequestTypeEnum = {
|
|
|
104
104
|
Manual: 'manual',
|
|
105
105
|
PluginConnector: 'plugin_connector'
|
|
106
106
|
};
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @export
|
|
110
|
+
* @enum {string}
|
|
111
|
+
*/
|
|
112
|
+
export const DataTypesExperimentStatus = {
|
|
113
|
+
ExperimentStatusDraft: 'draft',
|
|
114
|
+
ExperimentStatusScheduled: 'scheduled',
|
|
115
|
+
ExperimentStatusRunning: 'running',
|
|
116
|
+
ExperimentStatusPaused: 'paused',
|
|
117
|
+
ExperimentStatusCompleted: 'completed',
|
|
118
|
+
ExperimentStatusArchived: 'archived'
|
|
119
|
+
};
|
|
120
|
+
/**
|
|
121
|
+
*
|
|
122
|
+
* @export
|
|
123
|
+
* @enum {string}
|
|
124
|
+
*/
|
|
125
|
+
export const DataTypesExperimentType = {
|
|
126
|
+
ExperimentTypeSearchRanking: 'search_ranking',
|
|
127
|
+
ExperimentTypeRecommendation: 'recommendation',
|
|
128
|
+
ExperimentTypePersonalization: 'personalization',
|
|
129
|
+
ExperimentTypeUI: 'ui',
|
|
130
|
+
ExperimentTypePricing: 'pricing',
|
|
131
|
+
ExperimentTypeOther: 'other'
|
|
132
|
+
};
|
|
107
133
|
export const DataTypesGrantStoreAccessRequestAccessLevelEnum = {
|
|
108
134
|
Read: 'read',
|
|
109
135
|
Write: 'write',
|
|
@@ -20846,6 +20872,465 @@ export class CustomEventsApi extends BaseAPI {
|
|
|
20846
20872
|
return CustomEventsApiFp(this.configuration).adminAnalyticsStoreXStoreIDCustomEventsPost(xStoreID, authorization, modelsCreateCustomEventTypeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
20847
20873
|
}
|
|
20848
20874
|
}
|
|
20875
|
+
/**
|
|
20876
|
+
* CustomEventsAnalyticsApi - axios parameter creator
|
|
20877
|
+
* @export
|
|
20878
|
+
*/
|
|
20879
|
+
export const CustomEventsAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
20880
|
+
return {
|
|
20881
|
+
/**
|
|
20882
|
+
* Returns a breakdown of values for a specific field slot of a custom event
|
|
20883
|
+
* @summary Get Custom Event Field Breakdown
|
|
20884
|
+
* @param {string} xStoreID Store ID
|
|
20885
|
+
* @param {string} authorization Bearer JWT token
|
|
20886
|
+
* @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
|
|
20887
|
+
* @param {*} [options] Override http request option.
|
|
20888
|
+
* @throws {RequiredError}
|
|
20889
|
+
*/
|
|
20890
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost: (xStoreID_1, authorization_1, analyticsCustomEventFieldBreakdownRequestBody_1, ...args_1) => __awaiter(this, [xStoreID_1, authorization_1, analyticsCustomEventFieldBreakdownRequestBody_1, ...args_1], void 0, function* (xStoreID, authorization, analyticsCustomEventFieldBreakdownRequestBody, options = {}) {
|
|
20891
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
20892
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost', 'xStoreID', xStoreID);
|
|
20893
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
20894
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost', 'authorization', authorization);
|
|
20895
|
+
// verify required parameter 'analyticsCustomEventFieldBreakdownRequestBody' is not null or undefined
|
|
20896
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost', 'analyticsCustomEventFieldBreakdownRequestBody', analyticsCustomEventFieldBreakdownRequestBody);
|
|
20897
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/custom-events/analytics/field-breakdown`
|
|
20898
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
20899
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20900
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20901
|
+
let baseOptions;
|
|
20902
|
+
if (configuration) {
|
|
20903
|
+
baseOptions = configuration.baseOptions;
|
|
20904
|
+
}
|
|
20905
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
20906
|
+
const localVarHeaderParameter = {};
|
|
20907
|
+
const localVarQueryParameter = {};
|
|
20908
|
+
// authentication BearerAuth required
|
|
20909
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
20910
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
20911
|
+
if (authorization != null) {
|
|
20912
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
20913
|
+
}
|
|
20914
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20915
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20916
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
20917
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsCustomEventFieldBreakdownRequestBody, localVarRequestOptions, configuration);
|
|
20918
|
+
return {
|
|
20919
|
+
url: toPathString(localVarUrlObj),
|
|
20920
|
+
options: localVarRequestOptions,
|
|
20921
|
+
};
|
|
20922
|
+
}),
|
|
20923
|
+
/**
|
|
20924
|
+
* Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
|
|
20925
|
+
* @summary Get Custom Event Metrics
|
|
20926
|
+
* @param {string} xStoreID Store ID
|
|
20927
|
+
* @param {string} authorization Bearer JWT token
|
|
20928
|
+
* @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
|
|
20929
|
+
* @param {*} [options] Override http request option.
|
|
20930
|
+
* @throws {RequiredError}
|
|
20931
|
+
*/
|
|
20932
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost: (xStoreID_1, authorization_1, analyticsCustomEventMetricsRequestBody_1, ...args_1) => __awaiter(this, [xStoreID_1, authorization_1, analyticsCustomEventMetricsRequestBody_1, ...args_1], void 0, function* (xStoreID, authorization, analyticsCustomEventMetricsRequestBody, options = {}) {
|
|
20933
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
20934
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost', 'xStoreID', xStoreID);
|
|
20935
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
20936
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost', 'authorization', authorization);
|
|
20937
|
+
// verify required parameter 'analyticsCustomEventMetricsRequestBody' is not null or undefined
|
|
20938
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost', 'analyticsCustomEventMetricsRequestBody', analyticsCustomEventMetricsRequestBody);
|
|
20939
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/custom-events/analytics/metrics`
|
|
20940
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
20941
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20942
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20943
|
+
let baseOptions;
|
|
20944
|
+
if (configuration) {
|
|
20945
|
+
baseOptions = configuration.baseOptions;
|
|
20946
|
+
}
|
|
20947
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
20948
|
+
const localVarHeaderParameter = {};
|
|
20949
|
+
const localVarQueryParameter = {};
|
|
20950
|
+
// authentication BearerAuth required
|
|
20951
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
20952
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
20953
|
+
if (authorization != null) {
|
|
20954
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
20955
|
+
}
|
|
20956
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20957
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20958
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
20959
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsCustomEventMetricsRequestBody, localVarRequestOptions, configuration);
|
|
20960
|
+
return {
|
|
20961
|
+
url: toPathString(localVarUrlObj),
|
|
20962
|
+
options: localVarRequestOptions,
|
|
20963
|
+
};
|
|
20964
|
+
}),
|
|
20965
|
+
/**
|
|
20966
|
+
* Returns paginated raw custom events with field data
|
|
20967
|
+
* @summary Get Custom Event Stream
|
|
20968
|
+
* @param {string} xStoreID Store ID
|
|
20969
|
+
* @param {string} authorization Bearer JWT token
|
|
20970
|
+
* @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
|
|
20971
|
+
* @param {*} [options] Override http request option.
|
|
20972
|
+
* @throws {RequiredError}
|
|
20973
|
+
*/
|
|
20974
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost: (xStoreID_1, authorization_1, analyticsCustomEventStreamRequestBody_1, ...args_1) => __awaiter(this, [xStoreID_1, authorization_1, analyticsCustomEventStreamRequestBody_1, ...args_1], void 0, function* (xStoreID, authorization, analyticsCustomEventStreamRequestBody, options = {}) {
|
|
20975
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
20976
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost', 'xStoreID', xStoreID);
|
|
20977
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
20978
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost', 'authorization', authorization);
|
|
20979
|
+
// verify required parameter 'analyticsCustomEventStreamRequestBody' is not null or undefined
|
|
20980
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost', 'analyticsCustomEventStreamRequestBody', analyticsCustomEventStreamRequestBody);
|
|
20981
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/custom-events/analytics/stream`
|
|
20982
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
20983
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20984
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20985
|
+
let baseOptions;
|
|
20986
|
+
if (configuration) {
|
|
20987
|
+
baseOptions = configuration.baseOptions;
|
|
20988
|
+
}
|
|
20989
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
20990
|
+
const localVarHeaderParameter = {};
|
|
20991
|
+
const localVarQueryParameter = {};
|
|
20992
|
+
// authentication BearerAuth required
|
|
20993
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
20994
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
20995
|
+
if (authorization != null) {
|
|
20996
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
20997
|
+
}
|
|
20998
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20999
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21000
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
21001
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsCustomEventStreamRequestBody, localVarRequestOptions, configuration);
|
|
21002
|
+
return {
|
|
21003
|
+
url: toPathString(localVarUrlObj),
|
|
21004
|
+
options: localVarRequestOptions,
|
|
21005
|
+
};
|
|
21006
|
+
}),
|
|
21007
|
+
/**
|
|
21008
|
+
* Returns time series data for custom events grouped by event name and time bucket
|
|
21009
|
+
* @summary Get Custom Event Time Series
|
|
21010
|
+
* @param {string} xStoreID Store ID
|
|
21011
|
+
* @param {string} authorization Bearer JWT token
|
|
21012
|
+
* @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
|
|
21013
|
+
* @param {*} [options] Override http request option.
|
|
21014
|
+
* @throws {RequiredError}
|
|
21015
|
+
*/
|
|
21016
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost: (xStoreID_1, authorization_1, analyticsCustomEventTimeSeriesRequestBody_1, ...args_1) => __awaiter(this, [xStoreID_1, authorization_1, analyticsCustomEventTimeSeriesRequestBody_1, ...args_1], void 0, function* (xStoreID, authorization, analyticsCustomEventTimeSeriesRequestBody, options = {}) {
|
|
21017
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
21018
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost', 'xStoreID', xStoreID);
|
|
21019
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
21020
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost', 'authorization', authorization);
|
|
21021
|
+
// verify required parameter 'analyticsCustomEventTimeSeriesRequestBody' is not null or undefined
|
|
21022
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost', 'analyticsCustomEventTimeSeriesRequestBody', analyticsCustomEventTimeSeriesRequestBody);
|
|
21023
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/custom-events/analytics/time-series`
|
|
21024
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
21025
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21026
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21027
|
+
let baseOptions;
|
|
21028
|
+
if (configuration) {
|
|
21029
|
+
baseOptions = configuration.baseOptions;
|
|
21030
|
+
}
|
|
21031
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
21032
|
+
const localVarHeaderParameter = {};
|
|
21033
|
+
const localVarQueryParameter = {};
|
|
21034
|
+
// authentication BearerAuth required
|
|
21035
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
21036
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
21037
|
+
if (authorization != null) {
|
|
21038
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
21039
|
+
}
|
|
21040
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
21041
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21042
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
21043
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsCustomEventTimeSeriesRequestBody, localVarRequestOptions, configuration);
|
|
21044
|
+
return {
|
|
21045
|
+
url: toPathString(localVarUrlObj),
|
|
21046
|
+
options: localVarRequestOptions,
|
|
21047
|
+
};
|
|
21048
|
+
}),
|
|
21049
|
+
/**
|
|
21050
|
+
* Returns the top custom events by count or unique users
|
|
21051
|
+
* @summary Get Top Custom Events
|
|
21052
|
+
* @param {string} xStoreID Store ID
|
|
21053
|
+
* @param {string} authorization Bearer JWT token
|
|
21054
|
+
* @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
|
|
21055
|
+
* @param {*} [options] Override http request option.
|
|
21056
|
+
* @throws {RequiredError}
|
|
21057
|
+
*/
|
|
21058
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost: (xStoreID_1, authorization_1, analyticsTopCustomEventsRequestBody_1, ...args_1) => __awaiter(this, [xStoreID_1, authorization_1, analyticsTopCustomEventsRequestBody_1, ...args_1], void 0, function* (xStoreID, authorization, analyticsTopCustomEventsRequestBody, options = {}) {
|
|
21059
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
21060
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost', 'xStoreID', xStoreID);
|
|
21061
|
+
// verify required parameter 'authorization' is not null or undefined
|
|
21062
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost', 'authorization', authorization);
|
|
21063
|
+
// verify required parameter 'analyticsTopCustomEventsRequestBody' is not null or undefined
|
|
21064
|
+
assertParamExists('adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost', 'analyticsTopCustomEventsRequestBody', analyticsTopCustomEventsRequestBody);
|
|
21065
|
+
const localVarPath = `/admin/analytics/store/{xStoreID}/custom-events/analytics/top-events`
|
|
21066
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
21067
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
21068
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
21069
|
+
let baseOptions;
|
|
21070
|
+
if (configuration) {
|
|
21071
|
+
baseOptions = configuration.baseOptions;
|
|
21072
|
+
}
|
|
21073
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
21074
|
+
const localVarHeaderParameter = {};
|
|
21075
|
+
const localVarQueryParameter = {};
|
|
21076
|
+
// authentication BearerAuth required
|
|
21077
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
21078
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
21079
|
+
if (authorization != null) {
|
|
21080
|
+
localVarHeaderParameter['Authorization'] = String(authorization);
|
|
21081
|
+
}
|
|
21082
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
21083
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
21084
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
21085
|
+
localVarRequestOptions.data = serializeDataIfNeeded(analyticsTopCustomEventsRequestBody, localVarRequestOptions, configuration);
|
|
21086
|
+
return {
|
|
21087
|
+
url: toPathString(localVarUrlObj),
|
|
21088
|
+
options: localVarRequestOptions,
|
|
21089
|
+
};
|
|
21090
|
+
}),
|
|
21091
|
+
};
|
|
21092
|
+
};
|
|
21093
|
+
/**
|
|
21094
|
+
* CustomEventsAnalyticsApi - functional programming interface
|
|
21095
|
+
* @export
|
|
21096
|
+
*/
|
|
21097
|
+
export const CustomEventsAnalyticsApiFp = function (configuration) {
|
|
21098
|
+
const localVarAxiosParamCreator = CustomEventsAnalyticsApiAxiosParamCreator(configuration);
|
|
21099
|
+
return {
|
|
21100
|
+
/**
|
|
21101
|
+
* Returns a breakdown of values for a specific field slot of a custom event
|
|
21102
|
+
* @summary Get Custom Event Field Breakdown
|
|
21103
|
+
* @param {string} xStoreID Store ID
|
|
21104
|
+
* @param {string} authorization Bearer JWT token
|
|
21105
|
+
* @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
|
|
21106
|
+
* @param {*} [options] Override http request option.
|
|
21107
|
+
* @throws {RequiredError}
|
|
21108
|
+
*/
|
|
21109
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID, authorization, analyticsCustomEventFieldBreakdownRequestBody, options) {
|
|
21110
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
21111
|
+
var _a, _b, _c;
|
|
21112
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID, authorization, analyticsCustomEventFieldBreakdownRequestBody, options);
|
|
21113
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
21114
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomEventsAnalyticsApi.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
21115
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21116
|
+
});
|
|
21117
|
+
},
|
|
21118
|
+
/**
|
|
21119
|
+
* Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
|
|
21120
|
+
* @summary Get Custom Event Metrics
|
|
21121
|
+
* @param {string} xStoreID Store ID
|
|
21122
|
+
* @param {string} authorization Bearer JWT token
|
|
21123
|
+
* @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
|
|
21124
|
+
* @param {*} [options] Override http request option.
|
|
21125
|
+
* @throws {RequiredError}
|
|
21126
|
+
*/
|
|
21127
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID, authorization, analyticsCustomEventMetricsRequestBody, options) {
|
|
21128
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
21129
|
+
var _a, _b, _c;
|
|
21130
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID, authorization, analyticsCustomEventMetricsRequestBody, options);
|
|
21131
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
21132
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomEventsAnalyticsApi.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
21133
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21134
|
+
});
|
|
21135
|
+
},
|
|
21136
|
+
/**
|
|
21137
|
+
* Returns paginated raw custom events with field data
|
|
21138
|
+
* @summary Get Custom Event Stream
|
|
21139
|
+
* @param {string} xStoreID Store ID
|
|
21140
|
+
* @param {string} authorization Bearer JWT token
|
|
21141
|
+
* @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
|
|
21142
|
+
* @param {*} [options] Override http request option.
|
|
21143
|
+
* @throws {RequiredError}
|
|
21144
|
+
*/
|
|
21145
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID, authorization, analyticsCustomEventStreamRequestBody, options) {
|
|
21146
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
21147
|
+
var _a, _b, _c;
|
|
21148
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID, authorization, analyticsCustomEventStreamRequestBody, options);
|
|
21149
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
21150
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomEventsAnalyticsApi.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
21151
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21152
|
+
});
|
|
21153
|
+
},
|
|
21154
|
+
/**
|
|
21155
|
+
* Returns time series data for custom events grouped by event name and time bucket
|
|
21156
|
+
* @summary Get Custom Event Time Series
|
|
21157
|
+
* @param {string} xStoreID Store ID
|
|
21158
|
+
* @param {string} authorization Bearer JWT token
|
|
21159
|
+
* @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
|
|
21160
|
+
* @param {*} [options] Override http request option.
|
|
21161
|
+
* @throws {RequiredError}
|
|
21162
|
+
*/
|
|
21163
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID, authorization, analyticsCustomEventTimeSeriesRequestBody, options) {
|
|
21164
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
21165
|
+
var _a, _b, _c;
|
|
21166
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID, authorization, analyticsCustomEventTimeSeriesRequestBody, options);
|
|
21167
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
21168
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomEventsAnalyticsApi.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
21169
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21170
|
+
});
|
|
21171
|
+
},
|
|
21172
|
+
/**
|
|
21173
|
+
* Returns the top custom events by count or unique users
|
|
21174
|
+
* @summary Get Top Custom Events
|
|
21175
|
+
* @param {string} xStoreID Store ID
|
|
21176
|
+
* @param {string} authorization Bearer JWT token
|
|
21177
|
+
* @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
|
|
21178
|
+
* @param {*} [options] Override http request option.
|
|
21179
|
+
* @throws {RequiredError}
|
|
21180
|
+
*/
|
|
21181
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID, authorization, analyticsTopCustomEventsRequestBody, options) {
|
|
21182
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
21183
|
+
var _a, _b, _c;
|
|
21184
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID, authorization, analyticsTopCustomEventsRequestBody, options);
|
|
21185
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
21186
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomEventsAnalyticsApi.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
21187
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21188
|
+
});
|
|
21189
|
+
},
|
|
21190
|
+
};
|
|
21191
|
+
};
|
|
21192
|
+
/**
|
|
21193
|
+
* CustomEventsAnalyticsApi - factory interface
|
|
21194
|
+
* @export
|
|
21195
|
+
*/
|
|
21196
|
+
export const CustomEventsAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
21197
|
+
const localVarFp = CustomEventsAnalyticsApiFp(configuration);
|
|
21198
|
+
return {
|
|
21199
|
+
/**
|
|
21200
|
+
* Returns a breakdown of values for a specific field slot of a custom event
|
|
21201
|
+
* @summary Get Custom Event Field Breakdown
|
|
21202
|
+
* @param {string} xStoreID Store ID
|
|
21203
|
+
* @param {string} authorization Bearer JWT token
|
|
21204
|
+
* @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
|
|
21205
|
+
* @param {*} [options] Override http request option.
|
|
21206
|
+
* @throws {RequiredError}
|
|
21207
|
+
*/
|
|
21208
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID, authorization, analyticsCustomEventFieldBreakdownRequestBody, options) {
|
|
21209
|
+
return localVarFp.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID, authorization, analyticsCustomEventFieldBreakdownRequestBody, options).then((request) => request(axios, basePath));
|
|
21210
|
+
},
|
|
21211
|
+
/**
|
|
21212
|
+
* Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
|
|
21213
|
+
* @summary Get Custom Event Metrics
|
|
21214
|
+
* @param {string} xStoreID Store ID
|
|
21215
|
+
* @param {string} authorization Bearer JWT token
|
|
21216
|
+
* @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
|
|
21217
|
+
* @param {*} [options] Override http request option.
|
|
21218
|
+
* @throws {RequiredError}
|
|
21219
|
+
*/
|
|
21220
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID, authorization, analyticsCustomEventMetricsRequestBody, options) {
|
|
21221
|
+
return localVarFp.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID, authorization, analyticsCustomEventMetricsRequestBody, options).then((request) => request(axios, basePath));
|
|
21222
|
+
},
|
|
21223
|
+
/**
|
|
21224
|
+
* Returns paginated raw custom events with field data
|
|
21225
|
+
* @summary Get Custom Event Stream
|
|
21226
|
+
* @param {string} xStoreID Store ID
|
|
21227
|
+
* @param {string} authorization Bearer JWT token
|
|
21228
|
+
* @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
|
|
21229
|
+
* @param {*} [options] Override http request option.
|
|
21230
|
+
* @throws {RequiredError}
|
|
21231
|
+
*/
|
|
21232
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID, authorization, analyticsCustomEventStreamRequestBody, options) {
|
|
21233
|
+
return localVarFp.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID, authorization, analyticsCustomEventStreamRequestBody, options).then((request) => request(axios, basePath));
|
|
21234
|
+
},
|
|
21235
|
+
/**
|
|
21236
|
+
* Returns time series data for custom events grouped by event name and time bucket
|
|
21237
|
+
* @summary Get Custom Event Time Series
|
|
21238
|
+
* @param {string} xStoreID Store ID
|
|
21239
|
+
* @param {string} authorization Bearer JWT token
|
|
21240
|
+
* @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
|
|
21241
|
+
* @param {*} [options] Override http request option.
|
|
21242
|
+
* @throws {RequiredError}
|
|
21243
|
+
*/
|
|
21244
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID, authorization, analyticsCustomEventTimeSeriesRequestBody, options) {
|
|
21245
|
+
return localVarFp.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID, authorization, analyticsCustomEventTimeSeriesRequestBody, options).then((request) => request(axios, basePath));
|
|
21246
|
+
},
|
|
21247
|
+
/**
|
|
21248
|
+
* Returns the top custom events by count or unique users
|
|
21249
|
+
* @summary Get Top Custom Events
|
|
21250
|
+
* @param {string} xStoreID Store ID
|
|
21251
|
+
* @param {string} authorization Bearer JWT token
|
|
21252
|
+
* @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
|
|
21253
|
+
* @param {*} [options] Override http request option.
|
|
21254
|
+
* @throws {RequiredError}
|
|
21255
|
+
*/
|
|
21256
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID, authorization, analyticsTopCustomEventsRequestBody, options) {
|
|
21257
|
+
return localVarFp.adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID, authorization, analyticsTopCustomEventsRequestBody, options).then((request) => request(axios, basePath));
|
|
21258
|
+
},
|
|
21259
|
+
};
|
|
21260
|
+
};
|
|
21261
|
+
/**
|
|
21262
|
+
* CustomEventsAnalyticsApi - object-oriented interface
|
|
21263
|
+
* @export
|
|
21264
|
+
* @class CustomEventsAnalyticsApi
|
|
21265
|
+
* @extends {BaseAPI}
|
|
21266
|
+
*/
|
|
21267
|
+
export class CustomEventsAnalyticsApi extends BaseAPI {
|
|
21268
|
+
/**
|
|
21269
|
+
* Returns a breakdown of values for a specific field slot of a custom event
|
|
21270
|
+
* @summary Get Custom Event Field Breakdown
|
|
21271
|
+
* @param {string} xStoreID Store ID
|
|
21272
|
+
* @param {string} authorization Bearer JWT token
|
|
21273
|
+
* @param {AnalyticsCustomEventFieldBreakdownRequestBody} analyticsCustomEventFieldBreakdownRequestBody Field breakdown request
|
|
21274
|
+
* @param {*} [options] Override http request option.
|
|
21275
|
+
* @throws {RequiredError}
|
|
21276
|
+
* @memberof CustomEventsAnalyticsApi
|
|
21277
|
+
*/
|
|
21278
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID, authorization, analyticsCustomEventFieldBreakdownRequestBody, options) {
|
|
21279
|
+
return CustomEventsAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDCustomEventsAnalyticsFieldBreakdownPost(xStoreID, authorization, analyticsCustomEventFieldBreakdownRequestBody, options).then((request) => request(this.axios, this.basePath));
|
|
21280
|
+
}
|
|
21281
|
+
/**
|
|
21282
|
+
* Returns aggregated custom event metrics including total events, unique users, unique sessions, and unique event types
|
|
21283
|
+
* @summary Get Custom Event Metrics
|
|
21284
|
+
* @param {string} xStoreID Store ID
|
|
21285
|
+
* @param {string} authorization Bearer JWT token
|
|
21286
|
+
* @param {AnalyticsCustomEventMetricsRequestBody} analyticsCustomEventMetricsRequestBody Custom event metrics request
|
|
21287
|
+
* @param {*} [options] Override http request option.
|
|
21288
|
+
* @throws {RequiredError}
|
|
21289
|
+
* @memberof CustomEventsAnalyticsApi
|
|
21290
|
+
*/
|
|
21291
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID, authorization, analyticsCustomEventMetricsRequestBody, options) {
|
|
21292
|
+
return CustomEventsAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDCustomEventsAnalyticsMetricsPost(xStoreID, authorization, analyticsCustomEventMetricsRequestBody, options).then((request) => request(this.axios, this.basePath));
|
|
21293
|
+
}
|
|
21294
|
+
/**
|
|
21295
|
+
* Returns paginated raw custom events with field data
|
|
21296
|
+
* @summary Get Custom Event Stream
|
|
21297
|
+
* @param {string} xStoreID Store ID
|
|
21298
|
+
* @param {string} authorization Bearer JWT token
|
|
21299
|
+
* @param {AnalyticsCustomEventStreamRequestBody} analyticsCustomEventStreamRequestBody Event stream request
|
|
21300
|
+
* @param {*} [options] Override http request option.
|
|
21301
|
+
* @throws {RequiredError}
|
|
21302
|
+
* @memberof CustomEventsAnalyticsApi
|
|
21303
|
+
*/
|
|
21304
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID, authorization, analyticsCustomEventStreamRequestBody, options) {
|
|
21305
|
+
return CustomEventsAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDCustomEventsAnalyticsStreamPost(xStoreID, authorization, analyticsCustomEventStreamRequestBody, options).then((request) => request(this.axios, this.basePath));
|
|
21306
|
+
}
|
|
21307
|
+
/**
|
|
21308
|
+
* Returns time series data for custom events grouped by event name and time bucket
|
|
21309
|
+
* @summary Get Custom Event Time Series
|
|
21310
|
+
* @param {string} xStoreID Store ID
|
|
21311
|
+
* @param {string} authorization Bearer JWT token
|
|
21312
|
+
* @param {AnalyticsCustomEventTimeSeriesRequestBody} analyticsCustomEventTimeSeriesRequestBody Time series request
|
|
21313
|
+
* @param {*} [options] Override http request option.
|
|
21314
|
+
* @throws {RequiredError}
|
|
21315
|
+
* @memberof CustomEventsAnalyticsApi
|
|
21316
|
+
*/
|
|
21317
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID, authorization, analyticsCustomEventTimeSeriesRequestBody, options) {
|
|
21318
|
+
return CustomEventsAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTimeSeriesPost(xStoreID, authorization, analyticsCustomEventTimeSeriesRequestBody, options).then((request) => request(this.axios, this.basePath));
|
|
21319
|
+
}
|
|
21320
|
+
/**
|
|
21321
|
+
* Returns the top custom events by count or unique users
|
|
21322
|
+
* @summary Get Top Custom Events
|
|
21323
|
+
* @param {string} xStoreID Store ID
|
|
21324
|
+
* @param {string} authorization Bearer JWT token
|
|
21325
|
+
* @param {AnalyticsTopCustomEventsRequestBody} analyticsTopCustomEventsRequestBody Top events request
|
|
21326
|
+
* @param {*} [options] Override http request option.
|
|
21327
|
+
* @throws {RequiredError}
|
|
21328
|
+
* @memberof CustomEventsAnalyticsApi
|
|
21329
|
+
*/
|
|
21330
|
+
adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID, authorization, analyticsTopCustomEventsRequestBody, options) {
|
|
21331
|
+
return CustomEventsAnalyticsApiFp(this.configuration).adminAnalyticsStoreXStoreIDCustomEventsAnalyticsTopEventsPost(xStoreID, authorization, analyticsTopCustomEventsRequestBody, options).then((request) => request(this.axios, this.basePath));
|
|
21332
|
+
}
|
|
21333
|
+
}
|
|
20849
21334
|
/**
|
|
20850
21335
|
* CustomStopwordsApi - axios parameter creator
|
|
20851
21336
|
* @export
|
|
@@ -23332,6 +23817,660 @@ export class DocumentsApi extends BaseAPI {
|
|
|
23332
23817
|
return DocumentsApiFp(this.configuration).adminStoresXStoreIDUploadPost(xStoreID, file, options).then((request) => request(this.axios, this.basePath));
|
|
23333
23818
|
}
|
|
23334
23819
|
}
|
|
23820
|
+
/**
|
|
23821
|
+
* ExperimentsApi - axios parameter creator
|
|
23822
|
+
* @export
|
|
23823
|
+
*/
|
|
23824
|
+
export const ExperimentsApiAxiosParamCreator = function (configuration) {
|
|
23825
|
+
return {
|
|
23826
|
+
/**
|
|
23827
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
23828
|
+
* @summary List all experiments
|
|
23829
|
+
* @param {*} [options] Override http request option.
|
|
23830
|
+
* @throws {RequiredError}
|
|
23831
|
+
*/
|
|
23832
|
+
v1AdminExperimentsGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
23833
|
+
const localVarPath = `/v1/admin/experiments/`;
|
|
23834
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23835
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23836
|
+
let baseOptions;
|
|
23837
|
+
if (configuration) {
|
|
23838
|
+
baseOptions = configuration.baseOptions;
|
|
23839
|
+
}
|
|
23840
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
23841
|
+
const localVarHeaderParameter = {};
|
|
23842
|
+
const localVarQueryParameter = {};
|
|
23843
|
+
// authentication BearerAuth required
|
|
23844
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23845
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23846
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23847
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23848
|
+
return {
|
|
23849
|
+
url: toPathString(localVarUrlObj),
|
|
23850
|
+
options: localVarRequestOptions,
|
|
23851
|
+
};
|
|
23852
|
+
}),
|
|
23853
|
+
/**
|
|
23854
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
23855
|
+
* @summary Complete an experiment
|
|
23856
|
+
* @param {string} id Experiment ID (slug)
|
|
23857
|
+
* @param {object} [body] Optional winner variant ID
|
|
23858
|
+
* @param {*} [options] Override http request option.
|
|
23859
|
+
* @throws {RequiredError}
|
|
23860
|
+
*/
|
|
23861
|
+
v1AdminExperimentsIdCompletePost: (id_1, body_1, ...args_1) => __awaiter(this, [id_1, body_1, ...args_1], void 0, function* (id, body, options = {}) {
|
|
23862
|
+
// verify required parameter 'id' is not null or undefined
|
|
23863
|
+
assertParamExists('v1AdminExperimentsIdCompletePost', 'id', id);
|
|
23864
|
+
const localVarPath = `/v1/admin/experiments/{id}/complete`
|
|
23865
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23866
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23867
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23868
|
+
let baseOptions;
|
|
23869
|
+
if (configuration) {
|
|
23870
|
+
baseOptions = configuration.baseOptions;
|
|
23871
|
+
}
|
|
23872
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23873
|
+
const localVarHeaderParameter = {};
|
|
23874
|
+
const localVarQueryParameter = {};
|
|
23875
|
+
// authentication BearerAuth required
|
|
23876
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23877
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
23878
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23879
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23880
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23881
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
23882
|
+
return {
|
|
23883
|
+
url: toPathString(localVarUrlObj),
|
|
23884
|
+
options: localVarRequestOptions,
|
|
23885
|
+
};
|
|
23886
|
+
}),
|
|
23887
|
+
/**
|
|
23888
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
23889
|
+
* @summary Delete a draft experiment
|
|
23890
|
+
* @param {string} id Experiment ID (slug)
|
|
23891
|
+
* @param {*} [options] Override http request option.
|
|
23892
|
+
* @throws {RequiredError}
|
|
23893
|
+
*/
|
|
23894
|
+
v1AdminExperimentsIdDelete: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
23895
|
+
// verify required parameter 'id' is not null or undefined
|
|
23896
|
+
assertParamExists('v1AdminExperimentsIdDelete', 'id', id);
|
|
23897
|
+
const localVarPath = `/v1/admin/experiments/{id}`
|
|
23898
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23899
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23900
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23901
|
+
let baseOptions;
|
|
23902
|
+
if (configuration) {
|
|
23903
|
+
baseOptions = configuration.baseOptions;
|
|
23904
|
+
}
|
|
23905
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
23906
|
+
const localVarHeaderParameter = {};
|
|
23907
|
+
const localVarQueryParameter = {};
|
|
23908
|
+
// authentication BearerAuth required
|
|
23909
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23910
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23911
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23912
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23913
|
+
return {
|
|
23914
|
+
url: toPathString(localVarUrlObj),
|
|
23915
|
+
options: localVarRequestOptions,
|
|
23916
|
+
};
|
|
23917
|
+
}),
|
|
23918
|
+
/**
|
|
23919
|
+
* Returns a single experiment by its experiment_id slug.
|
|
23920
|
+
* @summary Get experiment by ID
|
|
23921
|
+
* @param {string} id Experiment ID (slug)
|
|
23922
|
+
* @param {*} [options] Override http request option.
|
|
23923
|
+
* @throws {RequiredError}
|
|
23924
|
+
*/
|
|
23925
|
+
v1AdminExperimentsIdGet: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
23926
|
+
// verify required parameter 'id' is not null or undefined
|
|
23927
|
+
assertParamExists('v1AdminExperimentsIdGet', 'id', id);
|
|
23928
|
+
const localVarPath = `/v1/admin/experiments/{id}`
|
|
23929
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23930
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23931
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23932
|
+
let baseOptions;
|
|
23933
|
+
if (configuration) {
|
|
23934
|
+
baseOptions = configuration.baseOptions;
|
|
23935
|
+
}
|
|
23936
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
23937
|
+
const localVarHeaderParameter = {};
|
|
23938
|
+
const localVarQueryParameter = {};
|
|
23939
|
+
// authentication BearerAuth required
|
|
23940
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23941
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23942
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23943
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23944
|
+
return {
|
|
23945
|
+
url: toPathString(localVarUrlObj),
|
|
23946
|
+
options: localVarRequestOptions,
|
|
23947
|
+
};
|
|
23948
|
+
}),
|
|
23949
|
+
/**
|
|
23950
|
+
* Transitions a running experiment to paused status.
|
|
23951
|
+
* @summary Pause an experiment
|
|
23952
|
+
* @param {string} id Experiment ID (slug)
|
|
23953
|
+
* @param {*} [options] Override http request option.
|
|
23954
|
+
* @throws {RequiredError}
|
|
23955
|
+
*/
|
|
23956
|
+
v1AdminExperimentsIdPausePost: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
23957
|
+
// verify required parameter 'id' is not null or undefined
|
|
23958
|
+
assertParamExists('v1AdminExperimentsIdPausePost', 'id', id);
|
|
23959
|
+
const localVarPath = `/v1/admin/experiments/{id}/pause`
|
|
23960
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23961
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23962
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23963
|
+
let baseOptions;
|
|
23964
|
+
if (configuration) {
|
|
23965
|
+
baseOptions = configuration.baseOptions;
|
|
23966
|
+
}
|
|
23967
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23968
|
+
const localVarHeaderParameter = {};
|
|
23969
|
+
const localVarQueryParameter = {};
|
|
23970
|
+
// authentication BearerAuth required
|
|
23971
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23972
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23973
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23974
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23975
|
+
return {
|
|
23976
|
+
url: toPathString(localVarUrlObj),
|
|
23977
|
+
options: localVarRequestOptions,
|
|
23978
|
+
};
|
|
23979
|
+
}),
|
|
23980
|
+
/**
|
|
23981
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
23982
|
+
* @summary Update an experiment
|
|
23983
|
+
* @param {string} id Experiment ID (slug)
|
|
23984
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
23985
|
+
* @param {*} [options] Override http request option.
|
|
23986
|
+
* @throws {RequiredError}
|
|
23987
|
+
*/
|
|
23988
|
+
v1AdminExperimentsIdPut: (id_1, dataTypesUpdateExperimentRequest_1, ...args_1) => __awaiter(this, [id_1, dataTypesUpdateExperimentRequest_1, ...args_1], void 0, function* (id, dataTypesUpdateExperimentRequest, options = {}) {
|
|
23989
|
+
// verify required parameter 'id' is not null or undefined
|
|
23990
|
+
assertParamExists('v1AdminExperimentsIdPut', 'id', id);
|
|
23991
|
+
// verify required parameter 'dataTypesUpdateExperimentRequest' is not null or undefined
|
|
23992
|
+
assertParamExists('v1AdminExperimentsIdPut', 'dataTypesUpdateExperimentRequest', dataTypesUpdateExperimentRequest);
|
|
23993
|
+
const localVarPath = `/v1/admin/experiments/{id}`
|
|
23994
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23995
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23996
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23997
|
+
let baseOptions;
|
|
23998
|
+
if (configuration) {
|
|
23999
|
+
baseOptions = configuration.baseOptions;
|
|
24000
|
+
}
|
|
24001
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
24002
|
+
const localVarHeaderParameter = {};
|
|
24003
|
+
const localVarQueryParameter = {};
|
|
24004
|
+
// authentication BearerAuth required
|
|
24005
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
24006
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24007
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24008
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24009
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24010
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesUpdateExperimentRequest, localVarRequestOptions, configuration);
|
|
24011
|
+
return {
|
|
24012
|
+
url: toPathString(localVarUrlObj),
|
|
24013
|
+
options: localVarRequestOptions,
|
|
24014
|
+
};
|
|
24015
|
+
}),
|
|
24016
|
+
/**
|
|
24017
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
24018
|
+
* @summary Get experiment results
|
|
24019
|
+
* @param {string} id Experiment ID (slug)
|
|
24020
|
+
* @param {*} [options] Override http request option.
|
|
24021
|
+
* @throws {RequiredError}
|
|
24022
|
+
*/
|
|
24023
|
+
v1AdminExperimentsIdResultsGet: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
24024
|
+
// verify required parameter 'id' is not null or undefined
|
|
24025
|
+
assertParamExists('v1AdminExperimentsIdResultsGet', 'id', id);
|
|
24026
|
+
const localVarPath = `/v1/admin/experiments/{id}/results`
|
|
24027
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
24028
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24029
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24030
|
+
let baseOptions;
|
|
24031
|
+
if (configuration) {
|
|
24032
|
+
baseOptions = configuration.baseOptions;
|
|
24033
|
+
}
|
|
24034
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
24035
|
+
const localVarHeaderParameter = {};
|
|
24036
|
+
const localVarQueryParameter = {};
|
|
24037
|
+
// authentication BearerAuth required
|
|
24038
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
24039
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24040
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24041
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24042
|
+
return {
|
|
24043
|
+
url: toPathString(localVarUrlObj),
|
|
24044
|
+
options: localVarRequestOptions,
|
|
24045
|
+
};
|
|
24046
|
+
}),
|
|
24047
|
+
/**
|
|
24048
|
+
* Transitions a draft or paused experiment to running status.
|
|
24049
|
+
* @summary Start an experiment
|
|
24050
|
+
* @param {string} id Experiment ID (slug)
|
|
24051
|
+
* @param {*} [options] Override http request option.
|
|
24052
|
+
* @throws {RequiredError}
|
|
24053
|
+
*/
|
|
24054
|
+
v1AdminExperimentsIdStartPost: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
24055
|
+
// verify required parameter 'id' is not null or undefined
|
|
24056
|
+
assertParamExists('v1AdminExperimentsIdStartPost', 'id', id);
|
|
24057
|
+
const localVarPath = `/v1/admin/experiments/{id}/start`
|
|
24058
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
24059
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24060
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24061
|
+
let baseOptions;
|
|
24062
|
+
if (configuration) {
|
|
24063
|
+
baseOptions = configuration.baseOptions;
|
|
24064
|
+
}
|
|
24065
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
24066
|
+
const localVarHeaderParameter = {};
|
|
24067
|
+
const localVarQueryParameter = {};
|
|
24068
|
+
// authentication BearerAuth required
|
|
24069
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
24070
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24071
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24072
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24073
|
+
return {
|
|
24074
|
+
url: toPathString(localVarUrlObj),
|
|
24075
|
+
options: localVarRequestOptions,
|
|
24076
|
+
};
|
|
24077
|
+
}),
|
|
24078
|
+
/**
|
|
24079
|
+
* Creates a new A/B test experiment in draft status.
|
|
24080
|
+
* @summary Create a new experiment
|
|
24081
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
24082
|
+
* @param {*} [options] Override http request option.
|
|
24083
|
+
* @throws {RequiredError}
|
|
24084
|
+
*/
|
|
24085
|
+
v1AdminExperimentsPost: (dataTypesCreateExperimentRequest_1, ...args_1) => __awaiter(this, [dataTypesCreateExperimentRequest_1, ...args_1], void 0, function* (dataTypesCreateExperimentRequest, options = {}) {
|
|
24086
|
+
// verify required parameter 'dataTypesCreateExperimentRequest' is not null or undefined
|
|
24087
|
+
assertParamExists('v1AdminExperimentsPost', 'dataTypesCreateExperimentRequest', dataTypesCreateExperimentRequest);
|
|
24088
|
+
const localVarPath = `/v1/admin/experiments/`;
|
|
24089
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
24090
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
24091
|
+
let baseOptions;
|
|
24092
|
+
if (configuration) {
|
|
24093
|
+
baseOptions = configuration.baseOptions;
|
|
24094
|
+
}
|
|
24095
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
24096
|
+
const localVarHeaderParameter = {};
|
|
24097
|
+
const localVarQueryParameter = {};
|
|
24098
|
+
// authentication BearerAuth required
|
|
24099
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
24100
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
24101
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
24102
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
24103
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
24104
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesCreateExperimentRequest, localVarRequestOptions, configuration);
|
|
24105
|
+
return {
|
|
24106
|
+
url: toPathString(localVarUrlObj),
|
|
24107
|
+
options: localVarRequestOptions,
|
|
24108
|
+
};
|
|
24109
|
+
}),
|
|
24110
|
+
};
|
|
24111
|
+
};
|
|
24112
|
+
/**
|
|
24113
|
+
* ExperimentsApi - functional programming interface
|
|
24114
|
+
* @export
|
|
24115
|
+
*/
|
|
24116
|
+
export const ExperimentsApiFp = function (configuration) {
|
|
24117
|
+
const localVarAxiosParamCreator = ExperimentsApiAxiosParamCreator(configuration);
|
|
24118
|
+
return {
|
|
24119
|
+
/**
|
|
24120
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
24121
|
+
* @summary List all experiments
|
|
24122
|
+
* @param {*} [options] Override http request option.
|
|
24123
|
+
* @throws {RequiredError}
|
|
24124
|
+
*/
|
|
24125
|
+
v1AdminExperimentsGet(options) {
|
|
24126
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24127
|
+
var _a, _b, _c;
|
|
24128
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsGet(options);
|
|
24129
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24130
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24131
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24132
|
+
});
|
|
24133
|
+
},
|
|
24134
|
+
/**
|
|
24135
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
24136
|
+
* @summary Complete an experiment
|
|
24137
|
+
* @param {string} id Experiment ID (slug)
|
|
24138
|
+
* @param {object} [body] Optional winner variant ID
|
|
24139
|
+
* @param {*} [options] Override http request option.
|
|
24140
|
+
* @throws {RequiredError}
|
|
24141
|
+
*/
|
|
24142
|
+
v1AdminExperimentsIdCompletePost(id, body, options) {
|
|
24143
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24144
|
+
var _a, _b, _c;
|
|
24145
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdCompletePost(id, body, options);
|
|
24146
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24147
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdCompletePost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24148
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24149
|
+
});
|
|
24150
|
+
},
|
|
24151
|
+
/**
|
|
24152
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
24153
|
+
* @summary Delete a draft experiment
|
|
24154
|
+
* @param {string} id Experiment ID (slug)
|
|
24155
|
+
* @param {*} [options] Override http request option.
|
|
24156
|
+
* @throws {RequiredError}
|
|
24157
|
+
*/
|
|
24158
|
+
v1AdminExperimentsIdDelete(id, options) {
|
|
24159
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24160
|
+
var _a, _b, _c;
|
|
24161
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdDelete(id, options);
|
|
24162
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24163
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdDelete']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24164
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24165
|
+
});
|
|
24166
|
+
},
|
|
24167
|
+
/**
|
|
24168
|
+
* Returns a single experiment by its experiment_id slug.
|
|
24169
|
+
* @summary Get experiment by ID
|
|
24170
|
+
* @param {string} id Experiment ID (slug)
|
|
24171
|
+
* @param {*} [options] Override http request option.
|
|
24172
|
+
* @throws {RequiredError}
|
|
24173
|
+
*/
|
|
24174
|
+
v1AdminExperimentsIdGet(id, options) {
|
|
24175
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24176
|
+
var _a, _b, _c;
|
|
24177
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdGet(id, options);
|
|
24178
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24179
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24180
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24181
|
+
});
|
|
24182
|
+
},
|
|
24183
|
+
/**
|
|
24184
|
+
* Transitions a running experiment to paused status.
|
|
24185
|
+
* @summary Pause an experiment
|
|
24186
|
+
* @param {string} id Experiment ID (slug)
|
|
24187
|
+
* @param {*} [options] Override http request option.
|
|
24188
|
+
* @throws {RequiredError}
|
|
24189
|
+
*/
|
|
24190
|
+
v1AdminExperimentsIdPausePost(id, options) {
|
|
24191
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24192
|
+
var _a, _b, _c;
|
|
24193
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdPausePost(id, options);
|
|
24194
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24195
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdPausePost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24196
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24197
|
+
});
|
|
24198
|
+
},
|
|
24199
|
+
/**
|
|
24200
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
24201
|
+
* @summary Update an experiment
|
|
24202
|
+
* @param {string} id Experiment ID (slug)
|
|
24203
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
24204
|
+
* @param {*} [options] Override http request option.
|
|
24205
|
+
* @throws {RequiredError}
|
|
24206
|
+
*/
|
|
24207
|
+
v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options) {
|
|
24208
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24209
|
+
var _a, _b, _c;
|
|
24210
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options);
|
|
24211
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24212
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdPut']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24213
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24214
|
+
});
|
|
24215
|
+
},
|
|
24216
|
+
/**
|
|
24217
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
24218
|
+
* @summary Get experiment results
|
|
24219
|
+
* @param {string} id Experiment ID (slug)
|
|
24220
|
+
* @param {*} [options] Override http request option.
|
|
24221
|
+
* @throws {RequiredError}
|
|
24222
|
+
*/
|
|
24223
|
+
v1AdminExperimentsIdResultsGet(id, options) {
|
|
24224
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24225
|
+
var _a, _b, _c;
|
|
24226
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdResultsGet(id, options);
|
|
24227
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24228
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24229
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24230
|
+
});
|
|
24231
|
+
},
|
|
24232
|
+
/**
|
|
24233
|
+
* Transitions a draft or paused experiment to running status.
|
|
24234
|
+
* @summary Start an experiment
|
|
24235
|
+
* @param {string} id Experiment ID (slug)
|
|
24236
|
+
* @param {*} [options] Override http request option.
|
|
24237
|
+
* @throws {RequiredError}
|
|
24238
|
+
*/
|
|
24239
|
+
v1AdminExperimentsIdStartPost(id, options) {
|
|
24240
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24241
|
+
var _a, _b, _c;
|
|
24242
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdStartPost(id, options);
|
|
24243
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24244
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdStartPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24245
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24246
|
+
});
|
|
24247
|
+
},
|
|
24248
|
+
/**
|
|
24249
|
+
* Creates a new A/B test experiment in draft status.
|
|
24250
|
+
* @summary Create a new experiment
|
|
24251
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
24252
|
+
* @param {*} [options] Override http request option.
|
|
24253
|
+
* @throws {RequiredError}
|
|
24254
|
+
*/
|
|
24255
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options) {
|
|
24256
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24257
|
+
var _a, _b, _c;
|
|
24258
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options);
|
|
24259
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
24260
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
24261
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
24262
|
+
});
|
|
24263
|
+
},
|
|
24264
|
+
};
|
|
24265
|
+
};
|
|
24266
|
+
/**
|
|
24267
|
+
* ExperimentsApi - factory interface
|
|
24268
|
+
* @export
|
|
24269
|
+
*/
|
|
24270
|
+
export const ExperimentsApiFactory = function (configuration, basePath, axios) {
|
|
24271
|
+
const localVarFp = ExperimentsApiFp(configuration);
|
|
24272
|
+
return {
|
|
24273
|
+
/**
|
|
24274
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
24275
|
+
* @summary List all experiments
|
|
24276
|
+
* @param {*} [options] Override http request option.
|
|
24277
|
+
* @throws {RequiredError}
|
|
24278
|
+
*/
|
|
24279
|
+
v1AdminExperimentsGet(options) {
|
|
24280
|
+
return localVarFp.v1AdminExperimentsGet(options).then((request) => request(axios, basePath));
|
|
24281
|
+
},
|
|
24282
|
+
/**
|
|
24283
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
24284
|
+
* @summary Complete an experiment
|
|
24285
|
+
* @param {string} id Experiment ID (slug)
|
|
24286
|
+
* @param {object} [body] Optional winner variant ID
|
|
24287
|
+
* @param {*} [options] Override http request option.
|
|
24288
|
+
* @throws {RequiredError}
|
|
24289
|
+
*/
|
|
24290
|
+
v1AdminExperimentsIdCompletePost(id, body, options) {
|
|
24291
|
+
return localVarFp.v1AdminExperimentsIdCompletePost(id, body, options).then((request) => request(axios, basePath));
|
|
24292
|
+
},
|
|
24293
|
+
/**
|
|
24294
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
24295
|
+
* @summary Delete a draft experiment
|
|
24296
|
+
* @param {string} id Experiment ID (slug)
|
|
24297
|
+
* @param {*} [options] Override http request option.
|
|
24298
|
+
* @throws {RequiredError}
|
|
24299
|
+
*/
|
|
24300
|
+
v1AdminExperimentsIdDelete(id, options) {
|
|
24301
|
+
return localVarFp.v1AdminExperimentsIdDelete(id, options).then((request) => request(axios, basePath));
|
|
24302
|
+
},
|
|
24303
|
+
/**
|
|
24304
|
+
* Returns a single experiment by its experiment_id slug.
|
|
24305
|
+
* @summary Get experiment by ID
|
|
24306
|
+
* @param {string} id Experiment ID (slug)
|
|
24307
|
+
* @param {*} [options] Override http request option.
|
|
24308
|
+
* @throws {RequiredError}
|
|
24309
|
+
*/
|
|
24310
|
+
v1AdminExperimentsIdGet(id, options) {
|
|
24311
|
+
return localVarFp.v1AdminExperimentsIdGet(id, options).then((request) => request(axios, basePath));
|
|
24312
|
+
},
|
|
24313
|
+
/**
|
|
24314
|
+
* Transitions a running experiment to paused status.
|
|
24315
|
+
* @summary Pause an experiment
|
|
24316
|
+
* @param {string} id Experiment ID (slug)
|
|
24317
|
+
* @param {*} [options] Override http request option.
|
|
24318
|
+
* @throws {RequiredError}
|
|
24319
|
+
*/
|
|
24320
|
+
v1AdminExperimentsIdPausePost(id, options) {
|
|
24321
|
+
return localVarFp.v1AdminExperimentsIdPausePost(id, options).then((request) => request(axios, basePath));
|
|
24322
|
+
},
|
|
24323
|
+
/**
|
|
24324
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
24325
|
+
* @summary Update an experiment
|
|
24326
|
+
* @param {string} id Experiment ID (slug)
|
|
24327
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
24328
|
+
* @param {*} [options] Override http request option.
|
|
24329
|
+
* @throws {RequiredError}
|
|
24330
|
+
*/
|
|
24331
|
+
v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options) {
|
|
24332
|
+
return localVarFp.v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options).then((request) => request(axios, basePath));
|
|
24333
|
+
},
|
|
24334
|
+
/**
|
|
24335
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
24336
|
+
* @summary Get experiment results
|
|
24337
|
+
* @param {string} id Experiment ID (slug)
|
|
24338
|
+
* @param {*} [options] Override http request option.
|
|
24339
|
+
* @throws {RequiredError}
|
|
24340
|
+
*/
|
|
24341
|
+
v1AdminExperimentsIdResultsGet(id, options) {
|
|
24342
|
+
return localVarFp.v1AdminExperimentsIdResultsGet(id, options).then((request) => request(axios, basePath));
|
|
24343
|
+
},
|
|
24344
|
+
/**
|
|
24345
|
+
* Transitions a draft or paused experiment to running status.
|
|
24346
|
+
* @summary Start an experiment
|
|
24347
|
+
* @param {string} id Experiment ID (slug)
|
|
24348
|
+
* @param {*} [options] Override http request option.
|
|
24349
|
+
* @throws {RequiredError}
|
|
24350
|
+
*/
|
|
24351
|
+
v1AdminExperimentsIdStartPost(id, options) {
|
|
24352
|
+
return localVarFp.v1AdminExperimentsIdStartPost(id, options).then((request) => request(axios, basePath));
|
|
24353
|
+
},
|
|
24354
|
+
/**
|
|
24355
|
+
* Creates a new A/B test experiment in draft status.
|
|
24356
|
+
* @summary Create a new experiment
|
|
24357
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
24358
|
+
* @param {*} [options] Override http request option.
|
|
24359
|
+
* @throws {RequiredError}
|
|
24360
|
+
*/
|
|
24361
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options) {
|
|
24362
|
+
return localVarFp.v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options).then((request) => request(axios, basePath));
|
|
24363
|
+
},
|
|
24364
|
+
};
|
|
24365
|
+
};
|
|
24366
|
+
/**
|
|
24367
|
+
* ExperimentsApi - object-oriented interface
|
|
24368
|
+
* @export
|
|
24369
|
+
* @class ExperimentsApi
|
|
24370
|
+
* @extends {BaseAPI}
|
|
24371
|
+
*/
|
|
24372
|
+
export class ExperimentsApi extends BaseAPI {
|
|
24373
|
+
/**
|
|
24374
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
24375
|
+
* @summary List all experiments
|
|
24376
|
+
* @param {*} [options] Override http request option.
|
|
24377
|
+
* @throws {RequiredError}
|
|
24378
|
+
* @memberof ExperimentsApi
|
|
24379
|
+
*/
|
|
24380
|
+
v1AdminExperimentsGet(options) {
|
|
24381
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsGet(options).then((request) => request(this.axios, this.basePath));
|
|
24382
|
+
}
|
|
24383
|
+
/**
|
|
24384
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
24385
|
+
* @summary Complete an experiment
|
|
24386
|
+
* @param {string} id Experiment ID (slug)
|
|
24387
|
+
* @param {object} [body] Optional winner variant ID
|
|
24388
|
+
* @param {*} [options] Override http request option.
|
|
24389
|
+
* @throws {RequiredError}
|
|
24390
|
+
* @memberof ExperimentsApi
|
|
24391
|
+
*/
|
|
24392
|
+
v1AdminExperimentsIdCompletePost(id, body, options) {
|
|
24393
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdCompletePost(id, body, options).then((request) => request(this.axios, this.basePath));
|
|
24394
|
+
}
|
|
24395
|
+
/**
|
|
24396
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
24397
|
+
* @summary Delete a draft experiment
|
|
24398
|
+
* @param {string} id Experiment ID (slug)
|
|
24399
|
+
* @param {*} [options] Override http request option.
|
|
24400
|
+
* @throws {RequiredError}
|
|
24401
|
+
* @memberof ExperimentsApi
|
|
24402
|
+
*/
|
|
24403
|
+
v1AdminExperimentsIdDelete(id, options) {
|
|
24404
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdDelete(id, options).then((request) => request(this.axios, this.basePath));
|
|
24405
|
+
}
|
|
24406
|
+
/**
|
|
24407
|
+
* Returns a single experiment by its experiment_id slug.
|
|
24408
|
+
* @summary Get experiment by ID
|
|
24409
|
+
* @param {string} id Experiment ID (slug)
|
|
24410
|
+
* @param {*} [options] Override http request option.
|
|
24411
|
+
* @throws {RequiredError}
|
|
24412
|
+
* @memberof ExperimentsApi
|
|
24413
|
+
*/
|
|
24414
|
+
v1AdminExperimentsIdGet(id, options) {
|
|
24415
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdGet(id, options).then((request) => request(this.axios, this.basePath));
|
|
24416
|
+
}
|
|
24417
|
+
/**
|
|
24418
|
+
* Transitions a running experiment to paused status.
|
|
24419
|
+
* @summary Pause an experiment
|
|
24420
|
+
* @param {string} id Experiment ID (slug)
|
|
24421
|
+
* @param {*} [options] Override http request option.
|
|
24422
|
+
* @throws {RequiredError}
|
|
24423
|
+
* @memberof ExperimentsApi
|
|
24424
|
+
*/
|
|
24425
|
+
v1AdminExperimentsIdPausePost(id, options) {
|
|
24426
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdPausePost(id, options).then((request) => request(this.axios, this.basePath));
|
|
24427
|
+
}
|
|
24428
|
+
/**
|
|
24429
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
24430
|
+
* @summary Update an experiment
|
|
24431
|
+
* @param {string} id Experiment ID (slug)
|
|
24432
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
24433
|
+
* @param {*} [options] Override http request option.
|
|
24434
|
+
* @throws {RequiredError}
|
|
24435
|
+
* @memberof ExperimentsApi
|
|
24436
|
+
*/
|
|
24437
|
+
v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options) {
|
|
24438
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
24439
|
+
}
|
|
24440
|
+
/**
|
|
24441
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
24442
|
+
* @summary Get experiment results
|
|
24443
|
+
* @param {string} id Experiment ID (slug)
|
|
24444
|
+
* @param {*} [options] Override http request option.
|
|
24445
|
+
* @throws {RequiredError}
|
|
24446
|
+
* @memberof ExperimentsApi
|
|
24447
|
+
*/
|
|
24448
|
+
v1AdminExperimentsIdResultsGet(id, options) {
|
|
24449
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdResultsGet(id, options).then((request) => request(this.axios, this.basePath));
|
|
24450
|
+
}
|
|
24451
|
+
/**
|
|
24452
|
+
* Transitions a draft or paused experiment to running status.
|
|
24453
|
+
* @summary Start an experiment
|
|
24454
|
+
* @param {string} id Experiment ID (slug)
|
|
24455
|
+
* @param {*} [options] Override http request option.
|
|
24456
|
+
* @throws {RequiredError}
|
|
24457
|
+
* @memberof ExperimentsApi
|
|
24458
|
+
*/
|
|
24459
|
+
v1AdminExperimentsIdStartPost(id, options) {
|
|
24460
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdStartPost(id, options).then((request) => request(this.axios, this.basePath));
|
|
24461
|
+
}
|
|
24462
|
+
/**
|
|
24463
|
+
* Creates a new A/B test experiment in draft status.
|
|
24464
|
+
* @summary Create a new experiment
|
|
24465
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
24466
|
+
* @param {*} [options] Override http request option.
|
|
24467
|
+
* @throws {RequiredError}
|
|
24468
|
+
* @memberof ExperimentsApi
|
|
24469
|
+
*/
|
|
24470
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options) {
|
|
24471
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
24472
|
+
}
|
|
24473
|
+
}
|
|
23335
24474
|
/**
|
|
23336
24475
|
* ExternalAPINotificationsApi - axios parameter creator
|
|
23337
24476
|
* @export
|
|
@@ -24303,6 +25442,517 @@ export class FeatureLimitsAdminApi extends BaseAPI {
|
|
|
24303
25442
|
return FeatureLimitsAdminApiFp(this.configuration).adminV1FeatureLimitsResetPost(featureName, options).then((request) => request(this.axios, this.basePath));
|
|
24304
25443
|
}
|
|
24305
25444
|
}
|
|
25445
|
+
/**
|
|
25446
|
+
* FiltersApi - axios parameter creator
|
|
25447
|
+
* @export
|
|
25448
|
+
*/
|
|
25449
|
+
export const FiltersApiAxiosParamCreator = function (configuration) {
|
|
25450
|
+
return {
|
|
25451
|
+
/**
|
|
25452
|
+
* Search within a facet\'s values (admin-authenticated version)
|
|
25453
|
+
* @summary Admin Search Facet Values
|
|
25454
|
+
* @param {string} xStoreID X-Store ID
|
|
25455
|
+
* @param {string} facetName Facet field name
|
|
25456
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
25457
|
+
* @param {*} [options] Override http request option.
|
|
25458
|
+
* @throws {RequiredError}
|
|
25459
|
+
*/
|
|
25460
|
+
adminV1FiltersXStoreIDFacetNameValuesPost: (xStoreID_1, facetName_1, dataTypesFacetValuesSearchRequest_1, ...args_1) => __awaiter(this, [xStoreID_1, facetName_1, dataTypesFacetValuesSearchRequest_1, ...args_1], void 0, function* (xStoreID, facetName, dataTypesFacetValuesSearchRequest, options = {}) {
|
|
25461
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
25462
|
+
assertParamExists('adminV1FiltersXStoreIDFacetNameValuesPost', 'xStoreID', xStoreID);
|
|
25463
|
+
// verify required parameter 'facetName' is not null or undefined
|
|
25464
|
+
assertParamExists('adminV1FiltersXStoreIDFacetNameValuesPost', 'facetName', facetName);
|
|
25465
|
+
// verify required parameter 'dataTypesFacetValuesSearchRequest' is not null or undefined
|
|
25466
|
+
assertParamExists('adminV1FiltersXStoreIDFacetNameValuesPost', 'dataTypesFacetValuesSearchRequest', dataTypesFacetValuesSearchRequest);
|
|
25467
|
+
const localVarPath = `/admin/v1/filters/{xStoreID}/{facetName}/values`
|
|
25468
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
25469
|
+
.replace(`{${"facetName"}}`, encodeURIComponent(String(facetName)));
|
|
25470
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25471
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25472
|
+
let baseOptions;
|
|
25473
|
+
if (configuration) {
|
|
25474
|
+
baseOptions = configuration.baseOptions;
|
|
25475
|
+
}
|
|
25476
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
25477
|
+
const localVarHeaderParameter = {};
|
|
25478
|
+
const localVarQueryParameter = {};
|
|
25479
|
+
// authentication BearerAuth required
|
|
25480
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
25481
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25482
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25483
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25484
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
25485
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesFacetValuesSearchRequest, localVarRequestOptions, configuration);
|
|
25486
|
+
return {
|
|
25487
|
+
url: toPathString(localVarUrlObj),
|
|
25488
|
+
options: localVarRequestOptions,
|
|
25489
|
+
};
|
|
25490
|
+
}),
|
|
25491
|
+
/**
|
|
25492
|
+
* Get filter values and counts (admin-authenticated version)
|
|
25493
|
+
* @summary Admin Get Filters
|
|
25494
|
+
* @param {string} xStoreID X-Store ID
|
|
25495
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
25496
|
+
* @param {*} [options] Override http request option.
|
|
25497
|
+
* @throws {RequiredError}
|
|
25498
|
+
*/
|
|
25499
|
+
adminV1FiltersXStoreIDPost: (xStoreID_1, dataTypesFiltersRequest_1, ...args_1) => __awaiter(this, [xStoreID_1, dataTypesFiltersRequest_1, ...args_1], void 0, function* (xStoreID, dataTypesFiltersRequest, options = {}) {
|
|
25500
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
25501
|
+
assertParamExists('adminV1FiltersXStoreIDPost', 'xStoreID', xStoreID);
|
|
25502
|
+
const localVarPath = `/admin/v1/filters/{xStoreID}`
|
|
25503
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
25504
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25505
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25506
|
+
let baseOptions;
|
|
25507
|
+
if (configuration) {
|
|
25508
|
+
baseOptions = configuration.baseOptions;
|
|
25509
|
+
}
|
|
25510
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
25511
|
+
const localVarHeaderParameter = {};
|
|
25512
|
+
const localVarQueryParameter = {};
|
|
25513
|
+
// authentication BearerAuth required
|
|
25514
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
25515
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25516
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25517
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25518
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
25519
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesFiltersRequest, localVarRequestOptions, configuration);
|
|
25520
|
+
return {
|
|
25521
|
+
url: toPathString(localVarUrlObj),
|
|
25522
|
+
options: localVarRequestOptions,
|
|
25523
|
+
};
|
|
25524
|
+
}),
|
|
25525
|
+
/**
|
|
25526
|
+
* Get filter field metadata (admin-authenticated version)
|
|
25527
|
+
* @summary Admin Get Filters Schema
|
|
25528
|
+
* @param {string} xStoreID X-Store ID
|
|
25529
|
+
* @param {*} [options] Override http request option.
|
|
25530
|
+
* @throws {RequiredError}
|
|
25531
|
+
*/
|
|
25532
|
+
adminV1FiltersXStoreIDSchemaGet: (xStoreID_1, ...args_1) => __awaiter(this, [xStoreID_1, ...args_1], void 0, function* (xStoreID, options = {}) {
|
|
25533
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
25534
|
+
assertParamExists('adminV1FiltersXStoreIDSchemaGet', 'xStoreID', xStoreID);
|
|
25535
|
+
const localVarPath = `/admin/v1/filters/{xStoreID}/schema`
|
|
25536
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)));
|
|
25537
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25538
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25539
|
+
let baseOptions;
|
|
25540
|
+
if (configuration) {
|
|
25541
|
+
baseOptions = configuration.baseOptions;
|
|
25542
|
+
}
|
|
25543
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
25544
|
+
const localVarHeaderParameter = {};
|
|
25545
|
+
const localVarQueryParameter = {};
|
|
25546
|
+
// authentication BearerAuth required
|
|
25547
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
25548
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25549
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25550
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
25551
|
+
return {
|
|
25552
|
+
url: toPathString(localVarUrlObj),
|
|
25553
|
+
options: localVarRequestOptions,
|
|
25554
|
+
};
|
|
25555
|
+
}),
|
|
25556
|
+
/**
|
|
25557
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
25558
|
+
* @summary Search Facet Values
|
|
25559
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25560
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25561
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
25562
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
25563
|
+
* @param {*} [options] Override http request option.
|
|
25564
|
+
* @throws {RequiredError}
|
|
25565
|
+
*/
|
|
25566
|
+
v1FiltersFacetNameValuesPost: (xStoreid_1, xStoresecret_1, facetName_1, dataTypesFacetValuesSearchRequest_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, facetName_1, dataTypesFacetValuesSearchRequest_1, ...args_1], void 0, function* (xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options = {}) {
|
|
25567
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
25568
|
+
assertParamExists('v1FiltersFacetNameValuesPost', 'xStoreid', xStoreid);
|
|
25569
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
25570
|
+
assertParamExists('v1FiltersFacetNameValuesPost', 'xStoresecret', xStoresecret);
|
|
25571
|
+
// verify required parameter 'facetName' is not null or undefined
|
|
25572
|
+
assertParamExists('v1FiltersFacetNameValuesPost', 'facetName', facetName);
|
|
25573
|
+
// verify required parameter 'dataTypesFacetValuesSearchRequest' is not null or undefined
|
|
25574
|
+
assertParamExists('v1FiltersFacetNameValuesPost', 'dataTypesFacetValuesSearchRequest', dataTypesFacetValuesSearchRequest);
|
|
25575
|
+
const localVarPath = `/v1/filters/{facetName}/values`
|
|
25576
|
+
.replace(`{${"facetName"}}`, encodeURIComponent(String(facetName)));
|
|
25577
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25578
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25579
|
+
let baseOptions;
|
|
25580
|
+
if (configuration) {
|
|
25581
|
+
baseOptions = configuration.baseOptions;
|
|
25582
|
+
}
|
|
25583
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
25584
|
+
const localVarHeaderParameter = {};
|
|
25585
|
+
const localVarQueryParameter = {};
|
|
25586
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25587
|
+
if (xStoreid != null) {
|
|
25588
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
25589
|
+
}
|
|
25590
|
+
if (xStoresecret != null) {
|
|
25591
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
25592
|
+
}
|
|
25593
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25594
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25595
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
25596
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesFacetValuesSearchRequest, localVarRequestOptions, configuration);
|
|
25597
|
+
return {
|
|
25598
|
+
url: toPathString(localVarUrlObj),
|
|
25599
|
+
options: localVarRequestOptions,
|
|
25600
|
+
};
|
|
25601
|
+
}),
|
|
25602
|
+
/**
|
|
25603
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
25604
|
+
* @summary Get Filters
|
|
25605
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25606
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25607
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
25608
|
+
* @param {*} [options] Override http request option.
|
|
25609
|
+
* @throws {RequiredError}
|
|
25610
|
+
*/
|
|
25611
|
+
v1FiltersPost: (xStoreid_1, xStoresecret_1, dataTypesFiltersRequest_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, dataTypesFiltersRequest_1, ...args_1], void 0, function* (xStoreid, xStoresecret, dataTypesFiltersRequest, options = {}) {
|
|
25612
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
25613
|
+
assertParamExists('v1FiltersPost', 'xStoreid', xStoreid);
|
|
25614
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
25615
|
+
assertParamExists('v1FiltersPost', 'xStoresecret', xStoresecret);
|
|
25616
|
+
const localVarPath = `/v1/filters`;
|
|
25617
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25618
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25619
|
+
let baseOptions;
|
|
25620
|
+
if (configuration) {
|
|
25621
|
+
baseOptions = configuration.baseOptions;
|
|
25622
|
+
}
|
|
25623
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
25624
|
+
const localVarHeaderParameter = {};
|
|
25625
|
+
const localVarQueryParameter = {};
|
|
25626
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
25627
|
+
if (xStoreid != null) {
|
|
25628
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
25629
|
+
}
|
|
25630
|
+
if (xStoresecret != null) {
|
|
25631
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
25632
|
+
}
|
|
25633
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25634
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25635
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
25636
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesFiltersRequest, localVarRequestOptions, configuration);
|
|
25637
|
+
return {
|
|
25638
|
+
url: toPathString(localVarUrlObj),
|
|
25639
|
+
options: localVarRequestOptions,
|
|
25640
|
+
};
|
|
25641
|
+
}),
|
|
25642
|
+
/**
|
|
25643
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
25644
|
+
* @summary Get Filters Schema
|
|
25645
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25646
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25647
|
+
* @param {*} [options] Override http request option.
|
|
25648
|
+
* @throws {RequiredError}
|
|
25649
|
+
*/
|
|
25650
|
+
v1FiltersSchemaGet: (xStoreid_1, xStoresecret_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, ...args_1], void 0, function* (xStoreid, xStoresecret, options = {}) {
|
|
25651
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
25652
|
+
assertParamExists('v1FiltersSchemaGet', 'xStoreid', xStoreid);
|
|
25653
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
25654
|
+
assertParamExists('v1FiltersSchemaGet', 'xStoresecret', xStoresecret);
|
|
25655
|
+
const localVarPath = `/v1/filters/schema`;
|
|
25656
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
25657
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
25658
|
+
let baseOptions;
|
|
25659
|
+
if (configuration) {
|
|
25660
|
+
baseOptions = configuration.baseOptions;
|
|
25661
|
+
}
|
|
25662
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
25663
|
+
const localVarHeaderParameter = {};
|
|
25664
|
+
const localVarQueryParameter = {};
|
|
25665
|
+
if (xStoreid != null) {
|
|
25666
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
25667
|
+
}
|
|
25668
|
+
if (xStoresecret != null) {
|
|
25669
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
25670
|
+
}
|
|
25671
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
25672
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
25673
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
25674
|
+
return {
|
|
25675
|
+
url: toPathString(localVarUrlObj),
|
|
25676
|
+
options: localVarRequestOptions,
|
|
25677
|
+
};
|
|
25678
|
+
}),
|
|
25679
|
+
};
|
|
25680
|
+
};
|
|
25681
|
+
/**
|
|
25682
|
+
* FiltersApi - functional programming interface
|
|
25683
|
+
* @export
|
|
25684
|
+
*/
|
|
25685
|
+
export const FiltersApiFp = function (configuration) {
|
|
25686
|
+
const localVarAxiosParamCreator = FiltersApiAxiosParamCreator(configuration);
|
|
25687
|
+
return {
|
|
25688
|
+
/**
|
|
25689
|
+
* Search within a facet\'s values (admin-authenticated version)
|
|
25690
|
+
* @summary Admin Search Facet Values
|
|
25691
|
+
* @param {string} xStoreID X-Store ID
|
|
25692
|
+
* @param {string} facetName Facet field name
|
|
25693
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
25694
|
+
* @param {*} [options] Override http request option.
|
|
25695
|
+
* @throws {RequiredError}
|
|
25696
|
+
*/
|
|
25697
|
+
adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID, facetName, dataTypesFacetValuesSearchRequest, options) {
|
|
25698
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
25699
|
+
var _a, _b, _c;
|
|
25700
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID, facetName, dataTypesFacetValuesSearchRequest, options);
|
|
25701
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
25702
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FiltersApi.adminV1FiltersXStoreIDFacetNameValuesPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
25703
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25704
|
+
});
|
|
25705
|
+
},
|
|
25706
|
+
/**
|
|
25707
|
+
* Get filter values and counts (admin-authenticated version)
|
|
25708
|
+
* @summary Admin Get Filters
|
|
25709
|
+
* @param {string} xStoreID X-Store ID
|
|
25710
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
25711
|
+
* @param {*} [options] Override http request option.
|
|
25712
|
+
* @throws {RequiredError}
|
|
25713
|
+
*/
|
|
25714
|
+
adminV1FiltersXStoreIDPost(xStoreID, dataTypesFiltersRequest, options) {
|
|
25715
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
25716
|
+
var _a, _b, _c;
|
|
25717
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminV1FiltersXStoreIDPost(xStoreID, dataTypesFiltersRequest, options);
|
|
25718
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
25719
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FiltersApi.adminV1FiltersXStoreIDPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
25720
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25721
|
+
});
|
|
25722
|
+
},
|
|
25723
|
+
/**
|
|
25724
|
+
* Get filter field metadata (admin-authenticated version)
|
|
25725
|
+
* @summary Admin Get Filters Schema
|
|
25726
|
+
* @param {string} xStoreID X-Store ID
|
|
25727
|
+
* @param {*} [options] Override http request option.
|
|
25728
|
+
* @throws {RequiredError}
|
|
25729
|
+
*/
|
|
25730
|
+
adminV1FiltersXStoreIDSchemaGet(xStoreID, options) {
|
|
25731
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
25732
|
+
var _a, _b, _c;
|
|
25733
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminV1FiltersXStoreIDSchemaGet(xStoreID, options);
|
|
25734
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
25735
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FiltersApi.adminV1FiltersXStoreIDSchemaGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
25736
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25737
|
+
});
|
|
25738
|
+
},
|
|
25739
|
+
/**
|
|
25740
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
25741
|
+
* @summary Search Facet Values
|
|
25742
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25743
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25744
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
25745
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
25746
|
+
* @param {*} [options] Override http request option.
|
|
25747
|
+
* @throws {RequiredError}
|
|
25748
|
+
*/
|
|
25749
|
+
v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options) {
|
|
25750
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
25751
|
+
var _a, _b, _c;
|
|
25752
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options);
|
|
25753
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
25754
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FiltersApi.v1FiltersFacetNameValuesPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
25755
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25756
|
+
});
|
|
25757
|
+
},
|
|
25758
|
+
/**
|
|
25759
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
25760
|
+
* @summary Get Filters
|
|
25761
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25762
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25763
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
25764
|
+
* @param {*} [options] Override http request option.
|
|
25765
|
+
* @throws {RequiredError}
|
|
25766
|
+
*/
|
|
25767
|
+
v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options) {
|
|
25768
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
25769
|
+
var _a, _b, _c;
|
|
25770
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options);
|
|
25771
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
25772
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FiltersApi.v1FiltersPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
25773
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25774
|
+
});
|
|
25775
|
+
},
|
|
25776
|
+
/**
|
|
25777
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
25778
|
+
* @summary Get Filters Schema
|
|
25779
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25780
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25781
|
+
* @param {*} [options] Override http request option.
|
|
25782
|
+
* @throws {RequiredError}
|
|
25783
|
+
*/
|
|
25784
|
+
v1FiltersSchemaGet(xStoreid, xStoresecret, options) {
|
|
25785
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
25786
|
+
var _a, _b, _c;
|
|
25787
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1FiltersSchemaGet(xStoreid, xStoresecret, options);
|
|
25788
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
25789
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FiltersApi.v1FiltersSchemaGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
25790
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
25791
|
+
});
|
|
25792
|
+
},
|
|
25793
|
+
};
|
|
25794
|
+
};
|
|
25795
|
+
/**
|
|
25796
|
+
* FiltersApi - factory interface
|
|
25797
|
+
* @export
|
|
25798
|
+
*/
|
|
25799
|
+
export const FiltersApiFactory = function (configuration, basePath, axios) {
|
|
25800
|
+
const localVarFp = FiltersApiFp(configuration);
|
|
25801
|
+
return {
|
|
25802
|
+
/**
|
|
25803
|
+
* Search within a facet\'s values (admin-authenticated version)
|
|
25804
|
+
* @summary Admin Search Facet Values
|
|
25805
|
+
* @param {string} xStoreID X-Store ID
|
|
25806
|
+
* @param {string} facetName Facet field name
|
|
25807
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
25808
|
+
* @param {*} [options] Override http request option.
|
|
25809
|
+
* @throws {RequiredError}
|
|
25810
|
+
*/
|
|
25811
|
+
adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID, facetName, dataTypesFacetValuesSearchRequest, options) {
|
|
25812
|
+
return localVarFp.adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID, facetName, dataTypesFacetValuesSearchRequest, options).then((request) => request(axios, basePath));
|
|
25813
|
+
},
|
|
25814
|
+
/**
|
|
25815
|
+
* Get filter values and counts (admin-authenticated version)
|
|
25816
|
+
* @summary Admin Get Filters
|
|
25817
|
+
* @param {string} xStoreID X-Store ID
|
|
25818
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
25819
|
+
* @param {*} [options] Override http request option.
|
|
25820
|
+
* @throws {RequiredError}
|
|
25821
|
+
*/
|
|
25822
|
+
adminV1FiltersXStoreIDPost(xStoreID, dataTypesFiltersRequest, options) {
|
|
25823
|
+
return localVarFp.adminV1FiltersXStoreIDPost(xStoreID, dataTypesFiltersRequest, options).then((request) => request(axios, basePath));
|
|
25824
|
+
},
|
|
25825
|
+
/**
|
|
25826
|
+
* Get filter field metadata (admin-authenticated version)
|
|
25827
|
+
* @summary Admin Get Filters Schema
|
|
25828
|
+
* @param {string} xStoreID X-Store ID
|
|
25829
|
+
* @param {*} [options] Override http request option.
|
|
25830
|
+
* @throws {RequiredError}
|
|
25831
|
+
*/
|
|
25832
|
+
adminV1FiltersXStoreIDSchemaGet(xStoreID, options) {
|
|
25833
|
+
return localVarFp.adminV1FiltersXStoreIDSchemaGet(xStoreID, options).then((request) => request(axios, basePath));
|
|
25834
|
+
},
|
|
25835
|
+
/**
|
|
25836
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
25837
|
+
* @summary Search Facet Values
|
|
25838
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25839
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25840
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
25841
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
25842
|
+
* @param {*} [options] Override http request option.
|
|
25843
|
+
* @throws {RequiredError}
|
|
25844
|
+
*/
|
|
25845
|
+
v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options) {
|
|
25846
|
+
return localVarFp.v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options).then((request) => request(axios, basePath));
|
|
25847
|
+
},
|
|
25848
|
+
/**
|
|
25849
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
25850
|
+
* @summary Get Filters
|
|
25851
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25852
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25853
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
25854
|
+
* @param {*} [options] Override http request option.
|
|
25855
|
+
* @throws {RequiredError}
|
|
25856
|
+
*/
|
|
25857
|
+
v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options) {
|
|
25858
|
+
return localVarFp.v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options).then((request) => request(axios, basePath));
|
|
25859
|
+
},
|
|
25860
|
+
/**
|
|
25861
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
25862
|
+
* @summary Get Filters Schema
|
|
25863
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25864
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25865
|
+
* @param {*} [options] Override http request option.
|
|
25866
|
+
* @throws {RequiredError}
|
|
25867
|
+
*/
|
|
25868
|
+
v1FiltersSchemaGet(xStoreid, xStoresecret, options) {
|
|
25869
|
+
return localVarFp.v1FiltersSchemaGet(xStoreid, xStoresecret, options).then((request) => request(axios, basePath));
|
|
25870
|
+
},
|
|
25871
|
+
};
|
|
25872
|
+
};
|
|
25873
|
+
/**
|
|
25874
|
+
* FiltersApi - object-oriented interface
|
|
25875
|
+
* @export
|
|
25876
|
+
* @class FiltersApi
|
|
25877
|
+
* @extends {BaseAPI}
|
|
25878
|
+
*/
|
|
25879
|
+
export class FiltersApi extends BaseAPI {
|
|
25880
|
+
/**
|
|
25881
|
+
* Search within a facet\'s values (admin-authenticated version)
|
|
25882
|
+
* @summary Admin Search Facet Values
|
|
25883
|
+
* @param {string} xStoreID X-Store ID
|
|
25884
|
+
* @param {string} facetName Facet field name
|
|
25885
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
25886
|
+
* @param {*} [options] Override http request option.
|
|
25887
|
+
* @throws {RequiredError}
|
|
25888
|
+
* @memberof FiltersApi
|
|
25889
|
+
*/
|
|
25890
|
+
adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID, facetName, dataTypesFacetValuesSearchRequest, options) {
|
|
25891
|
+
return FiltersApiFp(this.configuration).adminV1FiltersXStoreIDFacetNameValuesPost(xStoreID, facetName, dataTypesFacetValuesSearchRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25892
|
+
}
|
|
25893
|
+
/**
|
|
25894
|
+
* Get filter values and counts (admin-authenticated version)
|
|
25895
|
+
* @summary Admin Get Filters
|
|
25896
|
+
* @param {string} xStoreID X-Store ID
|
|
25897
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
25898
|
+
* @param {*} [options] Override http request option.
|
|
25899
|
+
* @throws {RequiredError}
|
|
25900
|
+
* @memberof FiltersApi
|
|
25901
|
+
*/
|
|
25902
|
+
adminV1FiltersXStoreIDPost(xStoreID, dataTypesFiltersRequest, options) {
|
|
25903
|
+
return FiltersApiFp(this.configuration).adminV1FiltersXStoreIDPost(xStoreID, dataTypesFiltersRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25904
|
+
}
|
|
25905
|
+
/**
|
|
25906
|
+
* Get filter field metadata (admin-authenticated version)
|
|
25907
|
+
* @summary Admin Get Filters Schema
|
|
25908
|
+
* @param {string} xStoreID X-Store ID
|
|
25909
|
+
* @param {*} [options] Override http request option.
|
|
25910
|
+
* @throws {RequiredError}
|
|
25911
|
+
* @memberof FiltersApi
|
|
25912
|
+
*/
|
|
25913
|
+
adminV1FiltersXStoreIDSchemaGet(xStoreID, options) {
|
|
25914
|
+
return FiltersApiFp(this.configuration).adminV1FiltersXStoreIDSchemaGet(xStoreID, options).then((request) => request(this.axios, this.basePath));
|
|
25915
|
+
}
|
|
25916
|
+
/**
|
|
25917
|
+
* Search or autocomplete within a single facet\'s values. Useful for facets with many values (e.g., brands) where you need typeahead search.
|
|
25918
|
+
* @summary Search Facet Values
|
|
25919
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25920
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25921
|
+
* @param {string} facetName Facet field name (e.g., brand, category)
|
|
25922
|
+
* @param {DataTypesFacetValuesSearchRequest} dataTypesFacetValuesSearchRequest Facet search query
|
|
25923
|
+
* @param {*} [options] Override http request option.
|
|
25924
|
+
* @throws {RequiredError}
|
|
25925
|
+
* @memberof FiltersApi
|
|
25926
|
+
*/
|
|
25927
|
+
v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options) {
|
|
25928
|
+
return FiltersApiFp(this.configuration).v1FiltersFacetNameValuesPost(xStoreid, xStoresecret, facetName, dataTypesFacetValuesSearchRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25929
|
+
}
|
|
25930
|
+
/**
|
|
25931
|
+
* Get filter values and counts for configured facets. Use this to build faceted navigation UIs. Supports disjunctive faceting for OR-based filter combinations.
|
|
25932
|
+
* @summary Get Filters
|
|
25933
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25934
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25935
|
+
* @param {DataTypesFiltersRequest} [dataTypesFiltersRequest] Filter options
|
|
25936
|
+
* @param {*} [options] Override http request option.
|
|
25937
|
+
* @throws {RequiredError}
|
|
25938
|
+
* @memberof FiltersApi
|
|
25939
|
+
*/
|
|
25940
|
+
v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options) {
|
|
25941
|
+
return FiltersApiFp(this.configuration).v1FiltersPost(xStoreid, xStoresecret, dataTypesFiltersRequest, options).then((request) => request(this.axios, this.basePath));
|
|
25942
|
+
}
|
|
25943
|
+
/**
|
|
25944
|
+
* Get available filter field metadata including types, sortability, and configured ranges. Useful for dynamically building filter UIs.
|
|
25945
|
+
* @summary Get Filters Schema
|
|
25946
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
25947
|
+
* @param {string} xStoresecret Store read secret (from dashboard)
|
|
25948
|
+
* @param {*} [options] Override http request option.
|
|
25949
|
+
* @throws {RequiredError}
|
|
25950
|
+
* @memberof FiltersApi
|
|
25951
|
+
*/
|
|
25952
|
+
v1FiltersSchemaGet(xStoreid, xStoresecret, options) {
|
|
25953
|
+
return FiltersApiFp(this.configuration).v1FiltersSchemaGet(xStoreid, xStoresecret, options).then((request) => request(this.axios, this.basePath));
|
|
25954
|
+
}
|
|
25955
|
+
}
|
|
24306
25956
|
/**
|
|
24307
25957
|
* ItemAnalyticsApi - axios parameter creator
|
|
24308
25958
|
* @export
|
|
@@ -40690,6 +42340,53 @@ export const SDKDocumentsApiAxiosParamCreator = function (configuration) {
|
|
|
40690
42340
|
options: localVarRequestOptions,
|
|
40691
42341
|
};
|
|
40692
42342
|
}),
|
|
42343
|
+
/**
|
|
42344
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
42345
|
+
* @summary Get a document by ID
|
|
42346
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
42347
|
+
* @param {string} xStoresecret Store read secret
|
|
42348
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
42349
|
+
* @param {string} documentID Document ID to retrieve
|
|
42350
|
+
* @param {*} [options] Override http request option.
|
|
42351
|
+
* @throws {RequiredError}
|
|
42352
|
+
*/
|
|
42353
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet: (xStoreid_1, xStoresecret_1, xStoreID_1, documentID_1, ...args_1) => __awaiter(this, [xStoreid_1, xStoresecret_1, xStoreID_1, documentID_1, ...args_1], void 0, function* (xStoreid, xStoresecret, xStoreID, documentID, options = {}) {
|
|
42354
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
42355
|
+
assertParamExists('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'xStoreid', xStoreid);
|
|
42356
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
42357
|
+
assertParamExists('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'xStoresecret', xStoresecret);
|
|
42358
|
+
// verify required parameter 'xStoreID' is not null or undefined
|
|
42359
|
+
assertParamExists('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'xStoreID', xStoreID);
|
|
42360
|
+
// verify required parameter 'documentID' is not null or undefined
|
|
42361
|
+
assertParamExists('apiV1StoresXStoreIDDocumentsDocumentIDGet', 'documentID', documentID);
|
|
42362
|
+
const localVarPath = `/api/v1/stores/{xStoreID}/documents/{documentID}`
|
|
42363
|
+
.replace(`{${"xStoreID"}}`, encodeURIComponent(String(xStoreID)))
|
|
42364
|
+
.replace(`{${"documentID"}}`, encodeURIComponent(String(documentID)));
|
|
42365
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42366
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42367
|
+
let baseOptions;
|
|
42368
|
+
if (configuration) {
|
|
42369
|
+
baseOptions = configuration.baseOptions;
|
|
42370
|
+
}
|
|
42371
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
42372
|
+
const localVarHeaderParameter = {};
|
|
42373
|
+
const localVarQueryParameter = {};
|
|
42374
|
+
// authentication ApiKeyAuth required
|
|
42375
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-storesecret", configuration);
|
|
42376
|
+
if (xStoreid != null) {
|
|
42377
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
42378
|
+
}
|
|
42379
|
+
if (xStoresecret != null) {
|
|
42380
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
42381
|
+
}
|
|
42382
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
42383
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42384
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
42385
|
+
return {
|
|
42386
|
+
url: toPathString(localVarUrlObj),
|
|
42387
|
+
options: localVarRequestOptions,
|
|
42388
|
+
};
|
|
42389
|
+
}),
|
|
40693
42390
|
/**
|
|
40694
42391
|
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
40695
42392
|
* @summary Index a single document
|
|
@@ -40785,6 +42482,25 @@ export const SDKDocumentsApiFp = function (configuration) {
|
|
|
40785
42482
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
40786
42483
|
});
|
|
40787
42484
|
},
|
|
42485
|
+
/**
|
|
42486
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
42487
|
+
* @summary Get a document by ID
|
|
42488
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
42489
|
+
* @param {string} xStoresecret Store read secret
|
|
42490
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
42491
|
+
* @param {string} documentID Document ID to retrieve
|
|
42492
|
+
* @param {*} [options] Override http request option.
|
|
42493
|
+
* @throws {RequiredError}
|
|
42494
|
+
*/
|
|
42495
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options) {
|
|
42496
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42497
|
+
var _a, _b, _c;
|
|
42498
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options);
|
|
42499
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
42500
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SDKDocumentsApi.apiV1StoresXStoreIDDocumentsDocumentIDGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
42501
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42502
|
+
});
|
|
42503
|
+
},
|
|
40788
42504
|
/**
|
|
40789
42505
|
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
40790
42506
|
* @summary Index a single document
|
|
@@ -40839,6 +42555,19 @@ export const SDKDocumentsApiFactory = function (configuration, basePath, axios)
|
|
|
40839
42555
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options) {
|
|
40840
42556
|
return localVarFp.apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options).then((request) => request(axios, basePath));
|
|
40841
42557
|
},
|
|
42558
|
+
/**
|
|
42559
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
42560
|
+
* @summary Get a document by ID
|
|
42561
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
42562
|
+
* @param {string} xStoresecret Store read secret
|
|
42563
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
42564
|
+
* @param {string} documentID Document ID to retrieve
|
|
42565
|
+
* @param {*} [options] Override http request option.
|
|
42566
|
+
* @throws {RequiredError}
|
|
42567
|
+
*/
|
|
42568
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options) {
|
|
42569
|
+
return localVarFp.apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options).then((request) => request(axios, basePath));
|
|
42570
|
+
},
|
|
40842
42571
|
/**
|
|
40843
42572
|
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
40844
42573
|
* @summary Index a single document
|
|
@@ -40889,6 +42618,20 @@ export class SDKDocumentsApi extends BaseAPI {
|
|
|
40889
42618
|
apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options) {
|
|
40890
42619
|
return SDKDocumentsApiFp(this.configuration).apiV1StoresXStoreIDDocumentsDocumentIDDelete(xStoreid, xStoreWriteSecret, xStoreID, documentID, options).then((request) => request(this.axios, this.basePath));
|
|
40891
42620
|
}
|
|
42621
|
+
/**
|
|
42622
|
+
* Retrieve a single document from the store\'s search index by ID. **Auth:** `x-storeid` and `x-storesecret` (read secret). Path `xStoreID` must match the `x-storeid` header. Used by product pages and PDP.
|
|
42623
|
+
* @summary Get a document by ID
|
|
42624
|
+
* @param {string} xStoreid Store ID (from dashboard)
|
|
42625
|
+
* @param {string} xStoresecret Store read secret
|
|
42626
|
+
* @param {string} xStoreID Store ID (must match x-storeid header)
|
|
42627
|
+
* @param {string} documentID Document ID to retrieve
|
|
42628
|
+
* @param {*} [options] Override http request option.
|
|
42629
|
+
* @throws {RequiredError}
|
|
42630
|
+
* @memberof SDKDocumentsApi
|
|
42631
|
+
*/
|
|
42632
|
+
apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options) {
|
|
42633
|
+
return SDKDocumentsApiFp(this.configuration).apiV1StoresXStoreIDDocumentsDocumentIDGet(xStoreid, xStoresecret, xStoreID, documentID, options).then((request) => request(this.axios, this.basePath));
|
|
42634
|
+
}
|
|
40892
42635
|
/**
|
|
40893
42636
|
* Add or update one document in the store\'s search index. **Auth:** `x-storeid` and `x-store-write-secret`. Path `xStoreID` must match the `x-storeid` header. If you omit document ID, one is generated; existing documents with the same ID are updated.
|
|
40894
42637
|
* @summary Index a single document
|
|
@@ -40904,6 +42647,133 @@ export class SDKDocumentsApi extends BaseAPI {
|
|
|
40904
42647
|
return SDKDocumentsApiFp(this.configuration).apiV1StoresXStoreIDDocumentsPost(xStoreid, xStoreWriteSecret, xStoreID, dataTypesDocumentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
40905
42648
|
}
|
|
40906
42649
|
}
|
|
42650
|
+
/**
|
|
42651
|
+
* SDKExperimentsApi - axios parameter creator
|
|
42652
|
+
* @export
|
|
42653
|
+
*/
|
|
42654
|
+
export const SDKExperimentsApiAxiosParamCreator = function (configuration) {
|
|
42655
|
+
return {
|
|
42656
|
+
/**
|
|
42657
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
42658
|
+
* @summary Get experiment assignments for a user
|
|
42659
|
+
* @param {string} xStoreid Store ID
|
|
42660
|
+
* @param {string} xStoresecret Store read secret
|
|
42661
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
42662
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
42663
|
+
* @param {*} [options] Override http request option.
|
|
42664
|
+
* @throws {RequiredError}
|
|
42665
|
+
*/
|
|
42666
|
+
v1ExperimentsAssignmentGet: (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 = {}) {
|
|
42667
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
42668
|
+
assertParamExists('v1ExperimentsAssignmentGet', 'xStoreid', xStoreid);
|
|
42669
|
+
// verify required parameter 'xStoresecret' is not null or undefined
|
|
42670
|
+
assertParamExists('v1ExperimentsAssignmentGet', 'xStoresecret', xStoresecret);
|
|
42671
|
+
const localVarPath = `/v1/experiments/assignment`;
|
|
42672
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42673
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42674
|
+
let baseOptions;
|
|
42675
|
+
if (configuration) {
|
|
42676
|
+
baseOptions = configuration.baseOptions;
|
|
42677
|
+
}
|
|
42678
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
42679
|
+
const localVarHeaderParameter = {};
|
|
42680
|
+
const localVarQueryParameter = {};
|
|
42681
|
+
// authentication ApiKeyAuth required
|
|
42682
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-storesecret", configuration);
|
|
42683
|
+
if (xStoreid != null) {
|
|
42684
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
42685
|
+
}
|
|
42686
|
+
if (xStoresecret != null) {
|
|
42687
|
+
localVarHeaderParameter['x-storesecret'] = String(xStoresecret);
|
|
42688
|
+
}
|
|
42689
|
+
if (xUserId != null) {
|
|
42690
|
+
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
42691
|
+
}
|
|
42692
|
+
if (xAnonId != null) {
|
|
42693
|
+
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
42694
|
+
}
|
|
42695
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
42696
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
42697
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
42698
|
+
return {
|
|
42699
|
+
url: toPathString(localVarUrlObj),
|
|
42700
|
+
options: localVarRequestOptions,
|
|
42701
|
+
};
|
|
42702
|
+
}),
|
|
42703
|
+
};
|
|
42704
|
+
};
|
|
42705
|
+
/**
|
|
42706
|
+
* SDKExperimentsApi - functional programming interface
|
|
42707
|
+
* @export
|
|
42708
|
+
*/
|
|
42709
|
+
export const SDKExperimentsApiFp = function (configuration) {
|
|
42710
|
+
const localVarAxiosParamCreator = SDKExperimentsApiAxiosParamCreator(configuration);
|
|
42711
|
+
return {
|
|
42712
|
+
/**
|
|
42713
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
42714
|
+
* @summary Get experiment assignments for a user
|
|
42715
|
+
* @param {string} xStoreid Store ID
|
|
42716
|
+
* @param {string} xStoresecret Store read secret
|
|
42717
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
42718
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
42719
|
+
* @param {*} [options] Override http request option.
|
|
42720
|
+
* @throws {RequiredError}
|
|
42721
|
+
*/
|
|
42722
|
+
v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
42723
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42724
|
+
var _a, _b, _c;
|
|
42725
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options);
|
|
42726
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
42727
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SDKExperimentsApi.v1ExperimentsAssignmentGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
42728
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
42729
|
+
});
|
|
42730
|
+
},
|
|
42731
|
+
};
|
|
42732
|
+
};
|
|
42733
|
+
/**
|
|
42734
|
+
* SDKExperimentsApi - factory interface
|
|
42735
|
+
* @export
|
|
42736
|
+
*/
|
|
42737
|
+
export const SDKExperimentsApiFactory = function (configuration, basePath, axios) {
|
|
42738
|
+
const localVarFp = SDKExperimentsApiFp(configuration);
|
|
42739
|
+
return {
|
|
42740
|
+
/**
|
|
42741
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
42742
|
+
* @summary Get experiment assignments for a user
|
|
42743
|
+
* @param {string} xStoreid Store ID
|
|
42744
|
+
* @param {string} xStoresecret Store read secret
|
|
42745
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
42746
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
42747
|
+
* @param {*} [options] Override http request option.
|
|
42748
|
+
* @throws {RequiredError}
|
|
42749
|
+
*/
|
|
42750
|
+
v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
42751
|
+
return localVarFp.v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options).then((request) => request(axios, basePath));
|
|
42752
|
+
},
|
|
42753
|
+
};
|
|
42754
|
+
};
|
|
42755
|
+
/**
|
|
42756
|
+
* SDKExperimentsApi - object-oriented interface
|
|
42757
|
+
* @export
|
|
42758
|
+
* @class SDKExperimentsApi
|
|
42759
|
+
* @extends {BaseAPI}
|
|
42760
|
+
*/
|
|
42761
|
+
export class SDKExperimentsApi extends BaseAPI {
|
|
42762
|
+
/**
|
|
42763
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
42764
|
+
* @summary Get experiment assignments for a user
|
|
42765
|
+
* @param {string} xStoreid Store ID
|
|
42766
|
+
* @param {string} xStoresecret Store read secret
|
|
42767
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
42768
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
42769
|
+
* @param {*} [options] Override http request option.
|
|
42770
|
+
* @throws {RequiredError}
|
|
42771
|
+
* @memberof SDKExperimentsApi
|
|
42772
|
+
*/
|
|
42773
|
+
v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options) {
|
|
42774
|
+
return SDKExperimentsApiFp(this.configuration).v1ExperimentsAssignmentGet(xStoreid, xStoresecret, xUserId, xAnonId, options).then((request) => request(this.axios, this.basePath));
|
|
42775
|
+
}
|
|
42776
|
+
}
|
|
40907
42777
|
/**
|
|
40908
42778
|
* SDKQuerySuggestionsConfigApi - axios parameter creator
|
|
40909
42779
|
* @export
|
|
@@ -45227,7 +47097,7 @@ export const StoresApiAxiosParamCreator = function (configuration) {
|
|
|
45227
47097
|
};
|
|
45228
47098
|
}),
|
|
45229
47099
|
/**
|
|
45230
|
-
* Retrieve detailed information for a specific API usage event including headers, request body, and response body
|
|
47100
|
+
* Retrieve detailed information for a specific API usage event including headers, request body, and response body.
|
|
45231
47101
|
* @summary Get Specific API Usage Event
|
|
45232
47102
|
* @param {string} xStoreID Store ID
|
|
45233
47103
|
* @param {string} eventID Event ID (UUID)
|
|
@@ -45916,7 +47786,7 @@ export const StoresApiFp = function (configuration) {
|
|
|
45916
47786
|
});
|
|
45917
47787
|
},
|
|
45918
47788
|
/**
|
|
45919
|
-
* Retrieve detailed information for a specific API usage event including headers, request body, and response body
|
|
47789
|
+
* Retrieve detailed information for a specific API usage event including headers, request body, and response body.
|
|
45920
47790
|
* @summary Get Specific API Usage Event
|
|
45921
47791
|
* @param {string} xStoreID Store ID
|
|
45922
47792
|
* @param {string} eventID Event ID (UUID)
|
|
@@ -46273,7 +48143,7 @@ export const StoresApiFactory = function (configuration, basePath, axios) {
|
|
|
46273
48143
|
return localVarFp.adminStoresXStoreIDAnalyticsTimeseriesGet(xStoreID, metric, startDate, endDate, options).then((request) => request(axios, basePath));
|
|
46274
48144
|
},
|
|
46275
48145
|
/**
|
|
46276
|
-
* Retrieve detailed information for a specific API usage event including headers, request body, and response body
|
|
48146
|
+
* Retrieve detailed information for a specific API usage event including headers, request body, and response body.
|
|
46277
48147
|
* @summary Get Specific API Usage Event
|
|
46278
48148
|
* @param {string} xStoreID Store ID
|
|
46279
48149
|
* @param {string} eventID Event ID (UUID)
|
|
@@ -46563,7 +48433,7 @@ export class StoresApi extends BaseAPI {
|
|
|
46563
48433
|
return StoresApiFp(this.configuration).adminStoresXStoreIDAnalyticsTimeseriesGet(xStoreID, metric, startDate, endDate, options).then((request) => request(this.axios, this.basePath));
|
|
46564
48434
|
}
|
|
46565
48435
|
/**
|
|
46566
|
-
* Retrieve detailed information for a specific API usage event including headers, request body, and response body
|
|
48436
|
+
* Retrieve detailed information for a specific API usage event including headers, request body, and response body.
|
|
46567
48437
|
* @summary Get Specific API Usage Event
|
|
46568
48438
|
* @param {string} xStoreID Store ID
|
|
46569
48439
|
* @param {string} eventID Event ID (UUID)
|