@teemill/product-catalog 1.23.0 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +130 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +122 -3
- package/dist/api.js +11 -6
- 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 +122 -3
- package/dist/esm/api.js +11 -6
- 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/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.25.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/product-catalog@1.
|
|
39
|
+
npm install @teemill/product-catalog@1.25.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.
|
|
7
|
+
* The version of the OpenAPI document: 1.25.0
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -453,6 +453,12 @@ export interface CreateProductRequest {
|
|
|
453
453
|
* @memberof CreateProductRequest
|
|
454
454
|
*/
|
|
455
455
|
'images'?: Array<CreateProductRequestImagesInner>;
|
|
456
|
+
/**
|
|
457
|
+
* Videos to attach to the product.
|
|
458
|
+
* @type {Array<CreateProductRequestVideosInner>}
|
|
459
|
+
* @memberof CreateProductRequest
|
|
460
|
+
*/
|
|
461
|
+
'videos'?: Array<CreateProductRequestVideosInner>;
|
|
456
462
|
/**
|
|
457
463
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
458
464
|
* @type {Array<CreateProductRequestAdditionalFilesInner>}
|
|
@@ -517,6 +523,19 @@ export interface CreateProductRequestSeoMetadata {
|
|
|
517
523
|
*/
|
|
518
524
|
'description'?: string | null;
|
|
519
525
|
}
|
|
526
|
+
/**
|
|
527
|
+
*
|
|
528
|
+
* @export
|
|
529
|
+
* @interface CreateProductRequestVideosInner
|
|
530
|
+
*/
|
|
531
|
+
export interface CreateProductRequestVideosInner {
|
|
532
|
+
/**
|
|
533
|
+
* Publicly available file URL.
|
|
534
|
+
* @type {string}
|
|
535
|
+
* @memberof CreateProductRequestVideosInner
|
|
536
|
+
*/
|
|
537
|
+
'src'?: string;
|
|
538
|
+
}
|
|
520
539
|
/**
|
|
521
540
|
*
|
|
522
541
|
* @export
|
|
@@ -843,6 +862,12 @@ export interface Product {
|
|
|
843
862
|
* @memberof Product
|
|
844
863
|
*/
|
|
845
864
|
'images'?: Array<Image>;
|
|
865
|
+
/**
|
|
866
|
+
* Videos
|
|
867
|
+
* @type {Array<Video>}
|
|
868
|
+
* @memberof Product
|
|
869
|
+
*/
|
|
870
|
+
'videos'?: Array<Video>;
|
|
846
871
|
/**
|
|
847
872
|
* Variants
|
|
848
873
|
* @type {Array<Variant>}
|
|
@@ -861,6 +886,30 @@ export interface Product {
|
|
|
861
886
|
* @memberof Product
|
|
862
887
|
*/
|
|
863
888
|
'applicationSets'?: Array<ProductApplicationSetsInner>;
|
|
889
|
+
/**
|
|
890
|
+
* The average review rating. This field is only present if included in the fields query parameter
|
|
891
|
+
* @type {number}
|
|
892
|
+
* @memberof Product
|
|
893
|
+
*/
|
|
894
|
+
'reviewScore'?: number | null;
|
|
895
|
+
/**
|
|
896
|
+
* A count of reviews. This field is only present if included in the fields query parameter
|
|
897
|
+
* @type {number}
|
|
898
|
+
* @memberof Product
|
|
899
|
+
*/
|
|
900
|
+
'reviewCount'?: number;
|
|
901
|
+
/**
|
|
902
|
+
*
|
|
903
|
+
* @type {string}
|
|
904
|
+
* @memberof Product
|
|
905
|
+
*/
|
|
906
|
+
'sku'?: string;
|
|
907
|
+
/**
|
|
908
|
+
* A count of sales. This field is only present if included in the fields query parameter
|
|
909
|
+
* @type {number}
|
|
910
|
+
* @memberof Product
|
|
911
|
+
*/
|
|
912
|
+
'sales'?: number;
|
|
864
913
|
/**
|
|
865
914
|
*
|
|
866
915
|
* @type {boolean}
|
|
@@ -1116,6 +1165,12 @@ export interface UpdateProductRequest {
|
|
|
1116
1165
|
* @memberof UpdateProductRequest
|
|
1117
1166
|
*/
|
|
1118
1167
|
'images'?: Array<ImageFile>;
|
|
1168
|
+
/**
|
|
1169
|
+
* Videos to attach to the product.
|
|
1170
|
+
* @type {Array<VideoFile>}
|
|
1171
|
+
* @memberof UpdateProductRequest
|
|
1172
|
+
*/
|
|
1173
|
+
'videos'?: Array<VideoFile>;
|
|
1119
1174
|
/**
|
|
1120
1175
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
1121
1176
|
* @type {Array<AdditionalFile>}
|
|
@@ -1276,6 +1331,62 @@ export interface VariantsResponse {
|
|
|
1276
1331
|
*/
|
|
1277
1332
|
'nextPageToken'?: number;
|
|
1278
1333
|
}
|
|
1334
|
+
/**
|
|
1335
|
+
* Video object
|
|
1336
|
+
* @export
|
|
1337
|
+
* @interface Video
|
|
1338
|
+
*/
|
|
1339
|
+
export interface Video {
|
|
1340
|
+
/**
|
|
1341
|
+
* Unique object identifier
|
|
1342
|
+
* @type {string}
|
|
1343
|
+
* @memberof Video
|
|
1344
|
+
*/
|
|
1345
|
+
'id'?: string;
|
|
1346
|
+
/**
|
|
1347
|
+
*
|
|
1348
|
+
* @type {string}
|
|
1349
|
+
* @memberof Video
|
|
1350
|
+
*/
|
|
1351
|
+
'src'?: string;
|
|
1352
|
+
/**
|
|
1353
|
+
*
|
|
1354
|
+
* @type {string}
|
|
1355
|
+
* @memberof Video
|
|
1356
|
+
*/
|
|
1357
|
+
'alt'?: string;
|
|
1358
|
+
/**
|
|
1359
|
+
*
|
|
1360
|
+
* @type {number}
|
|
1361
|
+
* @memberof Video
|
|
1362
|
+
*/
|
|
1363
|
+
'sortOrder'?: number;
|
|
1364
|
+
/**
|
|
1365
|
+
*
|
|
1366
|
+
* @type {string}
|
|
1367
|
+
* @memberof Video
|
|
1368
|
+
*/
|
|
1369
|
+
'createdAt'?: string;
|
|
1370
|
+
/**
|
|
1371
|
+
*
|
|
1372
|
+
* @type {string}
|
|
1373
|
+
* @memberof Video
|
|
1374
|
+
*/
|
|
1375
|
+
'updatedAt'?: string;
|
|
1376
|
+
}
|
|
1377
|
+
/**
|
|
1378
|
+
*
|
|
1379
|
+
* @export
|
|
1380
|
+
* @interface VideoFile
|
|
1381
|
+
*/
|
|
1382
|
+
export interface VideoFile {
|
|
1383
|
+
/**
|
|
1384
|
+
* Publicly available file URL.
|
|
1385
|
+
* @type {string}
|
|
1386
|
+
* @memberof VideoFile
|
|
1387
|
+
*/
|
|
1388
|
+
'src'?: string;
|
|
1389
|
+
}
|
|
1279
1390
|
|
|
1280
1391
|
/**
|
|
1281
1392
|
* ApplicationSetsApi - axios parameter creator
|
|
@@ -2041,12 +2152,13 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2041
2152
|
* @param {string} project What project it is
|
|
2042
2153
|
* @param {number} [pageToken] Page reference token
|
|
2043
2154
|
* @param {string} [search] Search term to filter based on product tags.
|
|
2155
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2044
2156
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2045
2157
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2046
2158
|
* @param {*} [options] Override http request option.
|
|
2047
2159
|
* @throws {RequiredError}
|
|
2048
2160
|
*/
|
|
2049
|
-
getProducts: async (project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2161
|
+
getProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2050
2162
|
// verify required parameter 'project' is not null or undefined
|
|
2051
2163
|
assertParamExists('getProducts', 'project', project)
|
|
2052
2164
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -2080,6 +2192,10 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2080
2192
|
localVarQueryParameter['search'] = search;
|
|
2081
2193
|
}
|
|
2082
2194
|
|
|
2195
|
+
if (sortBy) {
|
|
2196
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
2197
|
+
}
|
|
2198
|
+
|
|
2083
2199
|
if (pageSize !== undefined) {
|
|
2084
2200
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
2085
2201
|
}
|
|
@@ -2258,13 +2374,14 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
2258
2374
|
* @param {string} project What project it is
|
|
2259
2375
|
* @param {number} [pageToken] Page reference token
|
|
2260
2376
|
* @param {string} [search] Search term to filter based on product tags.
|
|
2377
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2261
2378
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2262
2379
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2263
2380
|
* @param {*} [options] Override http request option.
|
|
2264
2381
|
* @throws {RequiredError}
|
|
2265
2382
|
*/
|
|
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);
|
|
2383
|
+
async getProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
2384
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProducts(project, pageToken, search, sortBy, pageSize, fields, options);
|
|
2268
2385
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2269
2386
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.getProducts']?.[localVarOperationServerIndex]?.url;
|
|
2270
2387
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2346,7 +2463,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
2346
2463
|
* @throws {RequiredError}
|
|
2347
2464
|
*/
|
|
2348
2465
|
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));
|
|
2466
|
+
return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
2350
2467
|
},
|
|
2351
2468
|
/**
|
|
2352
2469
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
@@ -2468,6 +2585,13 @@ export interface ProductsApiGetProductsRequest {
|
|
|
2468
2585
|
*/
|
|
2469
2586
|
readonly search?: string
|
|
2470
2587
|
|
|
2588
|
+
/**
|
|
2589
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2590
|
+
* @type {Array<string>}
|
|
2591
|
+
* @memberof ProductsApiGetProducts
|
|
2592
|
+
*/
|
|
2593
|
+
readonly sortBy?: Array<string>
|
|
2594
|
+
|
|
2471
2595
|
/**
|
|
2472
2596
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2473
2597
|
* @type {number}
|
|
@@ -2584,7 +2708,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
2584
2708
|
* @memberof ProductsApi
|
|
2585
2709
|
*/
|
|
2586
2710
|
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));
|
|
2711
|
+
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
2712
|
}
|
|
2589
2713
|
|
|
2590
2714
|
/**
|
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.
|
|
7
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
7
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
7
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
5
|
+
* The version of the OpenAPI document: 1.25.0
|
|
6
6
|
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -436,6 +436,12 @@ export interface CreateProductRequest {
|
|
|
436
436
|
* @memberof CreateProductRequest
|
|
437
437
|
*/
|
|
438
438
|
'images'?: Array<CreateProductRequestImagesInner>;
|
|
439
|
+
/**
|
|
440
|
+
* Videos to attach to the product.
|
|
441
|
+
* @type {Array<CreateProductRequestVideosInner>}
|
|
442
|
+
* @memberof CreateProductRequest
|
|
443
|
+
*/
|
|
444
|
+
'videos'?: Array<CreateProductRequestVideosInner>;
|
|
439
445
|
/**
|
|
440
446
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
441
447
|
* @type {Array<CreateProductRequestAdditionalFilesInner>}
|
|
@@ -500,6 +506,19 @@ export interface CreateProductRequestSeoMetadata {
|
|
|
500
506
|
*/
|
|
501
507
|
'description'?: string | null;
|
|
502
508
|
}
|
|
509
|
+
/**
|
|
510
|
+
*
|
|
511
|
+
* @export
|
|
512
|
+
* @interface CreateProductRequestVideosInner
|
|
513
|
+
*/
|
|
514
|
+
export interface CreateProductRequestVideosInner {
|
|
515
|
+
/**
|
|
516
|
+
* Publicly available file URL.
|
|
517
|
+
* @type {string}
|
|
518
|
+
* @memberof CreateProductRequestVideosInner
|
|
519
|
+
*/
|
|
520
|
+
'src'?: string;
|
|
521
|
+
}
|
|
503
522
|
/**
|
|
504
523
|
*
|
|
505
524
|
* @export
|
|
@@ -814,6 +833,12 @@ export interface Product {
|
|
|
814
833
|
* @memberof Product
|
|
815
834
|
*/
|
|
816
835
|
'images'?: Array<Image>;
|
|
836
|
+
/**
|
|
837
|
+
* Videos
|
|
838
|
+
* @type {Array<Video>}
|
|
839
|
+
* @memberof Product
|
|
840
|
+
*/
|
|
841
|
+
'videos'?: Array<Video>;
|
|
817
842
|
/**
|
|
818
843
|
* Variants
|
|
819
844
|
* @type {Array<Variant>}
|
|
@@ -832,6 +857,30 @@ export interface Product {
|
|
|
832
857
|
* @memberof Product
|
|
833
858
|
*/
|
|
834
859
|
'applicationSets'?: Array<ProductApplicationSetsInner>;
|
|
860
|
+
/**
|
|
861
|
+
* The average review rating. This field is only present if included in the fields query parameter
|
|
862
|
+
* @type {number}
|
|
863
|
+
* @memberof Product
|
|
864
|
+
*/
|
|
865
|
+
'reviewScore'?: number | null;
|
|
866
|
+
/**
|
|
867
|
+
* A count of reviews. This field is only present if included in the fields query parameter
|
|
868
|
+
* @type {number}
|
|
869
|
+
* @memberof Product
|
|
870
|
+
*/
|
|
871
|
+
'reviewCount'?: number;
|
|
872
|
+
/**
|
|
873
|
+
*
|
|
874
|
+
* @type {string}
|
|
875
|
+
* @memberof Product
|
|
876
|
+
*/
|
|
877
|
+
'sku'?: string;
|
|
878
|
+
/**
|
|
879
|
+
* A count of sales. This field is only present if included in the fields query parameter
|
|
880
|
+
* @type {number}
|
|
881
|
+
* @memberof Product
|
|
882
|
+
*/
|
|
883
|
+
'sales'?: number;
|
|
835
884
|
/**
|
|
836
885
|
*
|
|
837
886
|
* @type {boolean}
|
|
@@ -1087,6 +1136,12 @@ export interface UpdateProductRequest {
|
|
|
1087
1136
|
* @memberof UpdateProductRequest
|
|
1088
1137
|
*/
|
|
1089
1138
|
'images'?: Array<ImageFile>;
|
|
1139
|
+
/**
|
|
1140
|
+
* Videos to attach to the product.
|
|
1141
|
+
* @type {Array<VideoFile>}
|
|
1142
|
+
* @memberof UpdateProductRequest
|
|
1143
|
+
*/
|
|
1144
|
+
'videos'?: Array<VideoFile>;
|
|
1090
1145
|
/**
|
|
1091
1146
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
1092
1147
|
* @type {Array<AdditionalFile>}
|
|
@@ -1247,6 +1302,62 @@ export interface VariantsResponse {
|
|
|
1247
1302
|
*/
|
|
1248
1303
|
'nextPageToken'?: number;
|
|
1249
1304
|
}
|
|
1305
|
+
/**
|
|
1306
|
+
* Video object
|
|
1307
|
+
* @export
|
|
1308
|
+
* @interface Video
|
|
1309
|
+
*/
|
|
1310
|
+
export interface Video {
|
|
1311
|
+
/**
|
|
1312
|
+
* Unique object identifier
|
|
1313
|
+
* @type {string}
|
|
1314
|
+
* @memberof Video
|
|
1315
|
+
*/
|
|
1316
|
+
'id'?: string;
|
|
1317
|
+
/**
|
|
1318
|
+
*
|
|
1319
|
+
* @type {string}
|
|
1320
|
+
* @memberof Video
|
|
1321
|
+
*/
|
|
1322
|
+
'src'?: string;
|
|
1323
|
+
/**
|
|
1324
|
+
*
|
|
1325
|
+
* @type {string}
|
|
1326
|
+
* @memberof Video
|
|
1327
|
+
*/
|
|
1328
|
+
'alt'?: string;
|
|
1329
|
+
/**
|
|
1330
|
+
*
|
|
1331
|
+
* @type {number}
|
|
1332
|
+
* @memberof Video
|
|
1333
|
+
*/
|
|
1334
|
+
'sortOrder'?: number;
|
|
1335
|
+
/**
|
|
1336
|
+
*
|
|
1337
|
+
* @type {string}
|
|
1338
|
+
* @memberof Video
|
|
1339
|
+
*/
|
|
1340
|
+
'createdAt'?: string;
|
|
1341
|
+
/**
|
|
1342
|
+
*
|
|
1343
|
+
* @type {string}
|
|
1344
|
+
* @memberof Video
|
|
1345
|
+
*/
|
|
1346
|
+
'updatedAt'?: string;
|
|
1347
|
+
}
|
|
1348
|
+
/**
|
|
1349
|
+
*
|
|
1350
|
+
* @export
|
|
1351
|
+
* @interface VideoFile
|
|
1352
|
+
*/
|
|
1353
|
+
export interface VideoFile {
|
|
1354
|
+
/**
|
|
1355
|
+
* Publicly available file URL.
|
|
1356
|
+
* @type {string}
|
|
1357
|
+
* @memberof VideoFile
|
|
1358
|
+
*/
|
|
1359
|
+
'src'?: string;
|
|
1360
|
+
}
|
|
1250
1361
|
/**
|
|
1251
1362
|
* ApplicationSetsApi - axios parameter creator
|
|
1252
1363
|
* @export
|
|
@@ -1606,12 +1717,13 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1606
1717
|
* @param {string} project What project it is
|
|
1607
1718
|
* @param {number} [pageToken] Page reference token
|
|
1608
1719
|
* @param {string} [search] Search term to filter based on product tags.
|
|
1720
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1609
1721
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1610
1722
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1611
1723
|
* @param {*} [options] Override http request option.
|
|
1612
1724
|
* @throws {RequiredError}
|
|
1613
1725
|
*/
|
|
1614
|
-
getProducts: (project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1726
|
+
getProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1615
1727
|
/**
|
|
1616
1728
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1617
1729
|
* @summary Import products
|
|
@@ -1671,12 +1783,13 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
1671
1783
|
* @param {string} project What project it is
|
|
1672
1784
|
* @param {number} [pageToken] Page reference token
|
|
1673
1785
|
* @param {string} [search] Search term to filter based on product tags.
|
|
1786
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1674
1787
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1675
1788
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1676
1789
|
* @param {*} [options] Override http request option.
|
|
1677
1790
|
* @throws {RequiredError}
|
|
1678
1791
|
*/
|
|
1679
|
-
getProducts(project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
1792
|
+
getProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
1680
1793
|
/**
|
|
1681
1794
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1682
1795
|
* @summary Import products
|
|
@@ -1838,6 +1951,12 @@ export interface ProductsApiGetProductsRequest {
|
|
|
1838
1951
|
* @memberof ProductsApiGetProducts
|
|
1839
1952
|
*/
|
|
1840
1953
|
readonly search?: string;
|
|
1954
|
+
/**
|
|
1955
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1956
|
+
* @type {Array<string>}
|
|
1957
|
+
* @memberof ProductsApiGetProducts
|
|
1958
|
+
*/
|
|
1959
|
+
readonly sortBy?: Array<string>;
|
|
1841
1960
|
/**
|
|
1842
1961
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1843
1962
|
* @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.
|
|
8
|
+
* The version of the OpenAPI document: 1.25.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 \'-\' for descending order or \'+\' 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 \'-\' for descending order or \'+\' 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.
|
|
5
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
8
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
5
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
8
|
+
* The version of the OpenAPI document: 1.25.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/configuration.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.
|
|
5
|
+
* The version of the OpenAPI document: 1.25.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/configuration.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.
|
|
8
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
5
|
+
* The version of the OpenAPI document: 1.25.0
|
|
6
6
|
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -436,6 +436,12 @@ export interface CreateProductRequest {
|
|
|
436
436
|
* @memberof CreateProductRequest
|
|
437
437
|
*/
|
|
438
438
|
'images'?: Array<CreateProductRequestImagesInner>;
|
|
439
|
+
/**
|
|
440
|
+
* Videos to attach to the product.
|
|
441
|
+
* @type {Array<CreateProductRequestVideosInner>}
|
|
442
|
+
* @memberof CreateProductRequest
|
|
443
|
+
*/
|
|
444
|
+
'videos'?: Array<CreateProductRequestVideosInner>;
|
|
439
445
|
/**
|
|
440
446
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
441
447
|
* @type {Array<CreateProductRequestAdditionalFilesInner>}
|
|
@@ -500,6 +506,19 @@ export interface CreateProductRequestSeoMetadata {
|
|
|
500
506
|
*/
|
|
501
507
|
'description'?: string | null;
|
|
502
508
|
}
|
|
509
|
+
/**
|
|
510
|
+
*
|
|
511
|
+
* @export
|
|
512
|
+
* @interface CreateProductRequestVideosInner
|
|
513
|
+
*/
|
|
514
|
+
export interface CreateProductRequestVideosInner {
|
|
515
|
+
/**
|
|
516
|
+
* Publicly available file URL.
|
|
517
|
+
* @type {string}
|
|
518
|
+
* @memberof CreateProductRequestVideosInner
|
|
519
|
+
*/
|
|
520
|
+
'src'?: string;
|
|
521
|
+
}
|
|
503
522
|
/**
|
|
504
523
|
*
|
|
505
524
|
* @export
|
|
@@ -814,6 +833,12 @@ export interface Product {
|
|
|
814
833
|
* @memberof Product
|
|
815
834
|
*/
|
|
816
835
|
'images'?: Array<Image>;
|
|
836
|
+
/**
|
|
837
|
+
* Videos
|
|
838
|
+
* @type {Array<Video>}
|
|
839
|
+
* @memberof Product
|
|
840
|
+
*/
|
|
841
|
+
'videos'?: Array<Video>;
|
|
817
842
|
/**
|
|
818
843
|
* Variants
|
|
819
844
|
* @type {Array<Variant>}
|
|
@@ -832,6 +857,30 @@ export interface Product {
|
|
|
832
857
|
* @memberof Product
|
|
833
858
|
*/
|
|
834
859
|
'applicationSets'?: Array<ProductApplicationSetsInner>;
|
|
860
|
+
/**
|
|
861
|
+
* The average review rating. This field is only present if included in the fields query parameter
|
|
862
|
+
* @type {number}
|
|
863
|
+
* @memberof Product
|
|
864
|
+
*/
|
|
865
|
+
'reviewScore'?: number | null;
|
|
866
|
+
/**
|
|
867
|
+
* A count of reviews. This field is only present if included in the fields query parameter
|
|
868
|
+
* @type {number}
|
|
869
|
+
* @memberof Product
|
|
870
|
+
*/
|
|
871
|
+
'reviewCount'?: number;
|
|
872
|
+
/**
|
|
873
|
+
*
|
|
874
|
+
* @type {string}
|
|
875
|
+
* @memberof Product
|
|
876
|
+
*/
|
|
877
|
+
'sku'?: string;
|
|
878
|
+
/**
|
|
879
|
+
* A count of sales. This field is only present if included in the fields query parameter
|
|
880
|
+
* @type {number}
|
|
881
|
+
* @memberof Product
|
|
882
|
+
*/
|
|
883
|
+
'sales'?: number;
|
|
835
884
|
/**
|
|
836
885
|
*
|
|
837
886
|
* @type {boolean}
|
|
@@ -1087,6 +1136,12 @@ export interface UpdateProductRequest {
|
|
|
1087
1136
|
* @memberof UpdateProductRequest
|
|
1088
1137
|
*/
|
|
1089
1138
|
'images'?: Array<ImageFile>;
|
|
1139
|
+
/**
|
|
1140
|
+
* Videos to attach to the product.
|
|
1141
|
+
* @type {Array<VideoFile>}
|
|
1142
|
+
* @memberof UpdateProductRequest
|
|
1143
|
+
*/
|
|
1144
|
+
'videos'?: Array<VideoFile>;
|
|
1090
1145
|
/**
|
|
1091
1146
|
* Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
|
|
1092
1147
|
* @type {Array<AdditionalFile>}
|
|
@@ -1247,6 +1302,62 @@ export interface VariantsResponse {
|
|
|
1247
1302
|
*/
|
|
1248
1303
|
'nextPageToken'?: number;
|
|
1249
1304
|
}
|
|
1305
|
+
/**
|
|
1306
|
+
* Video object
|
|
1307
|
+
* @export
|
|
1308
|
+
* @interface Video
|
|
1309
|
+
*/
|
|
1310
|
+
export interface Video {
|
|
1311
|
+
/**
|
|
1312
|
+
* Unique object identifier
|
|
1313
|
+
* @type {string}
|
|
1314
|
+
* @memberof Video
|
|
1315
|
+
*/
|
|
1316
|
+
'id'?: string;
|
|
1317
|
+
/**
|
|
1318
|
+
*
|
|
1319
|
+
* @type {string}
|
|
1320
|
+
* @memberof Video
|
|
1321
|
+
*/
|
|
1322
|
+
'src'?: string;
|
|
1323
|
+
/**
|
|
1324
|
+
*
|
|
1325
|
+
* @type {string}
|
|
1326
|
+
* @memberof Video
|
|
1327
|
+
*/
|
|
1328
|
+
'alt'?: string;
|
|
1329
|
+
/**
|
|
1330
|
+
*
|
|
1331
|
+
* @type {number}
|
|
1332
|
+
* @memberof Video
|
|
1333
|
+
*/
|
|
1334
|
+
'sortOrder'?: number;
|
|
1335
|
+
/**
|
|
1336
|
+
*
|
|
1337
|
+
* @type {string}
|
|
1338
|
+
* @memberof Video
|
|
1339
|
+
*/
|
|
1340
|
+
'createdAt'?: string;
|
|
1341
|
+
/**
|
|
1342
|
+
*
|
|
1343
|
+
* @type {string}
|
|
1344
|
+
* @memberof Video
|
|
1345
|
+
*/
|
|
1346
|
+
'updatedAt'?: string;
|
|
1347
|
+
}
|
|
1348
|
+
/**
|
|
1349
|
+
*
|
|
1350
|
+
* @export
|
|
1351
|
+
* @interface VideoFile
|
|
1352
|
+
*/
|
|
1353
|
+
export interface VideoFile {
|
|
1354
|
+
/**
|
|
1355
|
+
* Publicly available file URL.
|
|
1356
|
+
* @type {string}
|
|
1357
|
+
* @memberof VideoFile
|
|
1358
|
+
*/
|
|
1359
|
+
'src'?: string;
|
|
1360
|
+
}
|
|
1250
1361
|
/**
|
|
1251
1362
|
* ApplicationSetsApi - axios parameter creator
|
|
1252
1363
|
* @export
|
|
@@ -1606,12 +1717,13 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1606
1717
|
* @param {string} project What project it is
|
|
1607
1718
|
* @param {number} [pageToken] Page reference token
|
|
1608
1719
|
* @param {string} [search] Search term to filter based on product tags.
|
|
1720
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1609
1721
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1610
1722
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1611
1723
|
* @param {*} [options] Override http request option.
|
|
1612
1724
|
* @throws {RequiredError}
|
|
1613
1725
|
*/
|
|
1614
|
-
getProducts: (project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1726
|
+
getProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1615
1727
|
/**
|
|
1616
1728
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1617
1729
|
* @summary Import products
|
|
@@ -1671,12 +1783,13 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
1671
1783
|
* @param {string} project What project it is
|
|
1672
1784
|
* @param {number} [pageToken] Page reference token
|
|
1673
1785
|
* @param {string} [search] Search term to filter based on product tags.
|
|
1786
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1674
1787
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1675
1788
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1676
1789
|
* @param {*} [options] Override http request option.
|
|
1677
1790
|
* @throws {RequiredError}
|
|
1678
1791
|
*/
|
|
1679
|
-
getProducts(project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
1792
|
+
getProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
1680
1793
|
/**
|
|
1681
1794
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1682
1795
|
* @summary Import products
|
|
@@ -1838,6 +1951,12 @@ export interface ProductsApiGetProductsRequest {
|
|
|
1838
1951
|
* @memberof ProductsApiGetProducts
|
|
1839
1952
|
*/
|
|
1840
1953
|
readonly search?: string;
|
|
1954
|
+
/**
|
|
1955
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1956
|
+
* @type {Array<string>}
|
|
1957
|
+
* @memberof ProductsApiGetProducts
|
|
1958
|
+
*/
|
|
1959
|
+
readonly sortBy?: Array<string>;
|
|
1841
1960
|
/**
|
|
1842
1961
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1843
1962
|
* @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.
|
|
7
|
+
* The version of the OpenAPI document: 1.25.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 \'-\' for descending order or \'+\' 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 \'-\' for descending order or \'+\' 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.
|
package/dist/esm/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
7
|
+
* The version of the OpenAPI document: 1.25.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/esm/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.25.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/common.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.
|
|
7
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
5
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
7
|
+
* The version of the OpenAPI document: 1.25.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/esm/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
7
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
5
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
8
|
+
* The version of the OpenAPI document: 1.25.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.
|
|
7
|
+
* The version of the OpenAPI document: 1.25.0
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|