@teemill/product-catalog 1.83.1 → 1.84.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -2
- package/api.ts +368 -23
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +201 -17
- package/dist/api.js +256 -20
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +201 -17
- package/dist/esm/api.js +251 -19
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ApplicationSetsApi.md +2 -2
- package/docs/ProductAnalyticsApi.md +58 -2
- package/docs/ProductType.md +22 -0
- package/docs/ProductTypeListResponse.md +22 -0
- package/docs/ProductTypesApi.md +69 -0
- package/docs/ProductsApi.md +27 -3
- package/docs/VariantsApi.md +2 -2
- package/index.ts +1 -1
- package/package.json +2 -2
package/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.84.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1239,6 +1239,23 @@ export interface ProductBundleItemsInner {
|
|
|
1239
1239
|
'license'?: License;
|
|
1240
1240
|
'config'?: UpdateProductRequestBundleItemsInnerConfig;
|
|
1241
1241
|
}
|
|
1242
|
+
export interface ProductType {
|
|
1243
|
+
/**
|
|
1244
|
+
* Unique object identifier
|
|
1245
|
+
*/
|
|
1246
|
+
'id': string;
|
|
1247
|
+
/**
|
|
1248
|
+
* Name of the product type
|
|
1249
|
+
*/
|
|
1250
|
+
'name': string;
|
|
1251
|
+
}
|
|
1252
|
+
export interface ProductTypeListResponse {
|
|
1253
|
+
'productTypes': Array<ProductType>;
|
|
1254
|
+
/**
|
|
1255
|
+
* The token referencing the next page number
|
|
1256
|
+
*/
|
|
1257
|
+
'nextPageToken': number | null;
|
|
1258
|
+
}
|
|
1242
1259
|
export interface ProductWarehouseProduct {
|
|
1243
1260
|
/**
|
|
1244
1261
|
* Unique object identifier
|
|
@@ -2635,7 +2652,7 @@ export const ApplicationSetsApiAxiosParamCreator = function (configuration?: Con
|
|
|
2635
2652
|
* @summary List application sets
|
|
2636
2653
|
* @param {string} project What project it is
|
|
2637
2654
|
* @param {number} [pageToken] Page reference token
|
|
2638
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2655
|
+
* @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.
|
|
2639
2656
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2640
2657
|
* @param {*} [options] Override http request option.
|
|
2641
2658
|
* @throws {RequiredError}
|
|
@@ -2796,7 +2813,7 @@ export const ApplicationSetsApiFp = function(configuration?: Configuration) {
|
|
|
2796
2813
|
* @summary List application sets
|
|
2797
2814
|
* @param {string} project What project it is
|
|
2798
2815
|
* @param {number} [pageToken] Page reference token
|
|
2799
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2816
|
+
* @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.
|
|
2800
2817
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2801
2818
|
* @param {*} [options] Override http request option.
|
|
2802
2819
|
* @throws {RequiredError}
|
|
@@ -2944,7 +2961,7 @@ export interface ApplicationSetsApiListApplicationSetsRequest {
|
|
|
2944
2961
|
readonly pageToken?: number
|
|
2945
2962
|
|
|
2946
2963
|
/**
|
|
2947
|
-
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
2964
|
+
* 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.
|
|
2948
2965
|
*/
|
|
2949
2966
|
readonly search?: string
|
|
2950
2967
|
|
|
@@ -3162,12 +3179,56 @@ export class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
3162
3179
|
*/
|
|
3163
3180
|
export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3164
3181
|
return {
|
|
3182
|
+
/**
|
|
3183
|
+
* Exports all products with analytics data in a CSV file.
|
|
3184
|
+
* @summary Export product analytics
|
|
3185
|
+
* @param {string} project What project it is
|
|
3186
|
+
* @param {*} [options] Override http request option.
|
|
3187
|
+
* @throws {RequiredError}
|
|
3188
|
+
*/
|
|
3189
|
+
exportProductAnalytics: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3190
|
+
// verify required parameter 'project' is not null or undefined
|
|
3191
|
+
assertParamExists('exportProductAnalytics', 'project', project)
|
|
3192
|
+
const localVarPath = `/v1/catalog/analytics/export`;
|
|
3193
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3194
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3195
|
+
let baseOptions;
|
|
3196
|
+
if (configuration) {
|
|
3197
|
+
baseOptions = configuration.baseOptions;
|
|
3198
|
+
}
|
|
3199
|
+
|
|
3200
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3201
|
+
const localVarHeaderParameter = {} as any;
|
|
3202
|
+
const localVarQueryParameter = {} as any;
|
|
3203
|
+
|
|
3204
|
+
// authentication session-oauth required
|
|
3205
|
+
// oauth required
|
|
3206
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3207
|
+
|
|
3208
|
+
// authentication api-key required
|
|
3209
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3210
|
+
|
|
3211
|
+
if (project !== undefined) {
|
|
3212
|
+
localVarQueryParameter['project'] = project;
|
|
3213
|
+
}
|
|
3214
|
+
|
|
3215
|
+
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
3216
|
+
|
|
3217
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3218
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3219
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3220
|
+
|
|
3221
|
+
return {
|
|
3222
|
+
url: toPathString(localVarUrlObj),
|
|
3223
|
+
options: localVarRequestOptions,
|
|
3224
|
+
};
|
|
3225
|
+
},
|
|
3165
3226
|
/**
|
|
3166
3227
|
* Lists all product analytics items.
|
|
3167
3228
|
* @summary List product analytics
|
|
3168
3229
|
* @param {string} project What project it is
|
|
3169
3230
|
* @param {number} [pageToken] Page reference token
|
|
3170
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
3231
|
+
* @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.
|
|
3171
3232
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3172
3233
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3173
3234
|
* @param {*} [options] Override http request option.
|
|
@@ -3235,12 +3296,25 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
|
|
|
3235
3296
|
export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
3236
3297
|
const localVarAxiosParamCreator = ProductAnalyticsApiAxiosParamCreator(configuration)
|
|
3237
3298
|
return {
|
|
3299
|
+
/**
|
|
3300
|
+
* Exports all products with analytics data in a CSV file.
|
|
3301
|
+
* @summary Export product analytics
|
|
3302
|
+
* @param {string} project What project it is
|
|
3303
|
+
* @param {*} [options] Override http request option.
|
|
3304
|
+
* @throws {RequiredError}
|
|
3305
|
+
*/
|
|
3306
|
+
async exportProductAnalytics(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3307
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProductAnalytics(project, options);
|
|
3308
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3309
|
+
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.exportProductAnalytics']?.[localVarOperationServerIndex]?.url;
|
|
3310
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3311
|
+
},
|
|
3238
3312
|
/**
|
|
3239
3313
|
* Lists all product analytics items.
|
|
3240
3314
|
* @summary List product analytics
|
|
3241
3315
|
* @param {string} project What project it is
|
|
3242
3316
|
* @param {number} [pageToken] Page reference token
|
|
3243
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
3317
|
+
* @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.
|
|
3244
3318
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3245
3319
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3246
3320
|
* @param {*} [options] Override http request option.
|
|
@@ -3261,6 +3335,16 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
|
3261
3335
|
export const ProductAnalyticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3262
3336
|
const localVarFp = ProductAnalyticsApiFp(configuration)
|
|
3263
3337
|
return {
|
|
3338
|
+
/**
|
|
3339
|
+
* Exports all products with analytics data in a CSV file.
|
|
3340
|
+
* @summary Export product analytics
|
|
3341
|
+
* @param {ProductAnalyticsApiExportProductAnalyticsRequest} requestParameters Request parameters.
|
|
3342
|
+
* @param {*} [options] Override http request option.
|
|
3343
|
+
* @throws {RequiredError}
|
|
3344
|
+
*/
|
|
3345
|
+
exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3346
|
+
return localVarFp.exportProductAnalytics(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
3347
|
+
},
|
|
3264
3348
|
/**
|
|
3265
3349
|
* Lists all product analytics items.
|
|
3266
3350
|
* @summary List product analytics
|
|
@@ -3274,6 +3358,16 @@ export const ProductAnalyticsApiFactory = function (configuration?: Configuratio
|
|
|
3274
3358
|
};
|
|
3275
3359
|
};
|
|
3276
3360
|
|
|
3361
|
+
/**
|
|
3362
|
+
* Request parameters for exportProductAnalytics operation in ProductAnalyticsApi.
|
|
3363
|
+
*/
|
|
3364
|
+
export interface ProductAnalyticsApiExportProductAnalyticsRequest {
|
|
3365
|
+
/**
|
|
3366
|
+
* What project it is
|
|
3367
|
+
*/
|
|
3368
|
+
readonly project: string
|
|
3369
|
+
}
|
|
3370
|
+
|
|
3277
3371
|
/**
|
|
3278
3372
|
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
3279
3373
|
*/
|
|
@@ -3289,7 +3383,7 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
3289
3383
|
readonly pageToken?: number
|
|
3290
3384
|
|
|
3291
3385
|
/**
|
|
3292
|
-
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
3386
|
+
* 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.
|
|
3293
3387
|
*/
|
|
3294
3388
|
readonly search?: string
|
|
3295
3389
|
|
|
@@ -3308,6 +3402,17 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
|
3308
3402
|
* ProductAnalyticsApi - object-oriented interface
|
|
3309
3403
|
*/
|
|
3310
3404
|
export class ProductAnalyticsApi extends BaseAPI {
|
|
3405
|
+
/**
|
|
3406
|
+
* Exports all products with analytics data in a CSV file.
|
|
3407
|
+
* @summary Export product analytics
|
|
3408
|
+
* @param {ProductAnalyticsApiExportProductAnalyticsRequest} requestParameters Request parameters.
|
|
3409
|
+
* @param {*} [options] Override http request option.
|
|
3410
|
+
* @throws {RequiredError}
|
|
3411
|
+
*/
|
|
3412
|
+
public exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
|
|
3413
|
+
return ProductAnalyticsApiFp(this.configuration).exportProductAnalytics(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
3414
|
+
}
|
|
3415
|
+
|
|
3311
3416
|
/**
|
|
3312
3417
|
* Lists all product analytics items.
|
|
3313
3418
|
* @summary List product analytics
|
|
@@ -3322,6 +3427,149 @@ export class ProductAnalyticsApi extends BaseAPI {
|
|
|
3322
3427
|
|
|
3323
3428
|
|
|
3324
3429
|
|
|
3430
|
+
/**
|
|
3431
|
+
* ProductTypesApi - axios parameter creator
|
|
3432
|
+
*/
|
|
3433
|
+
export const ProductTypesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3434
|
+
return {
|
|
3435
|
+
/**
|
|
3436
|
+
* Lists the product types used by the given project\'s catalog.
|
|
3437
|
+
* @summary List product types
|
|
3438
|
+
* @param {string} project What project it is
|
|
3439
|
+
* @param {number} [pageToken] Page reference token
|
|
3440
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3441
|
+
* @param {*} [options] Override http request option.
|
|
3442
|
+
* @throws {RequiredError}
|
|
3443
|
+
*/
|
|
3444
|
+
listProductTypes: async (project: string, pageToken?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3445
|
+
// verify required parameter 'project' is not null or undefined
|
|
3446
|
+
assertParamExists('listProductTypes', 'project', project)
|
|
3447
|
+
const localVarPath = `/v1/catalog/product-types`;
|
|
3448
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3449
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3450
|
+
let baseOptions;
|
|
3451
|
+
if (configuration) {
|
|
3452
|
+
baseOptions = configuration.baseOptions;
|
|
3453
|
+
}
|
|
3454
|
+
|
|
3455
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3456
|
+
const localVarHeaderParameter = {} as any;
|
|
3457
|
+
const localVarQueryParameter = {} as any;
|
|
3458
|
+
|
|
3459
|
+
// authentication session-oauth required
|
|
3460
|
+
// oauth required
|
|
3461
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3462
|
+
|
|
3463
|
+
// authentication api-key required
|
|
3464
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3465
|
+
|
|
3466
|
+
if (project !== undefined) {
|
|
3467
|
+
localVarQueryParameter['project'] = project;
|
|
3468
|
+
}
|
|
3469
|
+
|
|
3470
|
+
if (pageToken !== undefined) {
|
|
3471
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
3472
|
+
}
|
|
3473
|
+
|
|
3474
|
+
if (pageSize !== undefined) {
|
|
3475
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
3476
|
+
}
|
|
3477
|
+
|
|
3478
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3479
|
+
|
|
3480
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3481
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3482
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3483
|
+
|
|
3484
|
+
return {
|
|
3485
|
+
url: toPathString(localVarUrlObj),
|
|
3486
|
+
options: localVarRequestOptions,
|
|
3487
|
+
};
|
|
3488
|
+
},
|
|
3489
|
+
}
|
|
3490
|
+
};
|
|
3491
|
+
|
|
3492
|
+
/**
|
|
3493
|
+
* ProductTypesApi - functional programming interface
|
|
3494
|
+
*/
|
|
3495
|
+
export const ProductTypesApiFp = function(configuration?: Configuration) {
|
|
3496
|
+
const localVarAxiosParamCreator = ProductTypesApiAxiosParamCreator(configuration)
|
|
3497
|
+
return {
|
|
3498
|
+
/**
|
|
3499
|
+
* Lists the product types used by the given project\'s catalog.
|
|
3500
|
+
* @summary List product types
|
|
3501
|
+
* @param {string} project What project it is
|
|
3502
|
+
* @param {number} [pageToken] Page reference token
|
|
3503
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3504
|
+
* @param {*} [options] Override http request option.
|
|
3505
|
+
* @throws {RequiredError}
|
|
3506
|
+
*/
|
|
3507
|
+
async listProductTypes(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductTypeListResponse>> {
|
|
3508
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductTypes(project, pageToken, pageSize, options);
|
|
3509
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3510
|
+
const localVarOperationServerBasePath = operationServerMap['ProductTypesApi.listProductTypes']?.[localVarOperationServerIndex]?.url;
|
|
3511
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3512
|
+
},
|
|
3513
|
+
}
|
|
3514
|
+
};
|
|
3515
|
+
|
|
3516
|
+
/**
|
|
3517
|
+
* ProductTypesApi - factory interface
|
|
3518
|
+
*/
|
|
3519
|
+
export const ProductTypesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3520
|
+
const localVarFp = ProductTypesApiFp(configuration)
|
|
3521
|
+
return {
|
|
3522
|
+
/**
|
|
3523
|
+
* Lists the product types used by the given project\'s catalog.
|
|
3524
|
+
* @summary List product types
|
|
3525
|
+
* @param {ProductTypesApiListProductTypesRequest} requestParameters Request parameters.
|
|
3526
|
+
* @param {*} [options] Override http request option.
|
|
3527
|
+
* @throws {RequiredError}
|
|
3528
|
+
*/
|
|
3529
|
+
listProductTypes(requestParameters: ProductTypesApiListProductTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductTypeListResponse> {
|
|
3530
|
+
return localVarFp.listProductTypes(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
3531
|
+
},
|
|
3532
|
+
};
|
|
3533
|
+
};
|
|
3534
|
+
|
|
3535
|
+
/**
|
|
3536
|
+
* Request parameters for listProductTypes operation in ProductTypesApi.
|
|
3537
|
+
*/
|
|
3538
|
+
export interface ProductTypesApiListProductTypesRequest {
|
|
3539
|
+
/**
|
|
3540
|
+
* What project it is
|
|
3541
|
+
*/
|
|
3542
|
+
readonly project: string
|
|
3543
|
+
|
|
3544
|
+
/**
|
|
3545
|
+
* Page reference token
|
|
3546
|
+
*/
|
|
3547
|
+
readonly pageToken?: number
|
|
3548
|
+
|
|
3549
|
+
/**
|
|
3550
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3551
|
+
*/
|
|
3552
|
+
readonly pageSize?: number
|
|
3553
|
+
}
|
|
3554
|
+
|
|
3555
|
+
/**
|
|
3556
|
+
* ProductTypesApi - object-oriented interface
|
|
3557
|
+
*/
|
|
3558
|
+
export class ProductTypesApi extends BaseAPI {
|
|
3559
|
+
/**
|
|
3560
|
+
* Lists the product types used by the given project\'s catalog.
|
|
3561
|
+
* @summary List product types
|
|
3562
|
+
* @param {ProductTypesApiListProductTypesRequest} requestParameters Request parameters.
|
|
3563
|
+
* @param {*} [options] Override http request option.
|
|
3564
|
+
* @throws {RequiredError}
|
|
3565
|
+
*/
|
|
3566
|
+
public listProductTypes(requestParameters: ProductTypesApiListProductTypesRequest, options?: RawAxiosRequestConfig) {
|
|
3567
|
+
return ProductTypesApiFp(this.configuration).listProductTypes(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3568
|
+
}
|
|
3569
|
+
}
|
|
3570
|
+
|
|
3571
|
+
|
|
3572
|
+
|
|
3325
3573
|
/**
|
|
3326
3574
|
* ProductsApi - axios parameter creator
|
|
3327
3575
|
*/
|
|
@@ -3522,10 +3770,16 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3522
3770
|
* Export the project\'s products and variants as a CSV file.
|
|
3523
3771
|
* @summary Export products
|
|
3524
3772
|
* @param {string} project What project it is
|
|
3773
|
+
* @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.
|
|
3774
|
+
* @param {string} [start] Start of date range to filter
|
|
3775
|
+
* @param {string} [end] End of date range to filter
|
|
3776
|
+
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3777
|
+
* @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.
|
|
3778
|
+
* @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.
|
|
3525
3779
|
* @param {*} [options] Override http request option.
|
|
3526
3780
|
* @throws {RequiredError}
|
|
3527
3781
|
*/
|
|
3528
|
-
exportProducts: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3782
|
+
exportProducts: async (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3529
3783
|
// verify required parameter 'project' is not null or undefined
|
|
3530
3784
|
assertParamExists('exportProducts', 'project', project)
|
|
3531
3785
|
const localVarPath = `/v1/catalog/products/export`;
|
|
@@ -3551,6 +3805,34 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3551
3805
|
localVarQueryParameter['project'] = project;
|
|
3552
3806
|
}
|
|
3553
3807
|
|
|
3808
|
+
if (search !== undefined) {
|
|
3809
|
+
localVarQueryParameter['search'] = search;
|
|
3810
|
+
}
|
|
3811
|
+
|
|
3812
|
+
if (start !== undefined) {
|
|
3813
|
+
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
3814
|
+
(start as any).toISOString() :
|
|
3815
|
+
start;
|
|
3816
|
+
}
|
|
3817
|
+
|
|
3818
|
+
if (end !== undefined) {
|
|
3819
|
+
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
3820
|
+
(end as any).toISOString() :
|
|
3821
|
+
end;
|
|
3822
|
+
}
|
|
3823
|
+
|
|
3824
|
+
if (dateFilterType !== undefined) {
|
|
3825
|
+
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
3826
|
+
}
|
|
3827
|
+
|
|
3828
|
+
if (maxRetailPrice !== undefined) {
|
|
3829
|
+
localVarQueryParameter['maxRetailPrice'] = maxRetailPrice;
|
|
3830
|
+
}
|
|
3831
|
+
|
|
3832
|
+
if (minRetailPrice !== undefined) {
|
|
3833
|
+
localVarQueryParameter['minRetailPrice'] = minRetailPrice;
|
|
3834
|
+
}
|
|
3835
|
+
|
|
3554
3836
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
3555
3837
|
|
|
3556
3838
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -3667,17 +3949,19 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3667
3949
|
* @summary List products
|
|
3668
3950
|
* @param {string} project What project it is
|
|
3669
3951
|
* @param {number} [pageToken] Page reference token
|
|
3670
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
3952
|
+
* @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.
|
|
3671
3953
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3672
3954
|
* @param {string} [start] Start of date range to filter
|
|
3673
3955
|
* @param {string} [end] End of date range to filter
|
|
3674
3956
|
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3957
|
+
* @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.
|
|
3958
|
+
* @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.
|
|
3675
3959
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3676
3960
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
3677
3961
|
* @param {*} [options] Override http request option.
|
|
3678
3962
|
* @throws {RequiredError}
|
|
3679
3963
|
*/
|
|
3680
|
-
listProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3964
|
+
listProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3681
3965
|
// verify required parameter 'project' is not null or undefined
|
|
3682
3966
|
assertParamExists('listProducts', 'project', project)
|
|
3683
3967
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -3731,6 +4015,14 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3731
4015
|
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
3732
4016
|
}
|
|
3733
4017
|
|
|
4018
|
+
if (maxRetailPrice !== undefined) {
|
|
4019
|
+
localVarQueryParameter['maxRetailPrice'] = maxRetailPrice;
|
|
4020
|
+
}
|
|
4021
|
+
|
|
4022
|
+
if (minRetailPrice !== undefined) {
|
|
4023
|
+
localVarQueryParameter['minRetailPrice'] = minRetailPrice;
|
|
4024
|
+
}
|
|
4025
|
+
|
|
3734
4026
|
if (pageSize !== undefined) {
|
|
3735
4027
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
3736
4028
|
}
|
|
@@ -3966,11 +4258,17 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
3966
4258
|
* Export the project\'s products and variants as a CSV file.
|
|
3967
4259
|
* @summary Export products
|
|
3968
4260
|
* @param {string} project What project it is
|
|
4261
|
+
* @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.
|
|
4262
|
+
* @param {string} [start] Start of date range to filter
|
|
4263
|
+
* @param {string} [end] End of date range to filter
|
|
4264
|
+
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4265
|
+
* @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.
|
|
4266
|
+
* @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.
|
|
3969
4267
|
* @param {*} [options] Override http request option.
|
|
3970
4268
|
* @throws {RequiredError}
|
|
3971
4269
|
*/
|
|
3972
|
-
async exportProducts(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3973
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProducts(project, options);
|
|
4270
|
+
async exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
4271
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options);
|
|
3974
4272
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3975
4273
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.exportProducts']?.[localVarOperationServerIndex]?.url;
|
|
3976
4274
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -4009,18 +4307,20 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
4009
4307
|
* @summary List products
|
|
4010
4308
|
* @param {string} project What project it is
|
|
4011
4309
|
* @param {number} [pageToken] Page reference token
|
|
4012
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
4310
|
+
* @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.
|
|
4013
4311
|
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
4014
4312
|
* @param {string} [start] Start of date range to filter
|
|
4015
4313
|
* @param {string} [end] End of date range to filter
|
|
4016
4314
|
* @param {ListProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4315
|
+
* @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.
|
|
4316
|
+
* @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.
|
|
4017
4317
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4018
4318
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
4019
4319
|
* @param {*} [options] Override http request option.
|
|
4020
4320
|
* @throws {RequiredError}
|
|
4021
4321
|
*/
|
|
4022
|
-
async listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
4023
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, pageSize, fields, options);
|
|
4322
|
+
async listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
4323
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options);
|
|
4024
4324
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4025
4325
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.listProducts']?.[localVarOperationServerIndex]?.url;
|
|
4026
4326
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -4125,7 +4425,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
4125
4425
|
* @throws {RequiredError}
|
|
4126
4426
|
*/
|
|
4127
4427
|
exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
4128
|
-
return localVarFp.exportProducts(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
4428
|
+
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(axios, basePath));
|
|
4129
4429
|
},
|
|
4130
4430
|
/**
|
|
4131
4431
|
* Gets a product by a given ID.
|
|
@@ -4155,7 +4455,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
4155
4455
|
* @throws {RequiredError}
|
|
4156
4456
|
*/
|
|
4157
4457
|
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
|
|
4158
|
-
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));
|
|
4458
|
+
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));
|
|
4159
4459
|
},
|
|
4160
4460
|
/**
|
|
4161
4461
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -4255,6 +4555,36 @@ export interface ProductsApiExportProductsRequest {
|
|
|
4255
4555
|
* What project it is
|
|
4256
4556
|
*/
|
|
4257
4557
|
readonly project: string
|
|
4558
|
+
|
|
4559
|
+
/**
|
|
4560
|
+
* 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.
|
|
4561
|
+
*/
|
|
4562
|
+
readonly search?: string
|
|
4563
|
+
|
|
4564
|
+
/**
|
|
4565
|
+
* Start of date range to filter
|
|
4566
|
+
*/
|
|
4567
|
+
readonly start?: string
|
|
4568
|
+
|
|
4569
|
+
/**
|
|
4570
|
+
* End of date range to filter
|
|
4571
|
+
*/
|
|
4572
|
+
readonly end?: string
|
|
4573
|
+
|
|
4574
|
+
/**
|
|
4575
|
+
* Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4576
|
+
*/
|
|
4577
|
+
readonly dateFilterType?: ExportProductsDateFilterTypeEnum
|
|
4578
|
+
|
|
4579
|
+
/**
|
|
4580
|
+
* 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.
|
|
4581
|
+
*/
|
|
4582
|
+
readonly maxRetailPrice?: number
|
|
4583
|
+
|
|
4584
|
+
/**
|
|
4585
|
+
* 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.
|
|
4586
|
+
*/
|
|
4587
|
+
readonly minRetailPrice?: number
|
|
4258
4588
|
}
|
|
4259
4589
|
|
|
4260
4590
|
/**
|
|
@@ -4307,7 +4637,7 @@ export interface ProductsApiListProductsRequest {
|
|
|
4307
4637
|
readonly pageToken?: number
|
|
4308
4638
|
|
|
4309
4639
|
/**
|
|
4310
|
-
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
4640
|
+
* 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.
|
|
4311
4641
|
*/
|
|
4312
4642
|
readonly search?: string
|
|
4313
4643
|
|
|
@@ -4331,6 +4661,16 @@ export interface ProductsApiListProductsRequest {
|
|
|
4331
4661
|
*/
|
|
4332
4662
|
readonly dateFilterType?: ListProductsDateFilterTypeEnum
|
|
4333
4663
|
|
|
4664
|
+
/**
|
|
4665
|
+
* 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.
|
|
4666
|
+
*/
|
|
4667
|
+
readonly maxRetailPrice?: number
|
|
4668
|
+
|
|
4669
|
+
/**
|
|
4670
|
+
* 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.
|
|
4671
|
+
*/
|
|
4672
|
+
readonly minRetailPrice?: number
|
|
4673
|
+
|
|
4334
4674
|
/**
|
|
4335
4675
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4336
4676
|
*/
|
|
@@ -4445,7 +4785,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
4445
4785
|
* @throws {RequiredError}
|
|
4446
4786
|
*/
|
|
4447
4787
|
public exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig) {
|
|
4448
|
-
return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
4788
|
+
return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(this.axios, this.basePath));
|
|
4449
4789
|
}
|
|
4450
4790
|
|
|
4451
4791
|
/**
|
|
@@ -4478,7 +4818,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
4478
4818
|
* @throws {RequiredError}
|
|
4479
4819
|
*/
|
|
4480
4820
|
public listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig) {
|
|
4481
|
-
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
4821
|
+
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
4482
4822
|
}
|
|
4483
4823
|
|
|
4484
4824
|
/**
|
|
@@ -4515,6 +4855,11 @@ export class ProductsApi extends BaseAPI {
|
|
|
4515
4855
|
}
|
|
4516
4856
|
}
|
|
4517
4857
|
|
|
4858
|
+
export const ExportProductsDateFilterTypeEnum = {
|
|
4859
|
+
CreatedAt: 'createdAt',
|
|
4860
|
+
UpdatedAt: 'updatedAt'
|
|
4861
|
+
} as const;
|
|
4862
|
+
export type ExportProductsDateFilterTypeEnum = typeof ExportProductsDateFilterTypeEnum[keyof typeof ExportProductsDateFilterTypeEnum];
|
|
4518
4863
|
export const ListProductsDateFilterTypeEnum = {
|
|
4519
4864
|
CreatedAt: 'createdAt',
|
|
4520
4865
|
UpdatedAt: 'updatedAt'
|
|
@@ -4584,7 +4929,7 @@ export const VariantsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4584
4929
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
4585
4930
|
* @summary List variants
|
|
4586
4931
|
* @param {string} project What project it is
|
|
4587
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
4932
|
+
* @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.
|
|
4588
4933
|
* @param {number} [pageToken] Page reference token
|
|
4589
4934
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4590
4935
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
@@ -4672,7 +5017,7 @@ export const VariantsApiFp = function(configuration?: Configuration) {
|
|
|
4672
5017
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
4673
5018
|
* @summary List variants
|
|
4674
5019
|
* @param {string} project What project it is
|
|
4675
|
-
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
5020
|
+
* @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.
|
|
4676
5021
|
* @param {number} [pageToken] Page reference token
|
|
4677
5022
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4678
5023
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
@@ -4747,7 +5092,7 @@ export interface VariantsApiListVariantsRequest {
|
|
|
4747
5092
|
readonly project: string
|
|
4748
5093
|
|
|
4749
5094
|
/**
|
|
4750
|
-
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'
|
|
5095
|
+
* 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.
|
|
4751
5096
|
*/
|
|
4752
5097
|
readonly search?: string
|
|
4753
5098
|
|