@teemill/product-catalog 1.83.1 → 1.84.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 +368 -23
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +201 -17
- package/dist/api.js +256 -20
- 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 +201 -17
- package/dist/esm/api.js +251 -19
- 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/ApplicationSetsApi.md +2 -2
- package/docs/ProductAnalyticsApi.md +58 -2
- package/docs/ProductType.md +22 -0
- package/docs/ProductTypeListResponse.md +22 -0
- package/docs/ProductTypesApi.md +69 -0
- package/docs/ProductsApi.md +27 -3
- package/docs/VariantsApi.md +2 -2
- package/index.ts +1 -1
- package/package.json +2 -2
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.
|
|
7
|
+
* The version of the OpenAPI document: 1.84.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -694,7 +694,7 @@ export const ApplicationSetsApiAxiosParamCreator = function (configuration) {
|
|
|
694
694
|
* @summary List application sets
|
|
695
695
|
* @param {string} project What project it is
|
|
696
696
|
* @param {number} [pageToken] Page reference token
|
|
697
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
697
|
+
* @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.
|
|
698
698
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
699
699
|
* @param {*} [options] Override http request option.
|
|
700
700
|
* @throws {RequiredError}
|
|
@@ -846,7 +846,7 @@ export const ApplicationSetsApiFp = function (configuration) {
|
|
|
846
846
|
* @summary List application sets
|
|
847
847
|
* @param {string} project What project it is
|
|
848
848
|
* @param {number} [pageToken] Page reference token
|
|
849
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
849
|
+
* @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.
|
|
850
850
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
851
851
|
* @param {*} [options] Override http request option.
|
|
852
852
|
* @throws {RequiredError}
|
|
@@ -1099,12 +1099,49 @@ export class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
1099
1099
|
*/
|
|
1100
1100
|
export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
1101
1101
|
return {
|
|
1102
|
+
/**
|
|
1103
|
+
* Exports all products with analytics data in a CSV file.
|
|
1104
|
+
* @summary Export product analytics
|
|
1105
|
+
* @param {string} project What project it is
|
|
1106
|
+
* @param {*} [options] Override http request option.
|
|
1107
|
+
* @throws {RequiredError}
|
|
1108
|
+
*/
|
|
1109
|
+
exportProductAnalytics: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
1110
|
+
// verify required parameter 'project' is not null or undefined
|
|
1111
|
+
assertParamExists('exportProductAnalytics', 'project', project);
|
|
1112
|
+
const localVarPath = `/v1/catalog/analytics/export`;
|
|
1113
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1114
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1115
|
+
let baseOptions;
|
|
1116
|
+
if (configuration) {
|
|
1117
|
+
baseOptions = configuration.baseOptions;
|
|
1118
|
+
}
|
|
1119
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1120
|
+
const localVarHeaderParameter = {};
|
|
1121
|
+
const localVarQueryParameter = {};
|
|
1122
|
+
// authentication session-oauth required
|
|
1123
|
+
// oauth required
|
|
1124
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1125
|
+
// authentication api-key required
|
|
1126
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1127
|
+
if (project !== undefined) {
|
|
1128
|
+
localVarQueryParameter['project'] = project;
|
|
1129
|
+
}
|
|
1130
|
+
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
1131
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1132
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1133
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1134
|
+
return {
|
|
1135
|
+
url: toPathString(localVarUrlObj),
|
|
1136
|
+
options: localVarRequestOptions,
|
|
1137
|
+
};
|
|
1138
|
+
}),
|
|
1102
1139
|
/**
|
|
1103
1140
|
* Lists all product analytics items.
|
|
1104
1141
|
* @summary List product analytics
|
|
1105
1142
|
* @param {string} project What project it is
|
|
1106
1143
|
* @param {number} [pageToken] Page reference token
|
|
1107
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
1144
|
+
* @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.
|
|
1108
1145
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1109
1146
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1110
1147
|
* @param {*} [options] Override http request option.
|
|
@@ -1160,12 +1197,28 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1160
1197
|
export const ProductAnalyticsApiFp = function (configuration) {
|
|
1161
1198
|
const localVarAxiosParamCreator = ProductAnalyticsApiAxiosParamCreator(configuration);
|
|
1162
1199
|
return {
|
|
1200
|
+
/**
|
|
1201
|
+
* Exports all products with analytics data in a CSV file.
|
|
1202
|
+
* @summary Export product analytics
|
|
1203
|
+
* @param {string} project What project it is
|
|
1204
|
+
* @param {*} [options] Override http request option.
|
|
1205
|
+
* @throws {RequiredError}
|
|
1206
|
+
*/
|
|
1207
|
+
exportProductAnalytics(project, options) {
|
|
1208
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1209
|
+
var _a, _b, _c;
|
|
1210
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProductAnalytics(project, options);
|
|
1211
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1212
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductAnalyticsApi.exportProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1213
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1214
|
+
});
|
|
1215
|
+
},
|
|
1163
1216
|
/**
|
|
1164
1217
|
* Lists all product analytics items.
|
|
1165
1218
|
* @summary List product analytics
|
|
1166
1219
|
* @param {string} project What project it is
|
|
1167
1220
|
* @param {number} [pageToken] Page reference token
|
|
1168
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
1221
|
+
* @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.
|
|
1169
1222
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1170
1223
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1171
1224
|
* @param {*} [options] Override http request option.
|
|
@@ -1188,6 +1241,16 @@ export const ProductAnalyticsApiFp = function (configuration) {
|
|
|
1188
1241
|
export const ProductAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
1189
1242
|
const localVarFp = ProductAnalyticsApiFp(configuration);
|
|
1190
1243
|
return {
|
|
1244
|
+
/**
|
|
1245
|
+
* Exports all products with analytics data in a CSV file.
|
|
1246
|
+
* @summary Export product analytics
|
|
1247
|
+
* @param {ProductAnalyticsApiExportProductAnalyticsRequest} requestParameters Request parameters.
|
|
1248
|
+
* @param {*} [options] Override http request option.
|
|
1249
|
+
* @throws {RequiredError}
|
|
1250
|
+
*/
|
|
1251
|
+
exportProductAnalytics(requestParameters, options) {
|
|
1252
|
+
return localVarFp.exportProductAnalytics(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
1253
|
+
},
|
|
1191
1254
|
/**
|
|
1192
1255
|
* Lists all product analytics items.
|
|
1193
1256
|
* @summary List product analytics
|
|
@@ -1204,6 +1267,16 @@ export const ProductAnalyticsApiFactory = function (configuration, basePath, axi
|
|
|
1204
1267
|
* ProductAnalyticsApi - object-oriented interface
|
|
1205
1268
|
*/
|
|
1206
1269
|
export class ProductAnalyticsApi extends BaseAPI {
|
|
1270
|
+
/**
|
|
1271
|
+
* Exports all products with analytics data in a CSV file.
|
|
1272
|
+
* @summary Export product analytics
|
|
1273
|
+
* @param {ProductAnalyticsApiExportProductAnalyticsRequest} requestParameters Request parameters.
|
|
1274
|
+
* @param {*} [options] Override http request option.
|
|
1275
|
+
* @throws {RequiredError}
|
|
1276
|
+
*/
|
|
1277
|
+
exportProductAnalytics(requestParameters, options) {
|
|
1278
|
+
return ProductAnalyticsApiFp(this.configuration).exportProductAnalytics(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
1279
|
+
}
|
|
1207
1280
|
/**
|
|
1208
1281
|
* Lists all product analytics items.
|
|
1209
1282
|
* @summary List product analytics
|
|
@@ -1215,6 +1288,117 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
1215
1288
|
return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
1216
1289
|
}
|
|
1217
1290
|
}
|
|
1291
|
+
/**
|
|
1292
|
+
* ProductTypesApi - axios parameter creator
|
|
1293
|
+
*/
|
|
1294
|
+
export const ProductTypesApiAxiosParamCreator = function (configuration) {
|
|
1295
|
+
return {
|
|
1296
|
+
/**
|
|
1297
|
+
* Lists the product types used by the given project\'s catalog.
|
|
1298
|
+
* @summary List product types
|
|
1299
|
+
* @param {string} project What project it is
|
|
1300
|
+
* @param {number} [pageToken] Page reference token
|
|
1301
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1302
|
+
* @param {*} [options] Override http request option.
|
|
1303
|
+
* @throws {RequiredError}
|
|
1304
|
+
*/
|
|
1305
|
+
listProductTypes: (project_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, pageToken, pageSize, options = {}) {
|
|
1306
|
+
// verify required parameter 'project' is not null or undefined
|
|
1307
|
+
assertParamExists('listProductTypes', 'project', project);
|
|
1308
|
+
const localVarPath = `/v1/catalog/product-types`;
|
|
1309
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1310
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1311
|
+
let baseOptions;
|
|
1312
|
+
if (configuration) {
|
|
1313
|
+
baseOptions = configuration.baseOptions;
|
|
1314
|
+
}
|
|
1315
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1316
|
+
const localVarHeaderParameter = {};
|
|
1317
|
+
const localVarQueryParameter = {};
|
|
1318
|
+
// authentication session-oauth required
|
|
1319
|
+
// oauth required
|
|
1320
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1321
|
+
// authentication api-key required
|
|
1322
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1323
|
+
if (project !== undefined) {
|
|
1324
|
+
localVarQueryParameter['project'] = project;
|
|
1325
|
+
}
|
|
1326
|
+
if (pageToken !== undefined) {
|
|
1327
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1328
|
+
}
|
|
1329
|
+
if (pageSize !== undefined) {
|
|
1330
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1331
|
+
}
|
|
1332
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1333
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1334
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1335
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1336
|
+
return {
|
|
1337
|
+
url: toPathString(localVarUrlObj),
|
|
1338
|
+
options: localVarRequestOptions,
|
|
1339
|
+
};
|
|
1340
|
+
}),
|
|
1341
|
+
};
|
|
1342
|
+
};
|
|
1343
|
+
/**
|
|
1344
|
+
* ProductTypesApi - functional programming interface
|
|
1345
|
+
*/
|
|
1346
|
+
export const ProductTypesApiFp = function (configuration) {
|
|
1347
|
+
const localVarAxiosParamCreator = ProductTypesApiAxiosParamCreator(configuration);
|
|
1348
|
+
return {
|
|
1349
|
+
/**
|
|
1350
|
+
* Lists the product types used by the given project\'s catalog.
|
|
1351
|
+
* @summary List product types
|
|
1352
|
+
* @param {string} project What project it is
|
|
1353
|
+
* @param {number} [pageToken] Page reference token
|
|
1354
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1355
|
+
* @param {*} [options] Override http request option.
|
|
1356
|
+
* @throws {RequiredError}
|
|
1357
|
+
*/
|
|
1358
|
+
listProductTypes(project, pageToken, pageSize, options) {
|
|
1359
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1360
|
+
var _a, _b, _c;
|
|
1361
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductTypes(project, pageToken, pageSize, options);
|
|
1362
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1363
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductTypesApi.listProductTypes']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1364
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1365
|
+
});
|
|
1366
|
+
},
|
|
1367
|
+
};
|
|
1368
|
+
};
|
|
1369
|
+
/**
|
|
1370
|
+
* ProductTypesApi - factory interface
|
|
1371
|
+
*/
|
|
1372
|
+
export const ProductTypesApiFactory = function (configuration, basePath, axios) {
|
|
1373
|
+
const localVarFp = ProductTypesApiFp(configuration);
|
|
1374
|
+
return {
|
|
1375
|
+
/**
|
|
1376
|
+
* Lists the product types used by the given project\'s catalog.
|
|
1377
|
+
* @summary List product types
|
|
1378
|
+
* @param {ProductTypesApiListProductTypesRequest} requestParameters Request parameters.
|
|
1379
|
+
* @param {*} [options] Override http request option.
|
|
1380
|
+
* @throws {RequiredError}
|
|
1381
|
+
*/
|
|
1382
|
+
listProductTypes(requestParameters, options) {
|
|
1383
|
+
return localVarFp.listProductTypes(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1384
|
+
},
|
|
1385
|
+
};
|
|
1386
|
+
};
|
|
1387
|
+
/**
|
|
1388
|
+
* ProductTypesApi - object-oriented interface
|
|
1389
|
+
*/
|
|
1390
|
+
export class ProductTypesApi extends BaseAPI {
|
|
1391
|
+
/**
|
|
1392
|
+
* Lists the product types used by the given project\'s catalog.
|
|
1393
|
+
* @summary List product types
|
|
1394
|
+
* @param {ProductTypesApiListProductTypesRequest} requestParameters Request parameters.
|
|
1395
|
+
* @param {*} [options] Override http request option.
|
|
1396
|
+
* @throws {RequiredError}
|
|
1397
|
+
*/
|
|
1398
|
+
listProductTypes(requestParameters, options) {
|
|
1399
|
+
return ProductTypesApiFp(this.configuration).listProductTypes(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
1400
|
+
}
|
|
1401
|
+
}
|
|
1218
1402
|
/**
|
|
1219
1403
|
* ProductsApi - axios parameter creator
|
|
1220
1404
|
*/
|
|
@@ -1387,10 +1571,16 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
1387
1571
|
* Export the project\'s products and variants as a CSV file.
|
|
1388
1572
|
* @summary Export products
|
|
1389
1573
|
* @param {string} project What project it is
|
|
1574
|
+
* @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.
|
|
1575
|
+
* @param {string} [start] Start of date range to filter
|
|
1576
|
+
* @param {string} [end] End of date range to filter
|
|
1577
|
+
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1578
|
+
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
1579
|
+
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
1390
1580
|
* @param {*} [options] Override http request option.
|
|
1391
1581
|
* @throws {RequiredError}
|
|
1392
1582
|
*/
|
|
1393
|
-
exportProducts: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
1583
|
+
exportProducts: (project_1, search_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, ...args_1) => __awaiter(this, [project_1, search_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, ...args_1], void 0, function* (project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options = {}) {
|
|
1394
1584
|
// verify required parameter 'project' is not null or undefined
|
|
1395
1585
|
assertParamExists('exportProducts', 'project', project);
|
|
1396
1586
|
const localVarPath = `/v1/catalog/products/export`;
|
|
@@ -1411,6 +1601,28 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
1411
1601
|
if (project !== undefined) {
|
|
1412
1602
|
localVarQueryParameter['project'] = project;
|
|
1413
1603
|
}
|
|
1604
|
+
if (search !== undefined) {
|
|
1605
|
+
localVarQueryParameter['search'] = search;
|
|
1606
|
+
}
|
|
1607
|
+
if (start !== undefined) {
|
|
1608
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
1609
|
+
start.toISOString() :
|
|
1610
|
+
start;
|
|
1611
|
+
}
|
|
1612
|
+
if (end !== undefined) {
|
|
1613
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
1614
|
+
end.toISOString() :
|
|
1615
|
+
end;
|
|
1616
|
+
}
|
|
1617
|
+
if (dateFilterType !== undefined) {
|
|
1618
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
1619
|
+
}
|
|
1620
|
+
if (maxRetailPrice !== undefined) {
|
|
1621
|
+
localVarQueryParameter['maxRetailPrice'] = maxRetailPrice;
|
|
1622
|
+
}
|
|
1623
|
+
if (minRetailPrice !== undefined) {
|
|
1624
|
+
localVarQueryParameter['minRetailPrice'] = minRetailPrice;
|
|
1625
|
+
}
|
|
1414
1626
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
1415
1627
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1416
1628
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1510,17 +1722,19 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
1510
1722
|
* @summary List products
|
|
1511
1723
|
* @param {string} project What project it is
|
|
1512
1724
|
* @param {number} [pageToken] Page reference token
|
|
1513
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
1725
|
+
* @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.
|
|
1514
1726
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1515
1727
|
* @param {string} [start] Start of date range to filter
|
|
1516
1728
|
* @param {string} [end] End of date range to filter
|
|
1517
1729
|
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1730
|
+
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
1731
|
+
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
1518
1732
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1519
1733
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1520
1734
|
* @param {*} [options] Override http request option.
|
|
1521
1735
|
* @throws {RequiredError}
|
|
1522
1736
|
*/
|
|
1523
|
-
listProducts: (project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options = {}) {
|
|
1737
|
+
listProducts: (project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options = {}) {
|
|
1524
1738
|
// verify required parameter 'project' is not null or undefined
|
|
1525
1739
|
assertParamExists('listProducts', 'project', project);
|
|
1526
1740
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -1563,6 +1777,12 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
1563
1777
|
if (dateFilterType !== undefined) {
|
|
1564
1778
|
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
1565
1779
|
}
|
|
1780
|
+
if (maxRetailPrice !== undefined) {
|
|
1781
|
+
localVarQueryParameter['maxRetailPrice'] = maxRetailPrice;
|
|
1782
|
+
}
|
|
1783
|
+
if (minRetailPrice !== undefined) {
|
|
1784
|
+
localVarQueryParameter['minRetailPrice'] = minRetailPrice;
|
|
1785
|
+
}
|
|
1566
1786
|
if (pageSize !== undefined) {
|
|
1567
1787
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
1568
1788
|
}
|
|
@@ -1784,13 +2004,19 @@ export const ProductsApiFp = function (configuration) {
|
|
|
1784
2004
|
* Export the project\'s products and variants as a CSV file.
|
|
1785
2005
|
* @summary Export products
|
|
1786
2006
|
* @param {string} project What project it is
|
|
2007
|
+
* @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.
|
|
2008
|
+
* @param {string} [start] Start of date range to filter
|
|
2009
|
+
* @param {string} [end] End of date range to filter
|
|
2010
|
+
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2011
|
+
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
2012
|
+
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
1787
2013
|
* @param {*} [options] Override http request option.
|
|
1788
2014
|
* @throws {RequiredError}
|
|
1789
2015
|
*/
|
|
1790
|
-
exportProducts(project, options) {
|
|
2016
|
+
exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options) {
|
|
1791
2017
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1792
2018
|
var _a, _b, _c;
|
|
1793
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProducts(project, options);
|
|
2019
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options);
|
|
1794
2020
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1795
2021
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.exportProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1796
2022
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1836,20 +2062,22 @@ export const ProductsApiFp = function (configuration) {
|
|
|
1836
2062
|
* @summary List products
|
|
1837
2063
|
* @param {string} project What project it is
|
|
1838
2064
|
* @param {number} [pageToken] Page reference token
|
|
1839
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2065
|
+
* @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.
|
|
1840
2066
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1841
2067
|
* @param {string} [start] Start of date range to filter
|
|
1842
2068
|
* @param {string} [end] End of date range to filter
|
|
1843
2069
|
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2070
|
+
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
2071
|
+
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
1844
2072
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1845
2073
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1846
2074
|
* @param {*} [options] Override http request option.
|
|
1847
2075
|
* @throws {RequiredError}
|
|
1848
2076
|
*/
|
|
1849
|
-
listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options) {
|
|
2077
|
+
listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options) {
|
|
1850
2078
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1851
2079
|
var _a, _b, _c;
|
|
1852
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options);
|
|
2080
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options);
|
|
1853
2081
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1854
2082
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.listProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1855
2083
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1963,7 +2191,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
1963
2191
|
* @throws {RequiredError}
|
|
1964
2192
|
*/
|
|
1965
2193
|
exportProducts(requestParameters, options) {
|
|
1966
|
-
return localVarFp.exportProducts(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
2194
|
+
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(axios, basePath));
|
|
1967
2195
|
},
|
|
1968
2196
|
/**
|
|
1969
2197
|
* Gets a product by a given ID.
|
|
@@ -1993,7 +2221,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
1993
2221
|
* @throws {RequiredError}
|
|
1994
2222
|
*/
|
|
1995
2223
|
listProducts(requestParameters, options) {
|
|
1996
|
-
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
2224
|
+
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
1997
2225
|
},
|
|
1998
2226
|
/**
|
|
1999
2227
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -2079,7 +2307,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
2079
2307
|
* @throws {RequiredError}
|
|
2080
2308
|
*/
|
|
2081
2309
|
exportProducts(requestParameters, options) {
|
|
2082
|
-
return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
2310
|
+
return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(this.axios, this.basePath));
|
|
2083
2311
|
}
|
|
2084
2312
|
/**
|
|
2085
2313
|
* Gets a product by a given ID.
|
|
@@ -2109,7 +2337,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
2109
2337
|
* @throws {RequiredError}
|
|
2110
2338
|
*/
|
|
2111
2339
|
listProducts(requestParameters, options) {
|
|
2112
|
-
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
2340
|
+
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
2113
2341
|
}
|
|
2114
2342
|
/**
|
|
2115
2343
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -2142,6 +2370,10 @@ export class ProductsApi extends BaseAPI {
|
|
|
2142
2370
|
return ProductsApiFp(this.configuration).updateProducts(requestParameters.project, requestParameters.updateProductsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2143
2371
|
}
|
|
2144
2372
|
}
|
|
2373
|
+
export const ExportProductsDateFilterTypeEnum = {
|
|
2374
|
+
CreatedAt: 'createdAt',
|
|
2375
|
+
UpdatedAt: 'updatedAt'
|
|
2376
|
+
};
|
|
2145
2377
|
export const ListProductsDateFilterTypeEnum = {
|
|
2146
2378
|
CreatedAt: 'createdAt',
|
|
2147
2379
|
UpdatedAt: 'updatedAt'
|
|
@@ -2200,7 +2432,7 @@ export const VariantsApiAxiosParamCreator = function (configuration) {
|
|
|
2200
2432
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
2201
2433
|
* @summary List variants
|
|
2202
2434
|
* @param {string} project What project it is
|
|
2203
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2435
|
+
* @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.
|
|
2204
2436
|
* @param {number} [pageToken] Page reference token
|
|
2205
2437
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2206
2438
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
@@ -2279,7 +2511,7 @@ export const VariantsApiFp = function (configuration) {
|
|
|
2279
2511
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
2280
2512
|
* @summary List variants
|
|
2281
2513
|
* @param {string} project What project it is
|
|
2282
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2514
|
+
* @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.
|
|
2283
2515
|
* @param {number} [pageToken] Page reference token
|
|
2284
2516
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2285
2517
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
package/dist/esm/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.84.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.
|
|
7
|
+
* The version of the OpenAPI document: 1.84.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/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.84.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.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.84.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.
|
|
5
|
+
* The version of the OpenAPI document: 1.84.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.
|
|
6
|
+
* The version of the OpenAPI document: 1.84.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.84.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.
|
|
7
|
+
* The version of the OpenAPI document: 1.84.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.
|
|
5
|
+
* The version of the OpenAPI document: 1.84.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.
|
|
8
|
+
* The version of the OpenAPI document: 1.84.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -206,7 +206,7 @@ const apiInstance = new ApplicationSetsApi(configuration);
|
|
|
206
206
|
|
|
207
207
|
let project: string; //What project it is (default to undefined)
|
|
208
208
|
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
209
|
-
let search: string; //Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
209
|
+
let search: string; //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. (optional) (default to 'enabled:true')
|
|
210
210
|
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 10)
|
|
211
211
|
|
|
212
212
|
const { status, data } = await apiInstance.listApplicationSets(
|
|
@@ -223,7 +223,7 @@ const { status, data } = await apiInstance.listApplicationSets(
|
|
|
223
223
|
|------------- | ------------- | ------------- | -------------|
|
|
224
224
|
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
225
225
|
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
226
|
-
| **search** | [**string**] | Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
226
|
+
| **search** | [**string**] | 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. | (optional) defaults to 'enabled:true'|
|
|
227
227
|
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 10|
|
|
228
228
|
|
|
229
229
|
|