@teemill/product-catalog 1.90.1 → 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/.openapi-generator/VERSION +1 -1
- package/README.md +3 -2
- package/api.ts +226 -32
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +117 -5
- package/dist/api.js +114 -30
- 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 +117 -5
- package/dist/esm/api.js +114 -30
- 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/Application.md +1 -1
- package/docs/CreateApplication.md +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
|
@@ -1 +1 @@
|
|
|
1
|
-
7.
|
|
1
|
+
7.21.0
|
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).
|
|
@@ -48,7 +48,7 @@ export interface Action {
|
|
|
48
48
|
export const ActionImpactEnum = {
|
|
49
49
|
High: 'high',
|
|
50
50
|
Medium: 'medium',
|
|
51
|
-
Low: 'low'
|
|
51
|
+
Low: 'low',
|
|
52
52
|
} as const;
|
|
53
53
|
|
|
54
54
|
export type ActionImpactEnum = typeof ActionImpactEnum[keyof typeof ActionImpactEnum];
|
|
@@ -104,7 +104,7 @@ export interface Application {
|
|
|
104
104
|
*/
|
|
105
105
|
'id'?: string;
|
|
106
106
|
/**
|
|
107
|
-
*
|
|
107
|
+
* The application technology used for this design application. `mug_sublimation` is deprecated. Use `sublimation_small` instead.
|
|
108
108
|
*/
|
|
109
109
|
'technology': ApplicationTechnologyEnum;
|
|
110
110
|
/**
|
|
@@ -137,11 +137,12 @@ export const ApplicationTechnologyEnum = {
|
|
|
137
137
|
Dtf: 'dtf',
|
|
138
138
|
Pretreat: 'pretreat',
|
|
139
139
|
MugSublimation: 'mug_sublimation',
|
|
140
|
+
SublimationSmall: 'sublimation_small',
|
|
140
141
|
ManualPrint: 'manual_print',
|
|
141
142
|
AdditionalApplication: 'additional_application',
|
|
142
143
|
NotebookSublimation: 'notebook_sublimation',
|
|
143
144
|
DuplexPrint: 'duplex_print',
|
|
144
|
-
DuplexInsert: 'duplex_insert'
|
|
145
|
+
DuplexInsert: 'duplex_insert',
|
|
145
146
|
} as const;
|
|
146
147
|
|
|
147
148
|
export type ApplicationTechnologyEnum = typeof ApplicationTechnologyEnum[keyof typeof ApplicationTechnologyEnum];
|
|
@@ -150,7 +151,7 @@ export const ApplicationPlacementEnum = {
|
|
|
150
151
|
Back: 'back',
|
|
151
152
|
Left: 'left',
|
|
152
153
|
Right: 'right',
|
|
153
|
-
Neck: 'neck'
|
|
154
|
+
Neck: 'neck',
|
|
154
155
|
} as const;
|
|
155
156
|
|
|
156
157
|
export type ApplicationPlacementEnum = typeof ApplicationPlacementEnum[keyof typeof ApplicationPlacementEnum];
|
|
@@ -227,7 +228,7 @@ export const ApplicationPropertiesPersonalizationRulesFitEnum = {
|
|
|
227
228
|
Contain: 'contain',
|
|
228
229
|
Cover: 'cover',
|
|
229
230
|
Stretch: 'stretch',
|
|
230
|
-
Crop: 'crop'
|
|
231
|
+
Crop: 'crop',
|
|
231
232
|
} as const;
|
|
232
233
|
|
|
233
234
|
export type ApplicationPropertiesPersonalizationRulesFitEnum = typeof ApplicationPropertiesPersonalizationRulesFitEnum[keyof typeof ApplicationPropertiesPersonalizationRulesFitEnum];
|
|
@@ -308,14 +309,14 @@ export const ApplicationPropertiesPropertiesFontWeightEnum = {
|
|
|
308
309
|
Lighter: 'lighter',
|
|
309
310
|
Normal: 'normal',
|
|
310
311
|
Bold: 'bold',
|
|
311
|
-
Bolder: 'bolder'
|
|
312
|
+
Bolder: 'bolder',
|
|
312
313
|
} as const;
|
|
313
314
|
|
|
314
315
|
export type ApplicationPropertiesPropertiesFontWeightEnum = typeof ApplicationPropertiesPropertiesFontWeightEnum[keyof typeof ApplicationPropertiesPropertiesFontWeightEnum];
|
|
315
316
|
export const ApplicationPropertiesPropertiesFontStyleEnum = {
|
|
316
317
|
Normal: 'normal',
|
|
317
318
|
Italic: 'italic',
|
|
318
|
-
Oblique: 'oblique'
|
|
319
|
+
Oblique: 'oblique',
|
|
319
320
|
} as const;
|
|
320
321
|
|
|
321
322
|
export type ApplicationPropertiesPropertiesFontStyleEnum = typeof ApplicationPropertiesPropertiesFontStyleEnum[keyof typeof ApplicationPropertiesPropertiesFontStyleEnum];
|
|
@@ -442,7 +443,7 @@ export interface AttributeThumbnail {
|
|
|
442
443
|
export const AttributeThumbnailTypeEnum = {
|
|
443
444
|
Text: 'text',
|
|
444
445
|
Color: 'color',
|
|
445
|
-
Image: 'image'
|
|
446
|
+
Image: 'image',
|
|
446
447
|
} as const;
|
|
447
448
|
|
|
448
449
|
export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
|
|
@@ -540,7 +541,7 @@ export interface BundleProduct {
|
|
|
540
541
|
}
|
|
541
542
|
export interface CreateApplication {
|
|
542
543
|
/**
|
|
543
|
-
*
|
|
544
|
+
* The application technology used for this design application. `mug_sublimation` is deprecated. Use `sublimation_small` instead.
|
|
544
545
|
*/
|
|
545
546
|
'technology': CreateApplicationTechnologyEnum;
|
|
546
547
|
/**
|
|
@@ -572,11 +573,12 @@ export const CreateApplicationTechnologyEnum = {
|
|
|
572
573
|
Dtf: 'dtf',
|
|
573
574
|
Pretreat: 'pretreat',
|
|
574
575
|
MugSublimation: 'mug_sublimation',
|
|
576
|
+
SublimationSmall: 'sublimation_small',
|
|
575
577
|
ManualPrint: 'manual_print',
|
|
576
578
|
AdditionalApplication: 'additional_application',
|
|
577
579
|
NotebookSublimation: 'notebook_sublimation',
|
|
578
580
|
DuplexPrint: 'duplex_print',
|
|
579
|
-
DuplexInsert: 'duplex_insert'
|
|
581
|
+
DuplexInsert: 'duplex_insert',
|
|
580
582
|
} as const;
|
|
581
583
|
|
|
582
584
|
export type CreateApplicationTechnologyEnum = typeof CreateApplicationTechnologyEnum[keyof typeof CreateApplicationTechnologyEnum];
|
|
@@ -585,7 +587,7 @@ export const CreateApplicationPlacementEnum = {
|
|
|
585
587
|
Back: 'back',
|
|
586
588
|
Left: 'left',
|
|
587
589
|
Right: 'right',
|
|
588
|
-
Neck: 'neck'
|
|
590
|
+
Neck: 'neck',
|
|
589
591
|
} as const;
|
|
590
592
|
|
|
591
593
|
export type CreateApplicationPlacementEnum = typeof CreateApplicationPlacementEnum[keyof typeof CreateApplicationPlacementEnum];
|
|
@@ -642,14 +644,14 @@ export const CreateApplicationPropertiesFontWeightEnum = {
|
|
|
642
644
|
Lighter: 'lighter',
|
|
643
645
|
Normal: 'normal',
|
|
644
646
|
Bold: 'bold',
|
|
645
|
-
Bolder: 'bolder'
|
|
647
|
+
Bolder: 'bolder',
|
|
646
648
|
} as const;
|
|
647
649
|
|
|
648
650
|
export type CreateApplicationPropertiesFontWeightEnum = typeof CreateApplicationPropertiesFontWeightEnum[keyof typeof CreateApplicationPropertiesFontWeightEnum];
|
|
649
651
|
export const CreateApplicationPropertiesFontStyleEnum = {
|
|
650
652
|
Normal: 'normal',
|
|
651
653
|
Italic: 'italic',
|
|
652
|
-
Oblique: 'oblique'
|
|
654
|
+
Oblique: 'oblique',
|
|
653
655
|
} as const;
|
|
654
656
|
|
|
655
657
|
export type CreateApplicationPropertiesFontStyleEnum = typeof CreateApplicationPropertiesFontStyleEnum[keyof typeof CreateApplicationPropertiesFontStyleEnum];
|
|
@@ -965,7 +967,7 @@ export interface CreateProductVariantAttributesInner {
|
|
|
965
967
|
|
|
966
968
|
export const CreateProductVariantAttributesInnerNameEnum = {
|
|
967
969
|
Size: 'Size',
|
|
968
|
-
Colour: 'Colour'
|
|
970
|
+
Colour: 'Colour',
|
|
969
971
|
} as const;
|
|
970
972
|
|
|
971
973
|
export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
|
|
@@ -1137,7 +1139,7 @@ export interface Price {
|
|
|
1137
1139
|
}
|
|
1138
1140
|
|
|
1139
1141
|
export const PriceCurrencyCodeEnum = {
|
|
1140
|
-
Gbp: 'GBP'
|
|
1142
|
+
Gbp: 'GBP',
|
|
1141
1143
|
} as const;
|
|
1142
1144
|
|
|
1143
1145
|
export type PriceCurrencyCodeEnum = typeof PriceCurrencyCodeEnum[keyof typeof PriceCurrencyCodeEnum];
|
|
@@ -1240,6 +1242,7 @@ export interface Product {
|
|
|
1240
1242
|
* Whether the product is digital
|
|
1241
1243
|
*/
|
|
1242
1244
|
'isDigital'?: boolean;
|
|
1245
|
+
'analytics'?: ProductAnalytics;
|
|
1243
1246
|
}
|
|
1244
1247
|
export interface ProductAdditionalFilesInner {
|
|
1245
1248
|
/**
|
|
@@ -1251,6 +1254,31 @@ export interface ProductAdditionalFilesInner {
|
|
|
1251
1254
|
*/
|
|
1252
1255
|
'src'?: string;
|
|
1253
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
|
+
}
|
|
1254
1282
|
export interface ProductAnalyticsResponse {
|
|
1255
1283
|
'analytics'?: Array<AnalyticsItem>;
|
|
1256
1284
|
}
|
|
@@ -1440,7 +1468,7 @@ export interface Recommendation {
|
|
|
1440
1468
|
export const RecommendationPriorityEnum = {
|
|
1441
1469
|
High: 'high',
|
|
1442
1470
|
Medium: 'medium',
|
|
1443
|
-
Low: 'low'
|
|
1471
|
+
Low: 'low',
|
|
1444
1472
|
} as const;
|
|
1445
1473
|
|
|
1446
1474
|
export type RecommendationPriorityEnum = typeof RecommendationPriorityEnum[keyof typeof RecommendationPriorityEnum];
|
|
@@ -1460,7 +1488,7 @@ export interface RequiredPrice {
|
|
|
1460
1488
|
}
|
|
1461
1489
|
|
|
1462
1490
|
export const RequiredPriceCurrencyCodeEnum = {
|
|
1463
|
-
Gbp: 'GBP'
|
|
1491
|
+
Gbp: 'GBP',
|
|
1464
1492
|
} as const;
|
|
1465
1493
|
|
|
1466
1494
|
export type RequiredPriceCurrencyCodeEnum = typeof RequiredPriceCurrencyCodeEnum[keyof typeof RequiredPriceCurrencyCodeEnum];
|
|
@@ -1510,7 +1538,7 @@ export interface SalePrice {
|
|
|
1510
1538
|
}
|
|
1511
1539
|
|
|
1512
1540
|
export const SalePriceCurrencyCodeEnum = {
|
|
1513
|
-
Gbp: 'GBP'
|
|
1541
|
+
Gbp: 'GBP',
|
|
1514
1542
|
} as const;
|
|
1515
1543
|
|
|
1516
1544
|
export type SalePriceCurrencyCodeEnum = typeof SalePriceCurrencyCodeEnum[keyof typeof SalePriceCurrencyCodeEnum];
|
|
@@ -1582,14 +1610,14 @@ export const TextApplicationPropertiesFontWeightEnum = {
|
|
|
1582
1610
|
Lighter: 'lighter',
|
|
1583
1611
|
Normal: 'normal',
|
|
1584
1612
|
Bold: 'bold',
|
|
1585
|
-
Bolder: 'bolder'
|
|
1613
|
+
Bolder: 'bolder',
|
|
1586
1614
|
} as const;
|
|
1587
1615
|
|
|
1588
1616
|
export type TextApplicationPropertiesFontWeightEnum = typeof TextApplicationPropertiesFontWeightEnum[keyof typeof TextApplicationPropertiesFontWeightEnum];
|
|
1589
1617
|
export const TextApplicationPropertiesFontStyleEnum = {
|
|
1590
1618
|
Normal: 'normal',
|
|
1591
1619
|
Italic: 'italic',
|
|
1592
|
-
Oblique: 'oblique'
|
|
1620
|
+
Oblique: 'oblique',
|
|
1593
1621
|
} as const;
|
|
1594
1622
|
|
|
1595
1623
|
export type TextApplicationPropertiesFontStyleEnum = typeof TextApplicationPropertiesFontStyleEnum[keyof typeof TextApplicationPropertiesFontStyleEnum];
|
|
@@ -1608,7 +1636,7 @@ export interface TextApplicationPropertiesPersonalization {
|
|
|
1608
1636
|
|
|
1609
1637
|
export const TextApplicationPropertiesPersonalizationTypeEnum = {
|
|
1610
1638
|
Text: 'text',
|
|
1611
|
-
Number: 'number'
|
|
1639
|
+
Number: 'number',
|
|
1612
1640
|
} as const;
|
|
1613
1641
|
|
|
1614
1642
|
export type TextApplicationPropertiesPersonalizationTypeEnum = typeof TextApplicationPropertiesPersonalizationTypeEnum[keyof typeof TextApplicationPropertiesPersonalizationTypeEnum];
|
|
@@ -1946,7 +1974,7 @@ export interface UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
|
|
|
1946
1974
|
|
|
1947
1975
|
export const UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = {
|
|
1948
1976
|
Size: 'Size',
|
|
1949
|
-
Colour: 'Colour'
|
|
1977
|
+
Colour: 'Colour',
|
|
1950
1978
|
} as const;
|
|
1951
1979
|
|
|
1952
1980
|
export type UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum];
|
|
@@ -1973,7 +2001,7 @@ export interface UpdateProductsRequestProductsInnerVariantsInnerRetailPrice {
|
|
|
1973
2001
|
}
|
|
1974
2002
|
|
|
1975
2003
|
export const UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = {
|
|
1976
|
-
Gbp: 'GBP'
|
|
2004
|
+
Gbp: 'GBP',
|
|
1977
2005
|
} as const;
|
|
1978
2006
|
|
|
1979
2007
|
export type UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum];
|
|
@@ -1993,7 +2021,7 @@ export interface UpdateProductsRequestProductsInnerVariantsInnerSalePrice {
|
|
|
1993
2021
|
}
|
|
1994
2022
|
|
|
1995
2023
|
export const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = {
|
|
1996
|
-
Gbp: 'GBP'
|
|
2024
|
+
Gbp: 'GBP',
|
|
1997
2025
|
} as const;
|
|
1998
2026
|
|
|
1999
2027
|
export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
|
|
@@ -4745,10 +4773,24 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4745
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.
|
|
4746
4774
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4747
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
|
|
4748
4790
|
* @param {*} [options] Override http request option.
|
|
4749
4791
|
* @throws {RequiredError}
|
|
4750
4792
|
*/
|
|
4751
|
-
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> => {
|
|
4752
4794
|
// verify required parameter 'project' is not null or undefined
|
|
4753
4795
|
assertParamExists('listProducts', 'project', project)
|
|
4754
4796
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -4818,6 +4860,74 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
4818
4860
|
localVarQueryParameter['fields'] = fields;
|
|
4819
4861
|
}
|
|
4820
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
|
+
|
|
4821
4931
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
4822
4932
|
|
|
4823
4933
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5103,11 +5213,25 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
5103
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.
|
|
5104
5214
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
5105
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
|
|
5106
5230
|
* @param {*} [options] Override http request option.
|
|
5107
5231
|
* @throws {RequiredError}
|
|
5108
5232
|
*/
|
|
5109
|
-
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>> {
|
|
5110
|
-
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);
|
|
5111
5235
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5112
5236
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.listProducts']?.[localVarOperationServerIndex]?.url;
|
|
5113
5237
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -5242,7 +5366,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
5242
5366
|
* @throws {RequiredError}
|
|
5243
5367
|
*/
|
|
5244
5368
|
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
|
|
5245
|
-
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));
|
|
5246
5370
|
},
|
|
5247
5371
|
/**
|
|
5248
5372
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -5467,6 +5591,76 @@ export interface ProductsApiListProductsRequest {
|
|
|
5467
5591
|
* Filter response fields to only include a subset of the resource.
|
|
5468
5592
|
*/
|
|
5469
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
|
|
5470
5664
|
}
|
|
5471
5665
|
|
|
5472
5666
|
/**
|
|
@@ -5605,7 +5799,7 @@ export class ProductsApi extends BaseAPI {
|
|
|
5605
5799
|
* @throws {RequiredError}
|
|
5606
5800
|
*/
|
|
5607
5801
|
public listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig) {
|
|
5608
|
-
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));
|
|
5609
5803
|
}
|
|
5610
5804
|
|
|
5611
5805
|
/**
|
|
@@ -5644,12 +5838,12 @@ export class ProductsApi extends BaseAPI {
|
|
|
5644
5838
|
|
|
5645
5839
|
export const ExportProductsDateFilterTypeEnum = {
|
|
5646
5840
|
CreatedAt: 'createdAt',
|
|
5647
|
-
UpdatedAt: 'updatedAt'
|
|
5841
|
+
UpdatedAt: 'updatedAt',
|
|
5648
5842
|
} as const;
|
|
5649
5843
|
export type ExportProductsDateFilterTypeEnum = typeof ExportProductsDateFilterTypeEnum[keyof typeof ExportProductsDateFilterTypeEnum];
|
|
5650
5844
|
export const ListProductsDateFilterTypeEnum = {
|
|
5651
5845
|
CreatedAt: 'createdAt',
|
|
5652
|
-
UpdatedAt: 'updatedAt'
|
|
5846
|
+
UpdatedAt: 'updatedAt',
|
|
5653
5847
|
} as const;
|
|
5654
5848
|
export type ListProductsDateFilterTypeEnum = typeof ListProductsDateFilterTypeEnum[keyof typeof ListProductsDateFilterTypeEnum];
|
|
5655
5849
|
|
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).
|