@teemill/product-catalog 1.91.0 → 1.92.1

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 (73) hide show
  1. package/.openapi-generator/FILES +2 -1
  2. package/README.md +4 -3
  3. package/api.ts +297 -47
  4. package/base.ts +1 -1
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/api.d.ts +271 -41
  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 +271 -41
  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 +2 -1
  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 +1 -0
  42. package/docs/CreateBundleProduct.md +2 -1
  43. package/docs/CreateProduct.md +3 -0
  44. package/docs/CreateProductRequest.md +3 -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 +11 -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/ProductStaticCollectionsInner.md +22 -0
  56. package/docs/ProductType.md +2 -1
  57. package/docs/ProductsApi.md +6 -6
  58. package/docs/Recommendation.md +2 -1
  59. package/docs/Stock.md +3 -2
  60. package/docs/TargetSearchPhraseData.md +1 -0
  61. package/docs/TextApplicationProperties.md +1 -0
  62. package/docs/TextApplicationPropertiesPersonalization.md +1 -0
  63. package/docs/UpdateProductRequest.md +4 -2
  64. package/docs/UpdateProductRequestBundleItemsInner.md +1 -1
  65. package/docs/UpdateProductsRequestProductsInner.md +2 -0
  66. package/docs/UpdateProductsRequestProductsInnerCollectionsInner.md +20 -0
  67. package/docs/UserList.md +2 -1
  68. package/docs/Variant.md +5 -4
  69. package/docs/VariantWholesaleCost.md +2 -2
  70. package/docs/Video.md +2 -2
  71. package/docs/VideoFile.md +1 -0
  72. package/index.ts +1 -1
  73. package/package.json +2 -2
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.91.0
5
+ * The version of the OpenAPI document: 1.92.1
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
  /**
@@ -139,13 +163,16 @@ export declare const ApplicationPlacementEnum: {
139
163
  readonly Neck: "neck";
140
164
  };
141
165
  export type ApplicationPlacementEnum = typeof ApplicationPlacementEnum[keyof typeof ApplicationPlacementEnum];
166
+ /**
167
+ * A named group of design applications that can be reused across multiple products.
168
+ */
142
169
  export interface ApplicationGroup {
143
170
  /**
144
- * Unique object identifier
171
+ * The unique identifier of the application group.
145
172
  */
146
173
  'id': string;
147
174
  /**
148
- * A reference to the application group resource location
175
+ * A URI reference to this application group resource.
149
176
  */
150
177
  'ref': string;
151
178
  /**
@@ -172,6 +199,9 @@ export interface ApplicationMockup {
172
199
  */
173
200
  'preview'?: string;
174
201
  }
202
+ /**
203
+ * Properties of a design application including dimensions, position, and optional personalisation rules. Null when the application has no configurable properties.
204
+ */
175
205
  export interface ApplicationProperties {
176
206
  /**
177
207
  * Width of the application in pixels
@@ -192,6 +222,9 @@ export interface ApplicationPropertiesMetadata {
192
222
  * @type ApplicationPropertiesMetadataPersonalization
193
223
  */
194
224
  export type ApplicationPropertiesMetadataPersonalization = ApplicationPropertiesPersonalization | TextApplicationPropertiesPersonalization;
225
+ /**
226
+ * Personalisation configuration for a design application, allowing end-users to customise the design.
227
+ */
195
228
  export interface ApplicationPropertiesPersonalization {
196
229
  /**
197
230
  * The label to be displayed on the personalization field.
@@ -296,13 +329,16 @@ export declare const ApplicationPropertiesPropertiesFontStyleEnum: {
296
329
  readonly Oblique: "oblique";
297
330
  };
298
331
  export type ApplicationPropertiesPropertiesFontStyleEnum = typeof ApplicationPropertiesPropertiesFontStyleEnum[keyof typeof ApplicationPropertiesPropertiesFontStyleEnum];
332
+ /**
333
+ * A set of application records that defines which design applications are applied to which variants.
334
+ */
299
335
  export interface ApplicationSet {
300
336
  /**
301
- * Unique object identifier
337
+ * The unique identifier of the application set.
302
338
  */
303
339
  'id': string;
304
340
  /**
305
- * A reference to the application set resource location
341
+ * A URI reference to this application set resource.
306
342
  */
307
343
  'ref': string;
308
344
  /**
@@ -342,9 +378,12 @@ export interface ApplicationSet1 {
342
378
  */
343
379
  'ref'?: string;
344
380
  }
381
+ /**
382
+ * A record within an application set, linking a specific application to a set.
383
+ */
345
384
  export interface ApplicationSetRecord {
346
385
  /**
347
- * Unique object identifier
386
+ * The unique identifier of this record.
348
387
  */
349
388
  'id'?: string;
350
389
  'set'?: ApplicationSet1;
@@ -367,9 +406,12 @@ export interface ApplicationSetsResponse {
367
406
  export interface ApplicationTechnologiesResponse {
368
407
  'applicationTechnologies'?: Array<ApplicationTechnology>;
369
408
  }
409
+ /**
410
+ * A print or application technology available for use on catalog products.
411
+ */
370
412
  export interface ApplicationTechnology {
371
413
  /**
372
- * Unique object identifier
414
+ * The unique identifier of the technology.
373
415
  */
374
416
  'id'?: string;
375
417
  /**
@@ -424,15 +466,21 @@ export interface Attributes1Inner {
424
466
  'name'?: string;
425
467
  'value'?: string;
426
468
  }
469
+ /**
470
+ * A bundle product that groups multiple items together at a combined price.
471
+ */
427
472
  export interface BundleProduct {
428
473
  /**
429
- * Unique object identifier
474
+ * The unique identifier of the bundle product.
430
475
  */
431
476
  'id'?: string;
432
477
  /**
433
- * A reference to the resource location
478
+ * A URI reference to this bundle product resource.
434
479
  */
435
480
  'ref'?: string;
481
+ /**
482
+ * The display title of the bundle product.
483
+ */
436
484
  'title': string;
437
485
  'description': string;
438
486
  'slug'?: string;
@@ -457,7 +505,13 @@ export interface BundleProduct {
457
505
  * Variants
458
506
  */
459
507
  'variants'?: Array<Variant>;
508
+ /**
509
+ * The retail price of the product, including tax. Only provided if the product is a bundle.
510
+ */
460
511
  'retailPrice'?: Price;
512
+ /**
513
+ * The sale price of the product, including tax. Only provided if the product is a bundle.
514
+ */
461
515
  'salePrice'?: SalePrice | null;
462
516
  /**
463
517
  * Additional files attached to the product.
@@ -475,12 +529,21 @@ export interface BundleProduct {
475
529
  * A count of reviews. This field is only present if included in the fields query parameter
476
530
  */
477
531
  'reviewCount'?: number;
532
+ /**
533
+ * A unique identifier for a specific variant (product + colour + size).
534
+ */
478
535
  'sku'?: string;
479
536
  /**
480
537
  * A count of sales. This field is only present if included in the fields query parameter
481
538
  */
482
539
  'sales'?: number;
540
+ /**
541
+ * The start of the window in which sales are counted
542
+ */
483
543
  'salesStart'?: string;
544
+ /**
545
+ * The end of the window in which sales are counted
546
+ */
484
547
  'salesEnd'?: string;
485
548
  'includeInDataFeeds'?: boolean;
486
549
  /**
@@ -511,6 +574,9 @@ export interface BundleProduct {
511
574
  'showSaleBadge'?: boolean;
512
575
  'license'?: License;
513
576
  }
577
+ /**
578
+ * The payload for creating a new design application on a product variant.
579
+ */
514
580
  export interface CreateApplication {
515
581
  /**
516
582
  * The application technology used for this design application. `mug_sublimation` is deprecated. Use `sublimation_small` instead.
@@ -666,6 +732,9 @@ export interface CreateApplicationSetRequestRecordsInnerAttributesInner {
666
732
  */
667
733
  'value': string;
668
734
  }
735
+ /**
736
+ * The payload for creating a new bundle product that groups multiple items together.
737
+ */
669
738
  export interface CreateBundleProduct {
670
739
  /**
671
740
  * Product title
@@ -723,17 +792,11 @@ export interface CreateBundleProduct {
723
792
  /**
724
793
  * A list of product uuids to include in this bundle
725
794
  */
726
- 'bundleItems': Array<CreateBundleProductBundleItemsInner>;
795
+ 'bundleItems': Array<UpdateProductRequestBundleItemsInner>;
727
796
  'retailPrice'?: Price;
728
797
  'salePrice'?: SalePrice | null;
729
798
  'price'?: Price;
730
799
  }
731
- export interface CreateBundleProductBundleItemsInner {
732
- /**
733
- * Unique object identifier
734
- */
735
- 'id'?: string;
736
- }
737
800
  export interface CreateBundleProductSeoMetadata {
738
801
  /**
739
802
  * 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 +851,9 @@ export interface CreateDigitalProductVariantsInnerImagesInner {
788
851
  */
789
852
  'src': string;
790
853
  }
854
+ /**
855
+ * The payload for creating a new catalog product from a GFN base product.
856
+ */
791
857
  export interface CreateProduct {
792
858
  /**
793
859
  * 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.
@@ -858,6 +924,10 @@ export interface CreateProduct {
858
924
  * For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one.
859
925
  */
860
926
  'shopifyId'?: number | null;
927
+ /**
928
+ * An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration.
929
+ */
930
+ 'collections'?: Array<UpdateProductsRequestProductsInnerCollectionsInner>;
861
931
  /**
862
932
  * Key/value pairs that can be used to store additional information about the product
863
933
  */
@@ -888,6 +958,9 @@ export interface CreateProductImagesInner {
888
958
  * @type CreateProductRequest
889
959
  */
890
960
  export type CreateProductRequest = CreateBundleProduct | CreateDigitalProduct | CreateProduct;
961
+ /**
962
+ * The payload for creating a new variant on a catalog product.
963
+ */
891
964
  export interface CreateProductVariant {
892
965
  /**
893
966
  * 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).
@@ -974,11 +1047,11 @@ export interface ExportProducts202Response {
974
1047
  'message'?: string;
975
1048
  }
976
1049
  /**
977
- * Image description
1050
+ * An image associated with a product or variant.
978
1051
  */
979
1052
  export interface Image {
980
1053
  /**
981
- * Unique object identifier
1054
+ * The unique identifier of the image.
982
1055
  */
983
1056
  'id'?: string;
984
1057
  'src': string;
@@ -992,6 +1065,9 @@ export interface Image {
992
1065
  'createdAt'?: string;
993
1066
  'updatedAt'?: string;
994
1067
  }
1068
+ /**
1069
+ * An image file to attach to a product, specified by a publicly available URL.
1070
+ */
995
1071
  export interface ImageFile {
996
1072
  /**
997
1073
  * Publicly available file URL.
@@ -1047,6 +1123,9 @@ export interface License {
1047
1123
  */
1048
1124
  'expiresAt'?: string;
1049
1125
  }
1126
+ /**
1127
+ * A stock location showing the number of units available at a specific warehouse location.
1128
+ */
1050
1129
  export interface Location {
1051
1130
  /**
1052
1131
  * The total number of units available at the location
@@ -1070,18 +1149,30 @@ export interface MetaField {
1070
1149
  */
1071
1150
  'value': string;
1072
1151
  }
1152
+ /**
1153
+ * A named price component (e.g. Fulfillment, Application) with its amount and currency.
1154
+ */
1073
1155
  export interface NamedPrice {
1074
1156
  /**
1075
1157
  * The name of the price
1076
1158
  */
1077
1159
  'name': string;
1160
+ /**
1161
+ * The price amount and currency.
1162
+ */
1078
1163
  'price': RequiredPrice;
1079
1164
  }
1165
+ /**
1166
+ * A record of an AI SEO optimisation performed on a product.
1167
+ */
1080
1168
  export interface OptimisationHistoryItem {
1081
1169
  /**
1082
- * Unique object identifier
1170
+ * The unique identifier of this optimisation.
1083
1171
  */
1084
1172
  'id'?: string;
1173
+ /**
1174
+ * The timestamp when this optimisation was performed.
1175
+ */
1085
1176
  'createdAt'?: string;
1086
1177
  }
1087
1178
  /**
@@ -1101,15 +1192,21 @@ export declare const PriceCurrencyCodeEnum: {
1101
1192
  readonly Gbp: "GBP";
1102
1193
  };
1103
1194
  export type PriceCurrencyCodeEnum = typeof PriceCurrencyCodeEnum[keyof typeof PriceCurrencyCodeEnum];
1195
+ /**
1196
+ * A catalog product listing that can be purchased, containing design applications, pricing, variants, and SEO metadata.
1197
+ */
1104
1198
  export interface Product {
1105
1199
  /**
1106
- * Unique object identifier
1200
+ * The unique identifier of the product.
1107
1201
  */
1108
1202
  'id'?: string;
1109
1203
  /**
1110
- * A reference to the resource location
1204
+ * A URI reference to this product resource.
1111
1205
  */
1112
1206
  'ref'?: string;
1207
+ /**
1208
+ * The display title of the product.
1209
+ */
1113
1210
  'title': string;
1114
1211
  'description': string;
1115
1212
  'slug'?: string;
@@ -1138,7 +1235,13 @@ export interface Product {
1138
1235
  * Products in the bundle.
1139
1236
  */
1140
1237
  'bundleItems'?: Array<ProductBundleItemsInner>;
1238
+ /**
1239
+ * The retail price of the product, including tax. Only provided if the product is a bundle.
1240
+ */
1141
1241
  'retailPrice'?: Price;
1242
+ /**
1243
+ * The sale price of the product, including tax. Only provided if the product is a bundle.
1244
+ */
1142
1245
  'salePrice'?: SalePrice | null;
1143
1246
  /**
1144
1247
  * Additional files attached to the product.
@@ -1156,12 +1259,21 @@ export interface Product {
1156
1259
  * A count of reviews. This field is only present if included in the fields query parameter
1157
1260
  */
1158
1261
  'reviewCount'?: number;
1262
+ /**
1263
+ * A unique identifier for a specific variant (product + colour + size).
1264
+ */
1159
1265
  'sku'?: string;
1160
1266
  /**
1161
1267
  * A count of sales. This field is only present if included in the fields query parameter
1162
1268
  */
1163
1269
  'sales'?: number;
1270
+ /**
1271
+ * The start of the window in which sales are counted
1272
+ */
1164
1273
  'salesStart'?: string;
1274
+ /**
1275
+ * The end of the window in which sales are counted
1276
+ */
1165
1277
  'salesEnd'?: string;
1166
1278
  'includeInDataFeeds'?: boolean;
1167
1279
  /**
@@ -1200,6 +1312,10 @@ export interface Product {
1200
1312
  */
1201
1313
  'isDigital'?: boolean;
1202
1314
  'analytics'?: ProductAnalytics;
1315
+ /**
1316
+ * The static (non-dynamic/filter-based) collections this product belongs to.
1317
+ */
1318
+ 'staticCollections'?: Array<ProductStaticCollectionsInner>;
1203
1319
  }
1204
1320
  export interface ProductAdditionalFilesInner {
1205
1321
  /**
@@ -1255,13 +1371,16 @@ export interface ProductApplicationSetsInner {
1255
1371
  }
1256
1372
  export interface ProductBundleItemsInner {
1257
1373
  /**
1258
- * Unique object identifier
1374
+ * The unique identifier of the bundle product.
1259
1375
  */
1260
1376
  'id'?: string;
1261
1377
  /**
1262
- * A reference to the resource location
1378
+ * A URI reference to this bundle product resource.
1263
1379
  */
1264
1380
  'ref'?: string;
1381
+ /**
1382
+ * The display title of the bundle product.
1383
+ */
1265
1384
  'title': string;
1266
1385
  'description': string;
1267
1386
  'slug'?: string;
@@ -1286,7 +1405,13 @@ export interface ProductBundleItemsInner {
1286
1405
  * Variants
1287
1406
  */
1288
1407
  'variants'?: Array<Variant>;
1408
+ /**
1409
+ * The retail price of the product, including tax. Only provided if the product is a bundle.
1410
+ */
1289
1411
  'retailPrice'?: Price;
1412
+ /**
1413
+ * The sale price of the product, including tax. Only provided if the product is a bundle.
1414
+ */
1290
1415
  'salePrice'?: SalePrice | null;
1291
1416
  /**
1292
1417
  * Additional files attached to the product.
@@ -1304,12 +1429,21 @@ export interface ProductBundleItemsInner {
1304
1429
  * A count of reviews. This field is only present if included in the fields query parameter
1305
1430
  */
1306
1431
  'reviewCount'?: number;
1432
+ /**
1433
+ * A unique identifier for a specific variant (product + colour + size).
1434
+ */
1307
1435
  'sku'?: string;
1308
1436
  /**
1309
1437
  * A count of sales. This field is only present if included in the fields query parameter
1310
1438
  */
1311
1439
  'sales'?: number;
1440
+ /**
1441
+ * The start of the window in which sales are counted
1442
+ */
1312
1443
  'salesStart'?: string;
1444
+ /**
1445
+ * The end of the window in which sales are counted
1446
+ */
1313
1447
  'salesEnd'?: string;
1314
1448
  'includeInDataFeeds'?: boolean;
1315
1449
  /**
@@ -1358,9 +1492,16 @@ export interface ProductGfnProduct {
1358
1492
  */
1359
1493
  'metafields'?: Array<MetaField>;
1360
1494
  }
1495
+ export interface ProductStaticCollectionsInner {
1496
+ 'id'?: string;
1497
+ 'title'?: string;
1498
+ }
1499
+ /**
1500
+ * A type of product available in the catalog (e.g. Printed T-Shirt, Embroidered Hoodie).
1501
+ */
1361
1502
  export interface ProductType {
1362
1503
  /**
1363
- * Unique object identifier
1504
+ * The unique identifier of the product type.
1364
1505
  */
1365
1506
  'id': string;
1366
1507
  /**
@@ -1399,9 +1540,12 @@ export interface ProductsResponse {
1399
1540
  */
1400
1541
  'nextPageToken'?: number | null;
1401
1542
  }
1543
+ /**
1544
+ * An AI-generated recommendation for improving product performance.
1545
+ */
1402
1546
  export interface Recommendation {
1403
1547
  /**
1404
- * Unique object identifier
1548
+ * The unique identifier of this recommendation.
1405
1549
  */
1406
1550
  'id': string;
1407
1551
  /**
@@ -1507,10 +1651,22 @@ export interface SeoOptimiseProductsRequest {
1507
1651
  */
1508
1652
  'fields'?: Array<string>;
1509
1653
  }
1654
+ /**
1655
+ * Stock availability information including total level and per-location breakdown.
1656
+ */
1510
1657
  export interface Stock {
1658
+ /**
1659
+ * The current total stock level available for purchase.
1660
+ */
1511
1661
  'level'?: number;
1662
+ /**
1663
+ * Stock levels broken down by warehouse location.
1664
+ */
1512
1665
  'locations'?: Array<Location>;
1513
1666
  }
1667
+ /**
1668
+ * Target search phrase configuration for SEO optimisation of a product.
1669
+ */
1514
1670
  export interface TargetSearchPhraseData {
1515
1671
  /**
1516
1672
  * The primary target search phrase for the product that you wish to rank for in search engine results.
@@ -1521,6 +1677,9 @@ export interface TargetSearchPhraseData {
1521
1677
  */
1522
1678
  'targetSearchPhraseSynonyms'?: Array<string>;
1523
1679
  }
1680
+ /**
1681
+ * Properties for a text-based application including font, colour, position, and optional personalisation. Null when the application has no configurable properties.
1682
+ */
1524
1683
  export interface TextApplicationProperties {
1525
1684
  'position'?: TextApplicationPropertiesPosition;
1526
1685
  'positionInference'?: ApplicationPropertiesPositionInference | null;
@@ -1566,6 +1725,9 @@ export declare const TextApplicationPropertiesFontStyleEnum: {
1566
1725
  readonly Oblique: "oblique";
1567
1726
  };
1568
1727
  export type TextApplicationPropertiesFontStyleEnum = typeof TextApplicationPropertiesFontStyleEnum[keyof typeof TextApplicationPropertiesFontStyleEnum];
1728
+ /**
1729
+ * Personalisation configuration for a text application, allowing end-users to customise the text content.
1730
+ */
1569
1731
  export interface TextApplicationPropertiesPersonalization {
1570
1732
  /**
1571
1733
  * The label to be displayed on the personalization field.
@@ -1724,7 +1886,13 @@ export interface UpdateProductRequest {
1724
1886
  * A list of products to be in this bundle. Only valid if the product is already a bundle.
1725
1887
  */
1726
1888
  'bundleItems'?: Array<UpdateProductRequestBundleItemsInner>;
1889
+ /**
1890
+ * The retail price of the product, including tax. Only provided if the product is a bundle.
1891
+ */
1727
1892
  'retailPrice'?: Price;
1893
+ /**
1894
+ * The sale price of the product, including tax. Only provided if the product is a bundle.
1895
+ */
1728
1896
  'salePrice'?: SalePrice | null;
1729
1897
  /**
1730
1898
  * Images to attach to the product. For example, photos of models using/wearing the product.
@@ -1767,10 +1935,14 @@ export interface UpdateProductRequest {
1767
1935
  * Whether to show a sale badge on the product
1768
1936
  */
1769
1937
  'showSaleBadge'?: boolean;
1938
+ /**
1939
+ * An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration.
1940
+ */
1941
+ 'collections'?: Array<UpdateProductsRequestProductsInnerCollectionsInner>;
1770
1942
  }
1771
1943
  export interface UpdateProductRequestBundleItemsInner {
1772
1944
  /**
1773
- * Unique object identifier
1945
+ * The product UUID to include in the bundle
1774
1946
  */
1775
1947
  'id'?: string;
1776
1948
  'config'?: UpdateProductRequestBundleItemsInnerConfig;
@@ -1849,8 +2021,15 @@ export interface UpdateProductsRequestProductsInner {
1849
2021
  * Whether to show a sale badge on the product
1850
2022
  */
1851
2023
  'showSaleBadge'?: boolean;
2024
+ /**
2025
+ * An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration.
2026
+ */
2027
+ 'collections'?: Array<UpdateProductsRequestProductsInnerCollectionsInner>;
1852
2028
  'license'?: UpdateProductsRequestProductsInnerLicense;
1853
2029
  }
2030
+ export interface UpdateProductsRequestProductsInnerCollectionsInner {
2031
+ 'id': string;
2032
+ }
1854
2033
  export interface UpdateProductsRequestProductsInnerIntegrationConnectionsInner {
1855
2034
  'integrationCode': string;
1856
2035
  /**
@@ -1958,7 +2137,13 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCur
1958
2137
  readonly Gbp: "GBP";
1959
2138
  };
1960
2139
  export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
2140
+ /**
2141
+ * A list of users who have created products for the project.
2142
+ */
1961
2143
  export interface UserList {
2144
+ /**
2145
+ * The list of product creators.
2146
+ */
1962
2147
  'creators': Array<UserListCreatorsInner>;
1963
2148
  }
1964
2149
  export interface UserListCreatorsInner {
@@ -1982,18 +2167,24 @@ export interface UserListCreatorsInnerAvatar {
1982
2167
  */
1983
2168
  'original': string | null;
1984
2169
  }
2170
+ /**
2171
+ * A specific colour/size combination of a catalog product with its own SKU, pricing, stock, and design applications.
2172
+ */
1985
2173
  export interface Variant {
1986
2174
  /**
1987
- * Unique object identifier
2175
+ * The unique identifier of the variant.
1988
2176
  */
1989
2177
  'id'?: string;
1990
2178
  /**
1991
- * 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.
2179
+ * The attributes (e.g. Colour, Size) that define this variant.
1992
2180
  */
1993
2181
  'attributes': Array<Attribute>;
2182
+ /**
2183
+ * The stock keeping unit code for this variant.
2184
+ */
1994
2185
  'sku': string;
1995
2186
  /**
1996
- * A reference to the variant resource location
2187
+ * A URI reference to this variant resource.
1997
2188
  */
1998
2189
  'ref'?: string;
1999
2190
  'product'?: VariantProduct;
@@ -2090,6 +2281,9 @@ export interface VariantWarehouseVariant {
2090
2281
  'metafields'?: Array<MetaField>;
2091
2282
  }
2092
2283
  export interface VariantWholesaleCost {
2284
+ /**
2285
+ * The cost of the variant alone
2286
+ */
2093
2287
  'item': RequiredPrice;
2094
2288
  /**
2095
2289
  * A breakdown of the cost per application
@@ -2099,6 +2293,9 @@ export interface VariantWholesaleCost {
2099
2293
  * a breakdown of the cost per handling fee
2100
2294
  */
2101
2295
  'handling': Array<NamedPrice>;
2296
+ /**
2297
+ * 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.
2298
+ */
2102
2299
  'fulfillment': RequiredPrice;
2103
2300
  }
2104
2301
  export interface VariantsResponse {
@@ -2109,11 +2306,11 @@ export interface VariantsResponse {
2109
2306
  'nextPageToken'?: number | null;
2110
2307
  }
2111
2308
  /**
2112
- * Video object
2309
+ * A video associated with a product.
2113
2310
  */
2114
2311
  export interface Video {
2115
2312
  /**
2116
- * Unique object identifier
2313
+ * The unique identifier of the video.
2117
2314
  */
2118
2315
  'id'?: string;
2119
2316
  'src'?: string;
@@ -2122,6 +2319,9 @@ export interface Video {
2122
2319
  'createdAt'?: string;
2123
2320
  'updatedAt'?: string;
2124
2321
  }
2322
+ /**
2323
+ * A video file to attach to a product, specified by a publicly available URL.
2324
+ */
2125
2325
  export interface VideoFile {
2126
2326
  /**
2127
2327
  * Publicly available file URL.
@@ -2682,10 +2882,12 @@ export declare const ApplicationTechnologiesApiAxiosParamCreator: (configuration
2682
2882
  * Lists all technologies available to this project.
2683
2883
  * @summary List technologies available to this project
2684
2884
  * @param {string} project What project it is
2885
+ * @param {number} [pageToken] Page reference token
2886
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2685
2887
  * @param {*} [options] Override http request option.
2686
2888
  * @throws {RequiredError}
2687
2889
  */
2688
- listTechnologies: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2890
+ listTechnologies: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2689
2891
  };
2690
2892
  /**
2691
2893
  * ApplicationTechnologiesApi - functional programming interface
@@ -2695,10 +2897,12 @@ export declare const ApplicationTechnologiesApiFp: (configuration?: Configuratio
2695
2897
  * Lists all technologies available to this project.
2696
2898
  * @summary List technologies available to this project
2697
2899
  * @param {string} project What project it is
2900
+ * @param {number} [pageToken] Page reference token
2901
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2698
2902
  * @param {*} [options] Override http request option.
2699
2903
  * @throws {RequiredError}
2700
2904
  */
2701
- listTechnologies(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationTechnologiesResponse>>;
2905
+ listTechnologies(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationTechnologiesResponse>>;
2702
2906
  };
2703
2907
  /**
2704
2908
  * ApplicationTechnologiesApi - factory interface
@@ -2721,6 +2925,14 @@ export interface ApplicationTechnologiesApiListTechnologiesRequest {
2721
2925
  * What project it is
2722
2926
  */
2723
2927
  readonly project: string;
2928
+ /**
2929
+ * Page reference token
2930
+ */
2931
+ readonly pageToken?: number;
2932
+ /**
2933
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2934
+ */
2935
+ readonly pageSize?: number;
2724
2936
  }
2725
2937
  /**
2726
2938
  * ApplicationTechnologiesApi - object-oriented interface
@@ -3090,10 +3302,12 @@ export declare const ProductCreatorsApiAxiosParamCreator: (configuration?: Confi
3090
3302
  * Lists all the unique users that have created products for the given project.
3091
3303
  * @summary List product creators
3092
3304
  * @param {string} project What project it is
3305
+ * @param {number} [pageToken] Page reference token
3306
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3093
3307
  * @param {*} [options] Override http request option.
3094
3308
  * @throws {RequiredError}
3095
3309
  */
3096
- listProductCreators: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3310
+ listProductCreators: (project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3097
3311
  };
3098
3312
  /**
3099
3313
  * ProductCreatorsApi - functional programming interface
@@ -3103,10 +3317,12 @@ export declare const ProductCreatorsApiFp: (configuration?: Configuration) => {
3103
3317
  * Lists all the unique users that have created products for the given project.
3104
3318
  * @summary List product creators
3105
3319
  * @param {string} project What project it is
3320
+ * @param {number} [pageToken] Page reference token
3321
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3106
3322
  * @param {*} [options] Override http request option.
3107
3323
  * @throws {RequiredError}
3108
3324
  */
3109
- listProductCreators(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>>;
3325
+ listProductCreators(project: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>>;
3110
3326
  };
3111
3327
  /**
3112
3328
  * ProductCreatorsApi - factory interface
@@ -3129,6 +3345,14 @@ export interface ProductCreatorsApiListProductCreatorsRequest {
3129
3345
  * What project it is
3130
3346
  */
3131
3347
  readonly project: string;
3348
+ /**
3349
+ * Page reference token
3350
+ */
3351
+ readonly pageToken?: number;
3352
+ /**
3353
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
3354
+ */
3355
+ readonly pageSize?: number;
3132
3356
  }
3133
3357
  /**
3134
3358
  * ProductCreatorsApi - object-oriented interface
@@ -3224,7 +3448,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
3224
3448
  * 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.
3225
3449
  * @summary Create product
3226
3450
  * @param {string} project What project it is
3227
- * @param {CreateProductRequest} [createProductRequest]
3451
+ * @param {CreateProductRequest} [createProductRequest] The product to create, including title, variants, design applications, and pricing.
3228
3452
  * @param {*} [options] Override http request option.
3229
3453
  * @throws {RequiredError}
3230
3454
  */
@@ -3335,7 +3559,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
3335
3559
  * @summary Update product
3336
3560
  * @param {string} project What project it is
3337
3561
  * @param {string} productId Product\&#39;s unique identifier
3338
- * @param {UpdateProductRequest} [updateProductRequest]
3562
+ * @param {UpdateProductRequest} [updateProductRequest] The product fields to update. Only the fields provided will be modified.
3339
3563
  * @param {*} [options] Override http request option.
3340
3564
  * @throws {RequiredError}
3341
3565
  */
@@ -3358,7 +3582,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
3358
3582
  * 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.
3359
3583
  * @summary Create product
3360
3584
  * @param {string} project What project it is
3361
- * @param {CreateProductRequest} [createProductRequest]
3585
+ * @param {CreateProductRequest} [createProductRequest] The product to create, including title, variants, design applications, and pricing.
3362
3586
  * @param {*} [options] Override http request option.
3363
3587
  * @throws {RequiredError}
3364
3588
  */
@@ -3469,7 +3693,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
3469
3693
  * @summary Update product
3470
3694
  * @param {string} project What project it is
3471
3695
  * @param {string} productId Product\&#39;s unique identifier
3472
- * @param {UpdateProductRequest} [updateProductRequest]
3696
+ * @param {UpdateProductRequest} [updateProductRequest] The product fields to update. Only the fields provided will be modified.
3473
3697
  * @param {*} [options] Override http request option.
3474
3698
  * @throws {RequiredError}
3475
3699
  */
@@ -3585,6 +3809,9 @@ export interface ProductsApiCreateProductRequest {
3585
3809
  * What project it is
3586
3810
  */
3587
3811
  readonly project: string;
3812
+ /**
3813
+ * The product to create, including title, variants, design applications, and pricing.
3814
+ */
3588
3815
  readonly createProductRequest?: CreateProductRequest;
3589
3816
  }
3590
3817
  /**
@@ -3819,6 +4046,9 @@ export interface ProductsApiUpdateProductRequest {
3819
4046
  * Product\&#39;s unique identifier
3820
4047
  */
3821
4048
  readonly productId: string;
4049
+ /**
4050
+ * The product fields to update. Only the fields provided will be modified.
4051
+ */
3822
4052
  readonly updateProductRequest?: UpdateProductRequest;
3823
4053
  }
3824
4054
  /**