@teemill/product-catalog 1.84.0 → 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 +2 -2
- package/api.ts +267 -17
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +141 -9
- package/dist/api.js +133 -15
- 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 +141 -9
- package/dist/esm/api.js +133 -15
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ProductAnalyticsApi.md +70 -4
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.85.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/product-catalog@1.
|
|
39
|
+
npm install @teemill/product-catalog@1.85.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
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.85.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3183,10 +3183,22 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3183
3183
|
* Exports all products with analytics data in a CSV file.
|
|
3184
3184
|
* @summary Export product analytics
|
|
3185
3185
|
* @param {string} project What project it is
|
|
3186
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3187
|
+
* @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.
|
|
3188
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3189
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
3190
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
3191
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
3192
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
3193
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
3194
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
3195
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3196
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3197
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
3186
3198
|
* @param {*} [options] Override http request option.
|
|
3187
3199
|
* @throws {RequiredError}
|
|
3188
3200
|
*/
|
|
3189
|
-
exportProductAnalytics: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3201
|
+
exportProductAnalytics: async (project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3190
3202
|
// verify required parameter 'project' is not null or undefined
|
|
3191
3203
|
assertParamExists('exportProductAnalytics', 'project', project)
|
|
3192
3204
|
const localVarPath = `/v1/catalog/analytics/export`;
|
|
@@ -3212,6 +3224,58 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3212
3224
|
localVarQueryParameter['project'] = project;
|
|
3213
3225
|
}
|
|
3214
3226
|
|
|
3227
|
+
if (sortBy) {
|
|
3228
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
3229
|
+
}
|
|
3230
|
+
|
|
3231
|
+
if (search !== undefined) {
|
|
3232
|
+
localVarQueryParameter['search'] = search;
|
|
3233
|
+
}
|
|
3234
|
+
|
|
3235
|
+
if (dateRangeStartDate !== undefined) {
|
|
3236
|
+
localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate as any instanceof Date) ?
|
|
3237
|
+
(dateRangeStartDate as any).toISOString() :
|
|
3238
|
+
dateRangeStartDate;
|
|
3239
|
+
}
|
|
3240
|
+
|
|
3241
|
+
if (dateRangeEndDate !== undefined) {
|
|
3242
|
+
localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate as any instanceof Date) ?
|
|
3243
|
+
(dateRangeEndDate as any).toISOString() :
|
|
3244
|
+
dateRangeEndDate;
|
|
3245
|
+
}
|
|
3246
|
+
|
|
3247
|
+
if (minimumRevenue !== undefined) {
|
|
3248
|
+
localVarQueryParameter['minimumRevenue'] = minimumRevenue;
|
|
3249
|
+
}
|
|
3250
|
+
|
|
3251
|
+
if (maximumRevenue !== undefined) {
|
|
3252
|
+
localVarQueryParameter['maximumRevenue'] = maximumRevenue;
|
|
3253
|
+
}
|
|
3254
|
+
|
|
3255
|
+
if (minimumSales !== undefined) {
|
|
3256
|
+
localVarQueryParameter['minimumSales'] = minimumSales;
|
|
3257
|
+
}
|
|
3258
|
+
|
|
3259
|
+
if (maximumSales !== undefined) {
|
|
3260
|
+
localVarQueryParameter['maximumSales'] = maximumSales;
|
|
3261
|
+
}
|
|
3262
|
+
|
|
3263
|
+
if (minimumBasketPercent !== undefined) {
|
|
3264
|
+
localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
|
|
3265
|
+
}
|
|
3266
|
+
|
|
3267
|
+
if (maximumBasketPercent !== undefined) {
|
|
3268
|
+
localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
|
|
3269
|
+
}
|
|
3270
|
+
|
|
3271
|
+
if (minimumTraffic !== undefined) {
|
|
3272
|
+
localVarQueryParameter['minimumTraffic'] = minimumTraffic;
|
|
3273
|
+
}
|
|
3274
|
+
|
|
3275
|
+
if (maximumTraffic !== undefined) {
|
|
3276
|
+
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
3277
|
+
}
|
|
3278
|
+
|
|
3215
3279
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
3216
3280
|
|
|
3217
3281
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3228,13 +3292,23 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3228
3292
|
* @summary List product analytics
|
|
3229
3293
|
* @param {string} project What project it is
|
|
3230
3294
|
* @param {number} [pageToken] Page reference token
|
|
3295
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3231
3296
|
* @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.
|
|
3232
3297
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3233
|
-
* @param {
|
|
3298
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3299
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
3300
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
3301
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
3302
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
3303
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
3304
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
3305
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3306
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3307
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
3234
3308
|
* @param {*} [options] Override http request option.
|
|
3235
3309
|
* @throws {RequiredError}
|
|
3236
3310
|
*/
|
|
3237
|
-
listProductAnalytics: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>,
|
|
3311
|
+
listProductAnalytics: async (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3238
3312
|
// verify required parameter 'project' is not null or undefined
|
|
3239
3313
|
assertParamExists('listProductAnalytics', 'project', project)
|
|
3240
3314
|
const localVarPath = `/v1/catalog/analytics`;
|
|
@@ -3264,6 +3338,10 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3264
3338
|
localVarQueryParameter['pageToken'] = pageToken;
|
|
3265
3339
|
}
|
|
3266
3340
|
|
|
3341
|
+
if (pageSize !== undefined) {
|
|
3342
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
3343
|
+
}
|
|
3344
|
+
|
|
3267
3345
|
if (search !== undefined) {
|
|
3268
3346
|
localVarQueryParameter['search'] = search;
|
|
3269
3347
|
}
|
|
@@ -3272,8 +3350,48 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3272
3350
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
3273
3351
|
}
|
|
3274
3352
|
|
|
3275
|
-
if (
|
|
3276
|
-
localVarQueryParameter['
|
|
3353
|
+
if (dateRangeStartDate !== undefined) {
|
|
3354
|
+
localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate as any instanceof Date) ?
|
|
3355
|
+
(dateRangeStartDate as any).toISOString() :
|
|
3356
|
+
dateRangeStartDate;
|
|
3357
|
+
}
|
|
3358
|
+
|
|
3359
|
+
if (dateRangeEndDate !== undefined) {
|
|
3360
|
+
localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate as any instanceof Date) ?
|
|
3361
|
+
(dateRangeEndDate as any).toISOString() :
|
|
3362
|
+
dateRangeEndDate;
|
|
3363
|
+
}
|
|
3364
|
+
|
|
3365
|
+
if (minimumRevenue !== undefined) {
|
|
3366
|
+
localVarQueryParameter['minimumRevenue'] = minimumRevenue;
|
|
3367
|
+
}
|
|
3368
|
+
|
|
3369
|
+
if (maximumRevenue !== undefined) {
|
|
3370
|
+
localVarQueryParameter['maximumRevenue'] = maximumRevenue;
|
|
3371
|
+
}
|
|
3372
|
+
|
|
3373
|
+
if (minimumSales !== undefined) {
|
|
3374
|
+
localVarQueryParameter['minimumSales'] = minimumSales;
|
|
3375
|
+
}
|
|
3376
|
+
|
|
3377
|
+
if (maximumSales !== undefined) {
|
|
3378
|
+
localVarQueryParameter['maximumSales'] = maximumSales;
|
|
3379
|
+
}
|
|
3380
|
+
|
|
3381
|
+
if (minimumBasketPercent !== undefined) {
|
|
3382
|
+
localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
|
|
3383
|
+
}
|
|
3384
|
+
|
|
3385
|
+
if (maximumBasketPercent !== undefined) {
|
|
3386
|
+
localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
|
|
3387
|
+
}
|
|
3388
|
+
|
|
3389
|
+
if (minimumTraffic !== undefined) {
|
|
3390
|
+
localVarQueryParameter['minimumTraffic'] = minimumTraffic;
|
|
3391
|
+
}
|
|
3392
|
+
|
|
3393
|
+
if (maximumTraffic !== undefined) {
|
|
3394
|
+
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
3277
3395
|
}
|
|
3278
3396
|
|
|
3279
3397
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
@@ -3300,11 +3418,23 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3300
3418
|
* Exports all products with analytics data in a CSV file.
|
|
3301
3419
|
* @summary Export product analytics
|
|
3302
3420
|
* @param {string} project What project it is
|
|
3421
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3422
|
+
* @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.
|
|
3423
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3424
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
3425
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
3426
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
3427
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
3428
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
3429
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
3430
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3431
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3432
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
3303
3433
|
* @param {*} [options] Override http request option.
|
|
3304
3434
|
* @throws {RequiredError}
|
|
3305
3435
|
*/
|
|
3306
|
-
async exportProductAnalytics(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3307
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProductAnalytics(project, options);
|
|
3436
|
+
async exportProductAnalytics(project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3437
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
|
|
3308
3438
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3309
3439
|
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.exportProductAnalytics']?.[localVarOperationServerIndex]?.url;
|
|
3310
3440
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3314,14 +3444,24 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3314
3444
|
* @summary List product analytics
|
|
3315
3445
|
* @param {string} project What project it is
|
|
3316
3446
|
* @param {number} [pageToken] Page reference token
|
|
3447
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3317
3448
|
* @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.
|
|
3318
3449
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3319
|
-
* @param {
|
|
3450
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3451
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
3452
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
3453
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
3454
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
3455
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
3456
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
3457
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3458
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3459
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
3320
3460
|
* @param {*} [options] Override http request option.
|
|
3321
3461
|
* @throws {RequiredError}
|
|
3322
3462
|
*/
|
|
3323
|
-
async listProductAnalytics(project: string, pageToken?: number, search?: string, sortBy?: Array<string>,
|
|
3324
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductAnalytics(project, pageToken, search, sortBy,
|
|
3463
|
+
async listProductAnalytics(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>> {
|
|
3464
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
|
|
3325
3465
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3326
3466
|
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.listProductAnalytics']?.[localVarOperationServerIndex]?.url;
|
|
3327
3467
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3343,7 +3483,7 @@ export const ProductAnalyticsApiFactory = function (configuration?: Configuratio
|
|
|
3343
3483
|
* @throws {RequiredError}
|
|
3344
3484
|
*/
|
|
3345
3485
|
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3346
|
-
return localVarFp.exportProductAnalytics(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
3486
|
+
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));
|
|
3347
3487
|
},
|
|
3348
3488
|
/**
|
|
3349
3489
|
* Lists all product analytics items.
|
|
@@ -3353,7 +3493,7 @@ export const ProductAnalyticsApiFactory = function (configuration?: Configuratio
|
|
|
3353
3493
|
* @throws {RequiredError}
|
|
3354
3494
|
*/
|
|
3355
3495
|
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductAnalyticsResponse> {
|
|
3356
|
-
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.
|
|
3496
|
+
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));
|
|
3357
3497
|
},
|
|
3358
3498
|
};
|
|
3359
3499
|
};
|
|
@@ -3366,6 +3506,66 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
|
3366
3506
|
* What project it is
|
|
3367
3507
|
*/
|
|
3368
3508
|
readonly project: string
|
|
3509
|
+
|
|
3510
|
+
/**
|
|
3511
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3512
|
+
*/
|
|
3513
|
+
readonly sortBy?: Array<string>
|
|
3514
|
+
|
|
3515
|
+
/**
|
|
3516
|
+
* 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.
|
|
3517
|
+
*/
|
|
3518
|
+
readonly search?: string
|
|
3519
|
+
|
|
3520
|
+
/**
|
|
3521
|
+
* Start date for the date range filter (ISO 8601 format)
|
|
3522
|
+
*/
|
|
3523
|
+
readonly dateRangeStartDate?: string
|
|
3524
|
+
|
|
3525
|
+
/**
|
|
3526
|
+
* End date for the date range filter (ISO 8601 format)
|
|
3527
|
+
*/
|
|
3528
|
+
readonly dateRangeEndDate?: string
|
|
3529
|
+
|
|
3530
|
+
/**
|
|
3531
|
+
* Filter to only include products with total revenue greater than or equal to this amount
|
|
3532
|
+
*/
|
|
3533
|
+
readonly minimumRevenue?: number
|
|
3534
|
+
|
|
3535
|
+
/**
|
|
3536
|
+
* Filter to only include products with total revenue less than or equal to this amount
|
|
3537
|
+
*/
|
|
3538
|
+
readonly maximumRevenue?: number
|
|
3539
|
+
|
|
3540
|
+
/**
|
|
3541
|
+
* Filter to only include products with total sales greater than or equal to this number
|
|
3542
|
+
*/
|
|
3543
|
+
readonly minimumSales?: number
|
|
3544
|
+
|
|
3545
|
+
/**
|
|
3546
|
+
* Filter to only include products with total sales less than or equal to this number
|
|
3547
|
+
*/
|
|
3548
|
+
readonly maximumSales?: number
|
|
3549
|
+
|
|
3550
|
+
/**
|
|
3551
|
+
* Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
3552
|
+
*/
|
|
3553
|
+
readonly minimumBasketPercent?: number
|
|
3554
|
+
|
|
3555
|
+
/**
|
|
3556
|
+
* Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3557
|
+
*/
|
|
3558
|
+
readonly maximumBasketPercent?: number
|
|
3559
|
+
|
|
3560
|
+
/**
|
|
3561
|
+
* Filter to only include products with total traffic greater than or equal to this number
|
|
3562
|
+
*/
|
|
3563
|
+
readonly minimumTraffic?: number
|
|
3564
|
+
|
|
3565
|
+
/**
|
|
3566
|
+
* Filter to only include products with total traffic less than or equal to this number
|
|
3567
|
+
*/
|
|
3568
|
+
readonly maximumTraffic?: number
|
|
3369
3569
|
}
|
|
3370
3570
|
|
|
3371
3571
|
/**
|
|
@@ -3382,6 +3582,11 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
3382
3582
|
*/
|
|
3383
3583
|
readonly pageToken?: number
|
|
3384
3584
|
|
|
3585
|
+
/**
|
|
3586
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3587
|
+
*/
|
|
3588
|
+
readonly pageSize?: number
|
|
3589
|
+
|
|
3385
3590
|
/**
|
|
3386
3591
|
* 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.
|
|
3387
3592
|
*/
|
|
@@ -3393,9 +3598,54 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
3393
3598
|
readonly sortBy?: Array<string>
|
|
3394
3599
|
|
|
3395
3600
|
/**
|
|
3396
|
-
*
|
|
3601
|
+
* Start date for the date range filter (ISO 8601 format)
|
|
3397
3602
|
*/
|
|
3398
|
-
readonly
|
|
3603
|
+
readonly dateRangeStartDate?: string
|
|
3604
|
+
|
|
3605
|
+
/**
|
|
3606
|
+
* End date for the date range filter (ISO 8601 format)
|
|
3607
|
+
*/
|
|
3608
|
+
readonly dateRangeEndDate?: string
|
|
3609
|
+
|
|
3610
|
+
/**
|
|
3611
|
+
* Filter to only include products with total revenue greater than or equal to this amount
|
|
3612
|
+
*/
|
|
3613
|
+
readonly minimumRevenue?: number
|
|
3614
|
+
|
|
3615
|
+
/**
|
|
3616
|
+
* Filter to only include products with total revenue less than or equal to this amount
|
|
3617
|
+
*/
|
|
3618
|
+
readonly maximumRevenue?: number
|
|
3619
|
+
|
|
3620
|
+
/**
|
|
3621
|
+
* Filter to only include products with total sales greater than or equal to this number
|
|
3622
|
+
*/
|
|
3623
|
+
readonly minimumSales?: number
|
|
3624
|
+
|
|
3625
|
+
/**
|
|
3626
|
+
* Filter to only include products with total sales less than or equal to this number
|
|
3627
|
+
*/
|
|
3628
|
+
readonly maximumSales?: number
|
|
3629
|
+
|
|
3630
|
+
/**
|
|
3631
|
+
* Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
3632
|
+
*/
|
|
3633
|
+
readonly minimumBasketPercent?: number
|
|
3634
|
+
|
|
3635
|
+
/**
|
|
3636
|
+
* Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3637
|
+
*/
|
|
3638
|
+
readonly maximumBasketPercent?: number
|
|
3639
|
+
|
|
3640
|
+
/**
|
|
3641
|
+
* Filter to only include products with total traffic greater than or equal to this number
|
|
3642
|
+
*/
|
|
3643
|
+
readonly minimumTraffic?: number
|
|
3644
|
+
|
|
3645
|
+
/**
|
|
3646
|
+
* Filter to only include products with total traffic less than or equal to this number
|
|
3647
|
+
*/
|
|
3648
|
+
readonly maximumTraffic?: number
|
|
3399
3649
|
}
|
|
3400
3650
|
|
|
3401
3651
|
/**
|
|
@@ -3410,7 +3660,7 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
3410
3660
|
* @throws {RequiredError}
|
|
3411
3661
|
*/
|
|
3412
3662
|
public exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
|
|
3413
|
-
return ProductAnalyticsApiFp(this.configuration).exportProductAnalytics(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
3663
|
+
return ProductAnalyticsApiFp(this.configuration).exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(this.axios, this.basePath));
|
|
3414
3664
|
}
|
|
3415
3665
|
|
|
3416
3666
|
/**
|
|
@@ -3421,7 +3671,7 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
3421
3671
|
* @throws {RequiredError}
|
|
3422
3672
|
*/
|
|
3423
3673
|
public listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
|
|
3424
|
-
return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.
|
|
3674
|
+
return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, options).then((request) => request(this.axios, this.basePath));
|
|
3425
3675
|
}
|
|
3426
3676
|
}
|
|
3427
3677
|
|
package/base.ts
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.85.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
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.85.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -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.85.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|