@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/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.92.0
7
+ * The version of the OpenAPI document: 1.93.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1018,10 +1018,12 @@ export const ApplicationTechnologiesApiAxiosParamCreator = function (configurati
1018
1018
  * Lists all technologies available to this project.
1019
1019
  * @summary List technologies available to this project
1020
1020
  * @param {string} project What project it is
1021
+ * @param {number} [pageToken] Page reference token
1022
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1021
1023
  * @param {*} [options] Override http request option.
1022
1024
  * @throws {RequiredError}
1023
1025
  */
1024
- listTechnologies: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
1026
+ listTechnologies: (project_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, pageToken, pageSize, options = {}) {
1025
1027
  // verify required parameter 'project' is not null or undefined
1026
1028
  assertParamExists('listTechnologies', 'project', project);
1027
1029
  const localVarPath = `/v1/catalog/applications/technologies`;
@@ -1042,6 +1044,12 @@ export const ApplicationTechnologiesApiAxiosParamCreator = function (configurati
1042
1044
  if (project !== undefined) {
1043
1045
  localVarQueryParameter['project'] = project;
1044
1046
  }
1047
+ if (pageToken !== undefined) {
1048
+ localVarQueryParameter['pageToken'] = pageToken;
1049
+ }
1050
+ if (pageSize !== undefined) {
1051
+ localVarQueryParameter['pageSize'] = pageSize;
1052
+ }
1045
1053
  localVarHeaderParameter['Accept'] = 'application/json';
1046
1054
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1047
1055
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1063,13 +1071,15 @@ export const ApplicationTechnologiesApiFp = function (configuration) {
1063
1071
  * Lists all technologies available to this project.
1064
1072
  * @summary List technologies available to this project
1065
1073
  * @param {string} project What project it is
1074
+ * @param {number} [pageToken] Page reference token
1075
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1066
1076
  * @param {*} [options] Override http request option.
1067
1077
  * @throws {RequiredError}
1068
1078
  */
1069
- listTechnologies(project, options) {
1079
+ listTechnologies(project, pageToken, pageSize, options) {
1070
1080
  return __awaiter(this, void 0, void 0, function* () {
1071
1081
  var _a, _b, _c;
1072
- const localVarAxiosArgs = yield localVarAxiosParamCreator.listTechnologies(project, options);
1082
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listTechnologies(project, pageToken, pageSize, options);
1073
1083
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1074
1084
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ApplicationTechnologiesApi.listTechnologies']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1075
1085
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1091,7 +1101,7 @@ export const ApplicationTechnologiesApiFactory = function (configuration, basePa
1091
1101
  * @throws {RequiredError}
1092
1102
  */
1093
1103
  listTechnologies(requestParameters, options) {
1094
- return localVarFp.listTechnologies(requestParameters.project, options).then((request) => request(axios, basePath));
1104
+ return localVarFp.listTechnologies(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1095
1105
  },
1096
1106
  };
1097
1107
  };
@@ -1107,7 +1117,7 @@ export class ApplicationTechnologiesApi extends BaseAPI {
1107
1117
  * @throws {RequiredError}
1108
1118
  */
1109
1119
  listTechnologies(requestParameters, options) {
1110
- return ApplicationTechnologiesApiFp(this.configuration).listTechnologies(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
1120
+ return ApplicationTechnologiesApiFp(this.configuration).listTechnologies(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
1111
1121
  }
1112
1122
  }
1113
1123
  /**
@@ -1560,10 +1570,12 @@ export const ProductCreatorsApiAxiosParamCreator = function (configuration) {
1560
1570
  * Lists all the unique users that have created products for the given project.
1561
1571
  * @summary List product creators
1562
1572
  * @param {string} project What project it is
1573
+ * @param {number} [pageToken] Page reference token
1574
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1563
1575
  * @param {*} [options] Override http request option.
1564
1576
  * @throws {RequiredError}
1565
1577
  */
1566
- listProductCreators: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
1578
+ listProductCreators: (project_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, pageToken, pageSize, options = {}) {
1567
1579
  // verify required parameter 'project' is not null or undefined
1568
1580
  assertParamExists('listProductCreators', 'project', project);
1569
1581
  const localVarPath = `/v1/catalog/creators`;
@@ -1584,6 +1596,12 @@ export const ProductCreatorsApiAxiosParamCreator = function (configuration) {
1584
1596
  if (project !== undefined) {
1585
1597
  localVarQueryParameter['project'] = project;
1586
1598
  }
1599
+ if (pageToken !== undefined) {
1600
+ localVarQueryParameter['pageToken'] = pageToken;
1601
+ }
1602
+ if (pageSize !== undefined) {
1603
+ localVarQueryParameter['pageSize'] = pageSize;
1604
+ }
1587
1605
  localVarHeaderParameter['Accept'] = 'application/json';
1588
1606
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1589
1607
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -1605,13 +1623,15 @@ export const ProductCreatorsApiFp = function (configuration) {
1605
1623
  * Lists all the unique users that have created products for the given project.
1606
1624
  * @summary List product creators
1607
1625
  * @param {string} project What project it is
1626
+ * @param {number} [pageToken] Page reference token
1627
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1608
1628
  * @param {*} [options] Override http request option.
1609
1629
  * @throws {RequiredError}
1610
1630
  */
1611
- listProductCreators(project, options) {
1631
+ listProductCreators(project, pageToken, pageSize, options) {
1612
1632
  return __awaiter(this, void 0, void 0, function* () {
1613
1633
  var _a, _b, _c;
1614
- const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductCreators(project, options);
1634
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listProductCreators(project, pageToken, pageSize, options);
1615
1635
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1616
1636
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductCreatorsApi.listProductCreators']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1617
1637
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1633,7 +1653,7 @@ export const ProductCreatorsApiFactory = function (configuration, basePath, axio
1633
1653
  * @throws {RequiredError}
1634
1654
  */
1635
1655
  listProductCreators(requestParameters, options) {
1636
- return localVarFp.listProductCreators(requestParameters.project, options).then((request) => request(axios, basePath));
1656
+ return localVarFp.listProductCreators(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1637
1657
  },
1638
1658
  };
1639
1659
  };
@@ -1649,7 +1669,7 @@ export class ProductCreatorsApi extends BaseAPI {
1649
1669
  * @throws {RequiredError}
1650
1670
  */
1651
1671
  listProductCreators(requestParameters, options) {
1652
- return ProductCreatorsApiFp(this.configuration).listProductCreators(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
1672
+ return ProductCreatorsApiFp(this.configuration).listProductCreators(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
1653
1673
  }
1654
1674
  }
1655
1675
  /**
@@ -1772,7 +1792,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
1772
1792
  * 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.
1773
1793
  * @summary Create product
1774
1794
  * @param {string} project What project it is
1775
- * @param {CreateProductRequest} [createProductRequest]
1795
+ * @param {CreateProductRequest} [createProductRequest] The product to create, including title, variants, design applications, and pricing.
1776
1796
  * @param {*} [options] Override http request option.
1777
1797
  * @throws {RequiredError}
1778
1798
  */
@@ -2275,7 +2295,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
2275
2295
  * @summary Update product
2276
2296
  * @param {string} project What project it is
2277
2297
  * @param {string} productId Product\'s unique identifier
2278
- * @param {UpdateProductRequest} [updateProductRequest]
2298
+ * @param {UpdateProductRequest} [updateProductRequest] The product fields to update. Only the fields provided will be modified.
2279
2299
  * @param {*} [options] Override http request option.
2280
2300
  * @throws {RequiredError}
2281
2301
  */
@@ -2368,7 +2388,7 @@ export const ProductsApiFp = function (configuration) {
2368
2388
  * 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.
2369
2389
  * @summary Create product
2370
2390
  * @param {string} project What project it is
2371
- * @param {CreateProductRequest} [createProductRequest]
2391
+ * @param {CreateProductRequest} [createProductRequest] The product to create, including title, variants, design applications, and pricing.
2372
2392
  * @param {*} [options] Override http request option.
2373
2393
  * @throws {RequiredError}
2374
2394
  */
@@ -2551,7 +2571,7 @@ export const ProductsApiFp = function (configuration) {
2551
2571
  * @summary Update product
2552
2572
  * @param {string} project What project it is
2553
2573
  * @param {string} productId Product\'s unique identifier
2554
- * @param {UpdateProductRequest} [updateProductRequest]
2574
+ * @param {UpdateProductRequest} [updateProductRequest] The product fields to update. Only the fields provided will be modified.
2555
2575
  * @param {*} [options] Override http request option.
2556
2576
  * @throws {RequiredError}
2557
2577
  */
@@ -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).
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.92.0
7
+ * The version of the OpenAPI document: 1.93.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.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).
@@ -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.92.0
7
+ * The version of the OpenAPI document: 1.93.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.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).
@@ -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.92.0
6
+ * The version of the OpenAPI document: 1.93.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.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).
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.92.0
7
+ * The version of the OpenAPI document: 1.93.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.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).
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.92.0
8
+ * The version of the OpenAPI document: 1.93.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/docs/Action.md CHANGED
@@ -1,11 +1,12 @@
1
1
  # Action
2
2
 
3
+ A specific action that can be taken to implement a recommendation.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | Unique object identifier | [default to undefined]
9
+ **id** | **string** | The unique identifier of this action. | [default to undefined]
9
10
  **ref** | **string** | A reference to the action resource location | [default to undefined]
10
11
  **title** | **string** | The title of the action | [default to undefined]
11
12
  **impact** | **string** | | [default to undefined]
@@ -1,5 +1,6 @@
1
1
  # AdditionalFile
2
2
 
3
+ An additional file to attach to a product (e.g. size guide, care instructions).
3
4
 
4
5
  ## Properties
5
6
 
@@ -1,5 +1,6 @@
1
1
  # AnalyticsItem
2
2
 
3
+ Analytics data for a product including revenue, sales, traffic, and conversion metrics.
3
4
 
4
5
  ## Properties
5
6
 
@@ -1,5 +1,6 @@
1
1
  # AnalyticsSummary
2
2
 
3
+ An AI-generated summary of product analytics with actionable recommendations.
3
4
 
4
5
  ## Properties
5
6
 
package/docs/ApiError.md CHANGED
@@ -1,12 +1,13 @@
1
1
  # ApiError
2
2
 
3
+ Represents an error returned by the API.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | | [optional] [default to undefined]
9
- **message** | **string** | | [default to undefined]
9
+ **code** | **string** | A machine-readable error code identifying the type of error. | [optional] [default to undefined]
10
+ **message** | **string** | A human-readable message providing more details about the error. | [default to undefined]
10
11
 
11
12
  ## Example
12
13
 
@@ -1,15 +1,17 @@
1
1
  # Application
2
2
 
3
+ A design application on a product variant, specifying the technology, placement, design file, and optional personalisation.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | Unique object identifier | [optional] [default to undefined]
9
+ **id** | **string** | The unique identifier of this application. | [optional] [default to undefined]
9
10
  **technology** | **string** | The application technology used for this design application. `mug_sublimation` is deprecated. Use `sublimation_small` instead. | [default to undefined]
10
11
  **placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
11
12
  **additionalInstructions** | **string** | Any additional instructions for the application | [optional] [default to undefined]
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]
13
+ **src** | **string** | Publicly available production print file URL for this application. For raster-only applications, this can also be used directly as the display image. | [optional] [default to undefined]
14
+ **displaySrc** | **string** | 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. | [optional] [default to undefined]
13
15
  **groupRef** | **string** | 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. | [optional] [default to undefined]
14
16
  **mockup** | [**ApplicationMockup**](ApplicationMockup.md) | | [optional] [default to undefined]
15
17
  **stockedOnly** | **boolean** | If set to true, transfers for this application will not be printed on demand, and will need to be stocked in trays in the factory. Note that this can only be set if the technology is stockable, such as DTF. | [optional] [default to undefined]
@@ -26,6 +28,7 @@ const instance: Application = {
26
28
  placement,
27
29
  additionalInstructions,
28
30
  src,
31
+ displaySrc,
29
32
  groupRef,
30
33
  mockup,
31
34
  stockedOnly,
@@ -1,12 +1,13 @@
1
1
  # ApplicationGroup
2
2
 
3
+ A named group of design applications that can be reused across multiple products.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | Unique object identifier | [default to undefined]
9
- **ref** | **string** | A reference to the application group resource location | [default to undefined]
9
+ **id** | **string** | The unique identifier of the application group. | [default to undefined]
10
+ **ref** | **string** | A URI reference to this application group resource. | [default to undefined]
10
11
  **name** | **string** | Name of the application group | [default to undefined]
11
12
  **createdAt** | **string** | | [default to undefined]
12
13
  **updatedAt** | **string** | | [default to undefined]
@@ -1,5 +1,6 @@
1
1
  # ApplicationProperties
2
2
 
3
+ Properties of a design application including dimensions, position, and optional personalisation rules. Null when the application has no configurable properties.
3
4
 
4
5
  ## Properties
5
6
 
@@ -1,5 +1,6 @@
1
1
  # ApplicationPropertiesPersonalization
2
2
 
3
+ Personalisation configuration for a design application, allowing end-users to customise the design.
3
4
 
4
5
  ## Properties
5
6
 
@@ -1,12 +1,13 @@
1
1
  # ApplicationSet
2
2
 
3
+ A set of application records that defines which design applications are applied to which variants.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | Unique object identifier | [default to undefined]
9
- **ref** | **string** | A reference to the application set resource location | [default to undefined]
9
+ **id** | **string** | The unique identifier of the application set. | [default to undefined]
10
+ **ref** | **string** | A URI reference to this application set resource. | [default to undefined]
10
11
  **name** | **string** | Name of the application set | [default to undefined]
11
12
  **description** | **string** | Description of the application set | [optional] [default to undefined]
12
13
  **width** | **number** | The width, in pixels of the images in the set | [default to undefined]
@@ -1,11 +1,12 @@
1
1
  # ApplicationSetRecord
2
2
 
3
+ A record within an application set, linking a specific application to a set.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | Unique object identifier | [optional] [default to undefined]
9
+ **id** | **string** | The unique identifier of this record. | [optional] [default to undefined]
9
10
  **set** | [**ApplicationSet1**](ApplicationSet1.md) | | [optional] [default to undefined]
10
11
  **attributes** | [**Array<Attributes1Inner>**](Attributes1Inner.md) | Attributes associated to a variant such as Colour and Size. | [optional] [default to undefined]
11
12
  **applications** | [**Array<Application>**](Application.md) | List of applications for this record | [optional] [default to undefined]
@@ -23,9 +23,13 @@ const configuration = new Configuration();
23
23
  const apiInstance = new ApplicationTechnologiesApi(configuration);
24
24
 
25
25
  let project: string; //What project it is (default to undefined)
26
+ let pageToken: number; //Page reference token (optional) (default to 1)
27
+ let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
26
28
 
27
29
  const { status, data } = await apiInstance.listTechnologies(
28
- project
30
+ project,
31
+ pageToken,
32
+ pageSize
29
33
  );
30
34
  ```
31
35
 
@@ -34,6 +38,8 @@ const { status, data } = await apiInstance.listTechnologies(
34
38
  |Name | Type | Description | Notes|
35
39
  |------------- | ------------- | ------------- | -------------|
36
40
  | **project** | [**string**] | What project it is | defaults to undefined|
41
+ | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
42
+ | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
37
43
 
38
44
 
39
45
  ### Return type
@@ -1,11 +1,12 @@
1
1
  # ApplicationTechnology
2
2
 
3
+ A print or application technology available for use on catalog products.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | Unique object identifier | [optional] [default to undefined]
9
+ **id** | **string** | The unique identifier of the technology. | [optional] [default to undefined]
9
10
  **name** | **string** | Name of the application technology | [optional] [default to undefined]
10
11
  **code** | **string** | Code of the application technology | [optional] [default to undefined]
11
12
  **integrationProduct** | [**ApplicationTechnologyIntegrationProduct**](ApplicationTechnologyIntegrationProduct.md) | | [optional] [default to undefined]
@@ -1,13 +1,14 @@
1
1
  # BundleProduct
2
2
 
3
+ A bundle product that groups multiple items together at a combined price.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | Unique object identifier | [optional] [default to undefined]
9
- **ref** | **string** | A reference to the resource location | [optional] [default to undefined]
10
- **title** | **string** | | [default to undefined]
9
+ **id** | **string** | The unique identifier of the bundle product. | [optional] [default to undefined]
10
+ **ref** | **string** | A URI reference to this bundle product resource. | [optional] [default to undefined]
11
+ **title** | **string** | The display title of the bundle product. | [default to undefined]
11
12
  **description** | **string** | | [default to undefined]
12
13
  **slug** | **string** | | [optional] [readonly] [default to undefined]
13
14
  **brand** | **string** | | [optional] [default to undefined]
@@ -22,16 +23,16 @@ Name | Type | Description | Notes
22
23
  **images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
23
24
  **videos** | [**Array<Video>**](Video.md) | Videos | [optional] [default to undefined]
24
25
  **variants** | [**Array<Variant>**](Variant.md) | Variants | [optional] [default to undefined]
25
- **retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
26
- **salePrice** | [**SalePrice**](SalePrice.md) | | [optional] [default to undefined]
26
+ **retailPrice** | [**Price**](Price.md) | The retail price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
27
+ **salePrice** | [**SalePrice**](SalePrice.md) | The sale price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
27
28
  **additionalFiles** | [**Array<ProductAdditionalFilesInner>**](ProductAdditionalFilesInner.md) | Additional files attached to the product. | [optional] [default to undefined]
28
29
  **applicationSets** | [**Array<ProductApplicationSetsInner>**](ProductApplicationSetsInner.md) | List of application sets associated with this product | [optional] [default to undefined]
29
30
  **reviewScore** | **number** | The average review rating. This field is only present if included in the fields query parameter | [optional] [default to undefined]
30
31
  **reviewCount** | **number** | A count of reviews. This field is only present if included in the fields query parameter | [optional] [default to undefined]
31
- **sku** | **string** | | [optional] [default to undefined]
32
+ **sku** | **string** | A unique identifier for a specific variant (product + colour + size). | [optional] [default to undefined]
32
33
  **sales** | **number** | A count of sales. This field is only present if included in the fields query parameter | [optional] [default to undefined]
33
- **salesStart** | **string** | | [optional] [default to undefined]
34
- **salesEnd** | **string** | | [optional] [default to undefined]
34
+ **salesStart** | **string** | The start of the window in which sales are counted | [optional] [default to undefined]
35
+ **salesEnd** | **string** | The end of the window in which sales are counted | [optional] [default to undefined]
35
36
  **includeInDataFeeds** | **boolean** | | [optional] [default to undefined]
36
37
  **shopifyId** | **number** | For use with the Shopify integration. The Shopify product ID that this product is linked to. | [optional] [default to undefined]
37
38
  **warehouseProduct** | [**ProductWarehouseProduct**](ProductWarehouseProduct.md) | | [optional] [default to undefined]
@@ -1,5 +1,6 @@
1
1
  # CreateApplication
2
2
 
3
+ The payload for creating a new design application on a product variant.
3
4
 
4
5
  ## Properties
5
6
 
@@ -8,7 +9,8 @@ Name | Type | Description | Notes
8
9
  **technology** | **string** | The application technology used for this design application. `mug_sublimation` is deprecated. Use `sublimation_small` instead. | [default to undefined]
9
10
  **placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
10
11
  **additionalInstructions** | **string** | Any additional instructions for the application | [optional] [default to undefined]
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]
12
+ **src** | **string** | Publicly available production print file URL for this application. For raster-only applications, this can also be used directly as the display image. | [default to undefined]
13
+ **displaySrc** | **string** | 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. | [optional] [default to undefined]
12
14
  **groupRef** | **string** | 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. | [optional] [default to undefined]
13
15
  **stockedOnly** | **boolean** | If set to true, transfers for this application will not be printed on demand, and will need to be stocked in trays in the factory. Note that this can only be set if the technology is stockable, such as DTF. | [optional] [default to undefined]
14
16
  **properties** | [**CreateApplicationProperties**](CreateApplicationProperties.md) | | [optional] [default to undefined]
@@ -23,6 +25,7 @@ const instance: CreateApplication = {
23
25
  placement,
24
26
  additionalInstructions,
25
27
  src,
28
+ displaySrc,
26
29
  groupRef,
27
30
  stockedOnly,
28
31
  properties,
@@ -1,5 +1,6 @@
1
1
  # CreateBundleProduct
2
2
 
3
+ The payload for creating a new bundle product that groups multiple items together.
3
4
 
4
5
  ## Properties
5
6
 
@@ -19,7 +20,7 @@ Name | Type | Description | Notes
19
20
  **additionalFiles** | [**Array<CreateProductAdditionalFilesInner>**](CreateProductAdditionalFilesInner.md) | Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc. | [optional] [default to undefined]
20
21
  **shopifyId** | **number** | 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. | [optional] [default to undefined]
21
22
  **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
22
- **bundleItems** | [**Array<CreateBundleProductBundleItemsInner>**](CreateBundleProductBundleItemsInner.md) | A list of product uuids to include in this bundle | [default to undefined]
23
+ **bundleItems** | [**Array<UpdateProductRequestBundleItemsInner>**](UpdateProductRequestBundleItemsInner.md) | A list of product uuids to include in this bundle | [default to undefined]
23
24
  **retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
24
25
  **salePrice** | [**SalePrice**](SalePrice.md) | | [optional] [default to undefined]
25
26
  **price** | [**Price**](Price.md) | | [optional] [readonly] [default to undefined]
@@ -1,5 +1,6 @@
1
1
  # CreateProduct
2
2
 
3
+ The payload for creating a new catalog product from a GFN base product.
3
4
 
4
5
  ## Properties
5
6
 
@@ -27,7 +27,7 @@ Name | Type | Description | Notes
27
27
  **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
28
28
  **personalizationTemplate** | **string** | A JSON object that defines the personalization template for the product. | [optional] [default to undefined]
29
29
  **license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) | | [optional] [default to undefined]
30
- **bundleItems** | [**Array<CreateBundleProductBundleItemsInner>**](CreateBundleProductBundleItemsInner.md) | A list of product uuids to include in this bundle | [default to undefined]
30
+ **bundleItems** | [**Array<UpdateProductRequestBundleItemsInner>**](UpdateProductRequestBundleItemsInner.md) | A list of product uuids to include in this bundle | [default to undefined]
31
31
  **retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
32
32
  **salePrice** | [**SalePrice**](SalePrice.md) | | [optional] [default to undefined]
33
33
  **price** | [**Price**](Price.md) | | [optional] [readonly] [default to undefined]
@@ -1,5 +1,6 @@
1
1
  # CreateProductVariant
2
2
 
3
+ The payload for creating a new variant on a catalog product.
3
4
 
4
5
  ## Properties
5
6
 
package/docs/Image.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # Image
2
2
 
3
- Image description
3
+ An image associated with a product or variant.
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | Unique object identifier | [optional] [default to undefined]
9
+ **id** | **string** | The unique identifier of the image. | [optional] [default to undefined]
10
10
  **src** | **string** | | [default to undefined]
11
11
  **type** | **string** | | [optional] [default to undefined]
12
12
  **alt** | **string** | | [optional] [default to undefined]
package/docs/ImageFile.md CHANGED
@@ -1,5 +1,6 @@
1
1
  # ImageFile
2
2
 
3
+ An image file to attach to a product, specified by a publicly available URL.
3
4
 
4
5
  ## Properties
5
6
 
package/docs/Location.md CHANGED
@@ -1,5 +1,6 @@
1
1
  # Location
2
2
 
3
+ A stock location showing the number of units available at a specific warehouse location.
3
4
 
4
5
  ## Properties
5
6
 
@@ -1,12 +1,13 @@
1
1
  # NamedPrice
2
2
 
3
+ A named price component (e.g. Fulfillment, Application) with its amount and currency.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
9
  **name** | **string** | The name of the price | [default to undefined]
9
- **price** | [**RequiredPrice**](RequiredPrice.md) | | [default to undefined]
10
+ **price** | [**RequiredPrice**](RequiredPrice.md) | The price amount and currency. | [default to undefined]
10
11
 
11
12
  ## Example
12
13