@teemill/product-catalog 1.23.0 → 1.24.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.23.0
1
+ ## @teemill/product-catalog@1.24.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.23.0 --save
39
+ npm install @teemill/product-catalog@1.24.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
5
  * Manage 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.23.0
7
+ * The version of the OpenAPI document: 1.24.0
8
8
  * Contact: hello@teemill.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -861,6 +861,30 @@ export interface Product {
861
861
  * @memberof Product
862
862
  */
863
863
  'applicationSets'?: Array<ProductApplicationSetsInner>;
864
+ /**
865
+ * The average review rating. This field is only present if included in the fields query parameter
866
+ * @type {number}
867
+ * @memberof Product
868
+ */
869
+ 'reviewScore'?: number | null;
870
+ /**
871
+ * A count of reviews. This field is only present if included in the fields query parameter
872
+ * @type {number}
873
+ * @memberof Product
874
+ */
875
+ 'reviewCount'?: number;
876
+ /**
877
+ *
878
+ * @type {string}
879
+ * @memberof Product
880
+ */
881
+ 'sku'?: string;
882
+ /**
883
+ * A count of sales. This field is only present if included in the fields query parameter
884
+ * @type {number}
885
+ * @memberof Product
886
+ */
887
+ 'sales'?: number;
864
888
  /**
865
889
  *
866
890
  * @type {boolean}
@@ -2041,12 +2065,13 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
2041
2065
  * @param {string} project What project it is
2042
2066
  * @param {number} [pageToken] Page reference token
2043
2067
  * @param {string} [search] Search term to filter based on product tags.
2068
+ * @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.
2044
2069
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2045
2070
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
2046
2071
  * @param {*} [options] Override http request option.
2047
2072
  * @throws {RequiredError}
2048
2073
  */
2049
- getProducts: async (project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2074
+ getProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2050
2075
  // verify required parameter 'project' is not null or undefined
2051
2076
  assertParamExists('getProducts', 'project', project)
2052
2077
  const localVarPath = `/v1/catalog/products`;
@@ -2080,6 +2105,10 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
2080
2105
  localVarQueryParameter['search'] = search;
2081
2106
  }
2082
2107
 
2108
+ if (sortBy) {
2109
+ localVarQueryParameter['sortBy'] = sortBy;
2110
+ }
2111
+
2083
2112
  if (pageSize !== undefined) {
2084
2113
  localVarQueryParameter['pageSize'] = pageSize;
2085
2114
  }
@@ -2258,13 +2287,14 @@ export const ProductsApiFp = function(configuration?: Configuration) {
2258
2287
  * @param {string} project What project it is
2259
2288
  * @param {number} [pageToken] Page reference token
2260
2289
  * @param {string} [search] Search term to filter based on product tags.
2290
+ * @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.
2261
2291
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2262
2292
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
2263
2293
  * @param {*} [options] Override http request option.
2264
2294
  * @throws {RequiredError}
2265
2295
  */
2266
- async getProducts(project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
2267
- const localVarAxiosArgs = await localVarAxiosParamCreator.getProducts(project, pageToken, search, pageSize, fields, options);
2296
+ async getProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
2297
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getProducts(project, pageToken, search, sortBy, pageSize, fields, options);
2268
2298
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2269
2299
  const localVarOperationServerBasePath = operationServerMap['ProductsApi.getProducts']?.[localVarOperationServerIndex]?.url;
2270
2300
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2346,7 +2376,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
2346
2376
  * @throws {RequiredError}
2347
2377
  */
2348
2378
  getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
2349
- return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
2379
+ return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
2350
2380
  },
2351
2381
  /**
2352
2382
  * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
@@ -2468,6 +2498,13 @@ export interface ProductsApiGetProductsRequest {
2468
2498
  */
2469
2499
  readonly search?: string
2470
2500
 
2501
+ /**
2502
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2503
+ * @type {Array<string>}
2504
+ * @memberof ProductsApiGetProducts
2505
+ */
2506
+ readonly sortBy?: Array<string>
2507
+
2471
2508
  /**
2472
2509
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2473
2510
  * @type {number}
@@ -2584,7 +2621,7 @@ export class ProductsApi extends BaseAPI {
2584
2621
  * @memberof ProductsApi
2585
2622
  */
2586
2623
  public getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig) {
2587
- return ProductsApiFp(this.configuration).getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
2624
+ return ProductsApiFp(this.configuration).getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
2588
2625
  }
2589
2626
 
2590
2627
  /**
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
5
  * Manage 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.23.0
7
+ * The version of the OpenAPI document: 1.24.0
8
8
  * Contact: hello@teemill.com
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 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.23.0
7
+ * The version of the OpenAPI document: 1.24.0
8
8
  * Contact: hello@teemill.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
5
  * Manage 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.23.0
7
+ * The version of the OpenAPI document: 1.24.0
8
8
  * Contact: hello@teemill.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.23.0
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -832,6 +832,30 @@ export interface Product {
832
832
  * @memberof Product
833
833
  */
834
834
  'applicationSets'?: Array<ProductApplicationSetsInner>;
835
+ /**
836
+ * The average review rating. This field is only present if included in the fields query parameter
837
+ * @type {number}
838
+ * @memberof Product
839
+ */
840
+ 'reviewScore'?: number | null;
841
+ /**
842
+ * A count of reviews. This field is only present if included in the fields query parameter
843
+ * @type {number}
844
+ * @memberof Product
845
+ */
846
+ 'reviewCount'?: number;
847
+ /**
848
+ *
849
+ * @type {string}
850
+ * @memberof Product
851
+ */
852
+ 'sku'?: string;
853
+ /**
854
+ * A count of sales. This field is only present if included in the fields query parameter
855
+ * @type {number}
856
+ * @memberof Product
857
+ */
858
+ 'sales'?: number;
835
859
  /**
836
860
  *
837
861
  * @type {boolean}
@@ -1606,12 +1630,13 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
1606
1630
  * @param {string} project What project it is
1607
1631
  * @param {number} [pageToken] Page reference token
1608
1632
  * @param {string} [search] Search term to filter based on product tags.
1633
+ * @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.
1609
1634
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1610
1635
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
1611
1636
  * @param {*} [options] Override http request option.
1612
1637
  * @throws {RequiredError}
1613
1638
  */
1614
- getProducts: (project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1639
+ getProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1615
1640
  /**
1616
1641
  * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
1617
1642
  * @summary Import products
@@ -1671,12 +1696,13 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
1671
1696
  * @param {string} project What project it is
1672
1697
  * @param {number} [pageToken] Page reference token
1673
1698
  * @param {string} [search] Search term to filter based on product tags.
1699
+ * @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.
1674
1700
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1675
1701
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
1676
1702
  * @param {*} [options] Override http request option.
1677
1703
  * @throws {RequiredError}
1678
1704
  */
1679
- getProducts(project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
1705
+ getProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
1680
1706
  /**
1681
1707
  * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
1682
1708
  * @summary Import products
@@ -1838,6 +1864,12 @@ export interface ProductsApiGetProductsRequest {
1838
1864
  * @memberof ProductsApiGetProducts
1839
1865
  */
1840
1866
  readonly search?: string;
1867
+ /**
1868
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1869
+ * @type {Array<string>}
1870
+ * @memberof ProductsApiGetProducts
1871
+ */
1872
+ readonly sortBy?: Array<string>;
1841
1873
  /**
1842
1874
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1843
1875
  * @type {number}
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog API
6
6
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.23.0
8
+ * The version of the OpenAPI document: 1.24.0
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -641,12 +641,13 @@ const ProductsApiAxiosParamCreator = function (configuration) {
641
641
  * @param {string} project What project it is
642
642
  * @param {number} [pageToken] Page reference token
643
643
  * @param {string} [search] Search term to filter based on product tags.
644
+ * @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.
644
645
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
645
646
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
646
647
  * @param {*} [options] Override http request option.
647
648
  * @throws {RequiredError}
648
649
  */
649
- getProducts: (project_1, pageToken_1, search_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, pageSize, fields, options = {}) {
650
+ getProducts: (project_1, pageToken_1, search_1, sortBy_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, pageSize, fields, options = {}) {
650
651
  // verify required parameter 'project' is not null or undefined
651
652
  (0, common_1.assertParamExists)('getProducts', 'project', project);
652
653
  const localVarPath = `/v1/catalog/products`;
@@ -673,6 +674,9 @@ const ProductsApiAxiosParamCreator = function (configuration) {
673
674
  if (search !== undefined) {
674
675
  localVarQueryParameter['search'] = search;
675
676
  }
677
+ if (sortBy) {
678
+ localVarQueryParameter['sortBy'] = sortBy;
679
+ }
676
680
  if (pageSize !== undefined) {
677
681
  localVarQueryParameter['pageSize'] = pageSize;
678
682
  }
@@ -837,15 +841,16 @@ const ProductsApiFp = function (configuration) {
837
841
  * @param {string} project What project it is
838
842
  * @param {number} [pageToken] Page reference token
839
843
  * @param {string} [search] Search term to filter based on product tags.
844
+ * @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.
840
845
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
841
846
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
842
847
  * @param {*} [options] Override http request option.
843
848
  * @throws {RequiredError}
844
849
  */
845
- getProducts(project, pageToken, search, pageSize, fields, options) {
850
+ getProducts(project, pageToken, search, sortBy, pageSize, fields, options) {
846
851
  return __awaiter(this, void 0, void 0, function* () {
847
852
  var _a, _b, _c;
848
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(project, pageToken, search, pageSize, fields, options);
853
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(project, pageToken, search, sortBy, pageSize, fields, options);
849
854
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
850
855
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.getProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
851
856
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -934,7 +939,7 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
934
939
  * @throws {RequiredError}
935
940
  */
936
941
  getProducts(requestParameters, options) {
937
- return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
942
+ return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
938
943
  },
939
944
  /**
940
945
  * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
@@ -1008,7 +1013,7 @@ class ProductsApi extends base_1.BaseAPI {
1008
1013
  * @memberof ProductsApi
1009
1014
  */
1010
1015
  getProducts(requestParameters, options) {
1011
- return (0, exports.ProductsApiFp)(this.configuration).getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
1016
+ return (0, exports.ProductsApiFp)(this.configuration).getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
1012
1017
  }
1013
1018
  /**
1014
1019
  * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.23.0
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog API
6
6
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.23.0
8
+ * The version of the OpenAPI document: 1.24.0
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.23.0
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog API
6
6
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.23.0
8
+ * The version of the OpenAPI document: 1.24.0
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.23.0
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Product Catalog API
6
6
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.23.0
8
+ * The version of the OpenAPI document: 1.24.0
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.23.0
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -832,6 +832,30 @@ export interface Product {
832
832
  * @memberof Product
833
833
  */
834
834
  'applicationSets'?: Array<ProductApplicationSetsInner>;
835
+ /**
836
+ * The average review rating. This field is only present if included in the fields query parameter
837
+ * @type {number}
838
+ * @memberof Product
839
+ */
840
+ 'reviewScore'?: number | null;
841
+ /**
842
+ * A count of reviews. This field is only present if included in the fields query parameter
843
+ * @type {number}
844
+ * @memberof Product
845
+ */
846
+ 'reviewCount'?: number;
847
+ /**
848
+ *
849
+ * @type {string}
850
+ * @memberof Product
851
+ */
852
+ 'sku'?: string;
853
+ /**
854
+ * A count of sales. This field is only present if included in the fields query parameter
855
+ * @type {number}
856
+ * @memberof Product
857
+ */
858
+ 'sales'?: number;
835
859
  /**
836
860
  *
837
861
  * @type {boolean}
@@ -1606,12 +1630,13 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
1606
1630
  * @param {string} project What project it is
1607
1631
  * @param {number} [pageToken] Page reference token
1608
1632
  * @param {string} [search] Search term to filter based on product tags.
1633
+ * @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.
1609
1634
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1610
1635
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
1611
1636
  * @param {*} [options] Override http request option.
1612
1637
  * @throws {RequiredError}
1613
1638
  */
1614
- getProducts: (project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1639
+ getProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1615
1640
  /**
1616
1641
  * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
1617
1642
  * @summary Import products
@@ -1671,12 +1696,13 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
1671
1696
  * @param {string} project What project it is
1672
1697
  * @param {number} [pageToken] Page reference token
1673
1698
  * @param {string} [search] Search term to filter based on product tags.
1699
+ * @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.
1674
1700
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1675
1701
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
1676
1702
  * @param {*} [options] Override http request option.
1677
1703
  * @throws {RequiredError}
1678
1704
  */
1679
- getProducts(project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
1705
+ getProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
1680
1706
  /**
1681
1707
  * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
1682
1708
  * @summary Import products
@@ -1838,6 +1864,12 @@ export interface ProductsApiGetProductsRequest {
1838
1864
  * @memberof ProductsApiGetProducts
1839
1865
  */
1840
1866
  readonly search?: string;
1867
+ /**
1868
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1869
+ * @type {Array<string>}
1870
+ * @memberof ProductsApiGetProducts
1871
+ */
1872
+ readonly sortBy?: Array<string>;
1841
1873
  /**
1842
1874
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1843
1875
  * @type {number}
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
5
  * Manage 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.23.0
7
+ * The version of the OpenAPI document: 1.24.0
8
8
  * Contact: hello@teemill.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -634,12 +634,13 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
634
634
  * @param {string} project What project it is
635
635
  * @param {number} [pageToken] Page reference token
636
636
  * @param {string} [search] Search term to filter based on product tags.
637
+ * @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.
637
638
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
638
639
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
639
640
  * @param {*} [options] Override http request option.
640
641
  * @throws {RequiredError}
641
642
  */
642
- getProducts: (project_1, pageToken_1, search_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, pageSize, fields, options = {}) {
643
+ getProducts: (project_1, pageToken_1, search_1, sortBy_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, pageSize, fields, options = {}) {
643
644
  // verify required parameter 'project' is not null or undefined
644
645
  assertParamExists('getProducts', 'project', project);
645
646
  const localVarPath = `/v1/catalog/products`;
@@ -666,6 +667,9 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
666
667
  if (search !== undefined) {
667
668
  localVarQueryParameter['search'] = search;
668
669
  }
670
+ if (sortBy) {
671
+ localVarQueryParameter['sortBy'] = sortBy;
672
+ }
669
673
  if (pageSize !== undefined) {
670
674
  localVarQueryParameter['pageSize'] = pageSize;
671
675
  }
@@ -829,15 +833,16 @@ export const ProductsApiFp = function (configuration) {
829
833
  * @param {string} project What project it is
830
834
  * @param {number} [pageToken] Page reference token
831
835
  * @param {string} [search] Search term to filter based on product tags.
836
+ * @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.
832
837
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
833
838
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
834
839
  * @param {*} [options] Override http request option.
835
840
  * @throws {RequiredError}
836
841
  */
837
- getProducts(project, pageToken, search, pageSize, fields, options) {
842
+ getProducts(project, pageToken, search, sortBy, pageSize, fields, options) {
838
843
  return __awaiter(this, void 0, void 0, function* () {
839
844
  var _a, _b, _c;
840
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(project, pageToken, search, pageSize, fields, options);
845
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(project, pageToken, search, sortBy, pageSize, fields, options);
841
846
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
842
847
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.getProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
843
848
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -925,7 +930,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
925
930
  * @throws {RequiredError}
926
931
  */
927
932
  getProducts(requestParameters, options) {
928
- return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
933
+ return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
929
934
  },
930
935
  /**
931
936
  * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
@@ -998,7 +1003,7 @@ export class ProductsApi extends BaseAPI {
998
1003
  * @memberof ProductsApi
999
1004
  */
1000
1005
  getProducts(requestParameters, options) {
1001
- return ProductsApiFp(this.configuration).getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
1006
+ return ProductsApiFp(this.configuration).getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
1002
1007
  }
1003
1008
  /**
1004
1009
  * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.23.0
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
5
  * Manage 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.23.0
7
+ * The version of the OpenAPI document: 1.24.0
8
8
  * Contact: hello@teemill.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.23.0
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
5
  * Manage 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.23.0
7
+ * The version of the OpenAPI document: 1.24.0
8
8
  * Contact: hello@teemill.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.23.0
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
5
  * Manage 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.23.0
7
+ * The version of the OpenAPI document: 1.24.0
8
8
  * Contact: hello@teemill.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.23.0
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
5
  * Manage 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.23.0
7
+ * The version of the OpenAPI document: 1.24.0
8
8
  * Contact: hello@teemill.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.23.0
5
+ * The version of the OpenAPI document: 1.24.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog API
6
6
  * Manage Product Catalog A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.23.0
8
+ * The version of the OpenAPI document: 1.24.0
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog API
5
5
  * Manage 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.23.0
7
+ * The version of the OpenAPI document: 1.24.0
8
8
  * Contact: hello@teemill.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/product-catalog",
3
- "version": "1.23.0",
3
+ "version": "1.24.0",
4
4
  "description": "OpenAPI client for @teemill/product-catalog",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {