@teemill/product-catalog 1.92.0 → 1.93.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.
Files changed (70) hide show
  1. package/.openapi-generator/FILES +0 -1
  2. package/README.md +2 -3
  3. package/api.ts +284 -49
  4. package/base.ts +1 -1
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/api.d.ts +258 -43
  8. package/dist/api.js +35 -15
  9. package/dist/base.d.ts +1 -1
  10. package/dist/base.js +1 -1
  11. package/dist/common.d.ts +1 -1
  12. package/dist/common.js +1 -1
  13. package/dist/configuration.d.ts +1 -1
  14. package/dist/configuration.js +1 -1
  15. package/dist/esm/api.d.ts +258 -43
  16. package/dist/esm/api.js +35 -15
  17. package/dist/esm/base.d.ts +1 -1
  18. package/dist/esm/base.js +1 -1
  19. package/dist/esm/common.d.ts +1 -1
  20. package/dist/esm/common.js +1 -1
  21. package/dist/esm/configuration.d.ts +1 -1
  22. package/dist/esm/configuration.js +1 -1
  23. package/dist/esm/index.d.ts +1 -1
  24. package/dist/esm/index.js +1 -1
  25. package/dist/index.d.ts +1 -1
  26. package/dist/index.js +1 -1
  27. package/docs/Action.md +2 -1
  28. package/docs/AdditionalFile.md +1 -0
  29. package/docs/AnalyticsItem.md +1 -0
  30. package/docs/AnalyticsSummary.md +1 -0
  31. package/docs/ApiError.md +3 -2
  32. package/docs/Application.md +5 -2
  33. package/docs/ApplicationGroup.md +3 -2
  34. package/docs/ApplicationProperties.md +1 -0
  35. package/docs/ApplicationPropertiesPersonalization.md +1 -0
  36. package/docs/ApplicationSet.md +3 -2
  37. package/docs/ApplicationSetRecord.md +2 -1
  38. package/docs/ApplicationTechnologiesApi.md +7 -1
  39. package/docs/ApplicationTechnology.md +2 -1
  40. package/docs/BundleProduct.md +9 -8
  41. package/docs/CreateApplication.md +4 -1
  42. package/docs/CreateBundleProduct.md +2 -1
  43. package/docs/CreateProduct.md +1 -0
  44. package/docs/CreateProductRequest.md +1 -1
  45. package/docs/CreateProductVariant.md +1 -0
  46. package/docs/Image.md +2 -2
  47. package/docs/ImageFile.md +1 -0
  48. package/docs/Location.md +1 -0
  49. package/docs/NamedPrice.md +2 -1
  50. package/docs/OptimisationHistoryItem.md +3 -2
  51. package/docs/Product.md +9 -8
  52. package/docs/ProductAnalyticsApi.md +2 -2
  53. package/docs/ProductBundleItemsInner.md +8 -8
  54. package/docs/ProductCreatorsApi.md +7 -1
  55. package/docs/ProductType.md +2 -1
  56. package/docs/ProductsApi.md +6 -6
  57. package/docs/Recommendation.md +2 -1
  58. package/docs/Stock.md +3 -2
  59. package/docs/TargetSearchPhraseData.md +1 -0
  60. package/docs/TextApplicationProperties.md +1 -0
  61. package/docs/TextApplicationPropertiesPersonalization.md +1 -0
  62. package/docs/UpdateProductRequest.md +2 -2
  63. package/docs/UpdateProductRequestBundleItemsInner.md +1 -1
  64. package/docs/UserList.md +2 -1
  65. package/docs/Variant.md +5 -4
  66. package/docs/VariantWholesaleCost.md +2 -2
  67. package/docs/Video.md +2 -2
  68. package/docs/VideoFile.md +1 -0
  69. package/index.ts +1 -1
  70. package/package.json +2 -2
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.92.0
5
+ * The version of the OpenAPI document: 1.93.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,9 +13,12 @@ import type { Configuration } from './configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import type { RequestArgs } from './base';
15
15
  import { BaseAPI } from './base';
16
+ /**
17
+ * A specific action that can be taken to implement a recommendation.
18
+ */
16
19
  export interface Action {
17
20
  /**
18
- * Unique object identifier
21
+ * The unique identifier of this action.
19
22
  */
20
23
  'id': string;
21
24
  /**
@@ -40,12 +43,18 @@ export declare const ActionImpactEnum: {
40
43
  readonly Low: "low";
41
44
  };
42
45
  export type ActionImpactEnum = typeof ActionImpactEnum[keyof typeof ActionImpactEnum];
46
+ /**
47
+ * An additional file to attach to a product (e.g. size guide, care instructions).
48
+ */
43
49
  export interface AdditionalFile {
44
50
  /**
45
51
  * Publicly available file URL.
46
52
  */
47
53
  'src'?: string;
48
54
  }
55
+ /**
56
+ * Analytics data for a product including revenue, sales, traffic, and conversion metrics.
57
+ */
49
58
  export interface AnalyticsItem {
50
59
  /**
51
60
  * Unique object identifier
@@ -72,6 +81,9 @@ export interface AnalyticsItem {
72
81
  */
73
82
  'revenue': number;
74
83
  }
84
+ /**
85
+ * An AI-generated summary of product analytics with actionable recommendations.
86
+ */
75
87
  export interface AnalyticsSummary {
76
88
  /**
77
89
  * A summary of the recommendations
@@ -81,13 +93,25 @@ export interface AnalyticsSummary {
81
93
  'createdAt': string;
82
94
  'updatedAt': string;
83
95
  }
96
+ /**
97
+ * Represents an error returned by the API.
98
+ */
84
99
  export interface ApiError {
100
+ /**
101
+ * A machine-readable error code identifying the type of error.
102
+ */
85
103
  'code'?: string;
104
+ /**
105
+ * A human-readable message providing more details about the error.
106
+ */
86
107
  'message': string;
87
108
  }
109
+ /**
110
+ * A design application on a product variant, specifying the technology, placement, design file, and optional personalisation.
111
+ */
88
112
  export interface Application {
89
113
  /**
90
- * Unique object identifier
114
+ * The unique identifier of this application.
91
115
  */
92
116
  'id'?: string;
93
117
  /**
@@ -103,9 +127,13 @@ export interface Application {
103
127
  */
104
128
  'additionalInstructions'?: string | null;
105
129
  /**
106
- * 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.
130
+ * Publicly available production print file URL for this application. For raster-only applications, this can also be used directly as the display image.
107
131
  */
108
132
  'src'?: string;
133
+ /**
134
+ * Optional display preview file URL. When provided alongside `src`, `src` is treated as the production print file and `displaySrc` is treated as the rasterized preview. Useful for technologies where the print file is non-rasterizable, e.g. Embroidery.
135
+ */
136
+ 'displaySrc'?: string | null;
109
137
  /**
110
138
  * A reference to the application group. The src across all applications in the same group will be considered the same src. The is useful for DTF when using the same transfer across multiple products.
111
139
  */
@@ -139,13 +167,16 @@ export declare const ApplicationPlacementEnum: {
139
167
  readonly Neck: "neck";
140
168
  };
141
169
  export type ApplicationPlacementEnum = typeof ApplicationPlacementEnum[keyof typeof ApplicationPlacementEnum];
170
+ /**
171
+ * A named group of design applications that can be reused across multiple products.
172
+ */
142
173
  export interface ApplicationGroup {
143
174
  /**
144
- * Unique object identifier
175
+ * The unique identifier of the application group.
145
176
  */
146
177
  'id': string;
147
178
  /**
148
- * A reference to the application group resource location
179
+ * A URI reference to this application group resource.
149
180
  */
150
181
  'ref': string;
151
182
  /**
@@ -172,6 +203,9 @@ export interface ApplicationMockup {
172
203
  */
173
204
  'preview'?: string;
174
205
  }
206
+ /**
207
+ * Properties of a design application including dimensions, position, and optional personalisation rules. Null when the application has no configurable properties.
208
+ */
175
209
  export interface ApplicationProperties {
176
210
  /**
177
211
  * Width of the application in pixels
@@ -192,6 +226,9 @@ export interface ApplicationPropertiesMetadata {
192
226
  * @type ApplicationPropertiesMetadataPersonalization
193
227
  */
194
228
  export type ApplicationPropertiesMetadataPersonalization = ApplicationPropertiesPersonalization | TextApplicationPropertiesPersonalization;
229
+ /**
230
+ * Personalisation configuration for a design application, allowing end-users to customise the design.
231
+ */
195
232
  export interface ApplicationPropertiesPersonalization {
196
233
  /**
197
234
  * The label to be displayed on the personalization field.
@@ -296,13 +333,16 @@ export declare const ApplicationPropertiesPropertiesFontStyleEnum: {
296
333
  readonly Oblique: "oblique";
297
334
  };
298
335
  export type ApplicationPropertiesPropertiesFontStyleEnum = typeof ApplicationPropertiesPropertiesFontStyleEnum[keyof typeof ApplicationPropertiesPropertiesFontStyleEnum];
336
+ /**
337
+ * A set of application records that defines which design applications are applied to which variants.
338
+ */
299
339
  export interface ApplicationSet {
300
340
  /**
301
- * Unique object identifier
341
+ * The unique identifier of the application set.
302
342
  */
303
343
  'id': string;
304
344
  /**
305
- * A reference to the application set resource location
345
+ * A URI reference to this application set resource.
306
346
  */
307
347
  'ref': string;
308
348
  /**
@@ -342,9 +382,12 @@ export interface ApplicationSet1 {
342
382
  */
343
383
  'ref'?: string;
344
384
  }
385
+ /**
386
+ * A record within an application set, linking a specific application to a set.
387
+ */
345
388
  export interface ApplicationSetRecord {
346
389
  /**
347
- * Unique object identifier
390
+ * The unique identifier of this record.
348
391
  */
349
392
  'id'?: string;
350
393
  'set'?: ApplicationSet1;
@@ -367,9 +410,12 @@ export interface ApplicationSetsResponse {
367
410
  export interface ApplicationTechnologiesResponse {
368
411
  'applicationTechnologies'?: Array<ApplicationTechnology>;
369
412
  }
413
+ /**
414
+ * A print or application technology available for use on catalog products.
415
+ */
370
416
  export interface ApplicationTechnology {
371
417
  /**
372
- * Unique object identifier
418
+ * The unique identifier of the technology.
373
419
  */
374
420
  'id'?: string;
375
421
  /**
@@ -424,15 +470,21 @@ export interface Attributes1Inner {
424
470
  'name'?: string;
425
471
  'value'?: string;
426
472
  }
473
+ /**
474
+ * A bundle product that groups multiple items together at a combined price.
475
+ */
427
476
  export interface BundleProduct {
428
477
  /**
429
- * Unique object identifier
478
+ * The unique identifier of the bundle product.
430
479
  */
431
480
  'id'?: string;
432
481
  /**
433
- * A reference to the resource location
482
+ * A URI reference to this bundle product resource.
434
483
  */
435
484
  'ref'?: string;
485
+ /**
486
+ * The display title of the bundle product.
487
+ */
436
488
  'title': string;
437
489
  'description': string;
438
490
  'slug'?: string;
@@ -457,7 +509,13 @@ export interface BundleProduct {
457
509
  * Variants
458
510
  */
459
511
  'variants'?: Array<Variant>;
512
+ /**
513
+ * The retail price of the product, including tax. Only provided if the product is a bundle.
514
+ */
460
515
  'retailPrice'?: Price;
516
+ /**
517
+ * The sale price of the product, including tax. Only provided if the product is a bundle.
518
+ */
461
519
  'salePrice'?: SalePrice | null;
462
520
  /**
463
521
  * Additional files attached to the product.
@@ -475,12 +533,21 @@ export interface BundleProduct {
475
533
  * A count of reviews. This field is only present if included in the fields query parameter
476
534
  */
477
535
  'reviewCount'?: number;
536
+ /**
537
+ * A unique identifier for a specific variant (product + colour + size).
538
+ */
478
539
  'sku'?: string;
479
540
  /**
480
541
  * A count of sales. This field is only present if included in the fields query parameter
481
542
  */
482
543
  'sales'?: number;
544
+ /**
545
+ * The start of the window in which sales are counted
546
+ */
483
547
  'salesStart'?: string;
548
+ /**
549
+ * The end of the window in which sales are counted
550
+ */
484
551
  'salesEnd'?: string;
485
552
  'includeInDataFeeds'?: boolean;
486
553
  /**
@@ -511,6 +578,9 @@ export interface BundleProduct {
511
578
  'showSaleBadge'?: boolean;
512
579
  'license'?: License;
513
580
  }
581
+ /**
582
+ * The payload for creating a new design application on a product variant.
583
+ */
514
584
  export interface CreateApplication {
515
585
  /**
516
586
  * The application technology used for this design application. `mug_sublimation` is deprecated. Use `sublimation_small` instead.
@@ -525,9 +595,13 @@ export interface CreateApplication {
525
595
  */
526
596
  'additionalInstructions'?: string | null;
527
597
  /**
528
- * 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.
598
+ * Publicly available production print file URL for this application. For raster-only applications, this can also be used directly as the display image.
529
599
  */
530
600
  'src': string;
601
+ /**
602
+ * Optional display preview file URL. When provided alongside `src`, `src` is treated as the production print file and `displaySrc` is treated as the rasterized preview. Useful for technologies where the print file is non-rasterizable, e.g. Embroidery.
603
+ */
604
+ 'displaySrc'?: string | null;
531
605
  /**
532
606
  * A reference to the application group. The src across all applications in the same group will be considered the same src. The is useful for DTF when using the same transfer across multiple products.
533
607
  */
@@ -666,6 +740,9 @@ export interface CreateApplicationSetRequestRecordsInnerAttributesInner {
666
740
  */
667
741
  'value': string;
668
742
  }
743
+ /**
744
+ * The payload for creating a new bundle product that groups multiple items together.
745
+ */
669
746
  export interface CreateBundleProduct {
670
747
  /**
671
748
  * Product title
@@ -723,17 +800,11 @@ export interface CreateBundleProduct {
723
800
  /**
724
801
  * A list of product uuids to include in this bundle
725
802
  */
726
- 'bundleItems': Array<CreateBundleProductBundleItemsInner>;
803
+ 'bundleItems': Array<UpdateProductRequestBundleItemsInner>;
727
804
  'retailPrice'?: Price;
728
805
  'salePrice'?: SalePrice | null;
729
806
  'price'?: Price;
730
807
  }
731
- export interface CreateBundleProductBundleItemsInner {
732
- /**
733
- * Unique object identifier
734
- */
735
- 'id'?: string;
736
- }
737
808
  export interface CreateBundleProductSeoMetadata {
738
809
  /**
739
810
  * Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
@@ -788,6 +859,9 @@ export interface CreateDigitalProductVariantsInnerImagesInner {
788
859
  */
789
860
  'src': string;
790
861
  }
862
+ /**
863
+ * The payload for creating a new catalog product from a GFN base product.
864
+ */
791
865
  export interface CreateProduct {
792
866
  /**
793
867
  * Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
@@ -892,6 +966,9 @@ export interface CreateProductImagesInner {
892
966
  * @type CreateProductRequest
893
967
  */
894
968
  export type CreateProductRequest = CreateBundleProduct | CreateDigitalProduct | CreateProduct;
969
+ /**
970
+ * The payload for creating a new variant on a catalog product.
971
+ */
895
972
  export interface CreateProductVariant {
896
973
  /**
897
974
  * One entry per attribute (e.g. Size, Colour). The name and value of each attribute must match the GFN Catalog API exactly — use the GFN Catalog API to list the product and its variants to get the exact strings (casing and spelling must match).
@@ -978,11 +1055,11 @@ export interface ExportProducts202Response {
978
1055
  'message'?: string;
979
1056
  }
980
1057
  /**
981
- * Image description
1058
+ * An image associated with a product or variant.
982
1059
  */
983
1060
  export interface Image {
984
1061
  /**
985
- * Unique object identifier
1062
+ * The unique identifier of the image.
986
1063
  */
987
1064
  'id'?: string;
988
1065
  'src': string;
@@ -996,6 +1073,9 @@ export interface Image {
996
1073
  'createdAt'?: string;
997
1074
  'updatedAt'?: string;
998
1075
  }
1076
+ /**
1077
+ * An image file to attach to a product, specified by a publicly available URL.
1078
+ */
999
1079
  export interface ImageFile {
1000
1080
  /**
1001
1081
  * Publicly available file URL.
@@ -1051,6 +1131,9 @@ export interface License {
1051
1131
  */
1052
1132
  'expiresAt'?: string;
1053
1133
  }
1134
+ /**
1135
+ * A stock location showing the number of units available at a specific warehouse location.
1136
+ */
1054
1137
  export interface Location {
1055
1138
  /**
1056
1139
  * The total number of units available at the location
@@ -1074,18 +1157,30 @@ export interface MetaField {
1074
1157
  */
1075
1158
  'value': string;
1076
1159
  }
1160
+ /**
1161
+ * A named price component (e.g. Fulfillment, Application) with its amount and currency.
1162
+ */
1077
1163
  export interface NamedPrice {
1078
1164
  /**
1079
1165
  * The name of the price
1080
1166
  */
1081
1167
  'name': string;
1168
+ /**
1169
+ * The price amount and currency.
1170
+ */
1082
1171
  'price': RequiredPrice;
1083
1172
  }
1173
+ /**
1174
+ * A record of an AI SEO optimisation performed on a product.
1175
+ */
1084
1176
  export interface OptimisationHistoryItem {
1085
1177
  /**
1086
- * Unique object identifier
1178
+ * The unique identifier of this optimisation.
1087
1179
  */
1088
1180
  'id'?: string;
1181
+ /**
1182
+ * The timestamp when this optimisation was performed.
1183
+ */
1089
1184
  'createdAt'?: string;
1090
1185
  }
1091
1186
  /**
@@ -1105,15 +1200,21 @@ export declare const PriceCurrencyCodeEnum: {
1105
1200
  readonly Gbp: "GBP";
1106
1201
  };
1107
1202
  export type PriceCurrencyCodeEnum = typeof PriceCurrencyCodeEnum[keyof typeof PriceCurrencyCodeEnum];
1203
+ /**
1204
+ * A catalog product listing that can be purchased, containing design applications, pricing, variants, and SEO metadata.
1205
+ */
1108
1206
  export interface Product {
1109
1207
  /**
1110
- * Unique object identifier
1208
+ * The unique identifier of the product.
1111
1209
  */
1112
1210
  'id'?: string;
1113
1211
  /**
1114
- * A reference to the resource location
1212
+ * A URI reference to this product resource.
1115
1213
  */
1116
1214
  'ref'?: string;
1215
+ /**
1216
+ * The display title of the product.
1217
+ */
1117
1218
  'title': string;
1118
1219
  'description': string;
1119
1220
  'slug'?: string;
@@ -1142,7 +1243,13 @@ export interface Product {
1142
1243
  * Products in the bundle.
1143
1244
  */
1144
1245
  'bundleItems'?: Array<ProductBundleItemsInner>;
1246
+ /**
1247
+ * The retail price of the product, including tax. Only provided if the product is a bundle.
1248
+ */
1145
1249
  'retailPrice'?: Price;
1250
+ /**
1251
+ * The sale price of the product, including tax. Only provided if the product is a bundle.
1252
+ */
1146
1253
  'salePrice'?: SalePrice | null;
1147
1254
  /**
1148
1255
  * Additional files attached to the product.
@@ -1160,12 +1267,21 @@ export interface Product {
1160
1267
  * A count of reviews. This field is only present if included in the fields query parameter
1161
1268
  */
1162
1269
  'reviewCount'?: number;
1270
+ /**
1271
+ * A unique identifier for a specific variant (product + colour + size).
1272
+ */
1163
1273
  'sku'?: string;
1164
1274
  /**
1165
1275
  * A count of sales. This field is only present if included in the fields query parameter
1166
1276
  */
1167
1277
  'sales'?: number;
1278
+ /**
1279
+ * The start of the window in which sales are counted
1280
+ */
1168
1281
  'salesStart'?: string;
1282
+ /**
1283
+ * The end of the window in which sales are counted
1284
+ */
1169
1285
  'salesEnd'?: string;
1170
1286
  'includeInDataFeeds'?: boolean;
1171
1287
  /**
@@ -1263,13 +1379,16 @@ export interface ProductApplicationSetsInner {
1263
1379
  }
1264
1380
  export interface ProductBundleItemsInner {
1265
1381
  /**
1266
- * Unique object identifier
1382
+ * The unique identifier of the bundle product.
1267
1383
  */
1268
1384
  'id'?: string;
1269
1385
  /**
1270
- * A reference to the resource location
1386
+ * A URI reference to this bundle product resource.
1271
1387
  */
1272
1388
  'ref'?: string;
1389
+ /**
1390
+ * The display title of the bundle product.
1391
+ */
1273
1392
  'title': string;
1274
1393
  'description': string;
1275
1394
  'slug'?: string;
@@ -1294,7 +1413,13 @@ export interface ProductBundleItemsInner {
1294
1413
  * Variants
1295
1414
  */
1296
1415
  'variants'?: Array<Variant>;
1416
+ /**
1417
+ * The retail price of the product, including tax. Only provided if the product is a bundle.
1418
+ */
1297
1419
  'retailPrice'?: Price;
1420
+ /**
1421
+ * The sale price of the product, including tax. Only provided if the product is a bundle.
1422
+ */
1298
1423
  'salePrice'?: SalePrice | null;
1299
1424
  /**
1300
1425
  * Additional files attached to the product.
@@ -1312,12 +1437,21 @@ export interface ProductBundleItemsInner {
1312
1437
  * A count of reviews. This field is only present if included in the fields query parameter
1313
1438
  */
1314
1439
  'reviewCount'?: number;
1440
+ /**
1441
+ * A unique identifier for a specific variant (product + colour + size).
1442
+ */
1315
1443
  'sku'?: string;
1316
1444
  /**
1317
1445
  * A count of sales. This field is only present if included in the fields query parameter
1318
1446
  */
1319
1447
  'sales'?: number;
1448
+ /**
1449
+ * The start of the window in which sales are counted
1450
+ */
1320
1451
  'salesStart'?: string;
1452
+ /**
1453
+ * The end of the window in which sales are counted
1454
+ */
1321
1455
  'salesEnd'?: string;
1322
1456
  'includeInDataFeeds'?: boolean;
1323
1457
  /**
@@ -1370,9 +1504,12 @@ export interface ProductStaticCollectionsInner {
1370
1504
  'id'?: string;
1371
1505
  'title'?: string;
1372
1506
  }
1507
+ /**
1508
+ * A type of product available in the catalog (e.g. Printed T-Shirt, Embroidered Hoodie).
1509
+ */
1373
1510
  export interface ProductType {
1374
1511
  /**
1375
- * Unique object identifier
1512
+ * The unique identifier of the product type.
1376
1513
  */
1377
1514
  'id': string;
1378
1515
  /**
@@ -1411,9 +1548,12 @@ export interface ProductsResponse {
1411
1548
  */
1412
1549
  'nextPageToken'?: number | null;
1413
1550
  }
1551
+ /**
1552
+ * An AI-generated recommendation for improving product performance.
1553
+ */
1414
1554
  export interface Recommendation {
1415
1555
  /**
1416
- * Unique object identifier
1556
+ * The unique identifier of this recommendation.
1417
1557
  */
1418
1558
  'id': string;
1419
1559
  /**
@@ -1519,10 +1659,22 @@ export interface SeoOptimiseProductsRequest {
1519
1659
  */
1520
1660
  'fields'?: Array<string>;
1521
1661
  }
1662
+ /**
1663
+ * Stock availability information including total level and per-location breakdown.
1664
+ */
1522
1665
  export interface Stock {
1666
+ /**
1667
+ * The current total stock level available for purchase.
1668
+ */
1523
1669
  'level'?: number;
1670
+ /**
1671
+ * Stock levels broken down by warehouse location.
1672
+ */
1524
1673
  'locations'?: Array<Location>;
1525
1674
  }
1675
+ /**
1676
+ * Target search phrase configuration for SEO optimisation of a product.
1677
+ */
1526
1678
  export interface TargetSearchPhraseData {
1527
1679
  /**
1528
1680
  * The primary target search phrase for the product that you wish to rank for in search engine results.
@@ -1533,6 +1685,9 @@ export interface TargetSearchPhraseData {
1533
1685
  */
1534
1686
  'targetSearchPhraseSynonyms'?: Array<string>;
1535
1687
  }
1688
+ /**
1689
+ * Properties for a text-based application including font, colour, position, and optional personalisation. Null when the application has no configurable properties.
1690
+ */
1536
1691
  export interface TextApplicationProperties {
1537
1692
  'position'?: TextApplicationPropertiesPosition;
1538
1693
  'positionInference'?: ApplicationPropertiesPositionInference | null;
@@ -1578,6 +1733,9 @@ export declare const TextApplicationPropertiesFontStyleEnum: {
1578
1733
  readonly Oblique: "oblique";
1579
1734
  };
1580
1735
  export type TextApplicationPropertiesFontStyleEnum = typeof TextApplicationPropertiesFontStyleEnum[keyof typeof TextApplicationPropertiesFontStyleEnum];
1736
+ /**
1737
+ * Personalisation configuration for a text application, allowing end-users to customise the text content.
1738
+ */
1581
1739
  export interface TextApplicationPropertiesPersonalization {
1582
1740
  /**
1583
1741
  * The label to be displayed on the personalization field.
@@ -1736,7 +1894,13 @@ export interface UpdateProductRequest {
1736
1894
  * A list of products to be in this bundle. Only valid if the product is already a bundle.
1737
1895
  */
1738
1896
  'bundleItems'?: Array<UpdateProductRequestBundleItemsInner>;
1897
+ /**
1898
+ * The retail price of the product, including tax. Only provided if the product is a bundle.
1899
+ */
1739
1900
  'retailPrice'?: Price;
1901
+ /**
1902
+ * The sale price of the product, including tax. Only provided if the product is a bundle.
1903
+ */
1740
1904
  'salePrice'?: SalePrice | null;
1741
1905
  /**
1742
1906
  * Images to attach to the product. For example, photos of models using/wearing the product.
@@ -1786,7 +1950,7 @@ export interface UpdateProductRequest {
1786
1950
  }
1787
1951
  export interface UpdateProductRequestBundleItemsInner {
1788
1952
  /**
1789
- * Unique object identifier
1953
+ * The product UUID to include in the bundle
1790
1954
  */
1791
1955
  'id'?: string;
1792
1956
  'config'?: UpdateProductRequestBundleItemsInnerConfig;
@@ -1981,7 +2145,13 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCur
1981
2145
  readonly Gbp: "GBP";
1982
2146
  };
1983
2147
  export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
2148
+ /**
2149
+ * A list of users who have created products for the project.
2150
+ */
1984
2151
  export interface UserList {
2152
+ /**
2153
+ * The list of product creators.
2154
+ */
1985
2155
  'creators': Array<UserListCreatorsInner>;
1986
2156
  }
1987
2157
  export interface UserListCreatorsInner {
@@ -2005,18 +2175,24 @@ export interface UserListCreatorsInnerAvatar {
2005
2175
  */
2006
2176
  'original': string | null;
2007
2177
  }
2178
+ /**
2179
+ * A specific colour/size combination of a catalog product with its own SKU, pricing, stock, and design applications.
2180
+ */
2008
2181
  export interface Variant {
2009
2182
  /**
2010
- * Unique object identifier
2183
+ * The unique identifier of the variant.
2011
2184
  */
2012
2185
  'id'?: string;
2013
2186
  /**
2014
- * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours.
2187
+ * The attributes (e.g. Colour, Size) that define this variant.
2015
2188
  */
2016
2189
  'attributes': Array<Attribute>;
2190
+ /**
2191
+ * The stock keeping unit code for this variant.
2192
+ */
2017
2193
  'sku': string;
2018
2194
  /**
2019
- * A reference to the variant resource location
2195
+ * A URI reference to this variant resource.
2020
2196
  */
2021
2197
  'ref'?: string;
2022
2198
  'product'?: VariantProduct;
@@ -2113,6 +2289,9 @@ export interface VariantWarehouseVariant {
2113
2289
  'metafields'?: Array<MetaField>;
2114
2290
  }
2115
2291
  export interface VariantWholesaleCost {
2292
+ /**
2293
+ * The cost of the variant alone
2294
+ */
2116
2295
  'item': RequiredPrice;
2117
2296
  /**
2118
2297
  * A breakdown of the cost per application
@@ -2122,6 +2301,9 @@ export interface VariantWholesaleCost {
2122
2301
  * a breakdown of the cost per handling fee
2123
2302
  */
2124
2303
  'handling': Array<NamedPrice>;
2304
+ /**
2305
+ * The total cost of fulfillment for the variant. This includes the cost of the variant, the cost of the applications, and the cost of the handling fees.
2306
+ */
2125
2307
  'fulfillment': RequiredPrice;
2126
2308
  }
2127
2309
  export interface VariantsResponse {
@@ -2132,11 +2314,11 @@ export interface VariantsResponse {
2132
2314
  'nextPageToken'?: number | null;
2133
2315
  }
2134
2316
  /**
2135
- * Video object
2317
+ * A video associated with a product.
2136
2318
  */
2137
2319
  export interface Video {
2138
2320
  /**
2139
- * Unique object identifier
2321
+ * The unique identifier of the video.
2140
2322
  */
2141
2323
  'id'?: string;
2142
2324
  'src'?: string;
@@ -2145,6 +2327,9 @@ export interface Video {
2145
2327
  'createdAt'?: string;
2146
2328
  'updatedAt'?: string;
2147
2329
  }
2330
+ /**
2331
+ * A video file to attach to a product, specified by a publicly available URL.
2332
+ */
2148
2333
  export interface VideoFile {
2149
2334
  /**
2150
2335
  * Publicly available file URL.
@@ -2705,10 +2890,12 @@ export declare const ApplicationTechnologiesApiAxiosParamCreator: (configuration
2705
2890
  * Lists all technologies available to this project.
2706
2891
  * @summary List technologies available to this project
2707
2892
  * @param {string} project What project it is
2893
+ * @param {number} [pageToken] Page reference token
2894
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2708
2895
  * @param {*} [options] Override http request option.
2709
2896
  * @throws {RequiredError}
2710
2897
  */
2711
- listTechnologies: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2898
+ listTechnologies: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2712
2899
  };
2713
2900
  /**
2714
2901
  * ApplicationTechnologiesApi - functional programming interface
@@ -2718,10 +2905,12 @@ export declare const ApplicationTechnologiesApiFp: (configuration?: Configuratio
2718
2905
  * Lists all technologies available to this project.
2719
2906
  * @summary List technologies available to this project
2720
2907
  * @param {string} project What project it is
2908
+ * @param {number} [pageToken] Page reference token
2909
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2721
2910
  * @param {*} [options] Override http request option.
2722
2911
  * @throws {RequiredError}
2723
2912
  */
2724
- listTechnologies(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationTechnologiesResponse>>;
2913
+ listTechnologies(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationTechnologiesResponse>>;
2725
2914
  };
2726
2915
  /**
2727
2916
  * ApplicationTechnologiesApi - factory interface
@@ -2744,6 +2933,14 @@ export interface ApplicationTechnologiesApiListTechnologiesRequest {
2744
2933
  * What project it is
2745
2934
  */
2746
2935
  readonly project: string;
2936
+ /**
2937
+ * Page reference token
2938
+ */
2939
+ readonly pageToken?: number;
2940
+ /**
2941
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2942
+ */
2943
+ readonly pageSize?: number;
2747
2944
  }
2748
2945
  /**
2749
2946
  * ApplicationTechnologiesApi - object-oriented interface
@@ -3113,10 +3310,12 @@ export declare const ProductCreatorsApiAxiosParamCreator: (configuration?: Confi
3113
3310
  * Lists all the unique users that have created products for the given project.
3114
3311
  * @summary List product creators
3115
3312
  * @param {string} project What project it is
3313
+ * @param {number} [pageToken] Page reference token
3314
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3116
3315
  * @param {*} [options] Override http request option.
3117
3316
  * @throws {RequiredError}
3118
3317
  */
3119
- listProductCreators: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3318
+ listProductCreators: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3120
3319
  };
3121
3320
  /**
3122
3321
  * ProductCreatorsApi - functional programming interface
@@ -3126,10 +3325,12 @@ export declare const ProductCreatorsApiFp: (configuration?: Configuration) => {
3126
3325
  * Lists all the unique users that have created products for the given project.
3127
3326
  * @summary List product creators
3128
3327
  * @param {string} project What project it is
3328
+ * @param {number} [pageToken] Page reference token
3329
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3129
3330
  * @param {*} [options] Override http request option.
3130
3331
  * @throws {RequiredError}
3131
3332
  */
3132
- listProductCreators(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>>;
3333
+ listProductCreators(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>>;
3133
3334
  };
3134
3335
  /**
3135
3336
  * ProductCreatorsApi - factory interface
@@ -3152,6 +3353,14 @@ export interface ProductCreatorsApiListProductCreatorsRequest {
3152
3353
  * What project it is
3153
3354
  */
3154
3355
  readonly project: string;
3356
+ /**
3357
+ * Page reference token
3358
+ */
3359
+ readonly pageToken?: number;
3360
+ /**
3361
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
3362
+ */
3363
+ readonly pageSize?: number;
3155
3364
  }
3156
3365
  /**
3157
3366
  * ProductCreatorsApi - object-oriented interface
@@ -3247,7 +3456,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
3247
3456
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
3248
3457
  * @summary Create product
3249
3458
  * @param {string} project What project it is
3250
- * @param {CreateProductRequest} [createProductRequest]
3459
+ * @param {CreateProductRequest} [createProductRequest] The product to create, including title, variants, design applications, and pricing.
3251
3460
  * @param {*} [options] Override http request option.
3252
3461
  * @throws {RequiredError}
3253
3462
  */
@@ -3358,7 +3567,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
3358
3567
  * @summary Update product
3359
3568
  * @param {string} project What project it is
3360
3569
  * @param {string} productId Product\&#39;s unique identifier
3361
- * @param {UpdateProductRequest} [updateProductRequest]
3570
+ * @param {UpdateProductRequest} [updateProductRequest] The product fields to update. Only the fields provided will be modified.
3362
3571
  * @param {*} [options] Override http request option.
3363
3572
  * @throws {RequiredError}
3364
3573
  */
@@ -3381,7 +3590,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
3381
3590
  * Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
3382
3591
  * @summary Create product
3383
3592
  * @param {string} project What project it is
3384
- * @param {CreateProductRequest} [createProductRequest]
3593
+ * @param {CreateProductRequest} [createProductRequest] The product to create, including title, variants, design applications, and pricing.
3385
3594
  * @param {*} [options] Override http request option.
3386
3595
  * @throws {RequiredError}
3387
3596
  */
@@ -3492,7 +3701,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
3492
3701
  * @summary Update product
3493
3702
  * @param {string} project What project it is
3494
3703
  * @param {string} productId Product\&#39;s unique identifier
3495
- * @param {UpdateProductRequest} [updateProductRequest]
3704
+ * @param {UpdateProductRequest} [updateProductRequest] The product fields to update. Only the fields provided will be modified.
3496
3705
  * @param {*} [options] Override http request option.
3497
3706
  * @throws {RequiredError}
3498
3707
  */
@@ -3608,6 +3817,9 @@ export interface ProductsApiCreateProductRequest {
3608
3817
  * What project it is
3609
3818
  */
3610
3819
  readonly project: string;
3820
+ /**
3821
+ * The product to create, including title, variants, design applications, and pricing.
3822
+ */
3611
3823
  readonly createProductRequest?: CreateProductRequest;
3612
3824
  }
3613
3825
  /**
@@ -3842,6 +4054,9 @@ export interface ProductsApiUpdateProductRequest {
3842
4054
  * Product\&#39;s unique identifier
3843
4055
  */
3844
4056
  readonly productId: string;
4057
+ /**
4058
+ * The product fields to update. Only the fields provided will be modified.
4059
+ */
3845
4060
  readonly updateProductRequest?: UpdateProductRequest;
3846
4061
  }
3847
4062
  /**