@teemill/product-catalog 1.83.2 → 1.85.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 +629 -34
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +339 -23
- package/dist/api.js +383 -29
- 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 +339 -23
- package/dist/esm/api.js +378 -28
- 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 +127 -5
- 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 +1 -1
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog API
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.
|
|
8
|
+
* The version of the OpenAPI document: 1.85.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ProductAnalyticsApi = exports.ProductAnalyticsApiFactory = exports.ProductAnalyticsApiFp = exports.ProductAnalyticsApiAxiosParamCreator = exports.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.ApplicationGroupsApi = exports.ApplicationGroupsApiFactory = exports.ApplicationGroupsApiFp = exports.ApplicationGroupsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.TextApplicationPropertiesPersonalizationTypeEnum = exports.TextApplicationPropertiesFontStyleEnum = exports.TextApplicationPropertiesFontWeightEnum = exports.SalePriceCurrencyCodeEnum = exports.RequiredPriceCurrencyCodeEnum = exports.PriceCurrencyCodeEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = void 0;
|
|
25
|
+
exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ListProductsDateFilterTypeEnum = exports.ExportProductsDateFilterTypeEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ProductTypesApi = exports.ProductTypesApiFactory = exports.ProductTypesApiFp = exports.ProductTypesApiAxiosParamCreator = exports.ProductAnalyticsApi = exports.ProductAnalyticsApiFactory = exports.ProductAnalyticsApiFp = exports.ProductAnalyticsApiAxiosParamCreator = exports.ApplicationTechnologiesApi = exports.ApplicationTechnologiesApiFactory = exports.ApplicationTechnologiesApiFp = exports.ApplicationTechnologiesApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.ApplicationGroupsApi = exports.ApplicationGroupsApiFactory = exports.ApplicationGroupsApiFp = exports.ApplicationGroupsApiAxiosParamCreator = exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = exports.TextApplicationPropertiesPersonalizationTypeEnum = exports.TextApplicationPropertiesFontStyleEnum = exports.TextApplicationPropertiesFontWeightEnum = exports.SalePriceCurrencyCodeEnum = exports.RequiredPriceCurrencyCodeEnum = exports.PriceCurrencyCodeEnum = exports.CreateApplicationPropertiesFontStyleEnum = exports.CreateApplicationPropertiesFontWeightEnum = exports.CreateApplicationPlacementEnum = exports.CreateApplicationTechnologyEnum = exports.AttributeThumbnailTypeEnum = exports.ApplicationPropertiesPropertiesFontStyleEnum = exports.ApplicationPropertiesPropertiesFontWeightEnum = exports.ApplicationPropertiesPersonalizationRulesFitEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -701,7 +701,7 @@ const ApplicationSetsApiAxiosParamCreator = function (configuration) {
|
|
|
701
701
|
* @summary List application sets
|
|
702
702
|
* @param {string} project What project it is
|
|
703
703
|
* @param {number} [pageToken] Page reference token
|
|
704
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
704
|
+
* @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.
|
|
705
705
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
706
706
|
* @param {*} [options] Override http request option.
|
|
707
707
|
* @throws {RequiredError}
|
|
@@ -854,7 +854,7 @@ const ApplicationSetsApiFp = function (configuration) {
|
|
|
854
854
|
* @summary List application sets
|
|
855
855
|
* @param {string} project What project it is
|
|
856
856
|
* @param {number} [pageToken] Page reference token
|
|
857
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
857
|
+
* @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.
|
|
858
858
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
859
859
|
* @param {*} [options] Override http request option.
|
|
860
860
|
* @throws {RequiredError}
|
|
@@ -1114,18 +1114,117 @@ exports.ApplicationTechnologiesApi = ApplicationTechnologiesApi;
|
|
|
1114
1114
|
*/
|
|
1115
1115
|
const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
1116
1116
|
return {
|
|
1117
|
+
/**
|
|
1118
|
+
* Exports all products with analytics data in a CSV file.
|
|
1119
|
+
* @summary Export product analytics
|
|
1120
|
+
* @param {string} project What project it is
|
|
1121
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1122
|
+
* @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.
|
|
1123
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1124
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
1125
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
1126
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
1127
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
1128
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
1129
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
1130
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1131
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1132
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1133
|
+
* @param {*} [options] Override http request option.
|
|
1134
|
+
* @throws {RequiredError}
|
|
1135
|
+
*/
|
|
1136
|
+
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 = {}) {
|
|
1137
|
+
// verify required parameter 'project' is not null or undefined
|
|
1138
|
+
(0, common_1.assertParamExists)('exportProductAnalytics', 'project', project);
|
|
1139
|
+
const localVarPath = `/v1/catalog/analytics/export`;
|
|
1140
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1141
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1142
|
+
let baseOptions;
|
|
1143
|
+
if (configuration) {
|
|
1144
|
+
baseOptions = configuration.baseOptions;
|
|
1145
|
+
}
|
|
1146
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1147
|
+
const localVarHeaderParameter = {};
|
|
1148
|
+
const localVarQueryParameter = {};
|
|
1149
|
+
// authentication session-oauth required
|
|
1150
|
+
// oauth required
|
|
1151
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1152
|
+
// authentication api-key required
|
|
1153
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1154
|
+
if (project !== undefined) {
|
|
1155
|
+
localVarQueryParameter['project'] = project;
|
|
1156
|
+
}
|
|
1157
|
+
if (sortBy) {
|
|
1158
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1159
|
+
}
|
|
1160
|
+
if (search !== undefined) {
|
|
1161
|
+
localVarQueryParameter['search'] = search;
|
|
1162
|
+
}
|
|
1163
|
+
if (dateRangeStartDate !== undefined) {
|
|
1164
|
+
localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate instanceof Date) ?
|
|
1165
|
+
dateRangeStartDate.toISOString() :
|
|
1166
|
+
dateRangeStartDate;
|
|
1167
|
+
}
|
|
1168
|
+
if (dateRangeEndDate !== undefined) {
|
|
1169
|
+
localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate instanceof Date) ?
|
|
1170
|
+
dateRangeEndDate.toISOString() :
|
|
1171
|
+
dateRangeEndDate;
|
|
1172
|
+
}
|
|
1173
|
+
if (minimumRevenue !== undefined) {
|
|
1174
|
+
localVarQueryParameter['minimumRevenue'] = minimumRevenue;
|
|
1175
|
+
}
|
|
1176
|
+
if (maximumRevenue !== undefined) {
|
|
1177
|
+
localVarQueryParameter['maximumRevenue'] = maximumRevenue;
|
|
1178
|
+
}
|
|
1179
|
+
if (minimumSales !== undefined) {
|
|
1180
|
+
localVarQueryParameter['minimumSales'] = minimumSales;
|
|
1181
|
+
}
|
|
1182
|
+
if (maximumSales !== undefined) {
|
|
1183
|
+
localVarQueryParameter['maximumSales'] = maximumSales;
|
|
1184
|
+
}
|
|
1185
|
+
if (minimumBasketPercent !== undefined) {
|
|
1186
|
+
localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
|
|
1187
|
+
}
|
|
1188
|
+
if (maximumBasketPercent !== undefined) {
|
|
1189
|
+
localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
|
|
1190
|
+
}
|
|
1191
|
+
if (minimumTraffic !== undefined) {
|
|
1192
|
+
localVarQueryParameter['minimumTraffic'] = minimumTraffic;
|
|
1193
|
+
}
|
|
1194
|
+
if (maximumTraffic !== undefined) {
|
|
1195
|
+
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
1196
|
+
}
|
|
1197
|
+
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
1198
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1199
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1200
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1201
|
+
return {
|
|
1202
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1203
|
+
options: localVarRequestOptions,
|
|
1204
|
+
};
|
|
1205
|
+
}),
|
|
1117
1206
|
/**
|
|
1118
1207
|
* Lists all product analytics items.
|
|
1119
1208
|
* @summary List product analytics
|
|
1120
1209
|
* @param {string} project What project it is
|
|
1121
1210
|
* @param {number} [pageToken] Page reference token
|
|
1122
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
1123
|
-
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1124
1211
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1212
|
+
* @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.
|
|
1213
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1214
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1215
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
1216
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
1217
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
1218
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
1219
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
1220
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
1221
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1222
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1223
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1125
1224
|
* @param {*} [options] Override http request option.
|
|
1126
1225
|
* @throws {RequiredError}
|
|
1127
1226
|
*/
|
|
1128
|
-
listProductAnalytics: (project_1, pageToken_1, search_1, sortBy_1,
|
|
1227
|
+
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 = {}) {
|
|
1129
1228
|
// verify required parameter 'project' is not null or undefined
|
|
1130
1229
|
(0, common_1.assertParamExists)('listProductAnalytics', 'project', project);
|
|
1131
1230
|
const localVarPath = `/v1/catalog/analytics`;
|
|
@@ -1149,14 +1248,48 @@ const ProductAnalyticsApiAxiosParamCreator = function (configuration) {
|
|
|
1149
1248
|
if (pageToken !== undefined) {
|
|
1150
1249
|
localVarQueryParameter['pageToken'] = pageToken;
|
|
1151
1250
|
}
|
|
1251
|
+
if (pageSize !== undefined) {
|
|
1252
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1253
|
+
}
|
|
1152
1254
|
if (search !== undefined) {
|
|
1153
1255
|
localVarQueryParameter['search'] = search;
|
|
1154
1256
|
}
|
|
1155
1257
|
if (sortBy) {
|
|
1156
1258
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
1157
1259
|
}
|
|
1158
|
-
if (
|
|
1159
|
-
localVarQueryParameter['
|
|
1260
|
+
if (dateRangeStartDate !== undefined) {
|
|
1261
|
+
localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate instanceof Date) ?
|
|
1262
|
+
dateRangeStartDate.toISOString() :
|
|
1263
|
+
dateRangeStartDate;
|
|
1264
|
+
}
|
|
1265
|
+
if (dateRangeEndDate !== undefined) {
|
|
1266
|
+
localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate instanceof Date) ?
|
|
1267
|
+
dateRangeEndDate.toISOString() :
|
|
1268
|
+
dateRangeEndDate;
|
|
1269
|
+
}
|
|
1270
|
+
if (minimumRevenue !== undefined) {
|
|
1271
|
+
localVarQueryParameter['minimumRevenue'] = minimumRevenue;
|
|
1272
|
+
}
|
|
1273
|
+
if (maximumRevenue !== undefined) {
|
|
1274
|
+
localVarQueryParameter['maximumRevenue'] = maximumRevenue;
|
|
1275
|
+
}
|
|
1276
|
+
if (minimumSales !== undefined) {
|
|
1277
|
+
localVarQueryParameter['minimumSales'] = minimumSales;
|
|
1278
|
+
}
|
|
1279
|
+
if (maximumSales !== undefined) {
|
|
1280
|
+
localVarQueryParameter['maximumSales'] = maximumSales;
|
|
1281
|
+
}
|
|
1282
|
+
if (minimumBasketPercent !== undefined) {
|
|
1283
|
+
localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
|
|
1284
|
+
}
|
|
1285
|
+
if (maximumBasketPercent !== undefined) {
|
|
1286
|
+
localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
|
|
1287
|
+
}
|
|
1288
|
+
if (minimumTraffic !== undefined) {
|
|
1289
|
+
localVarQueryParameter['minimumTraffic'] = minimumTraffic;
|
|
1290
|
+
}
|
|
1291
|
+
if (maximumTraffic !== undefined) {
|
|
1292
|
+
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
1160
1293
|
}
|
|
1161
1294
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1162
1295
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1176,21 +1309,59 @@ exports.ProductAnalyticsApiAxiosParamCreator = ProductAnalyticsApiAxiosParamCrea
|
|
|
1176
1309
|
const ProductAnalyticsApiFp = function (configuration) {
|
|
1177
1310
|
const localVarAxiosParamCreator = (0, exports.ProductAnalyticsApiAxiosParamCreator)(configuration);
|
|
1178
1311
|
return {
|
|
1312
|
+
/**
|
|
1313
|
+
* Exports all products with analytics data in a CSV file.
|
|
1314
|
+
* @summary Export product analytics
|
|
1315
|
+
* @param {string} project What project it is
|
|
1316
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1317
|
+
* @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.
|
|
1318
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1319
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
1320
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
1321
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
1322
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
1323
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
1324
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
1325
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1326
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1327
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1328
|
+
* @param {*} [options] Override http request option.
|
|
1329
|
+
* @throws {RequiredError}
|
|
1330
|
+
*/
|
|
1331
|
+
exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options) {
|
|
1332
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1333
|
+
var _a, _b, _c;
|
|
1334
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
|
|
1335
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1336
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductAnalyticsApi.exportProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1337
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1338
|
+
});
|
|
1339
|
+
},
|
|
1179
1340
|
/**
|
|
1180
1341
|
* Lists all product analytics items.
|
|
1181
1342
|
* @summary List product analytics
|
|
1182
1343
|
* @param {string} project What project it is
|
|
1183
1344
|
* @param {number} [pageToken] Page reference token
|
|
1184
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
1185
|
-
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1186
1345
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1346
|
+
* @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.
|
|
1347
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1348
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
1349
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
1350
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
1351
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
1352
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
1353
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
1354
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
1355
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
1356
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
1357
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
1187
1358
|
* @param {*} [options] Override http request option.
|
|
1188
1359
|
* @throws {RequiredError}
|
|
1189
1360
|
*/
|
|
1190
|
-
listProductAnalytics(project, pageToken, search, sortBy,
|
|
1361
|
+
listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options) {
|
|
1191
1362
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1192
1363
|
var _a, _b, _c;
|
|
1193
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, search, sortBy,
|
|
1364
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
|
|
1194
1365
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1195
1366
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductAnalyticsApi.listProductAnalytics']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1196
1367
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1205,6 +1376,16 @@ exports.ProductAnalyticsApiFp = ProductAnalyticsApiFp;
|
|
|
1205
1376
|
const ProductAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
1206
1377
|
const localVarFp = (0, exports.ProductAnalyticsApiFp)(configuration);
|
|
1207
1378
|
return {
|
|
1379
|
+
/**
|
|
1380
|
+
* Exports all products with analytics data in a CSV file.
|
|
1381
|
+
* @summary Export product analytics
|
|
1382
|
+
* @param {ProductAnalyticsApiExportProductAnalyticsRequest} requestParameters Request parameters.
|
|
1383
|
+
* @param {*} [options] Override http request option.
|
|
1384
|
+
* @throws {RequiredError}
|
|
1385
|
+
*/
|
|
1386
|
+
exportProductAnalytics(requestParameters, options) {
|
|
1387
|
+
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));
|
|
1388
|
+
},
|
|
1208
1389
|
/**
|
|
1209
1390
|
* Lists all product analytics items.
|
|
1210
1391
|
* @summary List product analytics
|
|
@@ -1213,7 +1394,7 @@ const ProductAnalyticsApiFactory = function (configuration, basePath, axios) {
|
|
|
1213
1394
|
* @throws {RequiredError}
|
|
1214
1395
|
*/
|
|
1215
1396
|
listProductAnalytics(requestParameters, options) {
|
|
1216
|
-
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.
|
|
1397
|
+
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));
|
|
1217
1398
|
},
|
|
1218
1399
|
};
|
|
1219
1400
|
};
|
|
@@ -1222,6 +1403,16 @@ exports.ProductAnalyticsApiFactory = ProductAnalyticsApiFactory;
|
|
|
1222
1403
|
* ProductAnalyticsApi - object-oriented interface
|
|
1223
1404
|
*/
|
|
1224
1405
|
class ProductAnalyticsApi extends base_1.BaseAPI {
|
|
1406
|
+
/**
|
|
1407
|
+
* Exports all products with analytics data in a CSV file.
|
|
1408
|
+
* @summary Export product analytics
|
|
1409
|
+
* @param {ProductAnalyticsApiExportProductAnalyticsRequest} requestParameters Request parameters.
|
|
1410
|
+
* @param {*} [options] Override http request option.
|
|
1411
|
+
* @throws {RequiredError}
|
|
1412
|
+
*/
|
|
1413
|
+
exportProductAnalytics(requestParameters, options) {
|
|
1414
|
+
return (0, exports.ProductAnalyticsApiFp)(this.configuration).exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(this.axios, this.basePath));
|
|
1415
|
+
}
|
|
1225
1416
|
/**
|
|
1226
1417
|
* Lists all product analytics items.
|
|
1227
1418
|
* @summary List product analytics
|
|
@@ -1230,10 +1421,125 @@ class ProductAnalyticsApi extends base_1.BaseAPI {
|
|
|
1230
1421
|
* @throws {RequiredError}
|
|
1231
1422
|
*/
|
|
1232
1423
|
listProductAnalytics(requestParameters, options) {
|
|
1233
|
-
return (0, exports.ProductAnalyticsApiFp)(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.
|
|
1424
|
+
return (0, exports.ProductAnalyticsApiFp)(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(this.axios, this.basePath));
|
|
1234
1425
|
}
|
|
1235
1426
|
}
|
|
1236
1427
|
exports.ProductAnalyticsApi = ProductAnalyticsApi;
|
|
1428
|
+
/**
|
|
1429
|
+
* ProductTypesApi - axios parameter creator
|
|
1430
|
+
*/
|
|
1431
|
+
const ProductTypesApiAxiosParamCreator = function (configuration) {
|
|
1432
|
+
return {
|
|
1433
|
+
/**
|
|
1434
|
+
* Lists the product types used by the given project\'s catalog.
|
|
1435
|
+
* @summary List product types
|
|
1436
|
+
* @param {string} project What project it is
|
|
1437
|
+
* @param {number} [pageToken] Page reference token
|
|
1438
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1439
|
+
* @param {*} [options] Override http request option.
|
|
1440
|
+
* @throws {RequiredError}
|
|
1441
|
+
*/
|
|
1442
|
+
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 = {}) {
|
|
1443
|
+
// verify required parameter 'project' is not null or undefined
|
|
1444
|
+
(0, common_1.assertParamExists)('listProductTypes', 'project', project);
|
|
1445
|
+
const localVarPath = `/v1/catalog/product-types`;
|
|
1446
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1447
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1448
|
+
let baseOptions;
|
|
1449
|
+
if (configuration) {
|
|
1450
|
+
baseOptions = configuration.baseOptions;
|
|
1451
|
+
}
|
|
1452
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1453
|
+
const localVarHeaderParameter = {};
|
|
1454
|
+
const localVarQueryParameter = {};
|
|
1455
|
+
// authentication session-oauth required
|
|
1456
|
+
// oauth required
|
|
1457
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1458
|
+
// authentication api-key required
|
|
1459
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
1460
|
+
if (project !== undefined) {
|
|
1461
|
+
localVarQueryParameter['project'] = project;
|
|
1462
|
+
}
|
|
1463
|
+
if (pageToken !== undefined) {
|
|
1464
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1465
|
+
}
|
|
1466
|
+
if (pageSize !== undefined) {
|
|
1467
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1468
|
+
}
|
|
1469
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1470
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1471
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1472
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1473
|
+
return {
|
|
1474
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1475
|
+
options: localVarRequestOptions,
|
|
1476
|
+
};
|
|
1477
|
+
}),
|
|
1478
|
+
};
|
|
1479
|
+
};
|
|
1480
|
+
exports.ProductTypesApiAxiosParamCreator = ProductTypesApiAxiosParamCreator;
|
|
1481
|
+
/**
|
|
1482
|
+
* ProductTypesApi - functional programming interface
|
|
1483
|
+
*/
|
|
1484
|
+
const ProductTypesApiFp = function (configuration) {
|
|
1485
|
+
const localVarAxiosParamCreator = (0, exports.ProductTypesApiAxiosParamCreator)(configuration);
|
|
1486
|
+
return {
|
|
1487
|
+
/**
|
|
1488
|
+
* Lists the product types used by the given project\'s catalog.
|
|
1489
|
+
* @summary List product types
|
|
1490
|
+
* @param {string} project What project it is
|
|
1491
|
+
* @param {number} [pageToken] Page reference token
|
|
1492
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1493
|
+
* @param {*} [options] Override http request option.
|
|
1494
|
+
* @throws {RequiredError}
|
|
1495
|
+
*/
|
|
1496
|
+
listProductTypes(project, pageToken, pageSize, options) {
|
|
1497
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1498
|
+
var _a, _b, _c;
|
|
1499
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductTypes(project, pageToken, pageSize, options);
|
|
1500
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1501
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductTypesApi.listProductTypes']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1502
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1503
|
+
});
|
|
1504
|
+
},
|
|
1505
|
+
};
|
|
1506
|
+
};
|
|
1507
|
+
exports.ProductTypesApiFp = ProductTypesApiFp;
|
|
1508
|
+
/**
|
|
1509
|
+
* ProductTypesApi - factory interface
|
|
1510
|
+
*/
|
|
1511
|
+
const ProductTypesApiFactory = function (configuration, basePath, axios) {
|
|
1512
|
+
const localVarFp = (0, exports.ProductTypesApiFp)(configuration);
|
|
1513
|
+
return {
|
|
1514
|
+
/**
|
|
1515
|
+
* Lists the product types used by the given project\'s catalog.
|
|
1516
|
+
* @summary List product types
|
|
1517
|
+
* @param {ProductTypesApiListProductTypesRequest} requestParameters Request parameters.
|
|
1518
|
+
* @param {*} [options] Override http request option.
|
|
1519
|
+
* @throws {RequiredError}
|
|
1520
|
+
*/
|
|
1521
|
+
listProductTypes(requestParameters, options) {
|
|
1522
|
+
return localVarFp.listProductTypes(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1523
|
+
},
|
|
1524
|
+
};
|
|
1525
|
+
};
|
|
1526
|
+
exports.ProductTypesApiFactory = ProductTypesApiFactory;
|
|
1527
|
+
/**
|
|
1528
|
+
* ProductTypesApi - object-oriented interface
|
|
1529
|
+
*/
|
|
1530
|
+
class ProductTypesApi extends base_1.BaseAPI {
|
|
1531
|
+
/**
|
|
1532
|
+
* Lists the product types used by the given project\'s catalog.
|
|
1533
|
+
* @summary List product types
|
|
1534
|
+
* @param {ProductTypesApiListProductTypesRequest} requestParameters Request parameters.
|
|
1535
|
+
* @param {*} [options] Override http request option.
|
|
1536
|
+
* @throws {RequiredError}
|
|
1537
|
+
*/
|
|
1538
|
+
listProductTypes(requestParameters, options) {
|
|
1539
|
+
return (0, exports.ProductTypesApiFp)(this.configuration).listProductTypes(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
1540
|
+
}
|
|
1541
|
+
}
|
|
1542
|
+
exports.ProductTypesApi = ProductTypesApi;
|
|
1237
1543
|
/**
|
|
1238
1544
|
* ProductsApi - axios parameter creator
|
|
1239
1545
|
*/
|
|
@@ -1406,10 +1712,16 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
1406
1712
|
* Export the project\'s products and variants as a CSV file.
|
|
1407
1713
|
* @summary Export products
|
|
1408
1714
|
* @param {string} project What project it is
|
|
1715
|
+
* @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.
|
|
1716
|
+
* @param {string} [start] Start of date range to filter
|
|
1717
|
+
* @param {string} [end] End of date range to filter
|
|
1718
|
+
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1719
|
+
* @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.
|
|
1720
|
+
* @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.
|
|
1409
1721
|
* @param {*} [options] Override http request option.
|
|
1410
1722
|
* @throws {RequiredError}
|
|
1411
1723
|
*/
|
|
1412
|
-
exportProducts: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
|
|
1724
|
+
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 = {}) {
|
|
1413
1725
|
// verify required parameter 'project' is not null or undefined
|
|
1414
1726
|
(0, common_1.assertParamExists)('exportProducts', 'project', project);
|
|
1415
1727
|
const localVarPath = `/v1/catalog/products/export`;
|
|
@@ -1430,6 +1742,28 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
1430
1742
|
if (project !== undefined) {
|
|
1431
1743
|
localVarQueryParameter['project'] = project;
|
|
1432
1744
|
}
|
|
1745
|
+
if (search !== undefined) {
|
|
1746
|
+
localVarQueryParameter['search'] = search;
|
|
1747
|
+
}
|
|
1748
|
+
if (start !== undefined) {
|
|
1749
|
+
localVarQueryParameter['start'] = (start instanceof Date) ?
|
|
1750
|
+
start.toISOString() :
|
|
1751
|
+
start;
|
|
1752
|
+
}
|
|
1753
|
+
if (end !== undefined) {
|
|
1754
|
+
localVarQueryParameter['end'] = (end instanceof Date) ?
|
|
1755
|
+
end.toISOString() :
|
|
1756
|
+
end;
|
|
1757
|
+
}
|
|
1758
|
+
if (dateFilterType !== undefined) {
|
|
1759
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
1760
|
+
}
|
|
1761
|
+
if (maxRetailPrice !== undefined) {
|
|
1762
|
+
localVarQueryParameter['maxRetailPrice'] = maxRetailPrice;
|
|
1763
|
+
}
|
|
1764
|
+
if (minRetailPrice !== undefined) {
|
|
1765
|
+
localVarQueryParameter['minRetailPrice'] = minRetailPrice;
|
|
1766
|
+
}
|
|
1433
1767
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
1434
1768
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1435
1769
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -1529,17 +1863,19 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
1529
1863
|
* @summary List products
|
|
1530
1864
|
* @param {string} project What project it is
|
|
1531
1865
|
* @param {number} [pageToken] Page reference token
|
|
1532
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
1866
|
+
* @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.
|
|
1533
1867
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1534
1868
|
* @param {string} [start] Start of date range to filter
|
|
1535
1869
|
* @param {string} [end] End of date range to filter
|
|
1536
1870
|
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1871
|
+
* @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.
|
|
1872
|
+
* @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.
|
|
1537
1873
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1538
1874
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1539
1875
|
* @param {*} [options] Override http request option.
|
|
1540
1876
|
* @throws {RequiredError}
|
|
1541
1877
|
*/
|
|
1542
|
-
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 = {}) {
|
|
1878
|
+
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 = {}) {
|
|
1543
1879
|
// verify required parameter 'project' is not null or undefined
|
|
1544
1880
|
(0, common_1.assertParamExists)('listProducts', 'project', project);
|
|
1545
1881
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -1582,6 +1918,12 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
1582
1918
|
if (dateFilterType !== undefined) {
|
|
1583
1919
|
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
1584
1920
|
}
|
|
1921
|
+
if (maxRetailPrice !== undefined) {
|
|
1922
|
+
localVarQueryParameter['maxRetailPrice'] = maxRetailPrice;
|
|
1923
|
+
}
|
|
1924
|
+
if (minRetailPrice !== undefined) {
|
|
1925
|
+
localVarQueryParameter['minRetailPrice'] = minRetailPrice;
|
|
1926
|
+
}
|
|
1585
1927
|
if (pageSize !== undefined) {
|
|
1586
1928
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
1587
1929
|
}
|
|
@@ -1804,13 +2146,19 @@ const ProductsApiFp = function (configuration) {
|
|
|
1804
2146
|
* Export the project\'s products and variants as a CSV file.
|
|
1805
2147
|
* @summary Export products
|
|
1806
2148
|
* @param {string} project What project it is
|
|
2149
|
+
* @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.
|
|
2150
|
+
* @param {string} [start] Start of date range to filter
|
|
2151
|
+
* @param {string} [end] End of date range to filter
|
|
2152
|
+
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2153
|
+
* @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.
|
|
2154
|
+
* @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.
|
|
1807
2155
|
* @param {*} [options] Override http request option.
|
|
1808
2156
|
* @throws {RequiredError}
|
|
1809
2157
|
*/
|
|
1810
|
-
exportProducts(project, options) {
|
|
2158
|
+
exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options) {
|
|
1811
2159
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1812
2160
|
var _a, _b, _c;
|
|
1813
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProducts(project, options);
|
|
2161
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options);
|
|
1814
2162
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1815
2163
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.exportProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1816
2164
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1856,20 +2204,22 @@ const ProductsApiFp = function (configuration) {
|
|
|
1856
2204
|
* @summary List products
|
|
1857
2205
|
* @param {string} project What project it is
|
|
1858
2206
|
* @param {number} [pageToken] Page reference token
|
|
1859
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2207
|
+
* @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.
|
|
1860
2208
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1861
2209
|
* @param {string} [start] Start of date range to filter
|
|
1862
2210
|
* @param {string} [end] End of date range to filter
|
|
1863
2211
|
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2212
|
+
* @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.
|
|
2213
|
+
* @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.
|
|
1864
2214
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1865
2215
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1866
2216
|
* @param {*} [options] Override http request option.
|
|
1867
2217
|
* @throws {RequiredError}
|
|
1868
2218
|
*/
|
|
1869
|
-
listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options) {
|
|
2219
|
+
listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options) {
|
|
1870
2220
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1871
2221
|
var _a, _b, _c;
|
|
1872
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options);
|
|
2222
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options);
|
|
1873
2223
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1874
2224
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.listProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1875
2225
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1984,7 +2334,7 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
1984
2334
|
* @throws {RequiredError}
|
|
1985
2335
|
*/
|
|
1986
2336
|
exportProducts(requestParameters, options) {
|
|
1987
|
-
return localVarFp.exportProducts(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
2337
|
+
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(axios, basePath));
|
|
1988
2338
|
},
|
|
1989
2339
|
/**
|
|
1990
2340
|
* Gets a product by a given ID.
|
|
@@ -2014,7 +2364,7 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
2014
2364
|
* @throws {RequiredError}
|
|
2015
2365
|
*/
|
|
2016
2366
|
listProducts(requestParameters, options) {
|
|
2017
|
-
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));
|
|
2367
|
+
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));
|
|
2018
2368
|
},
|
|
2019
2369
|
/**
|
|
2020
2370
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -2101,7 +2451,7 @@ class ProductsApi extends base_1.BaseAPI {
|
|
|
2101
2451
|
* @throws {RequiredError}
|
|
2102
2452
|
*/
|
|
2103
2453
|
exportProducts(requestParameters, options) {
|
|
2104
|
-
return (0, exports.ProductsApiFp)(this.configuration).exportProducts(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
2454
|
+
return (0, exports.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));
|
|
2105
2455
|
}
|
|
2106
2456
|
/**
|
|
2107
2457
|
* Gets a product by a given ID.
|
|
@@ -2131,7 +2481,7 @@ class ProductsApi extends base_1.BaseAPI {
|
|
|
2131
2481
|
* @throws {RequiredError}
|
|
2132
2482
|
*/
|
|
2133
2483
|
listProducts(requestParameters, options) {
|
|
2134
|
-
return (0, exports.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));
|
|
2484
|
+
return (0, exports.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));
|
|
2135
2485
|
}
|
|
2136
2486
|
/**
|
|
2137
2487
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -2165,6 +2515,10 @@ class ProductsApi extends base_1.BaseAPI {
|
|
|
2165
2515
|
}
|
|
2166
2516
|
}
|
|
2167
2517
|
exports.ProductsApi = ProductsApi;
|
|
2518
|
+
exports.ExportProductsDateFilterTypeEnum = {
|
|
2519
|
+
CreatedAt: 'createdAt',
|
|
2520
|
+
UpdatedAt: 'updatedAt'
|
|
2521
|
+
};
|
|
2168
2522
|
exports.ListProductsDateFilterTypeEnum = {
|
|
2169
2523
|
CreatedAt: 'createdAt',
|
|
2170
2524
|
UpdatedAt: 'updatedAt'
|
|
@@ -2223,7 +2577,7 @@ const VariantsApiAxiosParamCreator = function (configuration) {
|
|
|
2223
2577
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
2224
2578
|
* @summary List variants
|
|
2225
2579
|
* @param {string} project What project it is
|
|
2226
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2580
|
+
* @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.
|
|
2227
2581
|
* @param {number} [pageToken] Page reference token
|
|
2228
2582
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2229
2583
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
@@ -2303,7 +2657,7 @@ const VariantsApiFp = function (configuration) {
|
|
|
2303
2657
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
2304
2658
|
* @summary List variants
|
|
2305
2659
|
* @param {string} project What project it is
|
|
2306
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2660
|
+
* @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.
|
|
2307
2661
|
* @param {number} [pageToken] Page reference token
|
|
2308
2662
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2309
2663
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|