@teemill/product-catalog 1.84.0 → 1.86.0
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 +6 -2
- package/api.ts +425 -17
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +246 -9
- package/dist/api.js +218 -16
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +246 -9
- package/dist/esm/api.js +216 -15
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Action.md +32 -0
- package/docs/AnalyticsSummary.md +26 -0
- package/docs/ProductAnalyticsApi.md +125 -4
- package/docs/Recommendation.md +34 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.86.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,13 +22,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
25
|
+
exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ExportProductsDateFilterTypeEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ProductTypesApi = exports.ProductTypesApiFactory = exports.ProductTypesApiFp = exports.ProductTypesApiAxiosParamCreator = exports.ProductAnalyticsApi = exports.ProductAnalyticsApiFactory = exports.ProductAnalyticsApiFp = exports.ProductAnalyticsApiAxiosParamCreator = exports.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.ApplicationGroupsApi = exports.ApplicationGroupsApiFactory = exports.ApplicationGroupsApiFp = exports.ApplicationGroupsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.TextApplicationPropertiesPersonalizationTypeEnum = exports.TextApplicationPropertiesFontStyleEnum = exports.TextApplicationPropertiesFontWeightEnum = exports.SalePriceCurrencyCodeEnum = exports.RequiredPriceCurrencyCodeEnum = exports.RecommendationPriorityEnum = exports.PriceCurrencyCodeEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = exports.ActionImpactEnum = void 0;
|
|
26
|
+
exports.VariantsApi = void 0;
|
|
26
27
|
const axios_1 = require("axios");
|
|
27
28
|
// Some imports not used depending on template conditions
|
|
28
29
|
// @ts-ignore
|
|
29
30
|
const common_1 = require("./common");
|
|
30
31
|
// @ts-ignore
|
|
31
32
|
const base_1 = require("./base");
|
|
33
|
+
exports.ActionImpactEnum = {
|
|
34
|
+
High: 'high',
|
|
35
|
+
Medium: 'medium',
|
|
36
|
+
Low: 'low'
|
|
37
|
+
};
|
|
32
38
|
exports.ApplicationTechnologyEnum = {
|
|
33
39
|
Dtg: 'dtg',
|
|
34
40
|
Embroidery: 'embroidery',
|
|
@@ -103,6 +109,11 @@ exports.CreateApplicationPropertiesFontStyleEnum = {
|
|
|
103
109
|
exports.PriceCurrencyCodeEnum = {
|
|
104
110
|
Gbp: 'GBP'
|
|
105
111
|
};
|
|
112
|
+
exports.RecommendationPriorityEnum = {
|
|
113
|
+
High: 'high',
|
|
114
|
+
Medium: 'medium',
|
|
115
|
+
Low: 'low'
|
|
116
|
+
};
|
|
106
117
|
exports.RequiredPriceCurrencyCodeEnum = {
|
|
107
118
|
Gbp: 'GBP'
|
|
108
119
|
};
|
|
@@ -1118,10 +1129,22 @@ const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1118
1129
|
* Exports all products with analytics data in a CSV file.
|
|
1119
1130
|
* @summary Export product analytics
|
|
1120
1131
|
* @param {string} project What project it is
|
|
1132
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1133
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
1134
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1135
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
1136
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
1137
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
1138
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
1139
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
1140
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
1141
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1142
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1143
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1121
1144
|
* @param {*} [options] Override http request option.
|
|
1122
1145
|
* @throws {RequiredError}
|
|
1123
1146
|
*/
|
|
1124
|
-
exportProductAnalytics: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
1147
|
+
exportProductAnalytics: (project_1, sortBy_1, search_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, ...args_1) => __awaiter(this, [project_1, sortBy_1, search_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, ...args_1], void 0, function* (project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options = {}) {
|
|
1125
1148
|
// verify required parameter 'project' is not null or undefined
|
|
1126
1149
|
(0, common_1.assertParamExists)('exportProductAnalytics', 'project', project);
|
|
1127
1150
|
const localVarPath = `/v1/catalog/analytics/export`;
|
|
@@ -1142,6 +1165,46 @@ const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1142
1165
|
if (project !== undefined) {
|
|
1143
1166
|
localVarQueryParameter['project'] = project;
|
|
1144
1167
|
}
|
|
1168
|
+
if (sortBy) {
|
|
1169
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1170
|
+
}
|
|
1171
|
+
if (search !== undefined) {
|
|
1172
|
+
localVarQueryParameter['search'] = search;
|
|
1173
|
+
}
|
|
1174
|
+
if (dateRangeStartDate !== undefined) {
|
|
1175
|
+
localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate instanceof Date) ?
|
|
1176
|
+
dateRangeStartDate.toISOString() :
|
|
1177
|
+
dateRangeStartDate;
|
|
1178
|
+
}
|
|
1179
|
+
if (dateRangeEndDate !== undefined) {
|
|
1180
|
+
localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate instanceof Date) ?
|
|
1181
|
+
dateRangeEndDate.toISOString() :
|
|
1182
|
+
dateRangeEndDate;
|
|
1183
|
+
}
|
|
1184
|
+
if (minimumRevenue !== undefined) {
|
|
1185
|
+
localVarQueryParameter['minimumRevenue'] = minimumRevenue;
|
|
1186
|
+
}
|
|
1187
|
+
if (maximumRevenue !== undefined) {
|
|
1188
|
+
localVarQueryParameter['maximumRevenue'] = maximumRevenue;
|
|
1189
|
+
}
|
|
1190
|
+
if (minimumSales !== undefined) {
|
|
1191
|
+
localVarQueryParameter['minimumSales'] = minimumSales;
|
|
1192
|
+
}
|
|
1193
|
+
if (maximumSales !== undefined) {
|
|
1194
|
+
localVarQueryParameter['maximumSales'] = maximumSales;
|
|
1195
|
+
}
|
|
1196
|
+
if (minimumBasketPercent !== undefined) {
|
|
1197
|
+
localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
|
|
1198
|
+
}
|
|
1199
|
+
if (maximumBasketPercent !== undefined) {
|
|
1200
|
+
localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
|
|
1201
|
+
}
|
|
1202
|
+
if (minimumTraffic !== undefined) {
|
|
1203
|
+
localVarQueryParameter['minimumTraffic'] = minimumTraffic;
|
|
1204
|
+
}
|
|
1205
|
+
if (maximumTraffic !== undefined) {
|
|
1206
|
+
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
1207
|
+
}
|
|
1145
1208
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
1146
1209
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1147
1210
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1151,18 +1214,65 @@ const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1151
1214
|
options: localVarRequestOptions,
|
|
1152
1215
|
};
|
|
1153
1216
|
}),
|
|
1217
|
+
/**
|
|
1218
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1219
|
+
* @summary Get product analytics summary
|
|
1220
|
+
* @param {string} project What project it is
|
|
1221
|
+
* @param {*} [options] Override http request option.
|
|
1222
|
+
* @throws {RequiredError}
|
|
1223
|
+
*/
|
|
1224
|
+
getProductAnalyticsSummary: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
1225
|
+
// verify required parameter 'project' is not null or undefined
|
|
1226
|
+
(0, common_1.assertParamExists)('getProductAnalyticsSummary', 'project', project);
|
|
1227
|
+
const localVarPath = `/v1/catalog/analytics/summary`;
|
|
1228
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1229
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1230
|
+
let baseOptions;
|
|
1231
|
+
if (configuration) {
|
|
1232
|
+
baseOptions = configuration.baseOptions;
|
|
1233
|
+
}
|
|
1234
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1235
|
+
const localVarHeaderParameter = {};
|
|
1236
|
+
const localVarQueryParameter = {};
|
|
1237
|
+
// authentication session-oauth required
|
|
1238
|
+
// oauth required
|
|
1239
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1240
|
+
// authentication api-key required
|
|
1241
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1242
|
+
if (project !== undefined) {
|
|
1243
|
+
localVarQueryParameter['project'] = project;
|
|
1244
|
+
}
|
|
1245
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1246
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1247
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1248
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1249
|
+
return {
|
|
1250
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1251
|
+
options: localVarRequestOptions,
|
|
1252
|
+
};
|
|
1253
|
+
}),
|
|
1154
1254
|
/**
|
|
1155
1255
|
* Lists all product analytics items.
|
|
1156
1256
|
* @summary List product analytics
|
|
1157
1257
|
* @param {string} project What project it is
|
|
1158
1258
|
* @param {number} [pageToken] Page reference token
|
|
1259
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1159
1260
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
1160
1261
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1161
|
-
* @param {
|
|
1262
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1263
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
1264
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
1265
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
1266
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
1267
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
1268
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
1269
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1270
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1271
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1162
1272
|
* @param {*} [options] Override http request option.
|
|
1163
1273
|
* @throws {RequiredError}
|
|
1164
1274
|
*/
|
|
1165
|
-
listProductAnalytics: (project_1, pageToken_1, search_1, sortBy_1,
|
|
1275
|
+
listProductAnalytics: (project_1, pageToken_1, pageSize_1, search_1, sortBy_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, search_1, sortBy_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, ...args_1], void 0, function* (project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options = {}) {
|
|
1166
1276
|
// verify required parameter 'project' is not null or undefined
|
|
1167
1277
|
(0, common_1.assertParamExists)('listProductAnalytics', 'project', project);
|
|
1168
1278
|
const localVarPath = `/v1/catalog/analytics`;
|
|
@@ -1186,14 +1296,48 @@ const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1186
1296
|
if (pageToken !== undefined) {
|
|
1187
1297
|
localVarQueryParameter['pageToken'] = pageToken;
|
|
1188
1298
|
}
|
|
1299
|
+
if (pageSize !== undefined) {
|
|
1300
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1301
|
+
}
|
|
1189
1302
|
if (search !== undefined) {
|
|
1190
1303
|
localVarQueryParameter['search'] = search;
|
|
1191
1304
|
}
|
|
1192
1305
|
if (sortBy) {
|
|
1193
1306
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
1194
1307
|
}
|
|
1195
|
-
if (
|
|
1196
|
-
localVarQueryParameter['
|
|
1308
|
+
if (dateRangeStartDate !== undefined) {
|
|
1309
|
+
localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate instanceof Date) ?
|
|
1310
|
+
dateRangeStartDate.toISOString() :
|
|
1311
|
+
dateRangeStartDate;
|
|
1312
|
+
}
|
|
1313
|
+
if (dateRangeEndDate !== undefined) {
|
|
1314
|
+
localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate instanceof Date) ?
|
|
1315
|
+
dateRangeEndDate.toISOString() :
|
|
1316
|
+
dateRangeEndDate;
|
|
1317
|
+
}
|
|
1318
|
+
if (minimumRevenue !== undefined) {
|
|
1319
|
+
localVarQueryParameter['minimumRevenue'] = minimumRevenue;
|
|
1320
|
+
}
|
|
1321
|
+
if (maximumRevenue !== undefined) {
|
|
1322
|
+
localVarQueryParameter['maximumRevenue'] = maximumRevenue;
|
|
1323
|
+
}
|
|
1324
|
+
if (minimumSales !== undefined) {
|
|
1325
|
+
localVarQueryParameter['minimumSales'] = minimumSales;
|
|
1326
|
+
}
|
|
1327
|
+
if (maximumSales !== undefined) {
|
|
1328
|
+
localVarQueryParameter['maximumSales'] = maximumSales;
|
|
1329
|
+
}
|
|
1330
|
+
if (minimumBasketPercent !== undefined) {
|
|
1331
|
+
localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
|
|
1332
|
+
}
|
|
1333
|
+
if (maximumBasketPercent !== undefined) {
|
|
1334
|
+
localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
|
|
1335
|
+
}
|
|
1336
|
+
if (minimumTraffic !== undefined) {
|
|
1337
|
+
localVarQueryParameter['minimumTraffic'] = minimumTraffic;
|
|
1338
|
+
}
|
|
1339
|
+
if (maximumTraffic !== undefined) {
|
|
1340
|
+
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
1197
1341
|
}
|
|
1198
1342
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1199
1343
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1217,33 +1361,71 @@ const ProductAnalyticsApiFp = function (configuration) {
|
|
|
1217
1361
|
* Exports all products with analytics data in a CSV file.
|
|
1218
1362
|
* @summary Export product analytics
|
|
1219
1363
|
* @param {string} project What project it is
|
|
1364
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1365
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
1366
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1367
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
1368
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
1369
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
1370
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
1371
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
1372
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
1373
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1374
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1375
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1220
1376
|
* @param {*} [options] Override http request option.
|
|
1221
1377
|
* @throws {RequiredError}
|
|
1222
1378
|
*/
|
|
1223
|
-
exportProductAnalytics(project, options) {
|
|
1379
|
+
exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options) {
|
|
1224
1380
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1225
1381
|
var _a, _b, _c;
|
|
1226
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProductAnalytics(project, options);
|
|
1382
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
|
|
1227
1383
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1228
1384
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductAnalyticsApi.exportProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1229
1385
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1230
1386
|
});
|
|
1231
1387
|
},
|
|
1388
|
+
/**
|
|
1389
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1390
|
+
* @summary Get product analytics summary
|
|
1391
|
+
* @param {string} project What project it is
|
|
1392
|
+
* @param {*} [options] Override http request option.
|
|
1393
|
+
* @throws {RequiredError}
|
|
1394
|
+
*/
|
|
1395
|
+
getProductAnalyticsSummary(project, options) {
|
|
1396
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1397
|
+
var _a, _b, _c;
|
|
1398
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductAnalyticsSummary(project, options);
|
|
1399
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1400
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductAnalyticsApi.getProductAnalyticsSummary']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1401
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1402
|
+
});
|
|
1403
|
+
},
|
|
1232
1404
|
/**
|
|
1233
1405
|
* Lists all product analytics items.
|
|
1234
1406
|
* @summary List product analytics
|
|
1235
1407
|
* @param {string} project What project it is
|
|
1236
1408
|
* @param {number} [pageToken] Page reference token
|
|
1409
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1237
1410
|
* @param {string} [search] Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas.
|
|
1238
1411
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1239
|
-
* @param {
|
|
1412
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1413
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
1414
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
1415
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
1416
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
1417
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
1418
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
1419
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1420
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1421
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1240
1422
|
* @param {*} [options] Override http request option.
|
|
1241
1423
|
* @throws {RequiredError}
|
|
1242
1424
|
*/
|
|
1243
|
-
listProductAnalytics(project, pageToken, search, sortBy,
|
|
1425
|
+
listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options) {
|
|
1244
1426
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1245
1427
|
var _a, _b, _c;
|
|
1246
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, search, sortBy,
|
|
1428
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
|
|
1247
1429
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1248
1430
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductAnalyticsApi.listProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1249
1431
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1266,7 +1448,17 @@ const ProductAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
1266
1448
|
* @throws {RequiredError}
|
|
1267
1449
|
*/
|
|
1268
1450
|
exportProductAnalytics(requestParameters, options) {
|
|
1269
|
-
return localVarFp.exportProductAnalytics(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
1451
|
+
return localVarFp.exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(axios, basePath));
|
|
1452
|
+
},
|
|
1453
|
+
/**
|
|
1454
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1455
|
+
* @summary Get product analytics summary
|
|
1456
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
1457
|
+
* @param {*} [options] Override http request option.
|
|
1458
|
+
* @throws {RequiredError}
|
|
1459
|
+
*/
|
|
1460
|
+
getProductAnalyticsSummary(requestParameters, options) {
|
|
1461
|
+
return localVarFp.getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
1270
1462
|
},
|
|
1271
1463
|
/**
|
|
1272
1464
|
* Lists all product analytics items.
|
|
@@ -1276,7 +1468,7 @@ const ProductAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
1276
1468
|
* @throws {RequiredError}
|
|
1277
1469
|
*/
|
|
1278
1470
|
listProductAnalytics(requestParameters, options) {
|
|
1279
|
-
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.
|
|
1471
|
+
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(axios, basePath));
|
|
1280
1472
|
},
|
|
1281
1473
|
};
|
|
1282
1474
|
};
|
|
@@ -1293,7 +1485,17 @@ class ProductAnalyticsApi extends base_1.BaseAPI {
|
|
|
1293
1485
|
* @throws {RequiredError}
|
|
1294
1486
|
*/
|
|
1295
1487
|
exportProductAnalytics(requestParameters, options) {
|
|
1296
|
-
return (0, exports.ProductAnalyticsApiFp)(this.configuration).exportProductAnalytics(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
1488
|
+
return (0, exports.ProductAnalyticsApiFp)(this.configuration).exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(this.axios, this.basePath));
|
|
1489
|
+
}
|
|
1490
|
+
/**
|
|
1491
|
+
* Get the AI-generated summary of the product analytics for the given project.
|
|
1492
|
+
* @summary Get product analytics summary
|
|
1493
|
+
* @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
|
|
1494
|
+
* @param {*} [options] Override http request option.
|
|
1495
|
+
* @throws {RequiredError}
|
|
1496
|
+
*/
|
|
1497
|
+
getProductAnalyticsSummary(requestParameters, options) {
|
|
1498
|
+
return (0, exports.ProductAnalyticsApiFp)(this.configuration).getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
1297
1499
|
}
|
|
1298
1500
|
/**
|
|
1299
1501
|
* Lists all product analytics items.
|
|
@@ -1303,7 +1505,7 @@ class ProductAnalyticsApi extends base_1.BaseAPI {
|
|
|
1303
1505
|
* @throws {RequiredError}
|
|
1304
1506
|
*/
|
|
1305
1507
|
listProductAnalytics(requestParameters, options) {
|
|
1306
|
-
return (0, exports.ProductAnalyticsApiFp)(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.
|
|
1508
|
+
return (0, exports.ProductAnalyticsApiFp)(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(this.axios, this.basePath));
|
|
1307
1509
|
}
|
|
1308
1510
|
}
|
|
1309
1511
|
exports.ProductAnalyticsApi = ProductAnalyticsApi;
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.86.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.86.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.86.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.86.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|