@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/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.90.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
- * Technology to use for the application.
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
- * Technology to use for the application.
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/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.90.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).
@@ -29,7 +29,7 @@ import { BASE_PATH, BaseAPI, operationServerMap } from './base';
29
29
  export const ActionImpactEnum = {
30
30
  High: 'high',
31
31
  Medium: 'medium',
32
- Low: 'low'
32
+ Low: 'low',
33
33
  };
34
34
  export const ApplicationTechnologyEnum = {
35
35
  Dtg: 'dtg',
@@ -37,40 +37,41 @@ export const ApplicationTechnologyEnum = {
37
37
  Dtf: 'dtf',
38
38
  Pretreat: 'pretreat',
39
39
  MugSublimation: 'mug_sublimation',
40
+ SublimationSmall: 'sublimation_small',
40
41
  ManualPrint: 'manual_print',
41
42
  AdditionalApplication: 'additional_application',
42
43
  NotebookSublimation: 'notebook_sublimation',
43
44
  DuplexPrint: 'duplex_print',
44
- DuplexInsert: 'duplex_insert'
45
+ DuplexInsert: 'duplex_insert',
45
46
  };
46
47
  export const ApplicationPlacementEnum = {
47
48
  Front: 'front',
48
49
  Back: 'back',
49
50
  Left: 'left',
50
51
  Right: 'right',
51
- Neck: 'neck'
52
+ Neck: 'neck',
52
53
  };
53
54
  export const ApplicationPropertiesPersonalizationRulesFitEnum = {
54
55
  Contain: 'contain',
55
56
  Cover: 'cover',
56
57
  Stretch: 'stretch',
57
- Crop: 'crop'
58
+ Crop: 'crop',
58
59
  };
59
60
  export const ApplicationPropertiesPropertiesFontWeightEnum = {
60
61
  Lighter: 'lighter',
61
62
  Normal: 'normal',
62
63
  Bold: 'bold',
63
- Bolder: 'bolder'
64
+ Bolder: 'bolder',
64
65
  };
65
66
  export const ApplicationPropertiesPropertiesFontStyleEnum = {
66
67
  Normal: 'normal',
67
68
  Italic: 'italic',
68
- Oblique: 'oblique'
69
+ Oblique: 'oblique',
69
70
  };
70
71
  export const AttributeThumbnailTypeEnum = {
71
72
  Text: 'text',
72
73
  Color: 'color',
73
- Image: 'image'
74
+ Image: 'image',
74
75
  };
75
76
  export const CreateApplicationTechnologyEnum = {
76
77
  Dtg: 'dtg',
@@ -78,72 +79,73 @@ export const CreateApplicationTechnologyEnum = {
78
79
  Dtf: 'dtf',
79
80
  Pretreat: 'pretreat',
80
81
  MugSublimation: 'mug_sublimation',
82
+ SublimationSmall: 'sublimation_small',
81
83
  ManualPrint: 'manual_print',
82
84
  AdditionalApplication: 'additional_application',
83
85
  NotebookSublimation: 'notebook_sublimation',
84
86
  DuplexPrint: 'duplex_print',
85
- DuplexInsert: 'duplex_insert'
87
+ DuplexInsert: 'duplex_insert',
86
88
  };
87
89
  export const CreateApplicationPlacementEnum = {
88
90
  Front: 'front',
89
91
  Back: 'back',
90
92
  Left: 'left',
91
93
  Right: 'right',
92
- Neck: 'neck'
94
+ Neck: 'neck',
93
95
  };
94
96
  export const CreateApplicationPropertiesFontWeightEnum = {
95
97
  Lighter: 'lighter',
96
98
  Normal: 'normal',
97
99
  Bold: 'bold',
98
- Bolder: 'bolder'
100
+ Bolder: 'bolder',
99
101
  };
100
102
  export const CreateApplicationPropertiesFontStyleEnum = {
101
103
  Normal: 'normal',
102
104
  Italic: 'italic',
103
- Oblique: 'oblique'
105
+ Oblique: 'oblique',
104
106
  };
105
107
  export const CreateProductVariantAttributesInnerNameEnum = {
106
108
  Size: 'Size',
107
- Colour: 'Colour'
109
+ Colour: 'Colour',
108
110
  };
109
111
  export const PriceCurrencyCodeEnum = {
110
- Gbp: 'GBP'
112
+ Gbp: 'GBP',
111
113
  };
112
114
  export const RecommendationPriorityEnum = {
113
115
  High: 'high',
114
116
  Medium: 'medium',
115
- Low: 'low'
117
+ Low: 'low',
116
118
  };
117
119
  export const RequiredPriceCurrencyCodeEnum = {
118
- Gbp: 'GBP'
120
+ Gbp: 'GBP',
119
121
  };
120
122
  export const SalePriceCurrencyCodeEnum = {
121
- Gbp: 'GBP'
123
+ Gbp: 'GBP',
122
124
  };
123
125
  export const TextApplicationPropertiesFontWeightEnum = {
124
126
  Lighter: 'lighter',
125
127
  Normal: 'normal',
126
128
  Bold: 'bold',
127
- Bolder: 'bolder'
129
+ Bolder: 'bolder',
128
130
  };
129
131
  export const TextApplicationPropertiesFontStyleEnum = {
130
132
  Normal: 'normal',
131
133
  Italic: 'italic',
132
- Oblique: 'oblique'
134
+ Oblique: 'oblique',
133
135
  };
134
136
  export const TextApplicationPropertiesPersonalizationTypeEnum = {
135
137
  Text: 'text',
136
- Number: 'number'
138
+ Number: 'number',
137
139
  };
138
140
  export const UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = {
139
141
  Size: 'Size',
140
- Colour: 'Colour'
142
+ Colour: 'Colour',
141
143
  };
142
144
  export const UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = {
143
- Gbp: 'GBP'
145
+ Gbp: 'GBP',
144
146
  };
145
147
  export const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = {
146
- Gbp: 'GBP'
148
+ Gbp: 'GBP',
147
149
  };
148
150
  /**
149
151
  * ApplicationGroupsApi - axios parameter creator
@@ -2093,10 +2095,24 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
2093
2095
  * @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.
2094
2096
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2095
2097
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
2098
+ * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
2099
+ * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
2100
+ * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
2101
+ * @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
2102
+ * @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
2103
+ * @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
2104
+ * @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
2105
+ * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
2106
+ * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
2107
+ * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
2108
+ * @param {string} [createdBefore] Filter to only include products created before the given date
2109
+ * @param {string} [createdAfter] Filter to only include products created after the given date
2110
+ * @param {string} [updatedBefore] Filter to only include products updated before the given date
2111
+ * @param {string} [updatedAfter] Filter to only include products updated after the given date
2096
2112
  * @param {*} [options] Override http request option.
2097
2113
  * @throws {RequiredError}
2098
2114
  */
2099
- 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 = {}) {
2115
+ 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 = {}) {
2100
2116
  // verify required parameter 'project' is not null or undefined
2101
2117
  assertParamExists('listProducts', 'project', project);
2102
2118
  const localVarPath = `/v1/catalog/products`;
@@ -2151,6 +2167,60 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
2151
2167
  if (fields !== undefined) {
2152
2168
  localVarQueryParameter['fields'] = fields;
2153
2169
  }
2170
+ if (dateRangeStartDate !== undefined) {
2171
+ localVarQueryParameter['dateRangeStartDate'] = (dateRangeStartDate instanceof Date) ?
2172
+ dateRangeStartDate.toISOString() :
2173
+ dateRangeStartDate;
2174
+ }
2175
+ if (dateRangeEndDate !== undefined) {
2176
+ localVarQueryParameter['dateRangeEndDate'] = (dateRangeEndDate instanceof Date) ?
2177
+ dateRangeEndDate.toISOString() :
2178
+ dateRangeEndDate;
2179
+ }
2180
+ if (minimumRevenue !== undefined) {
2181
+ localVarQueryParameter['minimumRevenue'] = minimumRevenue;
2182
+ }
2183
+ if (maximumRevenue !== undefined) {
2184
+ localVarQueryParameter['maximumRevenue'] = maximumRevenue;
2185
+ }
2186
+ if (minimumSales !== undefined) {
2187
+ localVarQueryParameter['minimumSales'] = minimumSales;
2188
+ }
2189
+ if (maximumSales !== undefined) {
2190
+ localVarQueryParameter['maximumSales'] = maximumSales;
2191
+ }
2192
+ if (minimumBasketPercent !== undefined) {
2193
+ localVarQueryParameter['minimumBasketPercent'] = minimumBasketPercent;
2194
+ }
2195
+ if (maximumBasketPercent !== undefined) {
2196
+ localVarQueryParameter['maximumBasketPercent'] = maximumBasketPercent;
2197
+ }
2198
+ if (minimumTraffic !== undefined) {
2199
+ localVarQueryParameter['minimumTraffic'] = minimumTraffic;
2200
+ }
2201
+ if (maximumTraffic !== undefined) {
2202
+ localVarQueryParameter['maximumTraffic'] = maximumTraffic;
2203
+ }
2204
+ if (createdBefore !== undefined) {
2205
+ localVarQueryParameter['createdBefore'] = (createdBefore instanceof Date) ?
2206
+ createdBefore.toISOString() :
2207
+ createdBefore;
2208
+ }
2209
+ if (createdAfter !== undefined) {
2210
+ localVarQueryParameter['createdAfter'] = (createdAfter instanceof Date) ?
2211
+ createdAfter.toISOString() :
2212
+ createdAfter;
2213
+ }
2214
+ if (updatedBefore !== undefined) {
2215
+ localVarQueryParameter['updatedBefore'] = (updatedBefore instanceof Date) ?
2216
+ updatedBefore.toISOString() :
2217
+ updatedBefore;
2218
+ }
2219
+ if (updatedAfter !== undefined) {
2220
+ localVarQueryParameter['updatedAfter'] = (updatedAfter instanceof Date) ?
2221
+ updatedAfter.toISOString() :
2222
+ updatedAfter;
2223
+ }
2154
2224
  localVarHeaderParameter['Accept'] = 'application/json';
2155
2225
  setSearchParams(localVarUrlObj, localVarQueryParameter);
2156
2226
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -2433,13 +2503,27 @@ export const ProductsApiFp = function (configuration) {
2433
2503
  * @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.
2434
2504
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2435
2505
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
2506
+ * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
2507
+ * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
2508
+ * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
2509
+ * @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
2510
+ * @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
2511
+ * @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
2512
+ * @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
2513
+ * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
2514
+ * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
2515
+ * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
2516
+ * @param {string} [createdBefore] Filter to only include products created before the given date
2517
+ * @param {string} [createdAfter] Filter to only include products created after the given date
2518
+ * @param {string} [updatedBefore] Filter to only include products updated before the given date
2519
+ * @param {string} [updatedAfter] Filter to only include products updated after the given date
2436
2520
  * @param {*} [options] Override http request option.
2437
2521
  * @throws {RequiredError}
2438
2522
  */
2439
- listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options) {
2523
+ 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) {
2440
2524
  return __awaiter(this, void 0, void 0, function* () {
2441
2525
  var _a, _b, _c;
2442
- const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, start, end, dateFilterType, maxRetailPrice, minRetailPrice, pageSize, fields, options);
2526
+ 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);
2443
2527
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
2444
2528
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.listProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
2445
2529
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2583,7 +2667,7 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
2583
2667
  * @throws {RequiredError}
2584
2668
  */
2585
2669
  listProducts(requestParameters, options) {
2586
- 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));
2670
+ 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));
2587
2671
  },
2588
2672
  /**
2589
2673
  * AI SEO optimises products by a set of given IDs.
@@ -2699,7 +2783,7 @@ export class ProductsApi extends BaseAPI {
2699
2783
  * @throws {RequiredError}
2700
2784
  */
2701
2785
  listProducts(requestParameters, options) {
2702
- 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));
2786
+ 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));
2703
2787
  }
2704
2788
  /**
2705
2789
  * AI SEO optimises products by a set of given IDs.
@@ -2734,11 +2818,11 @@ export class ProductsApi extends BaseAPI {
2734
2818
  }
2735
2819
  export const ExportProductsDateFilterTypeEnum = {
2736
2820
  CreatedAt: 'createdAt',
2737
- UpdatedAt: 'updatedAt'
2821
+ UpdatedAt: 'updatedAt',
2738
2822
  };
2739
2823
  export const ListProductsDateFilterTypeEnum = {
2740
2824
  CreatedAt: 'createdAt',
2741
- UpdatedAt: 'updatedAt'
2825
+ UpdatedAt: 'updatedAt',
2742
2826
  };
2743
2827
  /**
2744
2828
  * VariantsApi - axios parameter creator
@@ -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.90.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/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.90.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).
@@ -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.90.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).
@@ -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.90.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).
@@ -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.90.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).
@@ -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.90.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).
@@ -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.90.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/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Product Catalog
5
5
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.90.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/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product Catalog
3
3
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.90.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/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Product Catalog
6
6
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a product from the GFN Catalog, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.90.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).
@@ -6,7 +6,7 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **id** | **string** | Unique object identifier | [optional] [default to undefined]
9
- **technology** | **string** | Technology to use for the application. | [default to undefined]
9
+ **technology** | **string** | The application technology used for this design application. &#x60;mug_sublimation&#x60; is deprecated. Use &#x60;sublimation_small&#x60; instead. | [default to undefined]
10
10
  **placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
11
11
  **additionalInstructions** | **string** | Any additional instructions for the application | [optional] [default to undefined]
12
12
  **src** | **string** | Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area. | [optional] [default to undefined]
@@ -5,7 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **technology** | **string** | Technology to use for the application. | [default to undefined]
8
+ **technology** | **string** | The application technology used for this design application. &#x60;mug_sublimation&#x60; is deprecated. Use &#x60;sublimation_small&#x60; instead. | [default to undefined]
9
9
  **placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
10
10
  **additionalInstructions** | **string** | Any additional instructions for the application | [optional] [default to undefined]
11
11
  **src** | **string** | Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area. | [default to undefined]
package/docs/Product.md CHANGED
@@ -45,6 +45,7 @@ Name | Type | Description | Notes
45
45
  **license** | [**License**](License.md) | | [optional] [default to undefined]
46
46
  **createdBy** | **string** | The user ID of the user who created the product | [optional] [default to undefined]
47
47
  **isDigital** | **boolean** | Whether the product is digital | [optional] [default to false]
48
+ **analytics** | [**ProductAnalytics**](ProductAnalytics.md) | | [optional] [default to undefined]
48
49
 
49
50
  ## Example
50
51
 
@@ -92,6 +93,7 @@ const instance: Product = {
92
93
  license,
93
94
  createdBy,
94
95
  isDigital,
96
+ analytics,
95
97
  };
96
98
  ```
97
99