@teemill/product-catalog 1.90.2 → 1.91.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 +198 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +113 -3
- package/dist/api.js +88 -6
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +113 -3
- package/dist/esm/api.js +88 -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/docs/Product.md +2 -0
- package/docs/ProductAnalytics.md +29 -0
- package/docs/ProductsApi.md +43 -1
- 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.91.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.91.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -149,6 +149,7 @@ Class | Method | HTTP request | Description
|
|
|
149
149
|
- [Price](docs/Price.md)
|
|
150
150
|
- [Product](docs/Product.md)
|
|
151
151
|
- [ProductAdditionalFilesInner](docs/ProductAdditionalFilesInner.md)
|
|
152
|
+
- [ProductAnalytics](docs/ProductAnalytics.md)
|
|
152
153
|
- [ProductAnalyticsResponse](docs/ProductAnalyticsResponse.md)
|
|
153
154
|
- [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
|
|
154
155
|
- [ProductBundleItemsInner](docs/ProductBundleItemsInner.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.91.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1242,6 +1242,7 @@ export interface Product {
|
|
|
1242
1242
|
* Whether the product is digital
|
|
1243
1243
|
*/
|
|
1244
1244
|
'isDigital'?: boolean;
|
|
1245
|
+
'analytics'?: ProductAnalytics;
|
|
1245
1246
|
}
|
|
1246
1247
|
export interface ProductAdditionalFilesInner {
|
|
1247
1248
|
/**
|
|
@@ -1253,6 +1254,31 @@ export interface ProductAdditionalFilesInner {
|
|
|
1253
1254
|
*/
|
|
1254
1255
|
'src'?: string;
|
|
1255
1256
|
}
|
|
1257
|
+
/**
|
|
1258
|
+
* Product analytics metrics. Only present when \'analytics\' is included in the fields query parameter.
|
|
1259
|
+
*/
|
|
1260
|
+
export interface ProductAnalytics {
|
|
1261
|
+
/**
|
|
1262
|
+
* Total revenue for this product within the date range
|
|
1263
|
+
*/
|
|
1264
|
+
'revenue'?: number;
|
|
1265
|
+
/**
|
|
1266
|
+
* Total number of sales for this product within the date range
|
|
1267
|
+
*/
|
|
1268
|
+
'sales'?: number;
|
|
1269
|
+
/**
|
|
1270
|
+
* Total page views for this product within the date range
|
|
1271
|
+
*/
|
|
1272
|
+
'traffic'?: number;
|
|
1273
|
+
/**
|
|
1274
|
+
* Conversion rate as a percentage (sales / traffic * 100)
|
|
1275
|
+
*/
|
|
1276
|
+
'conversionRate'?: number;
|
|
1277
|
+
/**
|
|
1278
|
+
* Basket rate as a percentage (cart adds / traffic * 100)
|
|
1279
|
+
*/
|
|
1280
|
+
'basketRate'?: number;
|
|
1281
|
+
}
|
|
1256
1282
|
export interface ProductAnalyticsResponse {
|
|
1257
1283
|
'analytics'?: Array<AnalyticsItem>;
|
|
1258
1284
|
}
|
|
@@ -4747,10 +4773,24 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4747
4773
|
* @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.
|
|
4748
4774
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4749
4775
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
4776
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
4777
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
4778
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
4779
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
4780
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
4781
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
4782
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
4783
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
4784
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
4785
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
4786
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
4787
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
4788
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
4789
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
4750
4790
|
* @param {*} [options] Override http request option.
|
|
4751
4791
|
* @throws {RequiredError}
|
|
4752
4792
|
*/
|
|
4753
|
-
listProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4793
|
+
listProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4754
4794
|
// verify required parameter 'project' is not null or undefined
|
|
4755
4795
|
assertParamExists('listProducts', 'project', project)
|
|
4756
4796
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -4820,6 +4860,74 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4820
4860
|
localVarQueryParameter['fields'] = fields;
|
|
4821
4861
|
}
|
|
4822
4862
|
|
|
4863
|
+
if (dateRangeStartDate !== undefined) {
|
|
4864
|
+
localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate as any instanceof Date) ?
|
|
4865
|
+
(dateRangeStartDate as any).toISOString() :
|
|
4866
|
+
dateRangeStartDate;
|
|
4867
|
+
}
|
|
4868
|
+
|
|
4869
|
+
if (dateRangeEndDate !== undefined) {
|
|
4870
|
+
localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate as any instanceof Date) ?
|
|
4871
|
+
(dateRangeEndDate as any).toISOString() :
|
|
4872
|
+
dateRangeEndDate;
|
|
4873
|
+
}
|
|
4874
|
+
|
|
4875
|
+
if (minimumRevenue !== undefined) {
|
|
4876
|
+
localVarQueryParameter['minimumRevenue'] = minimumRevenue;
|
|
4877
|
+
}
|
|
4878
|
+
|
|
4879
|
+
if (maximumRevenue !== undefined) {
|
|
4880
|
+
localVarQueryParameter['maximumRevenue'] = maximumRevenue;
|
|
4881
|
+
}
|
|
4882
|
+
|
|
4883
|
+
if (minimumSales !== undefined) {
|
|
4884
|
+
localVarQueryParameter['minimumSales'] = minimumSales;
|
|
4885
|
+
}
|
|
4886
|
+
|
|
4887
|
+
if (maximumSales !== undefined) {
|
|
4888
|
+
localVarQueryParameter['maximumSales'] = maximumSales;
|
|
4889
|
+
}
|
|
4890
|
+
|
|
4891
|
+
if (minimumBasketPercent !== undefined) {
|
|
4892
|
+
localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
|
|
4893
|
+
}
|
|
4894
|
+
|
|
4895
|
+
if (maximumBasketPercent !== undefined) {
|
|
4896
|
+
localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
|
|
4897
|
+
}
|
|
4898
|
+
|
|
4899
|
+
if (minimumTraffic !== undefined) {
|
|
4900
|
+
localVarQueryParameter['minimumTraffic'] = minimumTraffic;
|
|
4901
|
+
}
|
|
4902
|
+
|
|
4903
|
+
if (maximumTraffic !== undefined) {
|
|
4904
|
+
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
4905
|
+
}
|
|
4906
|
+
|
|
4907
|
+
if (createdBefore !== undefined) {
|
|
4908
|
+
localVarQueryParameter['createdBefore'] = (createdBefore as any instanceof Date) ?
|
|
4909
|
+
(createdBefore as any).toISOString() :
|
|
4910
|
+
createdBefore;
|
|
4911
|
+
}
|
|
4912
|
+
|
|
4913
|
+
if (createdAfter !== undefined) {
|
|
4914
|
+
localVarQueryParameter['createdAfter'] = (createdAfter as any instanceof Date) ?
|
|
4915
|
+
(createdAfter as any).toISOString() :
|
|
4916
|
+
createdAfter;
|
|
4917
|
+
}
|
|
4918
|
+
|
|
4919
|
+
if (updatedBefore !== undefined) {
|
|
4920
|
+
localVarQueryParameter['updatedBefore'] = (updatedBefore as any instanceof Date) ?
|
|
4921
|
+
(updatedBefore as any).toISOString() :
|
|
4922
|
+
updatedBefore;
|
|
4923
|
+
}
|
|
4924
|
+
|
|
4925
|
+
if (updatedAfter !== undefined) {
|
|
4926
|
+
localVarQueryParameter['updatedAfter'] = (updatedAfter as any instanceof Date) ?
|
|
4927
|
+
(updatedAfter as any).toISOString() :
|
|
4928
|
+
updatedAfter;
|
|
4929
|
+
}
|
|
4930
|
+
|
|
4823
4931
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
4824
4932
|
|
|
4825
4933
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5105,11 +5213,25 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
5105
5213
|
* @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.
|
|
5106
5214
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
5107
5215
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
5216
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
5217
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
5218
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
5219
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
5220
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
5221
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
5222
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
5223
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
5224
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
5225
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
5226
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
5227
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
5228
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
5229
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
5108
5230
|
* @param {*} [options] Override http request option.
|
|
5109
5231
|
* @throws {RequiredError}
|
|
5110
5232
|
*/
|
|
5111
|
-
async listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
5112
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options);
|
|
5233
|
+
async listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
5234
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, dateRangeStartDate, dateRangeEndDate, minimumRevenue, maximumRevenue, minimumSales, maximumSales, minimumBasketPercent, maximumBasketPercent, minimumTraffic, maximumTraffic, createdBefore, createdAfter, updatedBefore, updatedAfter, options);
|
|
5113
5235
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5114
5236
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.listProducts']?.[localVarOperationServerIndex]?.url;
|
|
5115
5237
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -5244,7 +5366,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
5244
5366
|
* @throws {RequiredError}
|
|
5245
5367
|
*/
|
|
5246
5368
|
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
|
|
5247
|
-
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
5369
|
+
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.pageSize, requestParameters.fields, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(axios, basePath));
|
|
5248
5370
|
},
|
|
5249
5371
|
/**
|
|
5250
5372
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -5469,6 +5591,76 @@ export interface ProductsApiListProductsRequest {
|
|
|
5469
5591
|
* Filter response fields to only include a subset of the resource.
|
|
5470
5592
|
*/
|
|
5471
5593
|
readonly fields?: string
|
|
5594
|
+
|
|
5595
|
+
/**
|
|
5596
|
+
* Start date for the date range filter (ISO 8601 format)
|
|
5597
|
+
*/
|
|
5598
|
+
readonly dateRangeStartDate?: string
|
|
5599
|
+
|
|
5600
|
+
/**
|
|
5601
|
+
* End date for the date range filter (ISO 8601 format)
|
|
5602
|
+
*/
|
|
5603
|
+
readonly dateRangeEndDate?: string
|
|
5604
|
+
|
|
5605
|
+
/**
|
|
5606
|
+
* Filter to only include products with total revenue greater than or equal to this amount
|
|
5607
|
+
*/
|
|
5608
|
+
readonly minimumRevenue?: number
|
|
5609
|
+
|
|
5610
|
+
/**
|
|
5611
|
+
* Filter to only include products with total revenue less than or equal to this amount
|
|
5612
|
+
*/
|
|
5613
|
+
readonly maximumRevenue?: number
|
|
5614
|
+
|
|
5615
|
+
/**
|
|
5616
|
+
* Filter to only include products with total sales greater than or equal to this number
|
|
5617
|
+
*/
|
|
5618
|
+
readonly minimumSales?: number
|
|
5619
|
+
|
|
5620
|
+
/**
|
|
5621
|
+
* Filter to only include products with total sales less than or equal to this number
|
|
5622
|
+
*/
|
|
5623
|
+
readonly maximumSales?: number
|
|
5624
|
+
|
|
5625
|
+
/**
|
|
5626
|
+
* Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
5627
|
+
*/
|
|
5628
|
+
readonly minimumBasketPercent?: number
|
|
5629
|
+
|
|
5630
|
+
/**
|
|
5631
|
+
* Filter to only include products where the average basket percentage is less than or equal to this value
|
|
5632
|
+
*/
|
|
5633
|
+
readonly maximumBasketPercent?: number
|
|
5634
|
+
|
|
5635
|
+
/**
|
|
5636
|
+
* Filter to only include products with total traffic greater than or equal to this number
|
|
5637
|
+
*/
|
|
5638
|
+
readonly minimumTraffic?: number
|
|
5639
|
+
|
|
5640
|
+
/**
|
|
5641
|
+
* Filter to only include products with total traffic less than or equal to this number
|
|
5642
|
+
*/
|
|
5643
|
+
readonly maximumTraffic?: number
|
|
5644
|
+
|
|
5645
|
+
/**
|
|
5646
|
+
* Filter to only include products created before the given date
|
|
5647
|
+
*/
|
|
5648
|
+
readonly createdBefore?: string
|
|
5649
|
+
|
|
5650
|
+
/**
|
|
5651
|
+
* Filter to only include products created after the given date
|
|
5652
|
+
*/
|
|
5653
|
+
readonly createdAfter?: string
|
|
5654
|
+
|
|
5655
|
+
/**
|
|
5656
|
+
* Filter to only include products updated before the given date
|
|
5657
|
+
*/
|
|
5658
|
+
readonly updatedBefore?: string
|
|
5659
|
+
|
|
5660
|
+
/**
|
|
5661
|
+
* Filter to only include products updated after the given date
|
|
5662
|
+
*/
|
|
5663
|
+
readonly updatedAfter?: string
|
|
5472
5664
|
}
|
|
5473
5665
|
|
|
5474
5666
|
/**
|
|
@@ -5607,7 +5799,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
5607
5799
|
* @throws {RequiredError}
|
|
5608
5800
|
*/
|
|
5609
5801
|
public listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig) {
|
|
5610
|
-
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
5802
|
+
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxRetailPrice, requestParameters.minRetailPrice, requestParameters.pageSize, requestParameters.fields, requestParameters.dateRangeStartDate, requestParameters.dateRangeEndDate, requestParameters.minimumRevenue, requestParameters.maximumRevenue, requestParameters.minimumSales, requestParameters.maximumSales, requestParameters.minimumBasketPercent, requestParameters.maximumBasketPercent, requestParameters.minimumTraffic, requestParameters.maximumTraffic, requestParameters.createdBefore, requestParameters.createdAfter, requestParameters.updatedBefore, requestParameters.updatedAfter, options).then((request) => request(this.axios, this.basePath));
|
|
5611
5803
|
}
|
|
5612
5804
|
|
|
5613
5805
|
/**
|
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.91.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.91.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Product Catalog
|
|
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.91.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.91.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1199,6 +1199,7 @@ export interface Product {
|
|
|
1199
1199
|
* Whether the product is digital
|
|
1200
1200
|
*/
|
|
1201
1201
|
'isDigital'?: boolean;
|
|
1202
|
+
'analytics'?: ProductAnalytics;
|
|
1202
1203
|
}
|
|
1203
1204
|
export interface ProductAdditionalFilesInner {
|
|
1204
1205
|
/**
|
|
@@ -1210,6 +1211,31 @@ export interface ProductAdditionalFilesInner {
|
|
|
1210
1211
|
*/
|
|
1211
1212
|
'src'?: string;
|
|
1212
1213
|
}
|
|
1214
|
+
/**
|
|
1215
|
+
* Product analytics metrics. Only present when \'analytics\' is included in the fields query parameter.
|
|
1216
|
+
*/
|
|
1217
|
+
export interface ProductAnalytics {
|
|
1218
|
+
/**
|
|
1219
|
+
* Total revenue for this product within the date range
|
|
1220
|
+
*/
|
|
1221
|
+
'revenue'?: number;
|
|
1222
|
+
/**
|
|
1223
|
+
* Total number of sales for this product within the date range
|
|
1224
|
+
*/
|
|
1225
|
+
'sales'?: number;
|
|
1226
|
+
/**
|
|
1227
|
+
* Total page views for this product within the date range
|
|
1228
|
+
*/
|
|
1229
|
+
'traffic'?: number;
|
|
1230
|
+
/**
|
|
1231
|
+
* Conversion rate as a percentage (sales / traffic * 100)
|
|
1232
|
+
*/
|
|
1233
|
+
'conversionRate'?: number;
|
|
1234
|
+
/**
|
|
1235
|
+
* Basket rate as a percentage (cart adds / traffic * 100)
|
|
1236
|
+
*/
|
|
1237
|
+
'basketRate'?: number;
|
|
1238
|
+
}
|
|
1213
1239
|
export interface ProductAnalyticsResponse {
|
|
1214
1240
|
'analytics'?: Array<AnalyticsItem>;
|
|
1215
1241
|
}
|
|
@@ -3277,10 +3303,24 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3277
3303
|
* @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.
|
|
3278
3304
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3279
3305
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
3306
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3307
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
3308
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
3309
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
3310
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
3311
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
3312
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
3313
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3314
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3315
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
3316
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
3317
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
3318
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
3319
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
3280
3320
|
* @param {*} [options] Override http request option.
|
|
3281
3321
|
* @throws {RequiredError}
|
|
3282
3322
|
*/
|
|
3283
|
-
listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3323
|
+
listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3284
3324
|
/**
|
|
3285
3325
|
* AI SEO optimises products by a set of given IDs.
|
|
3286
3326
|
* @summary AI SEO optimise products.
|
|
@@ -3397,10 +3437,24 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3397
3437
|
* @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.
|
|
3398
3438
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3399
3439
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
3440
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
3441
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
3442
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
3443
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
3444
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
3445
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
3446
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
3447
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3448
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
3449
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
3450
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
3451
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
3452
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
3453
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
3400
3454
|
* @param {*} [options] Override http request option.
|
|
3401
3455
|
* @throws {RequiredError}
|
|
3402
3456
|
*/
|
|
3403
|
-
listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
3457
|
+
listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, start?: string, end?: string, dateFilterType?: ListProductsDateFilterTypeEnum, maxRetailPrice?: number, minRetailPrice?: number, pageSize?: number, fields?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
3404
3458
|
/**
|
|
3405
3459
|
* AI SEO optimises products by a set of given IDs.
|
|
3406
3460
|
* @summary AI SEO optimise products.
|
|
@@ -3683,6 +3737,62 @@ export interface ProductsApiListProductsRequest {
|
|
|
3683
3737
|
* Filter response fields to only include a subset of the resource.
|
|
3684
3738
|
*/
|
|
3685
3739
|
readonly fields?: string;
|
|
3740
|
+
/**
|
|
3741
|
+
* Start date for the date range filter (ISO 8601 format)
|
|
3742
|
+
*/
|
|
3743
|
+
readonly dateRangeStartDate?: string;
|
|
3744
|
+
/**
|
|
3745
|
+
* End date for the date range filter (ISO 8601 format)
|
|
3746
|
+
*/
|
|
3747
|
+
readonly dateRangeEndDate?: string;
|
|
3748
|
+
/**
|
|
3749
|
+
* Filter to only include products with total revenue greater than or equal to this amount
|
|
3750
|
+
*/
|
|
3751
|
+
readonly minimumRevenue?: number;
|
|
3752
|
+
/**
|
|
3753
|
+
* Filter to only include products with total revenue less than or equal to this amount
|
|
3754
|
+
*/
|
|
3755
|
+
readonly maximumRevenue?: number;
|
|
3756
|
+
/**
|
|
3757
|
+
* Filter to only include products with total sales greater than or equal to this number
|
|
3758
|
+
*/
|
|
3759
|
+
readonly minimumSales?: number;
|
|
3760
|
+
/**
|
|
3761
|
+
* Filter to only include products with total sales less than or equal to this number
|
|
3762
|
+
*/
|
|
3763
|
+
readonly maximumSales?: number;
|
|
3764
|
+
/**
|
|
3765
|
+
* Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
3766
|
+
*/
|
|
3767
|
+
readonly minimumBasketPercent?: number;
|
|
3768
|
+
/**
|
|
3769
|
+
* Filter to only include products where the average basket percentage is less than or equal to this value
|
|
3770
|
+
*/
|
|
3771
|
+
readonly maximumBasketPercent?: number;
|
|
3772
|
+
/**
|
|
3773
|
+
* Filter to only include products with total traffic greater than or equal to this number
|
|
3774
|
+
*/
|
|
3775
|
+
readonly minimumTraffic?: number;
|
|
3776
|
+
/**
|
|
3777
|
+
* Filter to only include products with total traffic less than or equal to this number
|
|
3778
|
+
*/
|
|
3779
|
+
readonly maximumTraffic?: number;
|
|
3780
|
+
/**
|
|
3781
|
+
* Filter to only include products created before the given date
|
|
3782
|
+
*/
|
|
3783
|
+
readonly createdBefore?: string;
|
|
3784
|
+
/**
|
|
3785
|
+
* Filter to only include products created after the given date
|
|
3786
|
+
*/
|
|
3787
|
+
readonly createdAfter?: string;
|
|
3788
|
+
/**
|
|
3789
|
+
* Filter to only include products updated before the given date
|
|
3790
|
+
*/
|
|
3791
|
+
readonly updatedBefore?: string;
|
|
3792
|
+
/**
|
|
3793
|
+
* Filter to only include products updated after the given date
|
|
3794
|
+
*/
|
|
3795
|
+
readonly updatedAfter?: string;
|
|
3686
3796
|
}
|
|
3687
3797
|
/**
|
|
3688
3798
|
* Request parameters for seoOptimiseProducts operation in ProductsApi.
|