@seekora-ai/admin-api 1.1.84 → 1.1.85
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 +21 -2
- package/api.ts +1387 -0
- package/dist/api.d.ts +971 -0
- package/dist/api.js +778 -10
- package/dist/esm/api.d.ts +971 -0
- package/dist/esm/api.js +764 -0
- package/package.json +1 -1
- package/seekora-ai-admin-api-1.1.85.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',
|
|
@@ -23332,6 +23358,744 @@ export class DocumentsApi extends BaseAPI {
|
|
|
23332
23358
|
return DocumentsApiFp(this.configuration).adminStoresXStoreIDUploadPost(xStoreID, file, options).then((request) => request(this.axios, this.basePath));
|
|
23333
23359
|
}
|
|
23334
23360
|
}
|
|
23361
|
+
/**
|
|
23362
|
+
* ExperimentsApi - axios parameter creator
|
|
23363
|
+
* @export
|
|
23364
|
+
*/
|
|
23365
|
+
export const ExperimentsApiAxiosParamCreator = function (configuration) {
|
|
23366
|
+
return {
|
|
23367
|
+
/**
|
|
23368
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
23369
|
+
* @summary List all experiments
|
|
23370
|
+
* @param {*} [options] Override http request option.
|
|
23371
|
+
* @throws {RequiredError}
|
|
23372
|
+
*/
|
|
23373
|
+
v1AdminExperimentsGet: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
23374
|
+
const localVarPath = `/v1/admin/experiments/`;
|
|
23375
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23376
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23377
|
+
let baseOptions;
|
|
23378
|
+
if (configuration) {
|
|
23379
|
+
baseOptions = configuration.baseOptions;
|
|
23380
|
+
}
|
|
23381
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
23382
|
+
const localVarHeaderParameter = {};
|
|
23383
|
+
const localVarQueryParameter = {};
|
|
23384
|
+
// authentication BearerAuth required
|
|
23385
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23386
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23387
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23388
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23389
|
+
return {
|
|
23390
|
+
url: toPathString(localVarUrlObj),
|
|
23391
|
+
options: localVarRequestOptions,
|
|
23392
|
+
};
|
|
23393
|
+
}),
|
|
23394
|
+
/**
|
|
23395
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
23396
|
+
* @summary Complete an experiment
|
|
23397
|
+
* @param {string} id Experiment ID (slug)
|
|
23398
|
+
* @param {object} [body] Optional winner variant ID
|
|
23399
|
+
* @param {*} [options] Override http request option.
|
|
23400
|
+
* @throws {RequiredError}
|
|
23401
|
+
*/
|
|
23402
|
+
v1AdminExperimentsIdCompletePost: (id_1, body_1, ...args_1) => __awaiter(this, [id_1, body_1, ...args_1], void 0, function* (id, body, options = {}) {
|
|
23403
|
+
// verify required parameter 'id' is not null or undefined
|
|
23404
|
+
assertParamExists('v1AdminExperimentsIdCompletePost', 'id', id);
|
|
23405
|
+
const localVarPath = `/v1/admin/experiments/{id}/complete`
|
|
23406
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23407
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23408
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23409
|
+
let baseOptions;
|
|
23410
|
+
if (configuration) {
|
|
23411
|
+
baseOptions = configuration.baseOptions;
|
|
23412
|
+
}
|
|
23413
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23414
|
+
const localVarHeaderParameter = {};
|
|
23415
|
+
const localVarQueryParameter = {};
|
|
23416
|
+
// authentication BearerAuth required
|
|
23417
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23418
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
23419
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23420
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23421
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23422
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
23423
|
+
return {
|
|
23424
|
+
url: toPathString(localVarUrlObj),
|
|
23425
|
+
options: localVarRequestOptions,
|
|
23426
|
+
};
|
|
23427
|
+
}),
|
|
23428
|
+
/**
|
|
23429
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
23430
|
+
* @summary Delete a draft experiment
|
|
23431
|
+
* @param {string} id Experiment ID (slug)
|
|
23432
|
+
* @param {*} [options] Override http request option.
|
|
23433
|
+
* @throws {RequiredError}
|
|
23434
|
+
*/
|
|
23435
|
+
v1AdminExperimentsIdDelete: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
23436
|
+
// verify required parameter 'id' is not null or undefined
|
|
23437
|
+
assertParamExists('v1AdminExperimentsIdDelete', 'id', id);
|
|
23438
|
+
const localVarPath = `/v1/admin/experiments/{id}`
|
|
23439
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23440
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23441
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23442
|
+
let baseOptions;
|
|
23443
|
+
if (configuration) {
|
|
23444
|
+
baseOptions = configuration.baseOptions;
|
|
23445
|
+
}
|
|
23446
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
23447
|
+
const localVarHeaderParameter = {};
|
|
23448
|
+
const localVarQueryParameter = {};
|
|
23449
|
+
// authentication BearerAuth required
|
|
23450
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23451
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23452
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23453
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23454
|
+
return {
|
|
23455
|
+
url: toPathString(localVarUrlObj),
|
|
23456
|
+
options: localVarRequestOptions,
|
|
23457
|
+
};
|
|
23458
|
+
}),
|
|
23459
|
+
/**
|
|
23460
|
+
* Returns a single experiment by its experiment_id slug.
|
|
23461
|
+
* @summary Get experiment by ID
|
|
23462
|
+
* @param {string} id Experiment ID (slug)
|
|
23463
|
+
* @param {*} [options] Override http request option.
|
|
23464
|
+
* @throws {RequiredError}
|
|
23465
|
+
*/
|
|
23466
|
+
v1AdminExperimentsIdGet: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
23467
|
+
// verify required parameter 'id' is not null or undefined
|
|
23468
|
+
assertParamExists('v1AdminExperimentsIdGet', 'id', id);
|
|
23469
|
+
const localVarPath = `/v1/admin/experiments/{id}`
|
|
23470
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23471
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23472
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23473
|
+
let baseOptions;
|
|
23474
|
+
if (configuration) {
|
|
23475
|
+
baseOptions = configuration.baseOptions;
|
|
23476
|
+
}
|
|
23477
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
23478
|
+
const localVarHeaderParameter = {};
|
|
23479
|
+
const localVarQueryParameter = {};
|
|
23480
|
+
// authentication BearerAuth required
|
|
23481
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23482
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23483
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23484
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23485
|
+
return {
|
|
23486
|
+
url: toPathString(localVarUrlObj),
|
|
23487
|
+
options: localVarRequestOptions,
|
|
23488
|
+
};
|
|
23489
|
+
}),
|
|
23490
|
+
/**
|
|
23491
|
+
* Transitions a running experiment to paused status.
|
|
23492
|
+
* @summary Pause an experiment
|
|
23493
|
+
* @param {string} id Experiment ID (slug)
|
|
23494
|
+
* @param {*} [options] Override http request option.
|
|
23495
|
+
* @throws {RequiredError}
|
|
23496
|
+
*/
|
|
23497
|
+
v1AdminExperimentsIdPausePost: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
23498
|
+
// verify required parameter 'id' is not null or undefined
|
|
23499
|
+
assertParamExists('v1AdminExperimentsIdPausePost', 'id', id);
|
|
23500
|
+
const localVarPath = `/v1/admin/experiments/{id}/pause`
|
|
23501
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23502
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23503
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23504
|
+
let baseOptions;
|
|
23505
|
+
if (configuration) {
|
|
23506
|
+
baseOptions = configuration.baseOptions;
|
|
23507
|
+
}
|
|
23508
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23509
|
+
const localVarHeaderParameter = {};
|
|
23510
|
+
const localVarQueryParameter = {};
|
|
23511
|
+
// authentication BearerAuth required
|
|
23512
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23513
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23514
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23515
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23516
|
+
return {
|
|
23517
|
+
url: toPathString(localVarUrlObj),
|
|
23518
|
+
options: localVarRequestOptions,
|
|
23519
|
+
};
|
|
23520
|
+
}),
|
|
23521
|
+
/**
|
|
23522
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
23523
|
+
* @summary Update an experiment
|
|
23524
|
+
* @param {string} id Experiment ID (slug)
|
|
23525
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
23526
|
+
* @param {*} [options] Override http request option.
|
|
23527
|
+
* @throws {RequiredError}
|
|
23528
|
+
*/
|
|
23529
|
+
v1AdminExperimentsIdPut: (id_1, dataTypesUpdateExperimentRequest_1, ...args_1) => __awaiter(this, [id_1, dataTypesUpdateExperimentRequest_1, ...args_1], void 0, function* (id, dataTypesUpdateExperimentRequest, options = {}) {
|
|
23530
|
+
// verify required parameter 'id' is not null or undefined
|
|
23531
|
+
assertParamExists('v1AdminExperimentsIdPut', 'id', id);
|
|
23532
|
+
// verify required parameter 'dataTypesUpdateExperimentRequest' is not null or undefined
|
|
23533
|
+
assertParamExists('v1AdminExperimentsIdPut', 'dataTypesUpdateExperimentRequest', dataTypesUpdateExperimentRequest);
|
|
23534
|
+
const localVarPath = `/v1/admin/experiments/{id}`
|
|
23535
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23536
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23537
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23538
|
+
let baseOptions;
|
|
23539
|
+
if (configuration) {
|
|
23540
|
+
baseOptions = configuration.baseOptions;
|
|
23541
|
+
}
|
|
23542
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
23543
|
+
const localVarHeaderParameter = {};
|
|
23544
|
+
const localVarQueryParameter = {};
|
|
23545
|
+
// authentication BearerAuth required
|
|
23546
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23547
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
23548
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23549
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23550
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23551
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesUpdateExperimentRequest, localVarRequestOptions, configuration);
|
|
23552
|
+
return {
|
|
23553
|
+
url: toPathString(localVarUrlObj),
|
|
23554
|
+
options: localVarRequestOptions,
|
|
23555
|
+
};
|
|
23556
|
+
}),
|
|
23557
|
+
/**
|
|
23558
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
23559
|
+
* @summary Get experiment results
|
|
23560
|
+
* @param {string} id Experiment ID (slug)
|
|
23561
|
+
* @param {*} [options] Override http request option.
|
|
23562
|
+
* @throws {RequiredError}
|
|
23563
|
+
*/
|
|
23564
|
+
v1AdminExperimentsIdResultsGet: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
23565
|
+
// verify required parameter 'id' is not null or undefined
|
|
23566
|
+
assertParamExists('v1AdminExperimentsIdResultsGet', 'id', id);
|
|
23567
|
+
const localVarPath = `/v1/admin/experiments/{id}/results`
|
|
23568
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23569
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23570
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23571
|
+
let baseOptions;
|
|
23572
|
+
if (configuration) {
|
|
23573
|
+
baseOptions = configuration.baseOptions;
|
|
23574
|
+
}
|
|
23575
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
23576
|
+
const localVarHeaderParameter = {};
|
|
23577
|
+
const localVarQueryParameter = {};
|
|
23578
|
+
// authentication BearerAuth required
|
|
23579
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23580
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23581
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23582
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23583
|
+
return {
|
|
23584
|
+
url: toPathString(localVarUrlObj),
|
|
23585
|
+
options: localVarRequestOptions,
|
|
23586
|
+
};
|
|
23587
|
+
}),
|
|
23588
|
+
/**
|
|
23589
|
+
* Transitions a draft or paused experiment to running status.
|
|
23590
|
+
* @summary Start an experiment
|
|
23591
|
+
* @param {string} id Experiment ID (slug)
|
|
23592
|
+
* @param {*} [options] Override http request option.
|
|
23593
|
+
* @throws {RequiredError}
|
|
23594
|
+
*/
|
|
23595
|
+
v1AdminExperimentsIdStartPost: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
|
|
23596
|
+
// verify required parameter 'id' is not null or undefined
|
|
23597
|
+
assertParamExists('v1AdminExperimentsIdStartPost', 'id', id);
|
|
23598
|
+
const localVarPath = `/v1/admin/experiments/{id}/start`
|
|
23599
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
23600
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23601
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23602
|
+
let baseOptions;
|
|
23603
|
+
if (configuration) {
|
|
23604
|
+
baseOptions = configuration.baseOptions;
|
|
23605
|
+
}
|
|
23606
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23607
|
+
const localVarHeaderParameter = {};
|
|
23608
|
+
const localVarQueryParameter = {};
|
|
23609
|
+
// authentication BearerAuth required
|
|
23610
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23611
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23612
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23613
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23614
|
+
return {
|
|
23615
|
+
url: toPathString(localVarUrlObj),
|
|
23616
|
+
options: localVarRequestOptions,
|
|
23617
|
+
};
|
|
23618
|
+
}),
|
|
23619
|
+
/**
|
|
23620
|
+
* Creates a new A/B test experiment in draft status.
|
|
23621
|
+
* @summary Create a new experiment
|
|
23622
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
23623
|
+
* @param {*} [options] Override http request option.
|
|
23624
|
+
* @throws {RequiredError}
|
|
23625
|
+
*/
|
|
23626
|
+
v1AdminExperimentsPost: (dataTypesCreateExperimentRequest_1, ...args_1) => __awaiter(this, [dataTypesCreateExperimentRequest_1, ...args_1], void 0, function* (dataTypesCreateExperimentRequest, options = {}) {
|
|
23627
|
+
// verify required parameter 'dataTypesCreateExperimentRequest' is not null or undefined
|
|
23628
|
+
assertParamExists('v1AdminExperimentsPost', 'dataTypesCreateExperimentRequest', dataTypesCreateExperimentRequest);
|
|
23629
|
+
const localVarPath = `/v1/admin/experiments/`;
|
|
23630
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23631
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23632
|
+
let baseOptions;
|
|
23633
|
+
if (configuration) {
|
|
23634
|
+
baseOptions = configuration.baseOptions;
|
|
23635
|
+
}
|
|
23636
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
23637
|
+
const localVarHeaderParameter = {};
|
|
23638
|
+
const localVarQueryParameter = {};
|
|
23639
|
+
// authentication BearerAuth required
|
|
23640
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
23641
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
23642
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23643
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23644
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23645
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dataTypesCreateExperimentRequest, localVarRequestOptions, configuration);
|
|
23646
|
+
return {
|
|
23647
|
+
url: toPathString(localVarUrlObj),
|
|
23648
|
+
options: localVarRequestOptions,
|
|
23649
|
+
};
|
|
23650
|
+
}),
|
|
23651
|
+
/**
|
|
23652
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
23653
|
+
* @summary Get experiment assignments for a user
|
|
23654
|
+
* @param {string} xStoreid Store ID
|
|
23655
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
23656
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
23657
|
+
* @param {*} [options] Override http request option.
|
|
23658
|
+
* @throws {RequiredError}
|
|
23659
|
+
*/
|
|
23660
|
+
v1ExperimentsAssignmentGet: (xStoreid_1, xUserId_1, xAnonId_1, ...args_1) => __awaiter(this, [xStoreid_1, xUserId_1, xAnonId_1, ...args_1], void 0, function* (xStoreid, xUserId, xAnonId, options = {}) {
|
|
23661
|
+
// verify required parameter 'xStoreid' is not null or undefined
|
|
23662
|
+
assertParamExists('v1ExperimentsAssignmentGet', 'xStoreid', xStoreid);
|
|
23663
|
+
const localVarPath = `/v1/experiments/assignment`;
|
|
23664
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
23665
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
23666
|
+
let baseOptions;
|
|
23667
|
+
if (configuration) {
|
|
23668
|
+
baseOptions = configuration.baseOptions;
|
|
23669
|
+
}
|
|
23670
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
23671
|
+
const localVarHeaderParameter = {};
|
|
23672
|
+
const localVarQueryParameter = {};
|
|
23673
|
+
// authentication ApiKeyAuth required
|
|
23674
|
+
yield setApiKeyToObject(localVarHeaderParameter, "x-storesecret", configuration);
|
|
23675
|
+
if (xStoreid != null) {
|
|
23676
|
+
localVarHeaderParameter['x-storeid'] = String(xStoreid);
|
|
23677
|
+
}
|
|
23678
|
+
if (xUserId != null) {
|
|
23679
|
+
localVarHeaderParameter['x-user-id'] = String(xUserId);
|
|
23680
|
+
}
|
|
23681
|
+
if (xAnonId != null) {
|
|
23682
|
+
localVarHeaderParameter['x-anon-id'] = String(xAnonId);
|
|
23683
|
+
}
|
|
23684
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
23685
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
23686
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
23687
|
+
return {
|
|
23688
|
+
url: toPathString(localVarUrlObj),
|
|
23689
|
+
options: localVarRequestOptions,
|
|
23690
|
+
};
|
|
23691
|
+
}),
|
|
23692
|
+
};
|
|
23693
|
+
};
|
|
23694
|
+
/**
|
|
23695
|
+
* ExperimentsApi - functional programming interface
|
|
23696
|
+
* @export
|
|
23697
|
+
*/
|
|
23698
|
+
export const ExperimentsApiFp = function (configuration) {
|
|
23699
|
+
const localVarAxiosParamCreator = ExperimentsApiAxiosParamCreator(configuration);
|
|
23700
|
+
return {
|
|
23701
|
+
/**
|
|
23702
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
23703
|
+
* @summary List all experiments
|
|
23704
|
+
* @param {*} [options] Override http request option.
|
|
23705
|
+
* @throws {RequiredError}
|
|
23706
|
+
*/
|
|
23707
|
+
v1AdminExperimentsGet(options) {
|
|
23708
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23709
|
+
var _a, _b, _c;
|
|
23710
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsGet(options);
|
|
23711
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23712
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23713
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23714
|
+
});
|
|
23715
|
+
},
|
|
23716
|
+
/**
|
|
23717
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
23718
|
+
* @summary Complete an experiment
|
|
23719
|
+
* @param {string} id Experiment ID (slug)
|
|
23720
|
+
* @param {object} [body] Optional winner variant ID
|
|
23721
|
+
* @param {*} [options] Override http request option.
|
|
23722
|
+
* @throws {RequiredError}
|
|
23723
|
+
*/
|
|
23724
|
+
v1AdminExperimentsIdCompletePost(id, body, options) {
|
|
23725
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23726
|
+
var _a, _b, _c;
|
|
23727
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdCompletePost(id, body, options);
|
|
23728
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23729
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdCompletePost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23730
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23731
|
+
});
|
|
23732
|
+
},
|
|
23733
|
+
/**
|
|
23734
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
23735
|
+
* @summary Delete a draft experiment
|
|
23736
|
+
* @param {string} id Experiment ID (slug)
|
|
23737
|
+
* @param {*} [options] Override http request option.
|
|
23738
|
+
* @throws {RequiredError}
|
|
23739
|
+
*/
|
|
23740
|
+
v1AdminExperimentsIdDelete(id, options) {
|
|
23741
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23742
|
+
var _a, _b, _c;
|
|
23743
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdDelete(id, options);
|
|
23744
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23745
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdDelete']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23746
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23747
|
+
});
|
|
23748
|
+
},
|
|
23749
|
+
/**
|
|
23750
|
+
* Returns a single experiment by its experiment_id slug.
|
|
23751
|
+
* @summary Get experiment by ID
|
|
23752
|
+
* @param {string} id Experiment ID (slug)
|
|
23753
|
+
* @param {*} [options] Override http request option.
|
|
23754
|
+
* @throws {RequiredError}
|
|
23755
|
+
*/
|
|
23756
|
+
v1AdminExperimentsIdGet(id, options) {
|
|
23757
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23758
|
+
var _a, _b, _c;
|
|
23759
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdGet(id, options);
|
|
23760
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23761
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23762
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23763
|
+
});
|
|
23764
|
+
},
|
|
23765
|
+
/**
|
|
23766
|
+
* Transitions a running experiment to paused status.
|
|
23767
|
+
* @summary Pause an experiment
|
|
23768
|
+
* @param {string} id Experiment ID (slug)
|
|
23769
|
+
* @param {*} [options] Override http request option.
|
|
23770
|
+
* @throws {RequiredError}
|
|
23771
|
+
*/
|
|
23772
|
+
v1AdminExperimentsIdPausePost(id, options) {
|
|
23773
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23774
|
+
var _a, _b, _c;
|
|
23775
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdPausePost(id, options);
|
|
23776
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23777
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdPausePost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23778
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23779
|
+
});
|
|
23780
|
+
},
|
|
23781
|
+
/**
|
|
23782
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
23783
|
+
* @summary Update an experiment
|
|
23784
|
+
* @param {string} id Experiment ID (slug)
|
|
23785
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
23786
|
+
* @param {*} [options] Override http request option.
|
|
23787
|
+
* @throws {RequiredError}
|
|
23788
|
+
*/
|
|
23789
|
+
v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options) {
|
|
23790
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23791
|
+
var _a, _b, _c;
|
|
23792
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options);
|
|
23793
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23794
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdPut']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23795
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23796
|
+
});
|
|
23797
|
+
},
|
|
23798
|
+
/**
|
|
23799
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
23800
|
+
* @summary Get experiment results
|
|
23801
|
+
* @param {string} id Experiment ID (slug)
|
|
23802
|
+
* @param {*} [options] Override http request option.
|
|
23803
|
+
* @throws {RequiredError}
|
|
23804
|
+
*/
|
|
23805
|
+
v1AdminExperimentsIdResultsGet(id, options) {
|
|
23806
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23807
|
+
var _a, _b, _c;
|
|
23808
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdResultsGet(id, options);
|
|
23809
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23810
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdResultsGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23811
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23812
|
+
});
|
|
23813
|
+
},
|
|
23814
|
+
/**
|
|
23815
|
+
* Transitions a draft or paused experiment to running status.
|
|
23816
|
+
* @summary Start an experiment
|
|
23817
|
+
* @param {string} id Experiment ID (slug)
|
|
23818
|
+
* @param {*} [options] Override http request option.
|
|
23819
|
+
* @throws {RequiredError}
|
|
23820
|
+
*/
|
|
23821
|
+
v1AdminExperimentsIdStartPost(id, options) {
|
|
23822
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23823
|
+
var _a, _b, _c;
|
|
23824
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsIdStartPost(id, options);
|
|
23825
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23826
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsIdStartPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23827
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23828
|
+
});
|
|
23829
|
+
},
|
|
23830
|
+
/**
|
|
23831
|
+
* Creates a new A/B test experiment in draft status.
|
|
23832
|
+
* @summary Create a new experiment
|
|
23833
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
23834
|
+
* @param {*} [options] Override http request option.
|
|
23835
|
+
* @throws {RequiredError}
|
|
23836
|
+
*/
|
|
23837
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options) {
|
|
23838
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23839
|
+
var _a, _b, _c;
|
|
23840
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options);
|
|
23841
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23842
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1AdminExperimentsPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23843
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23844
|
+
});
|
|
23845
|
+
},
|
|
23846
|
+
/**
|
|
23847
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
23848
|
+
* @summary Get experiment assignments for a user
|
|
23849
|
+
* @param {string} xStoreid Store ID
|
|
23850
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
23851
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
23852
|
+
* @param {*} [options] Override http request option.
|
|
23853
|
+
* @throws {RequiredError}
|
|
23854
|
+
*/
|
|
23855
|
+
v1ExperimentsAssignmentGet(xStoreid, xUserId, xAnonId, options) {
|
|
23856
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
23857
|
+
var _a, _b, _c;
|
|
23858
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.v1ExperimentsAssignmentGet(xStoreid, xUserId, xAnonId, options);
|
|
23859
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
23860
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ExperimentsApi.v1ExperimentsAssignmentGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
23861
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
23862
|
+
});
|
|
23863
|
+
},
|
|
23864
|
+
};
|
|
23865
|
+
};
|
|
23866
|
+
/**
|
|
23867
|
+
* ExperimentsApi - factory interface
|
|
23868
|
+
* @export
|
|
23869
|
+
*/
|
|
23870
|
+
export const ExperimentsApiFactory = function (configuration, basePath, axios) {
|
|
23871
|
+
const localVarFp = ExperimentsApiFp(configuration);
|
|
23872
|
+
return {
|
|
23873
|
+
/**
|
|
23874
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
23875
|
+
* @summary List all experiments
|
|
23876
|
+
* @param {*} [options] Override http request option.
|
|
23877
|
+
* @throws {RequiredError}
|
|
23878
|
+
*/
|
|
23879
|
+
v1AdminExperimentsGet(options) {
|
|
23880
|
+
return localVarFp.v1AdminExperimentsGet(options).then((request) => request(axios, basePath));
|
|
23881
|
+
},
|
|
23882
|
+
/**
|
|
23883
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
23884
|
+
* @summary Complete an experiment
|
|
23885
|
+
* @param {string} id Experiment ID (slug)
|
|
23886
|
+
* @param {object} [body] Optional winner variant ID
|
|
23887
|
+
* @param {*} [options] Override http request option.
|
|
23888
|
+
* @throws {RequiredError}
|
|
23889
|
+
*/
|
|
23890
|
+
v1AdminExperimentsIdCompletePost(id, body, options) {
|
|
23891
|
+
return localVarFp.v1AdminExperimentsIdCompletePost(id, body, options).then((request) => request(axios, basePath));
|
|
23892
|
+
},
|
|
23893
|
+
/**
|
|
23894
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
23895
|
+
* @summary Delete a draft experiment
|
|
23896
|
+
* @param {string} id Experiment ID (slug)
|
|
23897
|
+
* @param {*} [options] Override http request option.
|
|
23898
|
+
* @throws {RequiredError}
|
|
23899
|
+
*/
|
|
23900
|
+
v1AdminExperimentsIdDelete(id, options) {
|
|
23901
|
+
return localVarFp.v1AdminExperimentsIdDelete(id, options).then((request) => request(axios, basePath));
|
|
23902
|
+
},
|
|
23903
|
+
/**
|
|
23904
|
+
* Returns a single experiment by its experiment_id slug.
|
|
23905
|
+
* @summary Get experiment by ID
|
|
23906
|
+
* @param {string} id Experiment ID (slug)
|
|
23907
|
+
* @param {*} [options] Override http request option.
|
|
23908
|
+
* @throws {RequiredError}
|
|
23909
|
+
*/
|
|
23910
|
+
v1AdminExperimentsIdGet(id, options) {
|
|
23911
|
+
return localVarFp.v1AdminExperimentsIdGet(id, options).then((request) => request(axios, basePath));
|
|
23912
|
+
},
|
|
23913
|
+
/**
|
|
23914
|
+
* Transitions a running experiment to paused status.
|
|
23915
|
+
* @summary Pause an experiment
|
|
23916
|
+
* @param {string} id Experiment ID (slug)
|
|
23917
|
+
* @param {*} [options] Override http request option.
|
|
23918
|
+
* @throws {RequiredError}
|
|
23919
|
+
*/
|
|
23920
|
+
v1AdminExperimentsIdPausePost(id, options) {
|
|
23921
|
+
return localVarFp.v1AdminExperimentsIdPausePost(id, options).then((request) => request(axios, basePath));
|
|
23922
|
+
},
|
|
23923
|
+
/**
|
|
23924
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
23925
|
+
* @summary Update an experiment
|
|
23926
|
+
* @param {string} id Experiment ID (slug)
|
|
23927
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
23928
|
+
* @param {*} [options] Override http request option.
|
|
23929
|
+
* @throws {RequiredError}
|
|
23930
|
+
*/
|
|
23931
|
+
v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options) {
|
|
23932
|
+
return localVarFp.v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options).then((request) => request(axios, basePath));
|
|
23933
|
+
},
|
|
23934
|
+
/**
|
|
23935
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
23936
|
+
* @summary Get experiment results
|
|
23937
|
+
* @param {string} id Experiment ID (slug)
|
|
23938
|
+
* @param {*} [options] Override http request option.
|
|
23939
|
+
* @throws {RequiredError}
|
|
23940
|
+
*/
|
|
23941
|
+
v1AdminExperimentsIdResultsGet(id, options) {
|
|
23942
|
+
return localVarFp.v1AdminExperimentsIdResultsGet(id, options).then((request) => request(axios, basePath));
|
|
23943
|
+
},
|
|
23944
|
+
/**
|
|
23945
|
+
* Transitions a draft or paused experiment to running status.
|
|
23946
|
+
* @summary Start an experiment
|
|
23947
|
+
* @param {string} id Experiment ID (slug)
|
|
23948
|
+
* @param {*} [options] Override http request option.
|
|
23949
|
+
* @throws {RequiredError}
|
|
23950
|
+
*/
|
|
23951
|
+
v1AdminExperimentsIdStartPost(id, options) {
|
|
23952
|
+
return localVarFp.v1AdminExperimentsIdStartPost(id, options).then((request) => request(axios, basePath));
|
|
23953
|
+
},
|
|
23954
|
+
/**
|
|
23955
|
+
* Creates a new A/B test experiment in draft status.
|
|
23956
|
+
* @summary Create a new experiment
|
|
23957
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
23958
|
+
* @param {*} [options] Override http request option.
|
|
23959
|
+
* @throws {RequiredError}
|
|
23960
|
+
*/
|
|
23961
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options) {
|
|
23962
|
+
return localVarFp.v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options).then((request) => request(axios, basePath));
|
|
23963
|
+
},
|
|
23964
|
+
/**
|
|
23965
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
23966
|
+
* @summary Get experiment assignments for a user
|
|
23967
|
+
* @param {string} xStoreid Store ID
|
|
23968
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
23969
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
23970
|
+
* @param {*} [options] Override http request option.
|
|
23971
|
+
* @throws {RequiredError}
|
|
23972
|
+
*/
|
|
23973
|
+
v1ExperimentsAssignmentGet(xStoreid, xUserId, xAnonId, options) {
|
|
23974
|
+
return localVarFp.v1ExperimentsAssignmentGet(xStoreid, xUserId, xAnonId, options).then((request) => request(axios, basePath));
|
|
23975
|
+
},
|
|
23976
|
+
};
|
|
23977
|
+
};
|
|
23978
|
+
/**
|
|
23979
|
+
* ExperimentsApi - object-oriented interface
|
|
23980
|
+
* @export
|
|
23981
|
+
* @class ExperimentsApi
|
|
23982
|
+
* @extends {BaseAPI}
|
|
23983
|
+
*/
|
|
23984
|
+
export class ExperimentsApi extends BaseAPI {
|
|
23985
|
+
/**
|
|
23986
|
+
* Returns all experiments for the authenticated organization, optionally filtered by store.
|
|
23987
|
+
* @summary List all experiments
|
|
23988
|
+
* @param {*} [options] Override http request option.
|
|
23989
|
+
* @throws {RequiredError}
|
|
23990
|
+
* @memberof ExperimentsApi
|
|
23991
|
+
*/
|
|
23992
|
+
v1AdminExperimentsGet(options) {
|
|
23993
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsGet(options).then((request) => request(this.axios, this.basePath));
|
|
23994
|
+
}
|
|
23995
|
+
/**
|
|
23996
|
+
* Transitions a running or paused experiment to completed status, optionally declaring a winner.
|
|
23997
|
+
* @summary Complete an experiment
|
|
23998
|
+
* @param {string} id Experiment ID (slug)
|
|
23999
|
+
* @param {object} [body] Optional winner variant ID
|
|
24000
|
+
* @param {*} [options] Override http request option.
|
|
24001
|
+
* @throws {RequiredError}
|
|
24002
|
+
* @memberof ExperimentsApi
|
|
24003
|
+
*/
|
|
24004
|
+
v1AdminExperimentsIdCompletePost(id, body, options) {
|
|
24005
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdCompletePost(id, body, options).then((request) => request(this.axios, this.basePath));
|
|
24006
|
+
}
|
|
24007
|
+
/**
|
|
24008
|
+
* Deletes an experiment. Only experiments in draft status can be deleted.
|
|
24009
|
+
* @summary Delete a draft experiment
|
|
24010
|
+
* @param {string} id Experiment ID (slug)
|
|
24011
|
+
* @param {*} [options] Override http request option.
|
|
24012
|
+
* @throws {RequiredError}
|
|
24013
|
+
* @memberof ExperimentsApi
|
|
24014
|
+
*/
|
|
24015
|
+
v1AdminExperimentsIdDelete(id, options) {
|
|
24016
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdDelete(id, options).then((request) => request(this.axios, this.basePath));
|
|
24017
|
+
}
|
|
24018
|
+
/**
|
|
24019
|
+
* Returns a single experiment by its experiment_id slug.
|
|
24020
|
+
* @summary Get experiment by ID
|
|
24021
|
+
* @param {string} id Experiment ID (slug)
|
|
24022
|
+
* @param {*} [options] Override http request option.
|
|
24023
|
+
* @throws {RequiredError}
|
|
24024
|
+
* @memberof ExperimentsApi
|
|
24025
|
+
*/
|
|
24026
|
+
v1AdminExperimentsIdGet(id, options) {
|
|
24027
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdGet(id, options).then((request) => request(this.axios, this.basePath));
|
|
24028
|
+
}
|
|
24029
|
+
/**
|
|
24030
|
+
* Transitions a running experiment to paused status.
|
|
24031
|
+
* @summary Pause an experiment
|
|
24032
|
+
* @param {string} id Experiment ID (slug)
|
|
24033
|
+
* @param {*} [options] Override http request option.
|
|
24034
|
+
* @throws {RequiredError}
|
|
24035
|
+
* @memberof ExperimentsApi
|
|
24036
|
+
*/
|
|
24037
|
+
v1AdminExperimentsIdPausePost(id, options) {
|
|
24038
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdPausePost(id, options).then((request) => request(this.axios, this.basePath));
|
|
24039
|
+
}
|
|
24040
|
+
/**
|
|
24041
|
+
* Updates an existing experiment. Only draft experiments can be fully updated.
|
|
24042
|
+
* @summary Update an experiment
|
|
24043
|
+
* @param {string} id Experiment ID (slug)
|
|
24044
|
+
* @param {DataTypesUpdateExperimentRequest} dataTypesUpdateExperimentRequest Fields to update
|
|
24045
|
+
* @param {*} [options] Override http request option.
|
|
24046
|
+
* @throws {RequiredError}
|
|
24047
|
+
* @memberof ExperimentsApi
|
|
24048
|
+
*/
|
|
24049
|
+
v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options) {
|
|
24050
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdPut(id, dataTypesUpdateExperimentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
24051
|
+
}
|
|
24052
|
+
/**
|
|
24053
|
+
* Returns analytics results for an experiment from ClickHouse, including per-variant metrics, lifts, and statistical significance.
|
|
24054
|
+
* @summary Get experiment results
|
|
24055
|
+
* @param {string} id Experiment ID (slug)
|
|
24056
|
+
* @param {*} [options] Override http request option.
|
|
24057
|
+
* @throws {RequiredError}
|
|
24058
|
+
* @memberof ExperimentsApi
|
|
24059
|
+
*/
|
|
24060
|
+
v1AdminExperimentsIdResultsGet(id, options) {
|
|
24061
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdResultsGet(id, options).then((request) => request(this.axios, this.basePath));
|
|
24062
|
+
}
|
|
24063
|
+
/**
|
|
24064
|
+
* Transitions a draft or paused experiment to running status.
|
|
24065
|
+
* @summary Start an experiment
|
|
24066
|
+
* @param {string} id Experiment ID (slug)
|
|
24067
|
+
* @param {*} [options] Override http request option.
|
|
24068
|
+
* @throws {RequiredError}
|
|
24069
|
+
* @memberof ExperimentsApi
|
|
24070
|
+
*/
|
|
24071
|
+
v1AdminExperimentsIdStartPost(id, options) {
|
|
24072
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsIdStartPost(id, options).then((request) => request(this.axios, this.basePath));
|
|
24073
|
+
}
|
|
24074
|
+
/**
|
|
24075
|
+
* Creates a new A/B test experiment in draft status.
|
|
24076
|
+
* @summary Create a new experiment
|
|
24077
|
+
* @param {DataTypesCreateExperimentRequest} dataTypesCreateExperimentRequest Experiment data
|
|
24078
|
+
* @param {*} [options] Override http request option.
|
|
24079
|
+
* @throws {RequiredError}
|
|
24080
|
+
* @memberof ExperimentsApi
|
|
24081
|
+
*/
|
|
24082
|
+
v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options) {
|
|
24083
|
+
return ExperimentsApiFp(this.configuration).v1AdminExperimentsPost(dataTypesCreateExperimentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
24084
|
+
}
|
|
24085
|
+
/**
|
|
24086
|
+
* Returns variant assignments for all running experiments for the requesting user. Uses hash-based consistent assignment.
|
|
24087
|
+
* @summary Get experiment assignments for a user
|
|
24088
|
+
* @param {string} xStoreid Store ID
|
|
24089
|
+
* @param {string} [xUserId] User ID (provide either x-user-id or x-anon-id)
|
|
24090
|
+
* @param {string} [xAnonId] Anonymous ID (provide either x-user-id or x-anon-id)
|
|
24091
|
+
* @param {*} [options] Override http request option.
|
|
24092
|
+
* @throws {RequiredError}
|
|
24093
|
+
* @memberof ExperimentsApi
|
|
24094
|
+
*/
|
|
24095
|
+
v1ExperimentsAssignmentGet(xStoreid, xUserId, xAnonId, options) {
|
|
24096
|
+
return ExperimentsApiFp(this.configuration).v1ExperimentsAssignmentGet(xStoreid, xUserId, xAnonId, options).then((request) => request(this.axios, this.basePath));
|
|
24097
|
+
}
|
|
24098
|
+
}
|
|
23335
24099
|
/**
|
|
23336
24100
|
* ExternalAPINotificationsApi - axios parameter creator
|
|
23337
24101
|
* @export
|