@teemill/product-catalog 1.85.0 → 1.87.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.85.0
7
+ * The version of the OpenAPI document: 1.87.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
  };
@@ -1104,7 +1114,7 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
1104
1114
  * @summary Export product analytics
1105
1115
  * @param {string} project What project it is
1106
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.
1107
- * @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.
1117
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39;
1108
1118
  * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
1109
1119
  * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
1110
1120
  * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
@@ -1115,10 +1125,14 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
1115
1125
  * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
1116
1126
  * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
1117
1127
  * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
1128
+ * @param {string} [createdBefore] Filter to only include products created before the given date
1129
+ * @param {string} [createdAfter] Filter to only include products created after the given date
1130
+ * @param {string} [updatedBefore] Filter to only include products updated before the given date
1131
+ * @param {string} [updatedAfter] Filter to only include products updated after the given date
1118
1132
  * @param {*} [options] Override http request option.
1119
1133
  * @throws {RequiredError}
1120
1134
  */
1121
- 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 = {}) {
1135
+ 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, createdBefore_1, createdAfter_1, updatedBefore_1, updatedAfter_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, createdBefore_1, createdAfter_1, updatedBefore_1, updatedAfter_1, ...args_1], void 0, function* (project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options = {}) {
1122
1136
  // verify required parameter 'project' is not null or undefined
1123
1137
  assertParamExists('exportProductAnalytics', 'project', project);
1124
1138
  const localVarPath = `/v1/catalog/analytics/export`;
@@ -1179,6 +1193,26 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
1179
1193
  if (maximumTraffic !== undefined) {
1180
1194
  localVarQueryParameter['maximumTraffic'] = maximumTraffic;
1181
1195
  }
1196
+ if (createdBefore !== undefined) {
1197
+ localVarQueryParameter['createdBefore'] = (createdBefore instanceof Date) ?
1198
+ createdBefore.toISOString() :
1199
+ createdBefore;
1200
+ }
1201
+ if (createdAfter !== undefined) {
1202
+ localVarQueryParameter['createdAfter'] = (createdAfter instanceof Date) ?
1203
+ createdAfter.toISOString() :
1204
+ createdAfter;
1205
+ }
1206
+ if (updatedBefore !== undefined) {
1207
+ localVarQueryParameter['updatedBefore'] = (updatedBefore instanceof Date) ?
1208
+ updatedBefore.toISOString() :
1209
+ updatedBefore;
1210
+ }
1211
+ if (updatedAfter !== undefined) {
1212
+ localVarQueryParameter['updatedAfter'] = (updatedAfter instanceof Date) ?
1213
+ updatedAfter.toISOString() :
1214
+ updatedAfter;
1215
+ }
1182
1216
  localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
1183
1217
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1184
1218
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1188,13 +1222,50 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
1188
1222
  options: localVarRequestOptions,
1189
1223
  };
1190
1224
  }),
1225
+ /**
1226
+ * Get the AI-generated summary of the product analytics for the given project.
1227
+ * @summary Get product analytics summary
1228
+ * @param {string} project What project it is
1229
+ * @param {*} [options] Override http request option.
1230
+ * @throws {RequiredError}
1231
+ */
1232
+ getProductAnalyticsSummary: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
1233
+ // verify required parameter 'project' is not null or undefined
1234
+ assertParamExists('getProductAnalyticsSummary', 'project', project);
1235
+ const localVarPath = `/v1/catalog/analytics/summary`;
1236
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1237
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1238
+ let baseOptions;
1239
+ if (configuration) {
1240
+ baseOptions = configuration.baseOptions;
1241
+ }
1242
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1243
+ const localVarHeaderParameter = {};
1244
+ const localVarQueryParameter = {};
1245
+ // authentication session-oauth required
1246
+ // oauth required
1247
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
1248
+ // authentication api-key required
1249
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1250
+ if (project !== undefined) {
1251
+ localVarQueryParameter['project'] = project;
1252
+ }
1253
+ localVarHeaderParameter['Accept'] = 'application/json';
1254
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1255
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1256
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1257
+ return {
1258
+ url: toPathString(localVarUrlObj),
1259
+ options: localVarRequestOptions,
1260
+ };
1261
+ }),
1191
1262
  /**
1192
1263
  * Lists all product analytics items.
1193
1264
  * @summary List product analytics
1194
1265
  * @param {string} project What project it is
1195
1266
  * @param {number} [pageToken] Page reference token
1196
1267
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1197
- * @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.
1268
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39;
1198
1269
  * @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.
1199
1270
  * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
1200
1271
  * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
@@ -1206,10 +1277,14 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
1206
1277
  * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
1207
1278
  * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
1208
1279
  * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
1280
+ * @param {string} [createdBefore] Filter to only include products created before the given date
1281
+ * @param {string} [createdAfter] Filter to only include products created after the given date
1282
+ * @param {string} [updatedBefore] Filter to only include products updated before the given date
1283
+ * @param {string} [updatedAfter] Filter to only include products updated after the given date
1209
1284
  * @param {*} [options] Override http request option.
1210
1285
  * @throws {RequiredError}
1211
1286
  */
1212
- 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 = {}) {
1287
+ 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, createdBefore_1, createdAfter_1, updatedBefore_1, updatedAfter_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, createdBefore_1, createdAfter_1, updatedBefore_1, updatedAfter_1, ...args_1], void 0, function* (project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options = {}) {
1213
1288
  // verify required parameter 'project' is not null or undefined
1214
1289
  assertParamExists('listProductAnalytics', 'project', project);
1215
1290
  const localVarPath = `/v1/catalog/analytics`;
@@ -1276,6 +1351,26 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
1276
1351
  if (maximumTraffic !== undefined) {
1277
1352
  localVarQueryParameter['maximumTraffic'] = maximumTraffic;
1278
1353
  }
1354
+ if (createdBefore !== undefined) {
1355
+ localVarQueryParameter['createdBefore'] = (createdBefore instanceof Date) ?
1356
+ createdBefore.toISOString() :
1357
+ createdBefore;
1358
+ }
1359
+ if (createdAfter !== undefined) {
1360
+ localVarQueryParameter['createdAfter'] = (createdAfter instanceof Date) ?
1361
+ createdAfter.toISOString() :
1362
+ createdAfter;
1363
+ }
1364
+ if (updatedBefore !== undefined) {
1365
+ localVarQueryParameter['updatedBefore'] = (updatedBefore instanceof Date) ?
1366
+ updatedBefore.toISOString() :
1367
+ updatedBefore;
1368
+ }
1369
+ if (updatedAfter !== undefined) {
1370
+ localVarQueryParameter['updatedAfter'] = (updatedAfter instanceof Date) ?
1371
+ updatedAfter.toISOString() :
1372
+ updatedAfter;
1373
+ }
1279
1374
  localVarHeaderParameter['Accept'] = 'application/json';
1280
1375
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1281
1376
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1298,7 +1393,7 @@ export const ProductAnalyticsApiFp = function (configuration) {
1298
1393
  * @summary Export product analytics
1299
1394
  * @param {string} project What project it is
1300
1395
  * @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.
1301
- * @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.
1396
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39;
1302
1397
  * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
1303
1398
  * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
1304
1399
  * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
@@ -1309,25 +1404,45 @@ export const ProductAnalyticsApiFp = function (configuration) {
1309
1404
  * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
1310
1405
  * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
1311
1406
  * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
1407
+ * @param {string} [createdBefore] Filter to only include products created before the given date
1408
+ * @param {string} [createdAfter] Filter to only include products created after the given date
1409
+ * @param {string} [updatedBefore] Filter to only include products updated before the given date
1410
+ * @param {string} [updatedAfter] Filter to only include products updated after the given date
1312
1411
  * @param {*} [options] Override http request option.
1313
1412
  * @throws {RequiredError}
1314
1413
  */
1315
- exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options) {
1414
+ exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options) {
1316
1415
  return __awaiter(this, void 0, void 0, function* () {
1317
1416
  var _a, _b, _c;
1318
- const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
1417
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options);
1319
1418
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1320
1419
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.exportProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1321
1420
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1322
1421
  });
1323
1422
  },
1423
+ /**
1424
+ * Get the AI-generated summary of the product analytics for the given project.
1425
+ * @summary Get product analytics summary
1426
+ * @param {string} project What project it is
1427
+ * @param {*} [options] Override http request option.
1428
+ * @throws {RequiredError}
1429
+ */
1430
+ getProductAnalyticsSummary(project, options) {
1431
+ return __awaiter(this, void 0, void 0, function* () {
1432
+ var _a, _b, _c;
1433
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProductAnalyticsSummary(project, options);
1434
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1435
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.getProductAnalyticsSummary']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1436
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1437
+ });
1438
+ },
1324
1439
  /**
1325
1440
  * Lists all product analytics items.
1326
1441
  * @summary List product analytics
1327
1442
  * @param {string} project What project it is
1328
1443
  * @param {number} [pageToken] Page reference token
1329
1444
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1330
- * @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.
1445
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39;
1331
1446
  * @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.
1332
1447
  * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
1333
1448
  * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
@@ -1339,13 +1454,17 @@ export const ProductAnalyticsApiFp = function (configuration) {
1339
1454
  * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
1340
1455
  * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
1341
1456
  * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
1457
+ * @param {string} [createdBefore] Filter to only include products created before the given date
1458
+ * @param {string} [createdAfter] Filter to only include products created after the given date
1459
+ * @param {string} [updatedBefore] Filter to only include products updated before the given date
1460
+ * @param {string} [updatedAfter] Filter to only include products updated after the given date
1342
1461
  * @param {*} [options] Override http request option.
1343
1462
  * @throws {RequiredError}
1344
1463
  */
1345
- listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options) {
1464
+ listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options) {
1346
1465
  return __awaiter(this, void 0, void 0, function* () {
1347
1466
  var _a, _b, _c;
1348
- const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
1467
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options);
1349
1468
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1350
1469
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.listProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1351
1470
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1367,7 +1486,17 @@ export const ProductAnalyticsApiFactory = function (configuration, basePath, axi
1367
1486
  * @throws {RequiredError}
1368
1487
  */
1369
1488
  exportProductAnalytics(requestParameters, options) {
1370
- 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));
1489
+ 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, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(axios, basePath));
1490
+ },
1491
+ /**
1492
+ * Get the AI-generated summary of the product analytics for the given project.
1493
+ * @summary Get product analytics summary
1494
+ * @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
1495
+ * @param {*} [options] Override http request option.
1496
+ * @throws {RequiredError}
1497
+ */
1498
+ getProductAnalyticsSummary(requestParameters, options) {
1499
+ return localVarFp.getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(axios, basePath));
1371
1500
  },
1372
1501
  /**
1373
1502
  * Lists all product analytics items.
@@ -1377,7 +1506,7 @@ export const ProductAnalyticsApiFactory = function (configuration, basePath, axi
1377
1506
  * @throws {RequiredError}
1378
1507
  */
1379
1508
  listProductAnalytics(requestParameters, options) {
1380
- 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));
1509
+ 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, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(axios, basePath));
1381
1510
  },
1382
1511
  };
1383
1512
  };
@@ -1393,7 +1522,17 @@ export class ProductAnalyticsApi extends BaseAPI {
1393
1522
  * @throws {RequiredError}
1394
1523
  */
1395
1524
  exportProductAnalytics(requestParameters, options) {
1396
- 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));
1525
+ 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, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
1526
+ }
1527
+ /**
1528
+ * Get the AI-generated summary of the product analytics for the given project.
1529
+ * @summary Get product analytics summary
1530
+ * @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
1531
+ * @param {*} [options] Override http request option.
1532
+ * @throws {RequiredError}
1533
+ */
1534
+ getProductAnalyticsSummary(requestParameters, options) {
1535
+ return ProductAnalyticsApiFp(this.configuration).getProductAnalyticsSummary(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
1397
1536
  }
1398
1537
  /**
1399
1538
  * Lists all product analytics items.
@@ -1403,7 +1542,108 @@ export class ProductAnalyticsApi extends BaseAPI {
1403
1542
  * @throws {RequiredError}
1404
1543
  */
1405
1544
  listProductAnalytics(requestParameters, options) {
1406
- 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));
1545
+ 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, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
1546
+ }
1547
+ }
1548
+ /**
1549
+ * ProductCreatorsApi - axios parameter creator
1550
+ */
1551
+ export const ProductCreatorsApiAxiosParamCreator = function (configuration) {
1552
+ return {
1553
+ /**
1554
+ * Lists all the unique users that have created products for the given project.
1555
+ * @summary List product creators
1556
+ * @param {string} project What project it is
1557
+ * @param {*} [options] Override http request option.
1558
+ * @throws {RequiredError}
1559
+ */
1560
+ listProductCreators: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
1561
+ // verify required parameter 'project' is not null or undefined
1562
+ assertParamExists('listProductCreators', 'project', project);
1563
+ const localVarPath = `/v1/catalog/creators`;
1564
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1565
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1566
+ let baseOptions;
1567
+ if (configuration) {
1568
+ baseOptions = configuration.baseOptions;
1569
+ }
1570
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1571
+ const localVarHeaderParameter = {};
1572
+ const localVarQueryParameter = {};
1573
+ // authentication session-oauth required
1574
+ // oauth required
1575
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
1576
+ // authentication api-key required
1577
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
1578
+ if (project !== undefined) {
1579
+ localVarQueryParameter['project'] = project;
1580
+ }
1581
+ localVarHeaderParameter['Accept'] = 'application/json';
1582
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1583
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1584
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1585
+ return {
1586
+ url: toPathString(localVarUrlObj),
1587
+ options: localVarRequestOptions,
1588
+ };
1589
+ }),
1590
+ };
1591
+ };
1592
+ /**
1593
+ * ProductCreatorsApi - functional programming interface
1594
+ */
1595
+ export const ProductCreatorsApiFp = function (configuration) {
1596
+ const localVarAxiosParamCreator = ProductCreatorsApiAxiosParamCreator(configuration);
1597
+ return {
1598
+ /**
1599
+ * Lists all the unique users that have created products for the given project.
1600
+ * @summary List product creators
1601
+ * @param {string} project What project it is
1602
+ * @param {*} [options] Override http request option.
1603
+ * @throws {RequiredError}
1604
+ */
1605
+ listProductCreators(project, options) {
1606
+ return __awaiter(this, void 0, void 0, function* () {
1607
+ var _a, _b, _c;
1608
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductCreators(project, options);
1609
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1610
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductCreatorsApi.listProductCreators']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1611
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1612
+ });
1613
+ },
1614
+ };
1615
+ };
1616
+ /**
1617
+ * ProductCreatorsApi - factory interface
1618
+ */
1619
+ export const ProductCreatorsApiFactory = function (configuration, basePath, axios) {
1620
+ const localVarFp = ProductCreatorsApiFp(configuration);
1621
+ return {
1622
+ /**
1623
+ * Lists all the unique users that have created products for the given project.
1624
+ * @summary List product creators
1625
+ * @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
1626
+ * @param {*} [options] Override http request option.
1627
+ * @throws {RequiredError}
1628
+ */
1629
+ listProductCreators(requestParameters, options) {
1630
+ return localVarFp.listProductCreators(requestParameters.project, options).then((request) => request(axios, basePath));
1631
+ },
1632
+ };
1633
+ };
1634
+ /**
1635
+ * ProductCreatorsApi - object-oriented interface
1636
+ */
1637
+ export class ProductCreatorsApi extends BaseAPI {
1638
+ /**
1639
+ * Lists all the unique users that have created products for the given project.
1640
+ * @summary List product creators
1641
+ * @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
1642
+ * @param {*} [options] Override http request option.
1643
+ * @throws {RequiredError}
1644
+ */
1645
+ listProductCreators(requestParameters, options) {
1646
+ return ProductCreatorsApiFp(this.configuration).listProductCreators(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
1407
1647
  }
1408
1648
  }
1409
1649
  /**
@@ -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.85.0
5
+ * The version of the OpenAPI document: 1.87.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.85.0
7
+ * The version of the OpenAPI document: 1.87.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.85.0
5
+ * The version of the OpenAPI document: 1.87.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.85.0
7
+ * The version of the OpenAPI document: 1.87.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.85.0
5
+ * The version of the OpenAPI document: 1.87.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.85.0
6
+ * The version of the OpenAPI document: 1.87.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.85.0
5
+ * The version of the OpenAPI document: 1.87.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.85.0
7
+ * The version of the OpenAPI document: 1.87.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.85.0
5
+ * The version of the OpenAPI document: 1.87.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.85.0
8
+ * The version of the OpenAPI document: 1.87.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)