@teemill/product-catalog 1.19.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 +2 -2
- package/api.ts +105 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +94 -3
- package/dist/api.js +15 -7
- 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 +94 -3
- package/dist/esm/api.js +14 -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.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.
|
|
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.
|
|
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).
|
|
@@ -465,6 +465,12 @@ export interface CreateProductRequest {
|
|
|
465
465
|
* @memberof CreateProductRequest
|
|
466
466
|
*/
|
|
467
467
|
'applicationSets'?: Array<string>;
|
|
468
|
+
/**
|
|
469
|
+
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
470
|
+
* @type {boolean}
|
|
471
|
+
* @memberof CreateProductRequest
|
|
472
|
+
*/
|
|
473
|
+
'includeInDataFeeds'?: boolean;
|
|
468
474
|
}
|
|
469
475
|
/**
|
|
470
476
|
*
|
|
@@ -504,6 +510,12 @@ export interface CreateProductRequestSeoMetadata {
|
|
|
504
510
|
* @memberof CreateProductRequestSeoMetadata
|
|
505
511
|
*/
|
|
506
512
|
'title'?: string;
|
|
513
|
+
/**
|
|
514
|
+
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
515
|
+
* @type {string}
|
|
516
|
+
* @memberof CreateProductRequestSeoMetadata
|
|
517
|
+
*/
|
|
518
|
+
'description'?: string | null;
|
|
507
519
|
}
|
|
508
520
|
/**
|
|
509
521
|
*
|
|
@@ -523,6 +535,12 @@ export interface CreateProductVariant {
|
|
|
523
535
|
* @memberof CreateProductVariant
|
|
524
536
|
*/
|
|
525
537
|
'retailPrice': CreateProductVariantRetailPrice;
|
|
538
|
+
/**
|
|
539
|
+
*
|
|
540
|
+
* @type {CreateProductVariantSalePrice}
|
|
541
|
+
* @memberof CreateProductVariant
|
|
542
|
+
*/
|
|
543
|
+
'salePrice'?: CreateProductVariantSalePrice;
|
|
526
544
|
/**
|
|
527
545
|
* A custom stock keeping unit for the variant.
|
|
528
546
|
* @type {string}
|
|
@@ -614,6 +632,32 @@ export const CreateProductVariantRetailPriceCurrencyCodeEnum = {
|
|
|
614
632
|
|
|
615
633
|
export type CreateProductVariantRetailPriceCurrencyCodeEnum = typeof CreateProductVariantRetailPriceCurrencyCodeEnum[keyof typeof CreateProductVariantRetailPriceCurrencyCodeEnum];
|
|
616
634
|
|
|
635
|
+
/**
|
|
636
|
+
* Variant discounted price including tax.
|
|
637
|
+
* @export
|
|
638
|
+
* @interface CreateProductVariantSalePrice
|
|
639
|
+
*/
|
|
640
|
+
export interface CreateProductVariantSalePrice {
|
|
641
|
+
/**
|
|
642
|
+
* Sale price including tax in the specified currency.
|
|
643
|
+
* @type {number}
|
|
644
|
+
* @memberof CreateProductVariantSalePrice
|
|
645
|
+
*/
|
|
646
|
+
'amount': number;
|
|
647
|
+
/**
|
|
648
|
+
* Currency code for the currency the sale price is valued in.
|
|
649
|
+
* @type {string}
|
|
650
|
+
* @memberof CreateProductVariantSalePrice
|
|
651
|
+
*/
|
|
652
|
+
'currencyCode': CreateProductVariantSalePriceCurrencyCodeEnum;
|
|
653
|
+
}
|
|
654
|
+
|
|
655
|
+
export const CreateProductVariantSalePriceCurrencyCodeEnum = {
|
|
656
|
+
Gbp: 'GBP'
|
|
657
|
+
} as const;
|
|
658
|
+
|
|
659
|
+
export type CreateProductVariantSalePriceCurrencyCodeEnum = typeof CreateProductVariantSalePriceCurrencyCodeEnum[keyof typeof CreateProductVariantSalePriceCurrencyCodeEnum];
|
|
660
|
+
|
|
617
661
|
/**
|
|
618
662
|
* Image description
|
|
619
663
|
* @export
|
|
@@ -817,6 +861,36 @@ export interface Product {
|
|
|
817
861
|
* @memberof Product
|
|
818
862
|
*/
|
|
819
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;
|
|
888
|
+
/**
|
|
889
|
+
*
|
|
890
|
+
* @type {boolean}
|
|
891
|
+
* @memberof Product
|
|
892
|
+
*/
|
|
893
|
+
'includeInDataFeeds'?: boolean;
|
|
820
894
|
}
|
|
821
895
|
/**
|
|
822
896
|
*
|
|
@@ -893,6 +967,12 @@ export interface SeoMetadata {
|
|
|
893
967
|
* @memberof SeoMetadata
|
|
894
968
|
*/
|
|
895
969
|
'title'?: string;
|
|
970
|
+
/**
|
|
971
|
+
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
972
|
+
* @type {string}
|
|
973
|
+
* @memberof SeoMetadata
|
|
974
|
+
*/
|
|
975
|
+
'description'?: string | null;
|
|
896
976
|
}
|
|
897
977
|
/**
|
|
898
978
|
*
|
|
@@ -1072,6 +1152,12 @@ export interface UpdateProductRequest {
|
|
|
1072
1152
|
* @memberof UpdateProductRequest
|
|
1073
1153
|
*/
|
|
1074
1154
|
'applicationSets'?: Array<string>;
|
|
1155
|
+
/**
|
|
1156
|
+
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
1157
|
+
* @type {boolean}
|
|
1158
|
+
* @memberof UpdateProductRequest
|
|
1159
|
+
*/
|
|
1160
|
+
'includeInDataFeeds'?: boolean;
|
|
1075
1161
|
}
|
|
1076
1162
|
/**
|
|
1077
1163
|
*
|
|
@@ -1979,12 +2065,13 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1979
2065
|
* @param {string} project What project it is
|
|
1980
2066
|
* @param {number} [pageToken] Page reference token
|
|
1981
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 \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1982
2069
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1983
2070
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1984
2071
|
* @param {*} [options] Override http request option.
|
|
1985
2072
|
* @throws {RequiredError}
|
|
1986
2073
|
*/
|
|
1987
|
-
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> => {
|
|
1988
2075
|
// verify required parameter 'project' is not null or undefined
|
|
1989
2076
|
assertParamExists('getProducts', 'project', project)
|
|
1990
2077
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -2018,6 +2105,10 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2018
2105
|
localVarQueryParameter['search'] = search;
|
|
2019
2106
|
}
|
|
2020
2107
|
|
|
2108
|
+
if (sortBy) {
|
|
2109
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
2110
|
+
}
|
|
2111
|
+
|
|
2021
2112
|
if (pageSize !== undefined) {
|
|
2022
2113
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
2023
2114
|
}
|
|
@@ -2196,13 +2287,14 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
2196
2287
|
* @param {string} project What project it is
|
|
2197
2288
|
* @param {number} [pageToken] Page reference token
|
|
2198
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 \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2199
2291
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2200
2292
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2201
2293
|
* @param {*} [options] Override http request option.
|
|
2202
2294
|
* @throws {RequiredError}
|
|
2203
2295
|
*/
|
|
2204
|
-
async getProducts(project: string, pageToken?: number, search?: string, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
2205
|
-
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);
|
|
2206
2298
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2207
2299
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.getProducts']?.[localVarOperationServerIndex]?.url;
|
|
2208
2300
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2284,7 +2376,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
2284
2376
|
* @throws {RequiredError}
|
|
2285
2377
|
*/
|
|
2286
2378
|
getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
|
|
2287
|
-
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));
|
|
2288
2380
|
},
|
|
2289
2381
|
/**
|
|
2290
2382
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
@@ -2406,6 +2498,13 @@ export interface ProductsApiGetProductsRequest {
|
|
|
2406
2498
|
*/
|
|
2407
2499
|
readonly search?: string
|
|
2408
2500
|
|
|
2501
|
+
/**
|
|
2502
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2503
|
+
* @type {Array<string>}
|
|
2504
|
+
* @memberof ProductsApiGetProducts
|
|
2505
|
+
*/
|
|
2506
|
+
readonly sortBy?: Array<string>
|
|
2507
|
+
|
|
2409
2508
|
/**
|
|
2410
2509
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2411
2510
|
* @type {number}
|
|
@@ -2522,7 +2621,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
2522
2621
|
* @memberof ProductsApi
|
|
2523
2622
|
*/
|
|
2524
2623
|
public getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig) {
|
|
2525
|
-
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));
|
|
2526
2625
|
}
|
|
2527
2626
|
|
|
2528
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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).
|
|
@@ -448,6 +448,12 @@ export interface CreateProductRequest {
|
|
|
448
448
|
* @memberof CreateProductRequest
|
|
449
449
|
*/
|
|
450
450
|
'applicationSets'?: Array<string>;
|
|
451
|
+
/**
|
|
452
|
+
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
453
|
+
* @type {boolean}
|
|
454
|
+
* @memberof CreateProductRequest
|
|
455
|
+
*/
|
|
456
|
+
'includeInDataFeeds'?: boolean;
|
|
451
457
|
}
|
|
452
458
|
/**
|
|
453
459
|
*
|
|
@@ -487,6 +493,12 @@ export interface CreateProductRequestSeoMetadata {
|
|
|
487
493
|
* @memberof CreateProductRequestSeoMetadata
|
|
488
494
|
*/
|
|
489
495
|
'title'?: string;
|
|
496
|
+
/**
|
|
497
|
+
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
498
|
+
* @type {string}
|
|
499
|
+
* @memberof CreateProductRequestSeoMetadata
|
|
500
|
+
*/
|
|
501
|
+
'description'?: string | null;
|
|
490
502
|
}
|
|
491
503
|
/**
|
|
492
504
|
*
|
|
@@ -506,6 +518,12 @@ export interface CreateProductVariant {
|
|
|
506
518
|
* @memberof CreateProductVariant
|
|
507
519
|
*/
|
|
508
520
|
'retailPrice': CreateProductVariantRetailPrice;
|
|
521
|
+
/**
|
|
522
|
+
*
|
|
523
|
+
* @type {CreateProductVariantSalePrice}
|
|
524
|
+
* @memberof CreateProductVariant
|
|
525
|
+
*/
|
|
526
|
+
'salePrice'?: CreateProductVariantSalePrice;
|
|
509
527
|
/**
|
|
510
528
|
* A custom stock keeping unit for the variant.
|
|
511
529
|
* @type {string}
|
|
@@ -591,6 +609,29 @@ export declare const CreateProductVariantRetailPriceCurrencyCodeEnum: {
|
|
|
591
609
|
readonly Gbp: "GBP";
|
|
592
610
|
};
|
|
593
611
|
export type CreateProductVariantRetailPriceCurrencyCodeEnum = typeof CreateProductVariantRetailPriceCurrencyCodeEnum[keyof typeof CreateProductVariantRetailPriceCurrencyCodeEnum];
|
|
612
|
+
/**
|
|
613
|
+
* Variant discounted price including tax.
|
|
614
|
+
* @export
|
|
615
|
+
* @interface CreateProductVariantSalePrice
|
|
616
|
+
*/
|
|
617
|
+
export interface CreateProductVariantSalePrice {
|
|
618
|
+
/**
|
|
619
|
+
* Sale price including tax in the specified currency.
|
|
620
|
+
* @type {number}
|
|
621
|
+
* @memberof CreateProductVariantSalePrice
|
|
622
|
+
*/
|
|
623
|
+
'amount': number;
|
|
624
|
+
/**
|
|
625
|
+
* Currency code for the currency the sale price is valued in.
|
|
626
|
+
* @type {string}
|
|
627
|
+
* @memberof CreateProductVariantSalePrice
|
|
628
|
+
*/
|
|
629
|
+
'currencyCode': CreateProductVariantSalePriceCurrencyCodeEnum;
|
|
630
|
+
}
|
|
631
|
+
export declare const CreateProductVariantSalePriceCurrencyCodeEnum: {
|
|
632
|
+
readonly Gbp: "GBP";
|
|
633
|
+
};
|
|
634
|
+
export type CreateProductVariantSalePriceCurrencyCodeEnum = typeof CreateProductVariantSalePriceCurrencyCodeEnum[keyof typeof CreateProductVariantSalePriceCurrencyCodeEnum];
|
|
594
635
|
/**
|
|
595
636
|
* Image description
|
|
596
637
|
* @export
|
|
@@ -791,6 +832,36 @@ export interface Product {
|
|
|
791
832
|
* @memberof Product
|
|
792
833
|
*/
|
|
793
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;
|
|
859
|
+
/**
|
|
860
|
+
*
|
|
861
|
+
* @type {boolean}
|
|
862
|
+
* @memberof Product
|
|
863
|
+
*/
|
|
864
|
+
'includeInDataFeeds'?: boolean;
|
|
794
865
|
}
|
|
795
866
|
/**
|
|
796
867
|
*
|
|
@@ -867,6 +938,12 @@ export interface SeoMetadata {
|
|
|
867
938
|
* @memberof SeoMetadata
|
|
868
939
|
*/
|
|
869
940
|
'title'?: string;
|
|
941
|
+
/**
|
|
942
|
+
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
943
|
+
* @type {string}
|
|
944
|
+
* @memberof SeoMetadata
|
|
945
|
+
*/
|
|
946
|
+
'description'?: string | null;
|
|
870
947
|
}
|
|
871
948
|
/**
|
|
872
949
|
*
|
|
@@ -1046,6 +1123,12 @@ export interface UpdateProductRequest {
|
|
|
1046
1123
|
* @memberof UpdateProductRequest
|
|
1047
1124
|
*/
|
|
1048
1125
|
'applicationSets'?: Array<string>;
|
|
1126
|
+
/**
|
|
1127
|
+
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
1128
|
+
* @type {boolean}
|
|
1129
|
+
* @memberof UpdateProductRequest
|
|
1130
|
+
*/
|
|
1131
|
+
'includeInDataFeeds'?: boolean;
|
|
1049
1132
|
}
|
|
1050
1133
|
/**
|
|
1051
1134
|
*
|
|
@@ -1547,12 +1630,13 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1547
1630
|
* @param {string} project What project it is
|
|
1548
1631
|
* @param {number} [pageToken] Page reference token
|
|
1549
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 \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1550
1634
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1551
1635
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1552
1636
|
* @param {*} [options] Override http request option.
|
|
1553
1637
|
* @throws {RequiredError}
|
|
1554
1638
|
*/
|
|
1555
|
-
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>;
|
|
1556
1640
|
/**
|
|
1557
1641
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1558
1642
|
* @summary Import products
|
|
@@ -1612,12 +1696,13 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
1612
1696
|
* @param {string} project What project it is
|
|
1613
1697
|
* @param {number} [pageToken] Page reference token
|
|
1614
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 \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1615
1700
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1616
1701
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1617
1702
|
* @param {*} [options] Override http request option.
|
|
1618
1703
|
* @throws {RequiredError}
|
|
1619
1704
|
*/
|
|
1620
|
-
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>>;
|
|
1621
1706
|
/**
|
|
1622
1707
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1623
1708
|
* @summary Import products
|
|
@@ -1779,6 +1864,12 @@ export interface ProductsApiGetProductsRequest {
|
|
|
1779
1864
|
* @memberof ProductsApiGetProducts
|
|
1780
1865
|
*/
|
|
1781
1866
|
readonly search?: string;
|
|
1867
|
+
/**
|
|
1868
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1869
|
+
* @type {Array<string>}
|
|
1870
|
+
* @memberof ProductsApiGetProducts
|
|
1871
|
+
*/
|
|
1872
|
+
readonly sortBy?: Array<string>;
|
|
1782
1873
|
/**
|
|
1783
1874
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1784
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.
|
|
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).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.PriceCurrencyCodeEnum = exports.CreateProductVariantRetailPriceCurrencyCodeEnum = exports.CreateProductVariantAttributesInnerNameEnum = exports.CreateApplicationSetRequestRecordsInnerAttributesInnerThumbnailTypeEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = void 0;
|
|
25
|
+
exports.VariantsApi = exports.VariantsApiFactory = exports.VariantsApiFp = exports.VariantsApiAxiosParamCreator = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.ApplicationSetsApi = exports.ApplicationSetsApiFactory = exports.ApplicationSetsApiFp = exports.ApplicationSetsApiAxiosParamCreator = exports.PriceCurrencyCodeEnum = exports.CreateProductVariantSalePriceCurrencyCodeEnum = exports.CreateProductVariantRetailPriceCurrencyCodeEnum = exports.CreateProductVariantAttributesInnerNameEnum = exports.CreateApplicationSetRequestRecordsInnerAttributesInnerThumbnailTypeEnum = exports.ApplicationPlacementEnum = exports.ApplicationTechnologyEnum = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -59,6 +59,9 @@ exports.CreateProductVariantAttributesInnerNameEnum = {
|
|
|
59
59
|
exports.CreateProductVariantRetailPriceCurrencyCodeEnum = {
|
|
60
60
|
Gbp: 'GBP'
|
|
61
61
|
};
|
|
62
|
+
exports.CreateProductVariantSalePriceCurrencyCodeEnum = {
|
|
63
|
+
Gbp: 'GBP'
|
|
64
|
+
};
|
|
62
65
|
exports.PriceCurrencyCodeEnum = {
|
|
63
66
|
Gbp: 'GBP'
|
|
64
67
|
};
|
|
@@ -638,12 +641,13 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
638
641
|
* @param {string} project What project it is
|
|
639
642
|
* @param {number} [pageToken] Page reference token
|
|
640
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.
|
|
641
645
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
642
646
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
643
647
|
* @param {*} [options] Override http request option.
|
|
644
648
|
* @throws {RequiredError}
|
|
645
649
|
*/
|
|
646
|
-
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 = {}) {
|
|
647
651
|
// verify required parameter 'project' is not null or undefined
|
|
648
652
|
(0, common_1.assertParamExists)('getProducts', 'project', project);
|
|
649
653
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -670,6 +674,9 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
670
674
|
if (search !== undefined) {
|
|
671
675
|
localVarQueryParameter['search'] = search;
|
|
672
676
|
}
|
|
677
|
+
if (sortBy) {
|
|
678
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
679
|
+
}
|
|
673
680
|
if (pageSize !== undefined) {
|
|
674
681
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
675
682
|
}
|
|
@@ -834,15 +841,16 @@ const ProductsApiFp = function (configuration) {
|
|
|
834
841
|
* @param {string} project What project it is
|
|
835
842
|
* @param {number} [pageToken] Page reference token
|
|
836
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.
|
|
837
845
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
838
846
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
839
847
|
* @param {*} [options] Override http request option.
|
|
840
848
|
* @throws {RequiredError}
|
|
841
849
|
*/
|
|
842
|
-
getProducts(project, pageToken, search, pageSize, fields, options) {
|
|
850
|
+
getProducts(project, pageToken, search, sortBy, pageSize, fields, options) {
|
|
843
851
|
return __awaiter(this, void 0, void 0, function* () {
|
|
844
852
|
var _a, _b, _c;
|
|
845
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(project, pageToken, search, pageSize, fields, options);
|
|
853
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(project, pageToken, search, sortBy, pageSize, fields, options);
|
|
846
854
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
847
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;
|
|
848
856
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -931,7 +939,7 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
931
939
|
* @throws {RequiredError}
|
|
932
940
|
*/
|
|
933
941
|
getProducts(requestParameters, options) {
|
|
934
|
-
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));
|
|
935
943
|
},
|
|
936
944
|
/**
|
|
937
945
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
@@ -1005,7 +1013,7 @@ class ProductsApi extends base_1.BaseAPI {
|
|
|
1005
1013
|
* @memberof ProductsApi
|
|
1006
1014
|
*/
|
|
1007
1015
|
getProducts(requestParameters, options) {
|
|
1008
|
-
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));
|
|
1009
1017
|
}
|
|
1010
1018
|
/**
|
|
1011
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.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.
|
|
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.
|
|
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.
|
|
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/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.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/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.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.
|
|
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).
|
|
@@ -448,6 +448,12 @@ export interface CreateProductRequest {
|
|
|
448
448
|
* @memberof CreateProductRequest
|
|
449
449
|
*/
|
|
450
450
|
'applicationSets'?: Array<string>;
|
|
451
|
+
/**
|
|
452
|
+
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
453
|
+
* @type {boolean}
|
|
454
|
+
* @memberof CreateProductRequest
|
|
455
|
+
*/
|
|
456
|
+
'includeInDataFeeds'?: boolean;
|
|
451
457
|
}
|
|
452
458
|
/**
|
|
453
459
|
*
|
|
@@ -487,6 +493,12 @@ export interface CreateProductRequestSeoMetadata {
|
|
|
487
493
|
* @memberof CreateProductRequestSeoMetadata
|
|
488
494
|
*/
|
|
489
495
|
'title'?: string;
|
|
496
|
+
/**
|
|
497
|
+
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
498
|
+
* @type {string}
|
|
499
|
+
* @memberof CreateProductRequestSeoMetadata
|
|
500
|
+
*/
|
|
501
|
+
'description'?: string | null;
|
|
490
502
|
}
|
|
491
503
|
/**
|
|
492
504
|
*
|
|
@@ -506,6 +518,12 @@ export interface CreateProductVariant {
|
|
|
506
518
|
* @memberof CreateProductVariant
|
|
507
519
|
*/
|
|
508
520
|
'retailPrice': CreateProductVariantRetailPrice;
|
|
521
|
+
/**
|
|
522
|
+
*
|
|
523
|
+
* @type {CreateProductVariantSalePrice}
|
|
524
|
+
* @memberof CreateProductVariant
|
|
525
|
+
*/
|
|
526
|
+
'salePrice'?: CreateProductVariantSalePrice;
|
|
509
527
|
/**
|
|
510
528
|
* A custom stock keeping unit for the variant.
|
|
511
529
|
* @type {string}
|
|
@@ -591,6 +609,29 @@ export declare const CreateProductVariantRetailPriceCurrencyCodeEnum: {
|
|
|
591
609
|
readonly Gbp: "GBP";
|
|
592
610
|
};
|
|
593
611
|
export type CreateProductVariantRetailPriceCurrencyCodeEnum = typeof CreateProductVariantRetailPriceCurrencyCodeEnum[keyof typeof CreateProductVariantRetailPriceCurrencyCodeEnum];
|
|
612
|
+
/**
|
|
613
|
+
* Variant discounted price including tax.
|
|
614
|
+
* @export
|
|
615
|
+
* @interface CreateProductVariantSalePrice
|
|
616
|
+
*/
|
|
617
|
+
export interface CreateProductVariantSalePrice {
|
|
618
|
+
/**
|
|
619
|
+
* Sale price including tax in the specified currency.
|
|
620
|
+
* @type {number}
|
|
621
|
+
* @memberof CreateProductVariantSalePrice
|
|
622
|
+
*/
|
|
623
|
+
'amount': number;
|
|
624
|
+
/**
|
|
625
|
+
* Currency code for the currency the sale price is valued in.
|
|
626
|
+
* @type {string}
|
|
627
|
+
* @memberof CreateProductVariantSalePrice
|
|
628
|
+
*/
|
|
629
|
+
'currencyCode': CreateProductVariantSalePriceCurrencyCodeEnum;
|
|
630
|
+
}
|
|
631
|
+
export declare const CreateProductVariantSalePriceCurrencyCodeEnum: {
|
|
632
|
+
readonly Gbp: "GBP";
|
|
633
|
+
};
|
|
634
|
+
export type CreateProductVariantSalePriceCurrencyCodeEnum = typeof CreateProductVariantSalePriceCurrencyCodeEnum[keyof typeof CreateProductVariantSalePriceCurrencyCodeEnum];
|
|
594
635
|
/**
|
|
595
636
|
* Image description
|
|
596
637
|
* @export
|
|
@@ -791,6 +832,36 @@ export interface Product {
|
|
|
791
832
|
* @memberof Product
|
|
792
833
|
*/
|
|
793
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;
|
|
859
|
+
/**
|
|
860
|
+
*
|
|
861
|
+
* @type {boolean}
|
|
862
|
+
* @memberof Product
|
|
863
|
+
*/
|
|
864
|
+
'includeInDataFeeds'?: boolean;
|
|
794
865
|
}
|
|
795
866
|
/**
|
|
796
867
|
*
|
|
@@ -867,6 +938,12 @@ export interface SeoMetadata {
|
|
|
867
938
|
* @memberof SeoMetadata
|
|
868
939
|
*/
|
|
869
940
|
'title'?: string;
|
|
941
|
+
/**
|
|
942
|
+
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
943
|
+
* @type {string}
|
|
944
|
+
* @memberof SeoMetadata
|
|
945
|
+
*/
|
|
946
|
+
'description'?: string | null;
|
|
870
947
|
}
|
|
871
948
|
/**
|
|
872
949
|
*
|
|
@@ -1046,6 +1123,12 @@ export interface UpdateProductRequest {
|
|
|
1046
1123
|
* @memberof UpdateProductRequest
|
|
1047
1124
|
*/
|
|
1048
1125
|
'applicationSets'?: Array<string>;
|
|
1126
|
+
/**
|
|
1127
|
+
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
1128
|
+
* @type {boolean}
|
|
1129
|
+
* @memberof UpdateProductRequest
|
|
1130
|
+
*/
|
|
1131
|
+
'includeInDataFeeds'?: boolean;
|
|
1049
1132
|
}
|
|
1050
1133
|
/**
|
|
1051
1134
|
*
|
|
@@ -1547,12 +1630,13 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1547
1630
|
* @param {string} project What project it is
|
|
1548
1631
|
* @param {number} [pageToken] Page reference token
|
|
1549
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 \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1550
1634
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1551
1635
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1552
1636
|
* @param {*} [options] Override http request option.
|
|
1553
1637
|
* @throws {RequiredError}
|
|
1554
1638
|
*/
|
|
1555
|
-
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>;
|
|
1556
1640
|
/**
|
|
1557
1641
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1558
1642
|
* @summary Import products
|
|
@@ -1612,12 +1696,13 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
1612
1696
|
* @param {string} project What project it is
|
|
1613
1697
|
* @param {number} [pageToken] Page reference token
|
|
1614
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 \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1615
1700
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1616
1701
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1617
1702
|
* @param {*} [options] Override http request option.
|
|
1618
1703
|
* @throws {RequiredError}
|
|
1619
1704
|
*/
|
|
1620
|
-
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>>;
|
|
1621
1706
|
/**
|
|
1622
1707
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1623
1708
|
* @summary Import products
|
|
@@ -1779,6 +1864,12 @@ export interface ProductsApiGetProductsRequest {
|
|
|
1779
1864
|
* @memberof ProductsApiGetProducts
|
|
1780
1865
|
*/
|
|
1781
1866
|
readonly search?: string;
|
|
1867
|
+
/**
|
|
1868
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1869
|
+
* @type {Array<string>}
|
|
1870
|
+
* @memberof ProductsApiGetProducts
|
|
1871
|
+
*/
|
|
1872
|
+
readonly sortBy?: Array<string>;
|
|
1782
1873
|
/**
|
|
1783
1874
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1784
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.
|
|
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).
|
|
@@ -56,6 +56,9 @@ export const CreateProductVariantAttributesInnerNameEnum = {
|
|
|
56
56
|
export const CreateProductVariantRetailPriceCurrencyCodeEnum = {
|
|
57
57
|
Gbp: 'GBP'
|
|
58
58
|
};
|
|
59
|
+
export const CreateProductVariantSalePriceCurrencyCodeEnum = {
|
|
60
|
+
Gbp: 'GBP'
|
|
61
|
+
};
|
|
59
62
|
export const PriceCurrencyCodeEnum = {
|
|
60
63
|
Gbp: 'GBP'
|
|
61
64
|
};
|
|
@@ -631,12 +634,13 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
631
634
|
* @param {string} project What project it is
|
|
632
635
|
* @param {number} [pageToken] Page reference token
|
|
633
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.
|
|
634
638
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
635
639
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
636
640
|
* @param {*} [options] Override http request option.
|
|
637
641
|
* @throws {RequiredError}
|
|
638
642
|
*/
|
|
639
|
-
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 = {}) {
|
|
640
644
|
// verify required parameter 'project' is not null or undefined
|
|
641
645
|
assertParamExists('getProducts', 'project', project);
|
|
642
646
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -663,6 +667,9 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
663
667
|
if (search !== undefined) {
|
|
664
668
|
localVarQueryParameter['search'] = search;
|
|
665
669
|
}
|
|
670
|
+
if (sortBy) {
|
|
671
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
672
|
+
}
|
|
666
673
|
if (pageSize !== undefined) {
|
|
667
674
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
668
675
|
}
|
|
@@ -826,15 +833,16 @@ export const ProductsApiFp = function (configuration) {
|
|
|
826
833
|
* @param {string} project What project it is
|
|
827
834
|
* @param {number} [pageToken] Page reference token
|
|
828
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.
|
|
829
837
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
830
838
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
831
839
|
* @param {*} [options] Override http request option.
|
|
832
840
|
* @throws {RequiredError}
|
|
833
841
|
*/
|
|
834
|
-
getProducts(project, pageToken, search, pageSize, fields, options) {
|
|
842
|
+
getProducts(project, pageToken, search, sortBy, pageSize, fields, options) {
|
|
835
843
|
return __awaiter(this, void 0, void 0, function* () {
|
|
836
844
|
var _a, _b, _c;
|
|
837
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(project, pageToken, search, pageSize, fields, options);
|
|
845
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProducts(project, pageToken, search, sortBy, pageSize, fields, options);
|
|
838
846
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
839
847
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.getProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
840
848
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -922,7 +930,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
922
930
|
* @throws {RequiredError}
|
|
923
931
|
*/
|
|
924
932
|
getProducts(requestParameters, options) {
|
|
925
|
-
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));
|
|
926
934
|
},
|
|
927
935
|
/**
|
|
928
936
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
@@ -995,7 +1003,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
995
1003
|
* @memberof ProductsApi
|
|
996
1004
|
*/
|
|
997
1005
|
getProducts(requestParameters, options) {
|
|
998
|
-
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));
|
|
999
1007
|
}
|
|
1000
1008
|
/**
|
|
1001
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.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.
|
|
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/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.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/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.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.
|
|
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.
|
|
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/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.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.
|
|
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.
|
|
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.
|
|
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.
|
|
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).
|