@teemill/product-catalog 1.95.3 → 1.97.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/.openapi-generator/FILES +1 -0
- package/README.md +3 -2
- package/api.ts +40 -6
- package/base.ts +1 -1
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api.d.ts +32 -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 +2 -2
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +32 -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 +2 -2
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/BulkUpdateMarketplaceListing.md +23 -0
- package/docs/BulkUpdateMarketplaceListingProduct.md +33 -0
- package/docs/BulkUpdateMarketplaceListingRequest.md +21 -0
- package/docs/BulkUpdateMarketplaceListingResponse.md +21 -0
- package/docs/BulkUpdatedMarketplaceListing.md +23 -0
- package/docs/BulkUpdatedMarketplaceListings.md +23 -0
- package/docs/MarketplaceListing.md +35 -0
- package/docs/MarketplaceListingFields.md +31 -0
- package/docs/MarketplaceListingsResponse.md +20 -0
- package/docs/Product.md +2 -0
- package/docs/ProductsApi.md +4 -1
- package/docs/UpdateMarketplaceListing.md +33 -0
- package/docs/UpdateMarketplaceListingRequest.md +21 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.97.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.97.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -145,6 +145,7 @@ Class | Method | HTTP request | Description
|
|
|
145
145
|
- [ImportProducts200Response](docs/ImportProducts200Response.md)
|
|
146
146
|
- [License](docs/License.md)
|
|
147
147
|
- [Location](docs/Location.md)
|
|
148
|
+
- [MarketplaceListing](docs/MarketplaceListing.md)
|
|
148
149
|
- [MetaField](docs/MetaField.md)
|
|
149
150
|
- [NamedPrice](docs/NamedPrice.md)
|
|
150
151
|
- [OptimisationHistoryItem](docs/OptimisationHistoryItem.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1225,6 +1225,25 @@ export interface Location {
|
|
|
1225
1225
|
*/
|
|
1226
1226
|
'country': string;
|
|
1227
1227
|
}
|
|
1228
|
+
/**
|
|
1229
|
+
* Product listing data for a marketplace.
|
|
1230
|
+
*/
|
|
1231
|
+
export interface MarketplaceListing {
|
|
1232
|
+
/**
|
|
1233
|
+
* The marketplace code.
|
|
1234
|
+
*/
|
|
1235
|
+
'code': string;
|
|
1236
|
+
/**
|
|
1237
|
+
* The display name of the marketplace.
|
|
1238
|
+
*/
|
|
1239
|
+
'name': string;
|
|
1240
|
+
'title'?: string | null;
|
|
1241
|
+
'description'?: string | null;
|
|
1242
|
+
'metaTitle'?: string | null;
|
|
1243
|
+
'metaDescription'?: string | null;
|
|
1244
|
+
'price'?: number | null;
|
|
1245
|
+
'images'?: Array<Image>;
|
|
1246
|
+
}
|
|
1228
1247
|
/**
|
|
1229
1248
|
* Key/value pairs that can be used to store additional information on the product
|
|
1230
1249
|
*/
|
|
@@ -1394,6 +1413,10 @@ export interface Product {
|
|
|
1394
1413
|
*/
|
|
1395
1414
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1396
1415
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1416
|
+
/**
|
|
1417
|
+
* Marketplace-specific listing data that can override product fields during integration syncs.
|
|
1418
|
+
*/
|
|
1419
|
+
'marketplaceListings'?: Array<MarketplaceListing>;
|
|
1397
1420
|
/**
|
|
1398
1421
|
* Whether to show a sale badge on the product
|
|
1399
1422
|
*/
|
|
@@ -4979,10 +5002,11 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4979
5002
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
4980
5003
|
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
4981
5004
|
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
5005
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
4982
5006
|
* @param {*} [options] Override http request option.
|
|
4983
5007
|
* @throws {RequiredError}
|
|
4984
5008
|
*/
|
|
4985
|
-
exportProducts: async (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5009
|
+
exportProducts: async (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4986
5010
|
// verify required parameter 'project' is not null or undefined
|
|
4987
5011
|
assertParamExists('exportProducts', 'project', project)
|
|
4988
5012
|
const localVarPath = `/v1/catalog/products/export`;
|
|
@@ -5036,6 +5060,10 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5036
5060
|
localVarQueryParameter['minRetailPrice'] = minRetailPrice;
|
|
5037
5061
|
}
|
|
5038
5062
|
|
|
5063
|
+
if (marketplaceCode !== undefined) {
|
|
5064
|
+
localVarQueryParameter['marketplaceCode'] = marketplaceCode;
|
|
5065
|
+
}
|
|
5066
|
+
|
|
5039
5067
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
5040
5068
|
|
|
5041
5069
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5563,11 +5591,12 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
5563
5591
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
5564
5592
|
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
5565
5593
|
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
5594
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
5566
5595
|
* @param {*} [options] Override http request option.
|
|
5567
5596
|
* @throws {RequiredError}
|
|
5568
5597
|
*/
|
|
5569
|
-
async exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
5570
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options);
|
|
5598
|
+
async exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
5599
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, marketplaceCode, options);
|
|
5571
5600
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5572
5601
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.exportProducts']?.[localVarOperationServerIndex]?.url;
|
|
5573
5602
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -5748,7 +5777,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
5748
5777
|
* @throws {RequiredError}
|
|
5749
5778
|
*/
|
|
5750
5779
|
exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
5751
|
-
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(axios, basePath));
|
|
5780
|
+
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.marketplaceCode, options).then((request) => request(axios, basePath));
|
|
5752
5781
|
},
|
|
5753
5782
|
/**
|
|
5754
5783
|
* Gets a product by a given ID.
|
|
@@ -5926,6 +5955,11 @@ export interface ProductsApiExportProductsRequest {
|
|
|
5926
5955
|
* Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
5927
5956
|
*/
|
|
5928
5957
|
readonly minRetailPrice?: number
|
|
5958
|
+
|
|
5959
|
+
/**
|
|
5960
|
+
* Export product data in the listing format for the selected marketplace code.
|
|
5961
|
+
*/
|
|
5962
|
+
readonly marketplaceCode?: string
|
|
5929
5963
|
}
|
|
5930
5964
|
|
|
5931
5965
|
/**
|
|
@@ -6210,7 +6244,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
6210
6244
|
* @throws {RequiredError}
|
|
6211
6245
|
*/
|
|
6212
6246
|
public exportProducts(requestParameters: ProductsApiExportProductsRequest, options?: RawAxiosRequestConfig) {
|
|
6213
|
-
return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(this.axios, this.basePath));
|
|
6247
|
+
return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.marketplaceCode, options).then((request) => request(this.axios, this.basePath));
|
|
6214
6248
|
}
|
|
6215
6249
|
|
|
6216
6250
|
/**
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -112,7 +112,7 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an
|
|
|
112
112
|
export const setSearchParams = function (url: URL, ...objects: any[]) {
|
|
113
113
|
const searchParams = new URLSearchParams(url.search);
|
|
114
114
|
setFlattenedQueryParams(searchParams, objects);
|
|
115
|
-
url.search =
|
|
115
|
+
url.search = searchParams.toString();
|
|
116
116
|
}
|
|
117
117
|
|
|
118
118
|
/**
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Product Catalog
|
|
4
4
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.97.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* 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
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1182,6 +1182,25 @@ export interface Location {
|
|
|
1182
1182
|
*/
|
|
1183
1183
|
'country': string;
|
|
1184
1184
|
}
|
|
1185
|
+
/**
|
|
1186
|
+
* Product listing data for a marketplace.
|
|
1187
|
+
*/
|
|
1188
|
+
export interface MarketplaceListing {
|
|
1189
|
+
/**
|
|
1190
|
+
* The marketplace code.
|
|
1191
|
+
*/
|
|
1192
|
+
'code': string;
|
|
1193
|
+
/**
|
|
1194
|
+
* The display name of the marketplace.
|
|
1195
|
+
*/
|
|
1196
|
+
'name': string;
|
|
1197
|
+
'title'?: string | null;
|
|
1198
|
+
'description'?: string | null;
|
|
1199
|
+
'metaTitle'?: string | null;
|
|
1200
|
+
'metaDescription'?: string | null;
|
|
1201
|
+
'price'?: number | null;
|
|
1202
|
+
'images'?: Array<Image>;
|
|
1203
|
+
}
|
|
1185
1204
|
/**
|
|
1186
1205
|
* Key/value pairs that can be used to store additional information on the product
|
|
1187
1206
|
*/
|
|
@@ -1348,6 +1367,10 @@ export interface Product {
|
|
|
1348
1367
|
*/
|
|
1349
1368
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1350
1369
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1370
|
+
/**
|
|
1371
|
+
* Marketplace-specific listing data that can override product fields during integration syncs.
|
|
1372
|
+
*/
|
|
1373
|
+
'marketplaceListings'?: Array<MarketplaceListing>;
|
|
1351
1374
|
/**
|
|
1352
1375
|
* Whether to show a sale badge on the product
|
|
1353
1376
|
*/
|
|
@@ -3593,10 +3616,11 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3593
3616
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3594
3617
|
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
3595
3618
|
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
3619
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
3596
3620
|
* @param {*} [options] Override http request option.
|
|
3597
3621
|
* @throws {RequiredError}
|
|
3598
3622
|
*/
|
|
3599
|
-
exportProducts: (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3623
|
+
exportProducts: (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3600
3624
|
/**
|
|
3601
3625
|
* Gets a product by a given ID.
|
|
3602
3626
|
* @summary Get product
|
|
@@ -3736,10 +3760,11 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3736
3760
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3737
3761
|
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
3738
3762
|
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
3763
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
3739
3764
|
* @param {*} [options] Override http request option.
|
|
3740
3765
|
* @throws {RequiredError}
|
|
3741
3766
|
*/
|
|
3742
|
-
exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
3767
|
+
exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
3743
3768
|
/**
|
|
3744
3769
|
* Gets a product by a given ID.
|
|
3745
3770
|
* @summary Get product
|
|
@@ -4018,6 +4043,10 @@ export interface ProductsApiExportProductsRequest {
|
|
|
4018
4043
|
* Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
4019
4044
|
*/
|
|
4020
4045
|
readonly minRetailPrice?: number;
|
|
4046
|
+
/**
|
|
4047
|
+
* Export product data in the listing format for the selected marketplace code.
|
|
4048
|
+
*/
|
|
4049
|
+
readonly marketplaceCode?: string;
|
|
4021
4050
|
}
|
|
4022
4051
|
/**
|
|
4023
4052
|
* Request parameters for getProduct operation in ProductsApi.
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Product Catalog
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2043,10 +2043,11 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
2043
2043
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2044
2044
|
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
2045
2045
|
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
2046
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
2046
2047
|
* @param {*} [options] Override http request option.
|
|
2047
2048
|
* @throws {RequiredError}
|
|
2048
2049
|
*/
|
|
2049
|
-
exportProducts: (project_1, search_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, ...args_1) => __awaiter(this, [project_1, search_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, ...args_1], void 0, function* (project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options = {}) {
|
|
2050
|
+
exportProducts: (project_1, search_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, marketplaceCode_1, ...args_1) => __awaiter(this, [project_1, search_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, marketplaceCode_1, ...args_1], void 0, function* (project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, marketplaceCode, options = {}) {
|
|
2050
2051
|
// verify required parameter 'project' is not null or undefined
|
|
2051
2052
|
(0, common_1.assertParamExists)('exportProducts', 'project', project);
|
|
2052
2053
|
const localVarPath = `/v1/catalog/products/export`;
|
|
@@ -2089,6 +2090,9 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
2089
2090
|
if (minRetailPrice !== undefined) {
|
|
2090
2091
|
localVarQueryParameter['minRetailPrice'] = minRetailPrice;
|
|
2091
2092
|
}
|
|
2093
|
+
if (marketplaceCode !== undefined) {
|
|
2094
|
+
localVarQueryParameter['marketplaceCode'] = marketplaceCode;
|
|
2095
|
+
}
|
|
2092
2096
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
2093
2097
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2094
2098
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2562,13 +2566,14 @@ const ProductsApiFp = function (configuration) {
|
|
|
2562
2566
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2563
2567
|
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
2564
2568
|
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
2569
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
2565
2570
|
* @param {*} [options] Override http request option.
|
|
2566
2571
|
* @throws {RequiredError}
|
|
2567
2572
|
*/
|
|
2568
|
-
exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options) {
|
|
2573
|
+
exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, marketplaceCode, options) {
|
|
2569
2574
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2570
2575
|
var _a, _b, _c;
|
|
2571
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options);
|
|
2576
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, marketplaceCode, options);
|
|
2572
2577
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2573
2578
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.exportProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2574
2579
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2768,7 +2773,7 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
2768
2773
|
* @throws {RequiredError}
|
|
2769
2774
|
*/
|
|
2770
2775
|
exportProducts(requestParameters, options) {
|
|
2771
|
-
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(axios, basePath));
|
|
2776
|
+
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.marketplaceCode, options).then((request) => request(axios, basePath));
|
|
2772
2777
|
},
|
|
2773
2778
|
/**
|
|
2774
2779
|
* Gets a product by a given ID.
|
|
@@ -2895,7 +2900,7 @@ class ProductsApi extends base_1.BaseAPI {
|
|
|
2895
2900
|
* @throws {RequiredError}
|
|
2896
2901
|
*/
|
|
2897
2902
|
exportProducts(requestParameters, options) {
|
|
2898
|
-
return (0, exports.ProductsApiFp)(this.configuration).exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(this.axios, this.basePath));
|
|
2903
|
+
return (0, exports.ProductsApiFp)(this.configuration).exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.marketplaceCode, options).then((request) => request(this.axios, this.basePath));
|
|
2899
2904
|
}
|
|
2900
2905
|
/**
|
|
2901
2906
|
* Gets a product by a given ID.
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
6
6
|
*
|
|
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
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
9
9
|
*
|
|
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
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
6
6
|
*
|
|
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
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -122,7 +122,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
|
122
122
|
const setSearchParams = function (url, ...objects) {
|
|
123
123
|
const searchParams = new URLSearchParams(url.search);
|
|
124
124
|
setFlattenedQueryParams(searchParams, objects);
|
|
125
|
-
url.search =
|
|
125
|
+
url.search = searchParams.toString();
|
|
126
126
|
};
|
|
127
127
|
exports.setSearchParams = setSearchParams;
|
|
128
128
|
/**
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* 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
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1182,6 +1182,25 @@ export interface Location {
|
|
|
1182
1182
|
*/
|
|
1183
1183
|
'country': string;
|
|
1184
1184
|
}
|
|
1185
|
+
/**
|
|
1186
|
+
* Product listing data for a marketplace.
|
|
1187
|
+
*/
|
|
1188
|
+
export interface MarketplaceListing {
|
|
1189
|
+
/**
|
|
1190
|
+
* The marketplace code.
|
|
1191
|
+
*/
|
|
1192
|
+
'code': string;
|
|
1193
|
+
/**
|
|
1194
|
+
* The display name of the marketplace.
|
|
1195
|
+
*/
|
|
1196
|
+
'name': string;
|
|
1197
|
+
'title'?: string | null;
|
|
1198
|
+
'description'?: string | null;
|
|
1199
|
+
'metaTitle'?: string | null;
|
|
1200
|
+
'metaDescription'?: string | null;
|
|
1201
|
+
'price'?: number | null;
|
|
1202
|
+
'images'?: Array<Image>;
|
|
1203
|
+
}
|
|
1185
1204
|
/**
|
|
1186
1205
|
* Key/value pairs that can be used to store additional information on the product
|
|
1187
1206
|
*/
|
|
@@ -1348,6 +1367,10 @@ export interface Product {
|
|
|
1348
1367
|
*/
|
|
1349
1368
|
'optimisationHistory'?: Array<OptimisationHistoryItem>;
|
|
1350
1369
|
'integrationConnections'?: Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>;
|
|
1370
|
+
/**
|
|
1371
|
+
* Marketplace-specific listing data that can override product fields during integration syncs.
|
|
1372
|
+
*/
|
|
1373
|
+
'marketplaceListings'?: Array<MarketplaceListing>;
|
|
1351
1374
|
/**
|
|
1352
1375
|
* Whether to show a sale badge on the product
|
|
1353
1376
|
*/
|
|
@@ -3593,10 +3616,11 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3593
3616
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3594
3617
|
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
3595
3618
|
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
3619
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
3596
3620
|
* @param {*} [options] Override http request option.
|
|
3597
3621
|
* @throws {RequiredError}
|
|
3598
3622
|
*/
|
|
3599
|
-
exportProducts: (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3623
|
+
exportProducts: (project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3600
3624
|
/**
|
|
3601
3625
|
* Gets a product by a given ID.
|
|
3602
3626
|
* @summary Get product
|
|
@@ -3736,10 +3760,11 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3736
3760
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
3737
3761
|
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
3738
3762
|
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
3763
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
3739
3764
|
* @param {*} [options] Override http request option.
|
|
3740
3765
|
* @throws {RequiredError}
|
|
3741
3766
|
*/
|
|
3742
|
-
exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
3767
|
+
exportProducts(project: string, search?: string, start?: string, end?: string, dateFilterType?: ExportProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, marketplaceCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
3743
3768
|
/**
|
|
3744
3769
|
* Gets a product by a given ID.
|
|
3745
3770
|
* @summary Get product
|
|
@@ -4018,6 +4043,10 @@ export interface ProductsApiExportProductsRequest {
|
|
|
4018
4043
|
* Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
4019
4044
|
*/
|
|
4020
4045
|
readonly minRetailPrice?: number;
|
|
4046
|
+
/**
|
|
4047
|
+
* Export product data in the listing format for the selected marketplace code.
|
|
4048
|
+
*/
|
|
4049
|
+
readonly marketplaceCode?: string;
|
|
4021
4050
|
}
|
|
4022
4051
|
/**
|
|
4023
4052
|
* Request parameters for getProduct operation in ProductsApi.
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2015,10 +2015,11 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
2015
2015
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2016
2016
|
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
2017
2017
|
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
2018
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
2018
2019
|
* @param {*} [options] Override http request option.
|
|
2019
2020
|
* @throws {RequiredError}
|
|
2020
2021
|
*/
|
|
2021
|
-
exportProducts: (project_1, search_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, ...args_1) => __awaiter(this, [project_1, search_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, ...args_1], void 0, function* (project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options = {}) {
|
|
2022
|
+
exportProducts: (project_1, search_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, marketplaceCode_1, ...args_1) => __awaiter(this, [project_1, search_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, marketplaceCode_1, ...args_1], void 0, function* (project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, marketplaceCode, options = {}) {
|
|
2022
2023
|
// verify required parameter 'project' is not null or undefined
|
|
2023
2024
|
assertParamExists('exportProducts', 'project', project);
|
|
2024
2025
|
const localVarPath = `/v1/catalog/products/export`;
|
|
@@ -2061,6 +2062,9 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
2061
2062
|
if (minRetailPrice !== undefined) {
|
|
2062
2063
|
localVarQueryParameter['minRetailPrice'] = minRetailPrice;
|
|
2063
2064
|
}
|
|
2065
|
+
if (marketplaceCode !== undefined) {
|
|
2066
|
+
localVarQueryParameter['marketplaceCode'] = marketplaceCode;
|
|
2067
|
+
}
|
|
2064
2068
|
localVarHeaderParameter['Accept'] = 'text/csv; charset=utf-8,application/json';
|
|
2065
2069
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2066
2070
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2533,13 +2537,14 @@ export const ProductsApiFp = function (configuration) {
|
|
|
2533
2537
|
* @param {ExportProductsDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
2534
2538
|
* @param {number} [maxRetailPrice] Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value.
|
|
2535
2539
|
* @param {number} [minRetailPrice] Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value.
|
|
2540
|
+
* @param {string} [marketplaceCode] Export product data in the listing format for the selected marketplace code.
|
|
2536
2541
|
* @param {*} [options] Override http request option.
|
|
2537
2542
|
* @throws {RequiredError}
|
|
2538
2543
|
*/
|
|
2539
|
-
exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options) {
|
|
2544
|
+
exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, marketplaceCode, options) {
|
|
2540
2545
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2541
2546
|
var _a, _b, _c;
|
|
2542
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, options);
|
|
2547
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportProducts(project, search, start, end, dateFilterType, maxRetailPrice, minRetailPrice, marketplaceCode, options);
|
|
2543
2548
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2544
2549
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.exportProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2545
2550
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2738,7 +2743,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
2738
2743
|
* @throws {RequiredError}
|
|
2739
2744
|
*/
|
|
2740
2745
|
exportProducts(requestParameters, options) {
|
|
2741
|
-
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(axios, basePath));
|
|
2746
|
+
return localVarFp.exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.marketplaceCode, options).then((request) => request(axios, basePath));
|
|
2742
2747
|
},
|
|
2743
2748
|
/**
|
|
2744
2749
|
* Gets a product by a given ID.
|
|
@@ -2864,7 +2869,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
2864
2869
|
* @throws {RequiredError}
|
|
2865
2870
|
*/
|
|
2866
2871
|
exportProducts(requestParameters, options) {
|
|
2867
|
-
return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, options).then((request) => request(this.axios, this.basePath));
|
|
2872
|
+
return ProductsApiFp(this.configuration).exportProducts(requestParameters.project, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.marketplaceCode, options).then((request) => request(this.axios, this.basePath));
|
|
2868
2873
|
}
|
|
2869
2874
|
/**
|
|
2870
2875
|
* Gets a product by a given ID.
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
6
6
|
*
|
|
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
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
8
8
|
*
|
|
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
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
6
6
|
*
|
|
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
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -114,7 +114,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
|
114
114
|
export const setSearchParams = function (url, ...objects) {
|
|
115
115
|
const searchParams = new URLSearchParams(url.search);
|
|
116
116
|
setFlattenedQueryParams(searchParams, objects);
|
|
117
|
-
url.search =
|
|
117
|
+
url.search = searchParams.toString();
|
|
118
118
|
};
|
|
119
119
|
/**
|
|
120
120
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Product Catalog
|
|
4
4
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, plus listing information such as title, description and tags.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.97.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* 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
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
6
6
|
*
|
|
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
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
8
8
|
*
|
|
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
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
6
6
|
*
|
|
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
|
|
6
6
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# BulkUpdateMarketplaceListing
|
|
2
|
+
|
|
3
|
+
Product marketplace listing updates grouped by marketplace.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**code** | **string** | The marketplace code to update. | [default to undefined]
|
|
10
|
+
**products** | [**Array<BulkUpdateMarketplaceListingProduct>**](BulkUpdateMarketplaceListingProduct.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { BulkUpdateMarketplaceListing } from '@teemill/product-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: BulkUpdateMarketplaceListing = {
|
|
18
|
+
code,
|
|
19
|
+
products,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# BulkUpdateMarketplaceListingProduct
|
|
2
|
+
|
|
3
|
+
Marketplace listing fields to update for a single product within a marketplace group.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
10
|
+
**title** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**metaTitle** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**metaDescription** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**price** | **number** | | [optional] [default to undefined]
|
|
15
|
+
**images** | [**Array<ImageFile>**](ImageFile.md) | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { BulkUpdateMarketplaceListingProduct } from '@teemill/product-catalog';
|
|
21
|
+
|
|
22
|
+
const instance: BulkUpdateMarketplaceListingProduct = {
|
|
23
|
+
id,
|
|
24
|
+
title,
|
|
25
|
+
description,
|
|
26
|
+
metaTitle,
|
|
27
|
+
metaDescription,
|
|
28
|
+
price,
|
|
29
|
+
images,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# BulkUpdateMarketplaceListingRequest
|
|
2
|
+
|
|
3
|
+
Listing updates scoped to exactly one marketplace per HTTP request. To change another marketplace, issue another request.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**marketplace** | [**Array<BulkUpdateMarketplaceListing>**](BulkUpdateMarketplaceListing.md) | Must contain exactly one marketplace group (`code` plus the `products` to update). | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BulkUpdateMarketplaceListingRequest } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: BulkUpdateMarketplaceListingRequest = {
|
|
17
|
+
marketplace,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# BulkUpdateMarketplaceListingResponse
|
|
2
|
+
|
|
3
|
+
Updated marketplace listing data grouped by marketplace.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**marketplaceListings** | [**Array<BulkUpdatedMarketplaceListings>**](BulkUpdatedMarketplaceListings.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BulkUpdateMarketplaceListingResponse } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: BulkUpdateMarketplaceListingResponse = {
|
|
17
|
+
marketplaceListings,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# BulkUpdatedMarketplaceListing
|
|
2
|
+
|
|
3
|
+
Updated marketplace listing data for a product.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
10
|
+
**listing** | [**MarketplaceListingFields**](MarketplaceListingFields.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { BulkUpdatedMarketplaceListing } from '@teemill/product-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: BulkUpdatedMarketplaceListing = {
|
|
18
|
+
id,
|
|
19
|
+
listing,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# BulkUpdatedMarketplaceListings
|
|
2
|
+
|
|
3
|
+
Updated product listings for a marketplace.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**code** | **string** | | [default to undefined]
|
|
10
|
+
**products** | [**Array<BulkUpdatedMarketplaceListing>**](BulkUpdatedMarketplaceListing.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { BulkUpdatedMarketplaceListings } from '@teemill/product-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: BulkUpdatedMarketplaceListings = {
|
|
18
|
+
code,
|
|
19
|
+
products,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# MarketplaceListing
|
|
2
|
+
|
|
3
|
+
Product listing data for a marketplace.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**code** | **string** | The marketplace code. | [default to undefined]
|
|
10
|
+
**name** | **string** | The display name of the marketplace. | [default to undefined]
|
|
11
|
+
**title** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**metaTitle** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**metaDescription** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**price** | **number** | | [optional] [default to undefined]
|
|
16
|
+
**images** | [**Array<Image>**](Image.md) | | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { MarketplaceListing } from '@teemill/product-catalog';
|
|
22
|
+
|
|
23
|
+
const instance: MarketplaceListing = {
|
|
24
|
+
code,
|
|
25
|
+
name,
|
|
26
|
+
title,
|
|
27
|
+
description,
|
|
28
|
+
metaTitle,
|
|
29
|
+
metaDescription,
|
|
30
|
+
price,
|
|
31
|
+
images,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# MarketplaceListingFields
|
|
2
|
+
|
|
3
|
+
Product listing fields for a marketplace.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**title** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**metaTitle** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**metaDescription** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**price** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**images** | [**Array<Image>**](Image.md) | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { MarketplaceListingFields } from '@teemill/product-catalog';
|
|
20
|
+
|
|
21
|
+
const instance: MarketplaceListingFields = {
|
|
22
|
+
title,
|
|
23
|
+
description,
|
|
24
|
+
metaTitle,
|
|
25
|
+
metaDescription,
|
|
26
|
+
price,
|
|
27
|
+
images,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# MarketplaceListingsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**marketplaceListings** | [**Array<MarketplaceListing>**](MarketplaceListing.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { MarketplaceListingsResponse } from '@teemill/product-catalog';
|
|
14
|
+
|
|
15
|
+
const instance: MarketplaceListingsResponse = {
|
|
16
|
+
marketplaceListings,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Product.md
CHANGED
|
@@ -43,6 +43,7 @@ Name | Type | Description | Notes
|
|
|
43
43
|
**personalizationTemplate** | **string** | a JSON string representing the personalization template for the product | [optional] [default to undefined]
|
|
44
44
|
**optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the product | [optional] [default to undefined]
|
|
45
45
|
**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
|
|
46
|
+
**marketplaceListings** | [**Array<MarketplaceListing>**](MarketplaceListing.md) | Marketplace-specific listing data that can override product fields during integration syncs. | [optional] [default to undefined]
|
|
46
47
|
**showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to undefined]
|
|
47
48
|
**license** | [**License**](License.md) | | [optional] [default to undefined]
|
|
48
49
|
**createdBy** | **string** | The user ID of the user who created the product | [optional] [default to undefined]
|
|
@@ -93,6 +94,7 @@ const instance: Product = {
|
|
|
93
94
|
personalizationTemplate,
|
|
94
95
|
optimisationHistory,
|
|
95
96
|
integrationConnections,
|
|
97
|
+
marketplaceListings,
|
|
96
98
|
showSaleBadge,
|
|
97
99
|
license,
|
|
98
100
|
createdBy,
|
package/docs/ProductsApi.md
CHANGED
|
@@ -339,6 +339,7 @@ let end: string; //End of date range to filter (optional) (default to undefined)
|
|
|
339
339
|
let dateFilterType: 'createdAt' | 'updatedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
340
340
|
let maxRetailPrice: number; //Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value. (optional) (default to undefined)
|
|
341
341
|
let minRetailPrice: number; //Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value. (optional) (default to undefined)
|
|
342
|
+
let marketplaceCode: string; //Export product data in the listing format for the selected marketplace code. (optional) (default to undefined)
|
|
342
343
|
|
|
343
344
|
const { status, data } = await apiInstance.exportProducts(
|
|
344
345
|
project,
|
|
@@ -347,7 +348,8 @@ const { status, data } = await apiInstance.exportProducts(
|
|
|
347
348
|
end,
|
|
348
349
|
dateFilterType,
|
|
349
350
|
maxRetailPrice,
|
|
350
|
-
minRetailPrice
|
|
351
|
+
minRetailPrice,
|
|
352
|
+
marketplaceCode
|
|
351
353
|
);
|
|
352
354
|
```
|
|
353
355
|
|
|
@@ -362,6 +364,7 @@ const { status, data } = await apiInstance.exportProducts(
|
|
|
362
364
|
| **dateFilterType** | [**'createdAt' | 'updatedAt'**]**Array<'createdAt' | 'updatedAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
363
365
|
| **maxRetailPrice** | [**number**] | Specify the maximum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price less than or equal to the specified value. | (optional) defaults to undefined|
|
|
364
366
|
| **minRetailPrice** | [**number**] | Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value. | (optional) defaults to undefined|
|
|
367
|
+
| **marketplaceCode** | [**string**] | Export product data in the listing format for the selected marketplace code. | (optional) defaults to undefined|
|
|
365
368
|
|
|
366
369
|
|
|
367
370
|
### Return type
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# UpdateMarketplaceListing
|
|
2
|
+
|
|
3
|
+
Marketplace listing fields to update for a product.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**code** | **string** | The marketplace code to update. | [default to undefined]
|
|
10
|
+
**title** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**metaTitle** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**metaDescription** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**price** | **number** | | [optional] [default to undefined]
|
|
15
|
+
**images** | [**Array<ImageFile>**](ImageFile.md) | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { UpdateMarketplaceListing } from '@teemill/product-catalog';
|
|
21
|
+
|
|
22
|
+
const instance: UpdateMarketplaceListing = {
|
|
23
|
+
code,
|
|
24
|
+
title,
|
|
25
|
+
description,
|
|
26
|
+
metaTitle,
|
|
27
|
+
metaDescription,
|
|
28
|
+
price,
|
|
29
|
+
images,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# UpdateMarketplaceListingRequest
|
|
2
|
+
|
|
3
|
+
Marketplace listings to update for a product.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**marketplaces** | [**Array<UpdateMarketplaceListing>**](UpdateMarketplaceListing.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UpdateMarketplaceListingRequest } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: UpdateMarketplaceListingRequest = {
|
|
17
|
+
marketplaces,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, 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.97.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|