@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/dist/esm/api.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.84.0
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).
@@ -26,6 +26,11 @@ import globalAxios from 'axios';
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
27
27
  // @ts-ignore
28
28
  import { BASE_PATH, BaseAPI, operationServerMap } from './base';
29
+ export const ActionImpactEnum = {
30
+ High: 'high',
31
+ Medium: 'medium',
32
+ Low: 'low'
33
+ };
29
34
  export const ApplicationTechnologyEnum = {
30
35
  Dtg: 'dtg',
31
36
  Embroidery: 'embroidery',
@@ -100,6 +105,11 @@ export const CreateApplicationPropertiesFontStyleEnum = {
100
105
  export const PriceCurrencyCodeEnum = {
101
106
  Gbp: 'GBP'
102
107
  };
108
+ export const RecommendationPriorityEnum = {
109
+ High: 'high',
110
+ Medium: 'medium',
111
+ Low: 'low'
112
+ };
103
113
  export const RequiredPriceCurrencyCodeEnum = {
104
114
  Gbp: 'GBP'
105
115
  };
@@ -1103,10 +1113,22 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
1103
1113
  * Exports all products with analytics data in a CSV file.
1104
1114
  * @summary Export product analytics
1105
1115
  * @param {string} project What project it is
1116
+ * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1117
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas.
1118
+ * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
1119
+ * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
1120
+ * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
1121
+ * @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
1122
+ * @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
1123
+ * @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
1124
+ * @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
1125
+ * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
1126
+ * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
1127
+ * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
1106
1128
  * @param {*} [options] Override http request option.
1107
1129
  * @throws {RequiredError}
1108
1130
  */
1109
- exportProductAnalytics: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
1131
+ 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 = {}) {
1110
1132
  // verify required parameter 'project' is not null or undefined
1111
1133
  assertParamExists('exportProductAnalytics', 'project', project);
1112
1134
  const localVarPath = `/v1/catalog/analytics/export`;
@@ -1127,6 +1149,46 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
1127
1149
  if (project !== undefined) {
1128
1150
  localVarQueryParameter['project'] = project;
1129
1151
  }
1152
+ if (sortBy) {
1153
+ localVarQueryParameter['sortBy'] = sortBy;
1154
+ }
1155
+ if (search !== undefined) {
1156
+ localVarQueryParameter['search'] = search;
1157
+ }
1158
+ if (dateRangeStartDate !== undefined) {
1159
+ localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate instanceof Date) ?
1160
+ dateRangeStartDate.toISOString() :
1161
+ dateRangeStartDate;
1162
+ }
1163
+ if (dateRangeEndDate !== undefined) {
1164
+ localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate instanceof Date) ?
1165
+ dateRangeEndDate.toISOString() :
1166
+ dateRangeEndDate;
1167
+ }
1168
+ if (minimumRevenue !== undefined) {
1169
+ localVarQueryParameter['minimumRevenue'] = minimumRevenue;
1170
+ }
1171
+ if (maximumRevenue !== undefined) {
1172
+ localVarQueryParameter['maximumRevenue'] = maximumRevenue;
1173
+ }
1174
+ if (minimumSales !== undefined) {
1175
+ localVarQueryParameter['minimumSales'] = minimumSales;
1176
+ }
1177
+ if (maximumSales !== undefined) {
1178
+ localVarQueryParameter['maximumSales'] = maximumSales;
1179
+ }
1180
+ if (minimumBasketPercent !== undefined) {
1181
+ localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
1182
+ }
1183
+ if (maximumBasketPercent !== undefined) {
1184
+ localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
1185
+ }
1186
+ if (minimumTraffic !== undefined) {
1187
+ localVarQueryParameter['minimumTraffic'] = minimumTraffic;
1188
+ }
1189
+ if (maximumTraffic !== undefined) {
1190
+ localVarQueryParameter['maximumTraffic'] = maximumTraffic;
1191
+ }
1130
1192
  localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
1131
1193
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1132
1194
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1136,18 +1198,65 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
1136
1198
  options: localVarRequestOptions,
1137
1199
  };
1138
1200
  }),
1201
+ /**
1202
+ * Get the AI-generated summary of the product analytics for the given project.
1203
+ * @summary Get product analytics summary
1204
+ * @param {string} project What project it is
1205
+ * @param {*} [options] Override http request option.
1206
+ * @throws {RequiredError}
1207
+ */
1208
+ getProductAnalyticsSummary: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
1209
+ // verify required parameter 'project' is not null or undefined
1210
+ assertParamExists('getProductAnalyticsSummary', 'project', project);
1211
+ const localVarPath = `/v1/catalog/analytics/summary`;
1212
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1213
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1214
+ let baseOptions;
1215
+ if (configuration) {
1216
+ baseOptions = configuration.baseOptions;
1217
+ }
1218
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1219
+ const localVarHeaderParameter = {};
1220
+ const localVarQueryParameter = {};
1221
+ // authentication session-oauth required
1222
+ // oauth required
1223
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
1224
+ // authentication api-key required
1225
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1226
+ if (project !== undefined) {
1227
+ localVarQueryParameter['project'] = project;
1228
+ }
1229
+ localVarHeaderParameter['Accept'] = 'application/json';
1230
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1231
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1232
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1233
+ return {
1234
+ url: toPathString(localVarUrlObj),
1235
+ options: localVarRequestOptions,
1236
+ };
1237
+ }),
1139
1238
  /**
1140
1239
  * Lists all product analytics items.
1141
1240
  * @summary List product analytics
1142
1241
  * @param {string} project What project it is
1143
1242
  * @param {number} [pageToken] Page reference token
1243
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1144
1244
  * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas.
1145
1245
  * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1146
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1246
+ * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
1247
+ * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
1248
+ * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
1249
+ * @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
1250
+ * @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
1251
+ * @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
1252
+ * @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
1253
+ * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
1254
+ * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
1255
+ * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
1147
1256
  * @param {*} [options] Override http request option.
1148
1257
  * @throws {RequiredError}
1149
1258
  */
1150
- listProductAnalytics: (project_1, pageToken_1, search_1, sortBy_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, pageSize_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, pageSize, options = {}) {
1259
+ 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 = {}) {
1151
1260
  // verify required parameter 'project' is not null or undefined
1152
1261
  assertParamExists('listProductAnalytics', 'project', project);
1153
1262
  const localVarPath = `/v1/catalog/analytics`;
@@ -1171,14 +1280,48 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
1171
1280
  if (pageToken !== undefined) {
1172
1281
  localVarQueryParameter['pageToken'] = pageToken;
1173
1282
  }
1283
+ if (pageSize !== undefined) {
1284
+ localVarQueryParameter['pageSize'] = pageSize;
1285
+ }
1174
1286
  if (search !== undefined) {
1175
1287
  localVarQueryParameter['search'] = search;
1176
1288
  }
1177
1289
  if (sortBy) {
1178
1290
  localVarQueryParameter['sortBy'] = sortBy;
1179
1291
  }
1180
- if (pageSize !== undefined) {
1181
- localVarQueryParameter['pageSize'] = pageSize;
1292
+ if (dateRangeStartDate !== undefined) {
1293
+ localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate instanceof Date) ?
1294
+ dateRangeStartDate.toISOString() :
1295
+ dateRangeStartDate;
1296
+ }
1297
+ if (dateRangeEndDate !== undefined) {
1298
+ localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate instanceof Date) ?
1299
+ dateRangeEndDate.toISOString() :
1300
+ dateRangeEndDate;
1301
+ }
1302
+ if (minimumRevenue !== undefined) {
1303
+ localVarQueryParameter['minimumRevenue'] = minimumRevenue;
1304
+ }
1305
+ if (maximumRevenue !== undefined) {
1306
+ localVarQueryParameter['maximumRevenue'] = maximumRevenue;
1307
+ }
1308
+ if (minimumSales !== undefined) {
1309
+ localVarQueryParameter['minimumSales'] = minimumSales;
1310
+ }
1311
+ if (maximumSales !== undefined) {
1312
+ localVarQueryParameter['maximumSales'] = maximumSales;
1313
+ }
1314
+ if (minimumBasketPercent !== undefined) {
1315
+ localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
1316
+ }
1317
+ if (maximumBasketPercent !== undefined) {
1318
+ localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
1319
+ }
1320
+ if (minimumTraffic !== undefined) {
1321
+ localVarQueryParameter['minimumTraffic'] = minimumTraffic;
1322
+ }
1323
+ if (maximumTraffic !== undefined) {
1324
+ localVarQueryParameter['maximumTraffic'] = maximumTraffic;
1182
1325
  }
1183
1326
  localVarHeaderParameter['Accept'] = 'application/json';
1184
1327
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1201,33 +1344,71 @@ export const ProductAnalyticsApiFp = function (configuration) {
1201
1344
  * Exports all products with analytics data in a CSV file.
1202
1345
  * @summary Export product analytics
1203
1346
  * @param {string} project What project it is
1347
+ * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1348
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas.
1349
+ * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
1350
+ * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
1351
+ * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
1352
+ * @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
1353
+ * @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
1354
+ * @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
1355
+ * @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
1356
+ * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
1357
+ * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
1358
+ * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
1204
1359
  * @param {*} [options] Override http request option.
1205
1360
  * @throws {RequiredError}
1206
1361
  */
1207
- exportProductAnalytics(project, options) {
1362
+ exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options) {
1208
1363
  return __awaiter(this, void 0, void 0, function* () {
1209
1364
  var _a, _b, _c;
1210
- const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProductAnalytics(project, options);
1365
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
1211
1366
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1212
1367
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.exportProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1213
1368
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1214
1369
  });
1215
1370
  },
1371
+ /**
1372
+ * Get the AI-generated summary of the product analytics for the given project.
1373
+ * @summary Get product analytics summary
1374
+ * @param {string} project What project it is
1375
+ * @param {*} [options] Override http request option.
1376
+ * @throws {RequiredError}
1377
+ */
1378
+ getProductAnalyticsSummary(project, options) {
1379
+ return __awaiter(this, void 0, void 0, function* () {
1380
+ var _a, _b, _c;
1381
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductAnalyticsSummary(project, options);
1382
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1383
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.getProductAnalyticsSummary']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1384
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1385
+ });
1386
+ },
1216
1387
  /**
1217
1388
  * Lists all product analytics items.
1218
1389
  * @summary List product analytics
1219
1390
  * @param {string} project What project it is
1220
1391
  * @param {number} [pageToken] Page reference token
1392
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1221
1393
  * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas.
1222
1394
  * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1223
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1395
+ * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
1396
+ * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
1397
+ * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
1398
+ * @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
1399
+ * @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
1400
+ * @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
1401
+ * @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
1402
+ * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
1403
+ * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
1404
+ * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
1224
1405
  * @param {*} [options] Override http request option.
1225
1406
  * @throws {RequiredError}
1226
1407
  */
1227
- listProductAnalytics(project, pageToken, search, sortBy, pageSize, options) {
1408
+ listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options) {
1228
1409
  return __awaiter(this, void 0, void 0, function* () {
1229
1410
  var _a, _b, _c;
1230
- const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, search, sortBy, pageSize, options);
1411
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
1231
1412
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1232
1413
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.listProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1233
1414
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1249,7 +1430,17 @@ export const ProductAnalyticsApiFactory = function (configuration, basePath, axi
1249
1430
  * @throws {RequiredError}
1250
1431
  */
1251
1432
  exportProductAnalytics(requestParameters, options) {
1252
- return localVarFp.exportProductAnalytics(requestParameters.project, options).then((request) => request(axios, basePath));
1433
+ 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));
1434
+ },
1435
+ /**
1436
+ * Get the AI-generated summary of the product analytics for the given project.
1437
+ * @summary Get product analytics summary
1438
+ * @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
1439
+ * @param {*} [options] Override http request option.
1440
+ * @throws {RequiredError}
1441
+ */
1442
+ getProductAnalyticsSummary(requestParameters, options) {
1443
+ return localVarFp.getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(axios, basePath));
1253
1444
  },
1254
1445
  /**
1255
1446
  * Lists all product analytics items.
@@ -1259,7 +1450,7 @@ export const ProductAnalyticsApiFactory = function (configuration, basePath, axi
1259
1450
  * @throws {RequiredError}
1260
1451
  */
1261
1452
  listProductAnalytics(requestParameters, options) {
1262
- return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1453
+ 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));
1263
1454
  },
1264
1455
  };
1265
1456
  };
@@ -1275,7 +1466,17 @@ export class ProductAnalyticsApi extends BaseAPI {
1275
1466
  * @throws {RequiredError}
1276
1467
  */
1277
1468
  exportProductAnalytics(requestParameters, options) {
1278
- return ProductAnalyticsApiFp(this.configuration).exportProductAnalytics(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
1469
+ return 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));
1470
+ }
1471
+ /**
1472
+ * Get the AI-generated summary of the product analytics for the given project.
1473
+ * @summary Get product analytics summary
1474
+ * @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
1475
+ * @param {*} [options] Override http request option.
1476
+ * @throws {RequiredError}
1477
+ */
1478
+ getProductAnalyticsSummary(requestParameters, options) {
1479
+ return ProductAnalyticsApiFp(this.configuration).getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
1279
1480
  }
1280
1481
  /**
1281
1482
  * Lists all product analytics items.
@@ -1285,7 +1486,7 @@ export class ProductAnalyticsApi extends BaseAPI {
1285
1486
  * @throws {RequiredError}
1286
1487
  */
1287
1488
  listProductAnalytics(requestParameters, options) {
1288
- return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
1489
+ return 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));
1289
1490
  }
1290
1491
  }
1291
1492
  /**
@@ -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.84.0
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/esm/base.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.84.0
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).
@@ -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.84.0
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).
@@ -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.84.0
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).
@@ -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.84.0
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).
@@ -3,7 +3,7 @@
3
3
  * Product Catalog API
4
4
  * 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.
5
5
  *
6
- * The version of the OpenAPI document: 1.84.0
6
+ * The version of the OpenAPI document: 1.86.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.84.0
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/esm/index.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.84.0
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).
package/dist/index.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.84.0
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/index.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.84.0
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/docs/Action.md ADDED
@@ -0,0 +1,32 @@
1
+ # Action
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | Unique object identifier | [default to undefined]
9
+ **ref** | **string** | A reference to the action resource location | [default to undefined]
10
+ **title** | **string** | The title of the action | [default to undefined]
11
+ **impact** | **string** | | [default to undefined]
12
+ **taskRef** | **string** | A reference to the task resource location | [default to undefined]
13
+ **createdAt** | **string** | | [default to undefined]
14
+ **updatedAt** | **string** | | [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { Action } from '@teemill/product-catalog';
20
+
21
+ const instance: Action = {
22
+ id,
23
+ ref,
24
+ title,
25
+ impact,
26
+ taskRef,
27
+ createdAt,
28
+ updatedAt,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # AnalyticsSummary
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **summary** | **string** | A summary of the recommendations | [default to undefined]
9
+ **recommendations** | [**Array&lt;Recommendation&gt;**](Recommendation.md) | | [default to undefined]
10
+ **createdAt** | **string** | | [default to undefined]
11
+ **updatedAt** | **string** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { AnalyticsSummary } from '@teemill/product-catalog';
17
+
18
+ const instance: AnalyticsSummary = {
19
+ summary,
20
+ recommendations,
21
+ createdAt,
22
+ updatedAt,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)