@teemill/product-catalog 1.86.0 → 1.88.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 CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/product-catalog@1.86.0
1
+ ## @teemill/product-catalog@1.88.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.86.0 --save
39
+ npm install @teemill/product-catalog@1.88.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -65,6 +65,7 @@ Class | Method | HTTP request | Description
65
65
  *ProductAnalyticsApi* | [**exportProductAnalytics**](docs/ProductAnalyticsApi.md#exportproductanalytics) | **GET** /v1/catalog/analytics/export | Export product analytics
66
66
  *ProductAnalyticsApi* | [**getProductAnalyticsSummary**](docs/ProductAnalyticsApi.md#getproductanalyticssummary) | **GET** /v1/catalog/analytics/summary | Get product analytics summary
67
67
  *ProductAnalyticsApi* | [**listProductAnalytics**](docs/ProductAnalyticsApi.md#listproductanalytics) | **GET** /v1/catalog/analytics | List product analytics
68
+ *ProductCreatorsApi* | [**listProductCreators**](docs/ProductCreatorsApi.md#listproductcreators) | **GET** /v1/catalog/creators | List product creators
68
69
  *ProductTypesApi* | [**listProductTypes**](docs/ProductTypesApi.md#listproducttypes) | **GET** /v1/catalog/product-types | List product types
69
70
  *ProductsApi* | [**createProduct**](docs/ProductsApi.md#createproduct) | **POST** /v1/catalog/products | Create product
70
71
  *ProductsApi* | [**deleteProduct**](docs/ProductsApi.md#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product
@@ -182,6 +183,9 @@ Class | Method | HTTP request | Description
182
183
  - [UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner](docs/UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md)
183
184
  - [UpdateProductsRequestProductsInnerVariantsInnerRetailPrice](docs/UpdateProductsRequestProductsInnerVariantsInnerRetailPrice.md)
184
185
  - [UpdateProductsRequestProductsInnerVariantsInnerSalePrice](docs/UpdateProductsRequestProductsInnerVariantsInnerSalePrice.md)
186
+ - [UserList](docs/UserList.md)
187
+ - [UserListCreatorsInner](docs/UserListCreatorsInner.md)
188
+ - [UserListCreatorsInnerAvatar](docs/UserListCreatorsInnerAvatar.md)
185
189
  - [Variant](docs/Variant.md)
186
190
  - [VariantIntegrationConnectionsInner](docs/VariantIntegrationConnectionsInner.md)
187
191
  - [VariantProduct](docs/VariantProduct.md)
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.86.0
7
+ * The version of the OpenAPI document: 1.88.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1304,6 +1304,10 @@ export interface ProductWarehouseProduct {
1304
1304
  * Reference to the product in the Global Fulfillment Network (GFN) catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
1305
1305
  */
1306
1306
  'gfnProductRef'?: string;
1307
+ /**
1308
+ * Meta fields from the warehouse product
1309
+ */
1310
+ 'metafields'?: Array<MetaField>;
1307
1311
  }
1308
1312
  export interface ProductsResponse {
1309
1313
  'products'?: Array<Product>;
@@ -1896,6 +1900,30 @@ export const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCod
1896
1900
 
1897
1901
  export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
1898
1902
 
1903
+ export interface UserList {
1904
+ 'creators': Array<UserListCreatorsInner>;
1905
+ }
1906
+ export interface UserListCreatorsInner {
1907
+ /**
1908
+ * Unique object identifier
1909
+ */
1910
+ 'id': string;
1911
+ /**
1912
+ * The username of the product creator
1913
+ */
1914
+ 'username': string;
1915
+ 'avatar': UserListCreatorsInnerAvatar;
1916
+ }
1917
+ export interface UserListCreatorsInnerAvatar {
1918
+ /**
1919
+ * URL to the thumbnail version of the avatar
1920
+ */
1921
+ 'thumbnail': string | null;
1922
+ /**
1923
+ * URL to the original avatar image
1924
+ */
1925
+ 'original': string | null;
1926
+ }
1899
1927
  export interface Variant {
1900
1928
  /**
1901
1929
  * Unique object identifier
@@ -1974,6 +2002,10 @@ export interface VariantWarehouseVariant {
1974
2002
  * Reference to the variant in the Global Fulfillment Network (GFN) catalog.
1975
2003
  */
1976
2004
  'gfnVariantRef'?: string;
2005
+ /**
2006
+ * Meta fields from the warehouse variant
2007
+ */
2008
+ 'metafields'?: Array<MetaField>;
1977
2009
  }
1978
2010
  export interface VariantWholesaleCost {
1979
2011
  'item': RequiredPrice;
@@ -3254,7 +3286,7 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
3254
3286
  * @summary Export product analytics
3255
3287
  * @param {string} project What project it is
3256
3288
  * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
3257
- * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas.
3289
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39;
3258
3290
  * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
3259
3291
  * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
3260
3292
  * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
@@ -3265,10 +3297,14 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
3265
3297
  * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
3266
3298
  * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
3267
3299
  * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
3300
+ * @param {string} [createdBefore] Filter to only include products created before the given date
3301
+ * @param {string} [createdAfter] Filter to only include products created after the given date
3302
+ * @param {string} [updatedBefore] Filter to only include products updated before the given date
3303
+ * @param {string} [updatedAfter] Filter to only include products updated after the given date
3268
3304
  * @param {*} [options] Override http request option.
3269
3305
  * @throws {RequiredError}
3270
3306
  */
3271
- 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> => {
3307
+ 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, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3272
3308
  // verify required parameter 'project' is not null or undefined
3273
3309
  assertParamExists('exportProductAnalytics', 'project', project)
3274
3310
  const localVarPath = `/v1/catalog/analytics/export`;
@@ -3346,6 +3382,30 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
3346
3382
  localVarQueryParameter['maximumTraffic'] = maximumTraffic;
3347
3383
  }
3348
3384
 
3385
+ if (createdBefore !== undefined) {
3386
+ localVarQueryParameter['createdBefore'] = (createdBefore as any instanceof Date) ?
3387
+ (createdBefore as any).toISOString() :
3388
+ createdBefore;
3389
+ }
3390
+
3391
+ if (createdAfter !== undefined) {
3392
+ localVarQueryParameter['createdAfter'] = (createdAfter as any instanceof Date) ?
3393
+ (createdAfter as any).toISOString() :
3394
+ createdAfter;
3395
+ }
3396
+
3397
+ if (updatedBefore !== undefined) {
3398
+ localVarQueryParameter['updatedBefore'] = (updatedBefore as any instanceof Date) ?
3399
+ (updatedBefore as any).toISOString() :
3400
+ updatedBefore;
3401
+ }
3402
+
3403
+ if (updatedAfter !== undefined) {
3404
+ localVarQueryParameter['updatedAfter'] = (updatedAfter as any instanceof Date) ?
3405
+ (updatedAfter as any).toISOString() :
3406
+ updatedAfter;
3407
+ }
3408
+
3349
3409
  localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
3350
3410
 
3351
3411
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -3407,7 +3467,7 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
3407
3467
  * @param {string} project What project it is
3408
3468
  * @param {number} [pageToken] Page reference token
3409
3469
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3410
- * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas.
3470
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39;
3411
3471
  * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
3412
3472
  * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
3413
3473
  * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
@@ -3419,10 +3479,14 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
3419
3479
  * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
3420
3480
  * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
3421
3481
  * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
3482
+ * @param {string} [createdBefore] Filter to only include products created before the given date
3483
+ * @param {string} [createdAfter] Filter to only include products created after the given date
3484
+ * @param {string} [updatedBefore] Filter to only include products updated before the given date
3485
+ * @param {string} [updatedAfter] Filter to only include products updated after the given date
3422
3486
  * @param {*} [options] Override http request option.
3423
3487
  * @throws {RequiredError}
3424
3488
  */
3425
- 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> => {
3489
+ 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, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3426
3490
  // verify required parameter 'project' is not null or undefined
3427
3491
  assertParamExists('listProductAnalytics', 'project', project)
3428
3492
  const localVarPath = `/v1/catalog/analytics`;
@@ -3508,6 +3572,30 @@ export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Co
3508
3572
  localVarQueryParameter['maximumTraffic'] = maximumTraffic;
3509
3573
  }
3510
3574
 
3575
+ if (createdBefore !== undefined) {
3576
+ localVarQueryParameter['createdBefore'] = (createdBefore as any instanceof Date) ?
3577
+ (createdBefore as any).toISOString() :
3578
+ createdBefore;
3579
+ }
3580
+
3581
+ if (createdAfter !== undefined) {
3582
+ localVarQueryParameter['createdAfter'] = (createdAfter as any instanceof Date) ?
3583
+ (createdAfter as any).toISOString() :
3584
+ createdAfter;
3585
+ }
3586
+
3587
+ if (updatedBefore !== undefined) {
3588
+ localVarQueryParameter['updatedBefore'] = (updatedBefore as any instanceof Date) ?
3589
+ (updatedBefore as any).toISOString() :
3590
+ updatedBefore;
3591
+ }
3592
+
3593
+ if (updatedAfter !== undefined) {
3594
+ localVarQueryParameter['updatedAfter'] = (updatedAfter as any instanceof Date) ?
3595
+ (updatedAfter as any).toISOString() :
3596
+ updatedAfter;
3597
+ }
3598
+
3511
3599
  localVarHeaderParameter['Accept'] = 'application/json';
3512
3600
 
3513
3601
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -3533,7 +3621,7 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
3533
3621
  * @summary Export product analytics
3534
3622
  * @param {string} project What project it is
3535
3623
  * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
3536
- * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas.
3624
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39;
3537
3625
  * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
3538
3626
  * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
3539
3627
  * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
@@ -3544,11 +3632,15 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
3544
3632
  * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
3545
3633
  * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
3546
3634
  * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
3635
+ * @param {string} [createdBefore] Filter to only include products created before the given date
3636
+ * @param {string} [createdAfter] Filter to only include products created after the given date
3637
+ * @param {string} [updatedBefore] Filter to only include products updated before the given date
3638
+ * @param {string} [updatedAfter] Filter to only include products updated after the given date
3547
3639
  * @param {*} [options] Override http request option.
3548
3640
  * @throws {RequiredError}
3549
3641
  */
3550
- 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>> {
3551
- const localVarAxiosArgs = await localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
3642
+ 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, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
3643
+ const localVarAxiosArgs = await localVarAxiosParamCreator.exportProductAnalytics(project, sortBy, search, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options);
3552
3644
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3553
3645
  const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.exportProductAnalytics']?.[localVarOperationServerIndex]?.url;
3554
3646
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3572,7 +3664,7 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
3572
3664
  * @param {string} project What project it is
3573
3665
  * @param {number} [pageToken] Page reference token
3574
3666
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3575
- * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas.
3667
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39;
3576
3668
  * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
3577
3669
  * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
3578
3670
  * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
@@ -3584,11 +3676,15 @@ export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
3584
3676
  * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
3585
3677
  * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
3586
3678
  * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
3679
+ * @param {string} [createdBefore] Filter to only include products created before the given date
3680
+ * @param {string} [createdAfter] Filter to only include products created after the given date
3681
+ * @param {string} [updatedBefore] Filter to only include products updated before the given date
3682
+ * @param {string} [updatedAfter] Filter to only include products updated after the given date
3587
3683
  * @param {*} [options] Override http request option.
3588
3684
  * @throws {RequiredError}
3589
3685
  */
3590
- 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>> {
3591
- const localVarAxiosArgs = await localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, options);
3686
+ 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, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>> {
3687
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProductAnalytics(project, pageToken, pageSize, search, sortBy, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options);
3592
3688
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3593
3689
  const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.listProductAnalytics']?.[localVarOperationServerIndex]?.url;
3594
3690
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3610,7 +3706,7 @@ export const ProductAnalyticsApiFactory = function (configuration?: Configuratio
3610
3706
  * @throws {RequiredError}
3611
3707
  */
3612
3708
  exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
3613
- 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));
3709
+ return localVarFp.exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(axios, basePath));
3614
3710
  },
3615
3711
  /**
3616
3712
  * Get the AI-generated summary of the product analytics for the given project.
@@ -3630,7 +3726,7 @@ export const ProductAnalyticsApiFactory = function (configuration?: Configuratio
3630
3726
  * @throws {RequiredError}
3631
3727
  */
3632
3728
  listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductAnalyticsResponse> {
3633
- 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));
3729
+ return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(axios, basePath));
3634
3730
  },
3635
3731
  };
3636
3732
  };
@@ -3650,7 +3746,7 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
3650
3746
  readonly sortBy?: Array<string>
3651
3747
 
3652
3748
  /**
3653
- * Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas.
3749
+ * Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39;
3654
3750
  */
3655
3751
  readonly search?: string
3656
3752
 
@@ -3703,6 +3799,26 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
3703
3799
  * Filter to only include products with total traffic less than or equal to this number
3704
3800
  */
3705
3801
  readonly maximumTraffic?: number
3802
+
3803
+ /**
3804
+ * Filter to only include products created before the given date
3805
+ */
3806
+ readonly createdBefore?: string
3807
+
3808
+ /**
3809
+ * Filter to only include products created after the given date
3810
+ */
3811
+ readonly createdAfter?: string
3812
+
3813
+ /**
3814
+ * Filter to only include products updated before the given date
3815
+ */
3816
+ readonly updatedBefore?: string
3817
+
3818
+ /**
3819
+ * Filter to only include products updated after the given date
3820
+ */
3821
+ readonly updatedAfter?: string
3706
3822
  }
3707
3823
 
3708
3824
  /**
@@ -3735,7 +3851,7 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
3735
3851
  readonly pageSize?: number
3736
3852
 
3737
3853
  /**
3738
- * Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas.
3854
+ * Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39;
3739
3855
  */
3740
3856
  readonly search?: string
3741
3857
 
@@ -3793,6 +3909,26 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
3793
3909
  * Filter to only include products with total traffic less than or equal to this number
3794
3910
  */
3795
3911
  readonly maximumTraffic?: number
3912
+
3913
+ /**
3914
+ * Filter to only include products created before the given date
3915
+ */
3916
+ readonly createdBefore?: string
3917
+
3918
+ /**
3919
+ * Filter to only include products created after the given date
3920
+ */
3921
+ readonly createdAfter?: string
3922
+
3923
+ /**
3924
+ * Filter to only include products updated before the given date
3925
+ */
3926
+ readonly updatedBefore?: string
3927
+
3928
+ /**
3929
+ * Filter to only include products updated after the given date
3930
+ */
3931
+ readonly updatedAfter?: string
3796
3932
  }
3797
3933
 
3798
3934
  /**
@@ -3807,7 +3943,7 @@ export class ProductAnalyticsApi extends BaseAPI {
3807
3943
  * @throws {RequiredError}
3808
3944
  */
3809
3945
  public exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
3810
- 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));
3946
+ return ProductAnalyticsApiFp(this.configuration).exportProductAnalytics(requestParameters.project, requestParameters.sortBy, requestParameters.search, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
3811
3947
  }
3812
3948
 
3813
3949
  /**
@@ -3829,7 +3965,128 @@ export class ProductAnalyticsApi extends BaseAPI {
3829
3965
  * @throws {RequiredError}
3830
3966
  */
3831
3967
  public listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
3832
- 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));
3968
+ return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
3969
+ }
3970
+ }
3971
+
3972
+
3973
+
3974
+ /**
3975
+ * ProductCreatorsApi - axios parameter creator
3976
+ */
3977
+ export const ProductCreatorsApiAxiosParamCreator = function (configuration?: Configuration) {
3978
+ return {
3979
+ /**
3980
+ * Lists all the unique users that have created products for the given project.
3981
+ * @summary List product creators
3982
+ * @param {string} project What project it is
3983
+ * @param {*} [options] Override http request option.
3984
+ * @throws {RequiredError}
3985
+ */
3986
+ listProductCreators: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3987
+ // verify required parameter 'project' is not null or undefined
3988
+ assertParamExists('listProductCreators', 'project', project)
3989
+ const localVarPath = `/v1/catalog/creators`;
3990
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3991
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3992
+ let baseOptions;
3993
+ if (configuration) {
3994
+ baseOptions = configuration.baseOptions;
3995
+ }
3996
+
3997
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3998
+ const localVarHeaderParameter = {} as any;
3999
+ const localVarQueryParameter = {} as any;
4000
+
4001
+ // authentication session-oauth required
4002
+ // oauth required
4003
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
4004
+
4005
+ // authentication api-key required
4006
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4007
+
4008
+ if (project !== undefined) {
4009
+ localVarQueryParameter['project'] = project;
4010
+ }
4011
+
4012
+ localVarHeaderParameter['Accept'] = 'application/json';
4013
+
4014
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4015
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4016
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4017
+
4018
+ return {
4019
+ url: toPathString(localVarUrlObj),
4020
+ options: localVarRequestOptions,
4021
+ };
4022
+ },
4023
+ }
4024
+ };
4025
+
4026
+ /**
4027
+ * ProductCreatorsApi - functional programming interface
4028
+ */
4029
+ export const ProductCreatorsApiFp = function(configuration?: Configuration) {
4030
+ const localVarAxiosParamCreator = ProductCreatorsApiAxiosParamCreator(configuration)
4031
+ return {
4032
+ /**
4033
+ * Lists all the unique users that have created products for the given project.
4034
+ * @summary List product creators
4035
+ * @param {string} project What project it is
4036
+ * @param {*} [options] Override http request option.
4037
+ * @throws {RequiredError}
4038
+ */
4039
+ async listProductCreators(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>> {
4040
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProductCreators(project, options);
4041
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4042
+ const localVarOperationServerBasePath = operationServerMap['ProductCreatorsApi.listProductCreators']?.[localVarOperationServerIndex]?.url;
4043
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4044
+ },
4045
+ }
4046
+ };
4047
+
4048
+ /**
4049
+ * ProductCreatorsApi - factory interface
4050
+ */
4051
+ export const ProductCreatorsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
4052
+ const localVarFp = ProductCreatorsApiFp(configuration)
4053
+ return {
4054
+ /**
4055
+ * Lists all the unique users that have created products for the given project.
4056
+ * @summary List product creators
4057
+ * @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
4058
+ * @param {*} [options] Override http request option.
4059
+ * @throws {RequiredError}
4060
+ */
4061
+ listProductCreators(requestParameters: ProductCreatorsApiListProductCreatorsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserList> {
4062
+ return localVarFp.listProductCreators(requestParameters.project, options).then((request) => request(axios, basePath));
4063
+ },
4064
+ };
4065
+ };
4066
+
4067
+ /**
4068
+ * Request parameters for listProductCreators operation in ProductCreatorsApi.
4069
+ */
4070
+ export interface ProductCreatorsApiListProductCreatorsRequest {
4071
+ /**
4072
+ * What project it is
4073
+ */
4074
+ readonly project: string
4075
+ }
4076
+
4077
+ /**
4078
+ * ProductCreatorsApi - object-oriented interface
4079
+ */
4080
+ export class ProductCreatorsApi extends BaseAPI {
4081
+ /**
4082
+ * Lists all the unique users that have created products for the given project.
4083
+ * @summary List product creators
4084
+ * @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
4085
+ * @param {*} [options] Override http request option.
4086
+ * @throws {RequiredError}
4087
+ */
4088
+ public listProductCreators(requestParameters: ProductCreatorsApiListProductCreatorsRequest, options?: RawAxiosRequestConfig) {
4089
+ return ProductCreatorsApiFp(this.configuration).listProductCreators(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
3833
4090
  }
3834
4091
  }
3835
4092
 
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.86.0
7
+ * The version of the OpenAPI document: 1.88.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.86.0
7
+ * The version of the OpenAPI document: 1.88.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.86.0
6
+ * The version of the OpenAPI document: 1.88.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).