@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/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).
|
|
@@ -91,7 +91,7 @@ export interface Application {
|
|
|
91
91
|
*/
|
|
92
92
|
'id'?: string;
|
|
93
93
|
/**
|
|
94
|
-
*
|
|
94
|
+
* The application technology used for this design application. `mug_sublimation` is deprecated. Use `sublimation_small` instead.
|
|
95
95
|
*/
|
|
96
96
|
'technology': ApplicationTechnologyEnum;
|
|
97
97
|
/**
|
|
@@ -123,6 +123,7 @@ export declare const ApplicationTechnologyEnum: {
|
|
|
123
123
|
readonly Dtf: "dtf";
|
|
124
124
|
readonly Pretreat: "pretreat";
|
|
125
125
|
readonly MugSublimation: "mug_sublimation";
|
|
126
|
+
readonly SublimationSmall: "sublimation_small";
|
|
126
127
|
readonly ManualPrint: "manual_print";
|
|
127
128
|
readonly AdditionalApplication: "additional_application";
|
|
128
129
|
readonly NotebookSublimation: "notebook_sublimation";
|
|
@@ -512,7 +513,7 @@ export interface BundleProduct {
|
|
|
512
513
|
}
|
|
513
514
|
export interface CreateApplication {
|
|
514
515
|
/**
|
|
515
|
-
*
|
|
516
|
+
* The application technology used for this design application. `mug_sublimation` is deprecated. Use `sublimation_small` instead.
|
|
516
517
|
*/
|
|
517
518
|
'technology': CreateApplicationTechnologyEnum;
|
|
518
519
|
/**
|
|
@@ -543,6 +544,7 @@ export declare const CreateApplicationTechnologyEnum: {
|
|
|
543
544
|
readonly Dtf: "dtf";
|
|
544
545
|
readonly Pretreat: "pretreat";
|
|
545
546
|
readonly MugSublimation: "mug_sublimation";
|
|
547
|
+
readonly SublimationSmall: "sublimation_small";
|
|
546
548
|
readonly ManualPrint: "manual_print";
|
|
547
549
|
readonly AdditionalApplication: "additional_application";
|
|
548
550
|
readonly NotebookSublimation: "notebook_sublimation";
|
|
@@ -1197,6 +1199,7 @@ export interface Product {
|
|
|
1197
1199
|
* Whether the product is digital
|
|
1198
1200
|
*/
|
|
1199
1201
|
'isDigital'?: boolean;
|
|
1202
|
+
'analytics'?: ProductAnalytics;
|
|
1200
1203
|
}
|
|
1201
1204
|
export interface ProductAdditionalFilesInner {
|
|
1202
1205
|
/**
|
|
@@ -1208,6 +1211,31 @@ export interface ProductAdditionalFilesInner {
|
|
|
1208
1211
|
*/
|
|
1209
1212
|
'src'?: string;
|
|
1210
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
|
+
}
|
|
1211
1239
|
export interface ProductAnalyticsResponse {
|
|
1212
1240
|
'analytics'?: Array<AnalyticsItem>;
|
|
1213
1241
|
}
|
|
@@ -3275,10 +3303,24 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
3275
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.
|
|
3276
3304
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3277
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
|
|
3278
3320
|
* @param {*} [options] Override http request option.
|
|
3279
3321
|
* @throws {RequiredError}
|
|
3280
3322
|
*/
|
|
3281
|
-
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>;
|
|
3282
3324
|
/**
|
|
3283
3325
|
* AI SEO optimises products by a set of given IDs.
|
|
3284
3326
|
* @summary AI SEO optimise products.
|
|
@@ -3395,10 +3437,24 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
3395
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.
|
|
3396
3438
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3397
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
|
|
3398
3454
|
* @param {*} [options] Override http request option.
|
|
3399
3455
|
* @throws {RequiredError}
|
|
3400
3456
|
*/
|
|
3401
|
-
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>>;
|
|
3402
3458
|
/**
|
|
3403
3459
|
* AI SEO optimises products by a set of given IDs.
|
|
3404
3460
|
* @summary AI SEO optimise products.
|
|
@@ -3681,6 +3737,62 @@ export interface ProductsApiListProductsRequest {
|
|
|
3681
3737
|
* Filter response fields to only include a subset of the resource.
|
|
3682
3738
|
*/
|
|
3683
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;
|
|
3684
3796
|
}
|
|
3685
3797
|
/**
|
|
3686
3798
|
* Request parameters for seoOptimiseProducts 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.91.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -33,7 +33,7 @@ const base_1 = require("./base");
|
|
|
33
33
|
exports.ActionImpactEnum = {
|
|
34
34
|
High: 'high',
|
|
35
35
|
Medium: 'medium',
|
|
36
|
-
Low: 'low'
|
|
36
|
+
Low: 'low',
|
|
37
37
|
};
|
|
38
38
|
exports.ApplicationTechnologyEnum = {
|
|
39
39
|
Dtg: 'dtg',
|
|
@@ -41,40 +41,41 @@ exports.ApplicationTechnologyEnum = {
|
|
|
41
41
|
Dtf: 'dtf',
|
|
42
42
|
Pretreat: 'pretreat',
|
|
43
43
|
MugSublimation: 'mug_sublimation',
|
|
44
|
+
SublimationSmall: 'sublimation_small',
|
|
44
45
|
ManualPrint: 'manual_print',
|
|
45
46
|
AdditionalApplication: 'additional_application',
|
|
46
47
|
NotebookSublimation: 'notebook_sublimation',
|
|
47
48
|
DuplexPrint: 'duplex_print',
|
|
48
|
-
DuplexInsert: 'duplex_insert'
|
|
49
|
+
DuplexInsert: 'duplex_insert',
|
|
49
50
|
};
|
|
50
51
|
exports.ApplicationPlacementEnum = {
|
|
51
52
|
Front: 'front',
|
|
52
53
|
Back: 'back',
|
|
53
54
|
Left: 'left',
|
|
54
55
|
Right: 'right',
|
|
55
|
-
Neck: 'neck'
|
|
56
|
+
Neck: 'neck',
|
|
56
57
|
};
|
|
57
58
|
exports.ApplicationPropertiesPersonalizationRulesFitEnum = {
|
|
58
59
|
Contain: 'contain',
|
|
59
60
|
Cover: 'cover',
|
|
60
61
|
Stretch: 'stretch',
|
|
61
|
-
Crop: 'crop'
|
|
62
|
+
Crop: 'crop',
|
|
62
63
|
};
|
|
63
64
|
exports.ApplicationPropertiesPropertiesFontWeightEnum = {
|
|
64
65
|
Lighter: 'lighter',
|
|
65
66
|
Normal: 'normal',
|
|
66
67
|
Bold: 'bold',
|
|
67
|
-
Bolder: 'bolder'
|
|
68
|
+
Bolder: 'bolder',
|
|
68
69
|
};
|
|
69
70
|
exports.ApplicationPropertiesPropertiesFontStyleEnum = {
|
|
70
71
|
Normal: 'normal',
|
|
71
72
|
Italic: 'italic',
|
|
72
|
-
Oblique: 'oblique'
|
|
73
|
+
Oblique: 'oblique',
|
|
73
74
|
};
|
|
74
75
|
exports.AttributeThumbnailTypeEnum = {
|
|
75
76
|
Text: 'text',
|
|
76
77
|
Color: 'color',
|
|
77
|
-
Image: 'image'
|
|
78
|
+
Image: 'image',
|
|
78
79
|
};
|
|
79
80
|
exports.CreateApplicationTechnologyEnum = {
|
|
80
81
|
Dtg: 'dtg',
|
|
@@ -82,72 +83,73 @@ exports.CreateApplicationTechnologyEnum = {
|
|
|
82
83
|
Dtf: 'dtf',
|
|
83
84
|
Pretreat: 'pretreat',
|
|
84
85
|
MugSublimation: 'mug_sublimation',
|
|
86
|
+
SublimationSmall: 'sublimation_small',
|
|
85
87
|
ManualPrint: 'manual_print',
|
|
86
88
|
AdditionalApplication: 'additional_application',
|
|
87
89
|
NotebookSublimation: 'notebook_sublimation',
|
|
88
90
|
DuplexPrint: 'duplex_print',
|
|
89
|
-
DuplexInsert: 'duplex_insert'
|
|
91
|
+
DuplexInsert: 'duplex_insert',
|
|
90
92
|
};
|
|
91
93
|
exports.CreateApplicationPlacementEnum = {
|
|
92
94
|
Front: 'front',
|
|
93
95
|
Back: 'back',
|
|
94
96
|
Left: 'left',
|
|
95
97
|
Right: 'right',
|
|
96
|
-
Neck: 'neck'
|
|
98
|
+
Neck: 'neck',
|
|
97
99
|
};
|
|
98
100
|
exports.CreateApplicationPropertiesFontWeightEnum = {
|
|
99
101
|
Lighter: 'lighter',
|
|
100
102
|
Normal: 'normal',
|
|
101
103
|
Bold: 'bold',
|
|
102
|
-
Bolder: 'bolder'
|
|
104
|
+
Bolder: 'bolder',
|
|
103
105
|
};
|
|
104
106
|
exports.CreateApplicationPropertiesFontStyleEnum = {
|
|
105
107
|
Normal: 'normal',
|
|
106
108
|
Italic: 'italic',
|
|
107
|
-
Oblique: 'oblique'
|
|
109
|
+
Oblique: 'oblique',
|
|
108
110
|
};
|
|
109
111
|
exports.CreateProductVariantAttributesInnerNameEnum = {
|
|
110
112
|
Size: 'Size',
|
|
111
|
-
Colour: 'Colour'
|
|
113
|
+
Colour: 'Colour',
|
|
112
114
|
};
|
|
113
115
|
exports.PriceCurrencyCodeEnum = {
|
|
114
|
-
Gbp: 'GBP'
|
|
116
|
+
Gbp: 'GBP',
|
|
115
117
|
};
|
|
116
118
|
exports.RecommendationPriorityEnum = {
|
|
117
119
|
High: 'high',
|
|
118
120
|
Medium: 'medium',
|
|
119
|
-
Low: 'low'
|
|
121
|
+
Low: 'low',
|
|
120
122
|
};
|
|
121
123
|
exports.RequiredPriceCurrencyCodeEnum = {
|
|
122
|
-
Gbp: 'GBP'
|
|
124
|
+
Gbp: 'GBP',
|
|
123
125
|
};
|
|
124
126
|
exports.SalePriceCurrencyCodeEnum = {
|
|
125
|
-
Gbp: 'GBP'
|
|
127
|
+
Gbp: 'GBP',
|
|
126
128
|
};
|
|
127
129
|
exports.TextApplicationPropertiesFontWeightEnum = {
|
|
128
130
|
Lighter: 'lighter',
|
|
129
131
|
Normal: 'normal',
|
|
130
132
|
Bold: 'bold',
|
|
131
|
-
Bolder: 'bolder'
|
|
133
|
+
Bolder: 'bolder',
|
|
132
134
|
};
|
|
133
135
|
exports.TextApplicationPropertiesFontStyleEnum = {
|
|
134
136
|
Normal: 'normal',
|
|
135
137
|
Italic: 'italic',
|
|
136
|
-
Oblique: 'oblique'
|
|
138
|
+
Oblique: 'oblique',
|
|
137
139
|
};
|
|
138
140
|
exports.TextApplicationPropertiesPersonalizationTypeEnum = {
|
|
139
141
|
Text: 'text',
|
|
140
|
-
Number: 'number'
|
|
142
|
+
Number: 'number',
|
|
141
143
|
};
|
|
142
144
|
exports.UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = {
|
|
143
145
|
Size: 'Size',
|
|
144
|
-
Colour: 'Colour'
|
|
146
|
+
Colour: 'Colour',
|
|
145
147
|
};
|
|
146
148
|
exports.UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = {
|
|
147
|
-
Gbp: 'GBP'
|
|
149
|
+
Gbp: 'GBP',
|
|
148
150
|
};
|
|
149
151
|
exports.UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = {
|
|
150
|
-
Gbp: 'GBP'
|
|
152
|
+
Gbp: 'GBP',
|
|
151
153
|
};
|
|
152
154
|
/**
|
|
153
155
|
* ApplicationGroupsApi - axios parameter creator
|
|
@@ -2121,10 +2123,24 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
2121
2123
|
* @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.
|
|
2122
2124
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2123
2125
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2126
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2127
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
2128
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
2129
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
2130
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
2131
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
2132
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
2133
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2134
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2135
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2136
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
2137
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
2138
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
2139
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
2124
2140
|
* @param {*} [options] Override http request option.
|
|
2125
2141
|
* @throws {RequiredError}
|
|
2126
2142
|
*/
|
|
2127
|
-
listProducts: (project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options = {}) {
|
|
2143
|
+
listProducts: (project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, pageSize_1, fields_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, createdBefore_1, createdAfter_1, updatedBefore_1, updatedAfter_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, start_1, end_1, dateFilterType_1, maxRetailPrice_1, minRetailPrice_1, pageSize_1, fields_1, dateRangeStartDate_1, dateRangeEndDate_1, minimumRevenue_1, maximumRevenue_1, minimumSales_1, maximumSales_1, minimumBasketPercent_1, maximumBasketPercent_1, minimumTraffic_1, maximumTraffic_1, createdBefore_1, createdAfter_1, updatedBefore_1, updatedAfter_1, ...args_1], void 0, function* (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 = {}) {
|
|
2128
2144
|
// verify required parameter 'project' is not null or undefined
|
|
2129
2145
|
(0, common_1.assertParamExists)('listProducts', 'project', project);
|
|
2130
2146
|
const localVarPath = `/v1/catalog/products`;
|
|
@@ -2179,6 +2195,60 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
2179
2195
|
if (fields !== undefined) {
|
|
2180
2196
|
localVarQueryParameter['fields'] = fields;
|
|
2181
2197
|
}
|
|
2198
|
+
if (dateRangeStartDate !== undefined) {
|
|
2199
|
+
localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate instanceof Date) ?
|
|
2200
|
+
dateRangeStartDate.toISOString() :
|
|
2201
|
+
dateRangeStartDate;
|
|
2202
|
+
}
|
|
2203
|
+
if (dateRangeEndDate !== undefined) {
|
|
2204
|
+
localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate instanceof Date) ?
|
|
2205
|
+
dateRangeEndDate.toISOString() :
|
|
2206
|
+
dateRangeEndDate;
|
|
2207
|
+
}
|
|
2208
|
+
if (minimumRevenue !== undefined) {
|
|
2209
|
+
localVarQueryParameter['minimumRevenue'] = minimumRevenue;
|
|
2210
|
+
}
|
|
2211
|
+
if (maximumRevenue !== undefined) {
|
|
2212
|
+
localVarQueryParameter['maximumRevenue'] = maximumRevenue;
|
|
2213
|
+
}
|
|
2214
|
+
if (minimumSales !== undefined) {
|
|
2215
|
+
localVarQueryParameter['minimumSales'] = minimumSales;
|
|
2216
|
+
}
|
|
2217
|
+
if (maximumSales !== undefined) {
|
|
2218
|
+
localVarQueryParameter['maximumSales'] = maximumSales;
|
|
2219
|
+
}
|
|
2220
|
+
if (minimumBasketPercent !== undefined) {
|
|
2221
|
+
localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
|
|
2222
|
+
}
|
|
2223
|
+
if (maximumBasketPercent !== undefined) {
|
|
2224
|
+
localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
|
|
2225
|
+
}
|
|
2226
|
+
if (minimumTraffic !== undefined) {
|
|
2227
|
+
localVarQueryParameter['minimumTraffic'] = minimumTraffic;
|
|
2228
|
+
}
|
|
2229
|
+
if (maximumTraffic !== undefined) {
|
|
2230
|
+
localVarQueryParameter['maximumTraffic'] = maximumTraffic;
|
|
2231
|
+
}
|
|
2232
|
+
if (createdBefore !== undefined) {
|
|
2233
|
+
localVarQueryParameter['createdBefore'] = (createdBefore instanceof Date) ?
|
|
2234
|
+
createdBefore.toISOString() :
|
|
2235
|
+
createdBefore;
|
|
2236
|
+
}
|
|
2237
|
+
if (createdAfter !== undefined) {
|
|
2238
|
+
localVarQueryParameter['createdAfter'] = (createdAfter instanceof Date) ?
|
|
2239
|
+
createdAfter.toISOString() :
|
|
2240
|
+
createdAfter;
|
|
2241
|
+
}
|
|
2242
|
+
if (updatedBefore !== undefined) {
|
|
2243
|
+
localVarQueryParameter['updatedBefore'] = (updatedBefore instanceof Date) ?
|
|
2244
|
+
updatedBefore.toISOString() :
|
|
2245
|
+
updatedBefore;
|
|
2246
|
+
}
|
|
2247
|
+
if (updatedAfter !== undefined) {
|
|
2248
|
+
localVarQueryParameter['updatedAfter'] = (updatedAfter instanceof Date) ?
|
|
2249
|
+
updatedAfter.toISOString() :
|
|
2250
|
+
updatedAfter;
|
|
2251
|
+
}
|
|
2182
2252
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
2183
2253
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
2184
2254
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -2462,13 +2532,27 @@ const ProductsApiFp = function (configuration) {
|
|
|
2462
2532
|
* @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.
|
|
2463
2533
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2464
2534
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2535
|
+
* @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
|
|
2536
|
+
* @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
|
|
2537
|
+
* @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
|
|
2538
|
+
* @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
|
|
2539
|
+
* @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
|
|
2540
|
+
* @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
|
|
2541
|
+
* @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
|
|
2542
|
+
* @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
|
|
2543
|
+
* @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
|
|
2544
|
+
* @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
|
|
2545
|
+
* @param {string} [createdBefore] Filter to only include products created before the given date
|
|
2546
|
+
* @param {string} [createdAfter] Filter to only include products created after the given date
|
|
2547
|
+
* @param {string} [updatedBefore] Filter to only include products updated before the given date
|
|
2548
|
+
* @param {string} [updatedAfter] Filter to only include products updated after the given date
|
|
2465
2549
|
* @param {*} [options] Override http request option.
|
|
2466
2550
|
* @throws {RequiredError}
|
|
2467
2551
|
*/
|
|
2468
|
-
listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options) {
|
|
2552
|
+
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) {
|
|
2469
2553
|
return __awaiter(this, void 0, void 0, function* () {
|
|
2470
2554
|
var _a, _b, _c;
|
|
2471
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options);
|
|
2555
|
+
const localVarAxiosArgs = yield 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);
|
|
2472
2556
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2473
2557
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.listProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2474
2558
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2613,7 +2697,7 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
2613
2697
|
* @throws {RequiredError}
|
|
2614
2698
|
*/
|
|
2615
2699
|
listProducts(requestParameters, options) {
|
|
2616
|
-
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));
|
|
2700
|
+
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));
|
|
2617
2701
|
},
|
|
2618
2702
|
/**
|
|
2619
2703
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -2730,7 +2814,7 @@ class ProductsApi extends base_1.BaseAPI {
|
|
|
2730
2814
|
* @throws {RequiredError}
|
|
2731
2815
|
*/
|
|
2732
2816
|
listProducts(requestParameters, options) {
|
|
2733
|
-
return (0, exports.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));
|
|
2817
|
+
return (0, exports.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));
|
|
2734
2818
|
}
|
|
2735
2819
|
/**
|
|
2736
2820
|
* AI SEO optimises products by a set of given IDs.
|
|
@@ -2766,11 +2850,11 @@ class ProductsApi extends base_1.BaseAPI {
|
|
|
2766
2850
|
exports.ProductsApi = ProductsApi;
|
|
2767
2851
|
exports.ExportProductsDateFilterTypeEnum = {
|
|
2768
2852
|
CreatedAt: 'createdAt',
|
|
2769
|
-
UpdatedAt: 'updatedAt'
|
|
2853
|
+
UpdatedAt: 'updatedAt',
|
|
2770
2854
|
};
|
|
2771
2855
|
exports.ListProductsDateFilterTypeEnum = {
|
|
2772
2856
|
CreatedAt: 'createdAt',
|
|
2773
|
-
UpdatedAt: 'updatedAt'
|
|
2857
|
+
UpdatedAt: 'updatedAt',
|
|
2774
2858
|
};
|
|
2775
2859
|
/**
|
|
2776
2860
|
* VariantsApi - axios parameter creator
|
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.91.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.91.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.91.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.91.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog
|
|
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).
|
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.91.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|