@teemill/product-catalog 1.6.2 → 1.6.4

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 +1 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +5 -4
  4. package/dist/apis/ProductsApi.d.ts +11 -25
  5. package/dist/apis/ProductsApi.js +10 -75
  6. package/dist/apis/VariantsApi.d.ts +6 -6
  7. package/dist/apis/VariantsApi.js +6 -6
  8. package/dist/models/ApiError.d.ts +2 -2
  9. package/dist/models/ApiError.js +2 -2
  10. package/dist/models/Attribute.d.ts +2 -2
  11. package/dist/models/Attribute.js +2 -2
  12. package/dist/models/AttributeThumbnail.d.ts +3 -3
  13. package/dist/models/AttributeThumbnail.js +2 -2
  14. package/dist/models/CreateProductRequest.d.ts +7 -7
  15. package/dist/models/CreateProductRequest.js +2 -2
  16. package/dist/models/CreateProductRequestVariantsInner.d.ts +10 -10
  17. package/dist/models/CreateProductRequestVariantsInner.js +9 -7
  18. package/dist/models/CreateProductRequestVariantsInnerApplicationsInner.d.ts +12 -8
  19. package/dist/models/CreateProductRequestVariantsInnerApplicationsInner.js +14 -8
  20. package/dist/models/CreateProductRequestVariantsInnerAttributesInner.d.ts +4 -4
  21. package/dist/models/CreateProductRequestVariantsInnerAttributesInner.js +6 -5
  22. package/dist/models/CreateProductRequestVariantsInnerImagesInner.d.ts +3 -3
  23. package/dist/models/CreateProductRequestVariantsInnerImagesInner.js +2 -2
  24. package/dist/models/CreateProductRequestVariantsInnerRetailPrice.d.ts +37 -0
  25. package/dist/models/CreateProductRequestVariantsInnerRetailPrice.js +53 -0
  26. package/dist/models/Image.d.ts +2 -2
  27. package/dist/models/Image.js +2 -2
  28. package/dist/models/ImportProducts200Response.d.ts +2 -2
  29. package/dist/models/ImportProducts200Response.js +2 -2
  30. package/dist/models/Price.d.ts +2 -2
  31. package/dist/models/Price.js +2 -2
  32. package/dist/models/Product.d.ts +3 -3
  33. package/dist/models/Product.js +2 -2
  34. package/dist/models/ProductAdditionalFilesInner.d.ts +3 -3
  35. package/dist/models/ProductAdditionalFilesInner.js +2 -2
  36. package/dist/models/ProductsResponse.d.ts +2 -2
  37. package/dist/models/ProductsResponse.js +2 -2
  38. package/dist/models/Stock.d.ts +2 -2
  39. package/dist/models/Stock.js +2 -2
  40. package/dist/models/Variant.d.ts +2 -2
  41. package/dist/models/Variant.js +2 -2
  42. package/dist/models/VariantProduct.d.ts +2 -2
  43. package/dist/models/VariantProduct.js +2 -2
  44. package/dist/models/VariantsResponse.d.ts +2 -2
  45. package/dist/models/VariantsResponse.js +2 -2
  46. package/dist/models/index.d.ts +1 -0
  47. package/dist/models/index.js +1 -0
  48. package/dist/runtime.d.ts +2 -2
  49. package/dist/runtime.js +2 -2
  50. package/package.json +1 -1
  51. package/src/apis/ProductsApi.ts +10 -77
  52. package/src/apis/VariantsApi.ts +6 -6
  53. package/src/models/ApiError.ts +2 -2
  54. package/src/models/Attribute.ts +2 -2
  55. package/src/models/AttributeThumbnail.ts +3 -3
  56. package/src/models/CreateProductRequest.ts +7 -7
  57. package/src/models/CreateProductRequestVariantsInner.ts +20 -18
  58. package/src/models/CreateProductRequestVariantsInnerApplicationsInner.ts +20 -13
  59. package/src/models/CreateProductRequestVariantsInnerAttributesInner.ts +8 -6
  60. package/src/models/CreateProductRequestVariantsInnerImagesInner.ts +3 -3
  61. package/src/models/CreateProductRequestVariantsInnerRetailPrice.ts +75 -0
  62. package/src/models/Image.ts +2 -2
  63. package/src/models/ImportProducts200Response.ts +2 -2
  64. package/src/models/Price.ts +2 -2
  65. package/src/models/Product.ts +3 -3
  66. package/src/models/ProductAdditionalFilesInner.ts +3 -3
  67. package/src/models/ProductsResponse.ts +2 -2
  68. package/src/models/Stock.ts +2 -2
  69. package/src/models/Variant.ts +2 -2
  70. package/src/models/VariantProduct.ts +2 -2
  71. package/src/models/VariantsResponse.ts +2 -2
  72. package/src/models/index.ts +1 -0
  73. package/src/runtime.ts +2 -2
@@ -14,6 +14,7 @@ src/models/CreateProductRequestVariantsInner.ts
14
14
  src/models/CreateProductRequestVariantsInnerApplicationsInner.ts
15
15
  src/models/CreateProductRequestVariantsInnerAttributesInner.ts
16
16
  src/models/CreateProductRequestVariantsInnerImagesInner.ts
17
+ src/models/CreateProductRequestVariantsInnerRetailPrice.ts
17
18
  src/models/Image.ts
18
19
  src/models/ImportProducts200Response.ts
19
20
  src/models/Price.ts
@@ -1 +1 @@
1
- 7.3.0-SNAPSHOT
1
+ 7.3.0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/product-catalog@1.6.2
1
+ ## @teemill/product-catalog@1.6.4
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -15,7 +15,7 @@ Module system
15
15
  * CommonJS
16
16
  * ES6 module system
17
17
 
18
- It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
18
+ It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
19
19
 
20
20
  ### Building
21
21
 
@@ -27,7 +27,7 @@ npm run build
27
27
 
28
28
  ### Publishing
29
29
 
30
- First build the package then run ```npm publish```
30
+ First build the package then run `npm publish`
31
31
 
32
32
  ### Consuming
33
33
 
@@ -36,10 +36,11 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @teemill/product-catalog@1.6.2 --save
39
+ npm install @teemill/product-catalog@1.6.4 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
43
43
 
44
44
  ```
45
45
  npm install PATH_TO_GENERATED_PACKAGE --save
46
+ ```
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Product Catalog API
3
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
3
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.6.2
5
+ * The version of the OpenAPI document: 1.6.4
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { CreateProductRequest, ImportProducts200Response, Product, ProductsResponse } from '../models/index';
13
+ import type { CreateProductRequest, Product, ProductsResponse } from '../models/index';
14
14
  export interface CreateProductOperationRequest {
15
15
  project: string;
16
16
  createProductRequest?: CreateProductRequest;
@@ -26,52 +26,38 @@ export interface GetProductsRequest {
26
26
  pageSize?: number;
27
27
  fields?: string;
28
28
  }
29
- export interface ImportProductsRequest {
30
- project: string;
31
- body?: string;
32
- }
33
29
  /**
34
30
  *
35
31
  */
36
32
  export declare class ProductsApi extends runtime.BaseAPI {
37
33
  /**
38
- * Creates a catalog product
39
- * Create catalog product
34
+ * Creates a new catalog product based on a given warehouse product with the variants and design applications provided. To select a warehouse product to base this product on, use the GFN Catalog API to list available options.
35
+ * Create product
40
36
  */
41
37
  createProductRaw(requestParameters: CreateProductOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Product>>;
42
38
  /**
43
- * Creates a catalog product
44
- * Create catalog product
39
+ * Creates a new catalog product based on a given warehouse product with the variants and design applications provided. To select a warehouse product to base this product on, use the GFN Catalog API to list available options.
40
+ * Create product
45
41
  */
46
42
  createProduct(project: string, optionalParameters?: runtime.OptionalOnly<CreateProductOperationRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Product>;
47
43
  /**
48
- * Gets a product by the given id
44
+ * Gets a product by a given ID.
49
45
  * Get product
50
46
  */
51
47
  getProductRaw(requestParameters: GetProductRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Product>>;
52
48
  /**
53
- * Gets a product by the given id
49
+ * Gets a product by a given ID.
54
50
  * Get product
55
51
  */
56
52
  getProduct(project: string, productId: string, optionalParameters?: runtime.OptionalOnly<GetProductRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Product>;
57
53
  /**
58
- * Lists all products
54
+ * Lists all enabled store listing products attached to the given project.
59
55
  * List products
60
56
  */
61
57
  getProductsRaw(requestParameters: GetProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductsResponse>>;
62
58
  /**
63
- * Lists all products
59
+ * Lists all enabled store listing products attached to the given project.
64
60
  * List products
65
61
  */
66
62
  getProducts(project: string, optionalParameters?: runtime.OptionalOnly<GetProductsRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductsResponse>;
67
- /**
68
- * Import products
69
- * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
70
- */
71
- importProductsRaw(requestParameters: ImportProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImportProducts200Response>>;
72
- /**
73
- * Import products
74
- * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
75
- */
76
- importProducts(project: string, optionalParameters?: runtime.OptionalOnly<ImportProductsRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImportProducts200Response>;
77
63
  }
@@ -3,9 +3,9 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Product Catalog API
6
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.6.2
8
+ * The version of the OpenAPI document: 1.6.4
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -87,8 +87,8 @@ var ProductsApi = /** @class */ (function (_super) {
87
87
  return _super !== null && _super.apply(this, arguments) || this;
88
88
  }
89
89
  /**
90
- * Creates a catalog product
91
- * Create catalog product
90
+ * Creates a new catalog product based on a given warehouse product with the variants and design applications provided. To select a warehouse product to base this product on, use the GFN Catalog API to list available options.
91
+ * Create product
92
92
  */
93
93
  ProductsApi.prototype.createProductRaw = function (requestParameters, initOverrides) {
94
94
  return __awaiter(this, void 0, void 0, function () {
@@ -133,8 +133,8 @@ var ProductsApi = /** @class */ (function (_super) {
133
133
  });
134
134
  };
135
135
  /**
136
- * Creates a catalog product
137
- * Create catalog product
136
+ * Creates a new catalog product based on a given warehouse product with the variants and design applications provided. To select a warehouse product to base this product on, use the GFN Catalog API to list available options.
137
+ * Create product
138
138
  */
139
139
  ProductsApi.prototype.createProduct = function (project, optionalParameters, initOverrides) {
140
140
  if (optionalParameters === void 0) { optionalParameters = {}; }
@@ -152,7 +152,7 @@ var ProductsApi = /** @class */ (function (_super) {
152
152
  });
153
153
  };
154
154
  /**
155
- * Gets a product by the given id
155
+ * Gets a product by a given ID.
156
156
  * Get product
157
157
  */
158
158
  ProductsApi.prototype.getProductRaw = function (requestParameters, initOverrides) {
@@ -202,7 +202,7 @@ var ProductsApi = /** @class */ (function (_super) {
202
202
  });
203
203
  };
204
204
  /**
205
- * Gets a product by the given id
205
+ * Gets a product by a given ID.
206
206
  * Get product
207
207
  */
208
208
  ProductsApi.prototype.getProduct = function (project, productId, optionalParameters, initOverrides) {
@@ -221,7 +221,7 @@ var ProductsApi = /** @class */ (function (_super) {
221
221
  });
222
222
  };
223
223
  /**
224
- * Lists all products
224
+ * Lists all enabled store listing products attached to the given project.
225
225
  * List products
226
226
  */
227
227
  ProductsApi.prototype.getProductsRaw = function (requestParameters, initOverrides) {
@@ -274,7 +274,7 @@ var ProductsApi = /** @class */ (function (_super) {
274
274
  });
275
275
  };
276
276
  /**
277
- * Lists all products
277
+ * Lists all enabled store listing products attached to the given project.
278
278
  * List products
279
279
  */
280
280
  ProductsApi.prototype.getProducts = function (project, optionalParameters, initOverrides) {
@@ -292,71 +292,6 @@ var ProductsApi = /** @class */ (function (_super) {
292
292
  });
293
293
  });
294
294
  };
295
- /**
296
- * Import products
297
- * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
298
- */
299
- ProductsApi.prototype.importProductsRaw = function (requestParameters, initOverrides) {
300
- return __awaiter(this, void 0, void 0, function () {
301
- var queryParameters, headerParameters, _a, _b, response;
302
- return __generator(this, function (_c) {
303
- switch (_c.label) {
304
- case 0:
305
- if (requestParameters.project === null || requestParameters.project === undefined) {
306
- throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling importProducts.');
307
- }
308
- queryParameters = {};
309
- if (requestParameters.project !== undefined) {
310
- queryParameters['project'] = requestParameters.project;
311
- }
312
- headerParameters = {};
313
- headerParameters['Content-Type'] = 'text/csv';
314
- if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
315
- // oauth required
316
- _a = headerParameters;
317
- _b = "Authorization";
318
- return [4 /*yield*/, this.configuration.accessToken("session-oauth", [])];
319
- case 1:
320
- // oauth required
321
- _a[_b] = _c.sent();
322
- _c.label = 2;
323
- case 2:
324
- if (this.configuration && this.configuration.apiKey) {
325
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
326
- }
327
- return [4 /*yield*/, this.request({
328
- path: "/v1/catalog/products/import",
329
- method: 'POST',
330
- headers: headerParameters,
331
- query: queryParameters,
332
- body: requestParameters.body,
333
- }, initOverrides)];
334
- case 3:
335
- response = _c.sent();
336
- return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.ImportProducts200ResponseFromJSON)(jsonValue); })];
337
- }
338
- });
339
- });
340
- };
341
- /**
342
- * Import products
343
- * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
344
- */
345
- ProductsApi.prototype.importProducts = function (project, optionalParameters, initOverrides) {
346
- if (optionalParameters === void 0) { optionalParameters = {}; }
347
- return __awaiter(this, void 0, void 0, function () {
348
- var response;
349
- return __generator(this, function (_a) {
350
- switch (_a.label) {
351
- case 0: return [4 /*yield*/, this.importProductsRaw(__assign({ project: project }, optionalParameters), initOverrides)];
352
- case 1:
353
- response = _a.sent();
354
- return [4 /*yield*/, response.value()];
355
- case 2: return [2 /*return*/, _a.sent()];
356
- }
357
- });
358
- });
359
- };
360
295
  return ProductsApi;
361
296
  }(runtime.BaseAPI));
362
297
  exports.ProductsApi = ProductsApi;
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Product Catalog API
3
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
3
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.6.2
5
+ * The version of the OpenAPI document: 1.6.4
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,22 +28,22 @@ export interface ListVariantsRequest {
28
28
  */
29
29
  export declare class VariantsApi extends runtime.BaseAPI {
30
30
  /**
31
- * Gets a variant by the given id
31
+ * Gets a variant by a given ID.
32
32
  * Get variant
33
33
  */
34
34
  getVariantRaw(requestParameters: GetVariantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Variant>>;
35
35
  /**
36
- * Gets a variant by the given id
36
+ * Gets a variant by a given ID.
37
37
  * Get variant
38
38
  */
39
39
  getVariant(project: string, variantId: string, optionalParameters?: runtime.OptionalOnly<GetVariantRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Variant>;
40
40
  /**
41
- * Lists all variants
41
+ * Lists all variants that belong to enabled products attached to the given project.
42
42
  * List variants
43
43
  */
44
44
  listVariantsRaw(requestParameters: ListVariantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantsResponse>>;
45
45
  /**
46
- * Lists all variants
46
+ * Lists all variants that belong to enabled products attached to the given project.
47
47
  * List variants
48
48
  */
49
49
  listVariants(project: string, optionalParameters?: runtime.OptionalOnly<ListVariantsRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantsResponse>;
@@ -3,9 +3,9 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Product Catalog API
6
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.6.2
8
+ * The version of the OpenAPI document: 1.6.4
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -87,7 +87,7 @@ var VariantsApi = /** @class */ (function (_super) {
87
87
  return _super !== null && _super.apply(this, arguments) || this;
88
88
  }
89
89
  /**
90
- * Gets a variant by the given id
90
+ * Gets a variant by a given ID.
91
91
  * Get variant
92
92
  */
93
93
  VariantsApi.prototype.getVariantRaw = function (requestParameters, initOverrides) {
@@ -137,7 +137,7 @@ var VariantsApi = /** @class */ (function (_super) {
137
137
  });
138
138
  };
139
139
  /**
140
- * Gets a variant by the given id
140
+ * Gets a variant by a given ID.
141
141
  * Get variant
142
142
  */
143
143
  VariantsApi.prototype.getVariant = function (project, variantId, optionalParameters, initOverrides) {
@@ -156,7 +156,7 @@ var VariantsApi = /** @class */ (function (_super) {
156
156
  });
157
157
  };
158
158
  /**
159
- * Lists all variants
159
+ * Lists all variants that belong to enabled products attached to the given project.
160
160
  * List variants
161
161
  */
162
162
  VariantsApi.prototype.listVariantsRaw = function (requestParameters, initOverrides) {
@@ -212,7 +212,7 @@ var VariantsApi = /** @class */ (function (_super) {
212
212
  });
213
213
  };
214
214
  /**
215
- * Lists all variants
215
+ * Lists all variants that belong to enabled products attached to the given project.
216
216
  * List variants
217
217
  */
218
218
  VariantsApi.prototype.listVariants = function (project, optionalParameters, initOverrides) {
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Product Catalog API
3
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
3
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.6.2
5
+ * The version of the OpenAPI document: 1.6.4
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,9 +3,9 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Product Catalog API
6
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.6.2
8
+ * The version of the OpenAPI document: 1.6.4
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Product Catalog API
3
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
3
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.6.2
5
+ * The version of the OpenAPI document: 1.6.4
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,9 +3,9 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Product Catalog API
6
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.6.2
8
+ * The version of the OpenAPI document: 1.6.4
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Product Catalog API
3
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
3
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.6.2
5
+ * The version of the OpenAPI document: 1.6.4
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Attribute thumbnail, intended for interfaces like storefront colour selector
13
+ * Attribute thumbnail, intended for interfaces like storefront colour selector.
14
14
  * @export
15
15
  * @interface AttributeThumbnail
16
16
  */
@@ -3,9 +3,9 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Product Catalog API
6
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.6.2
8
+ * The version of the OpenAPI document: 1.6.4
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Product Catalog API
3
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
3
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.6.2
5
+ * The version of the OpenAPI document: 1.6.4
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,7 +18,7 @@ import type { CreateProductRequestVariantsInnerImagesInner } from './CreateProdu
18
18
  */
19
19
  export interface CreateProductRequest {
20
20
  /**
21
- * GFN product ref
21
+ * 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.
22
22
  * @type {string}
23
23
  * @memberof CreateProductRequest
24
24
  */
@@ -36,19 +36,19 @@ export interface CreateProductRequest {
36
36
  */
37
37
  description?: string;
38
38
  /**
39
- * Whether the product is enabled
39
+ * Whether the product is enabled upon creation.
40
40
  * @type {boolean}
41
41
  * @memberof CreateProductRequest
42
42
  */
43
43
  enabled?: boolean;
44
44
  /**
45
- * A custom url slug for the product
45
+ * A custom URL slug for the product. This must be unique for each product on the project.
46
46
  * @type {string}
47
47
  * @memberof CreateProductRequest
48
48
  */
49
49
  slug?: string;
50
50
  /**
51
- * Product tags
51
+ * Additional product tags used for searching and filtering.
52
52
  * @type {Array<string>}
53
53
  * @memberof CreateProductRequest
54
54
  */
@@ -60,7 +60,7 @@ export interface CreateProductRequest {
60
60
  */
61
61
  variants: Array<CreateProductRequestVariantsInner>;
62
62
  /**
63
- * Additional files
63
+ * Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc.
64
64
  * @type {Array<CreateProductRequestVariantsInnerImagesInner>}
65
65
  * @memberof CreateProductRequest
66
66
  */
@@ -3,9 +3,9 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Product Catalog API
6
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.6.2
8
+ * The version of the OpenAPI document: 1.6.4
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Product Catalog API
3
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
3
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.6.2
5
+ * The version of the OpenAPI document: 1.6.4
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,7 +12,7 @@
12
12
  import type { CreateProductRequestVariantsInnerApplicationsInner } from './CreateProductRequestVariantsInnerApplicationsInner';
13
13
  import type { CreateProductRequestVariantsInnerAttributesInner } from './CreateProductRequestVariantsInnerAttributesInner';
14
14
  import type { CreateProductRequestVariantsInnerImagesInner } from './CreateProductRequestVariantsInnerImagesInner';
15
- import type { Price } from './Price';
15
+ import type { CreateProductRequestVariantsInnerRetailPrice } from './CreateProductRequestVariantsInnerRetailPrice';
16
16
  /**
17
17
  *
18
18
  * @export
@@ -20,31 +20,31 @@ import type { Price } from './Price';
20
20
  */
21
21
  export interface CreateProductRequestVariantsInner {
22
22
  /**
23
- * Variant attributes
23
+ * Attributes associated to a variant such as Colour and Size.
24
24
  * @type {Array<CreateProductRequestVariantsInnerAttributesInner>}
25
25
  * @memberof CreateProductRequestVariantsInner
26
26
  */
27
- attributes?: Array<CreateProductRequestVariantsInnerAttributesInner>;
27
+ attributes: Array<CreateProductRequestVariantsInnerAttributesInner>;
28
28
  /**
29
29
  *
30
- * @type {Price}
30
+ * @type {CreateProductRequestVariantsInnerRetailPrice}
31
31
  * @memberof CreateProductRequestVariantsInner
32
32
  */
33
- retailPrice?: Price;
33
+ retailPrice: CreateProductRequestVariantsInnerRetailPrice;
34
34
  /**
35
- * A custom sku
35
+ * A custom stock keeping unit for the variant.
36
36
  * @type {string}
37
37
  * @memberof CreateProductRequestVariantsInner
38
38
  */
39
39
  sku?: string;
40
40
  /**
41
- * Design applications.
41
+ * Design applications. If not provided, the product will be blank.
42
42
  * @type {Array<CreateProductRequestVariantsInnerApplicationsInner>}
43
43
  * @memberof CreateProductRequestVariantsInner
44
44
  */
45
45
  applications?: Array<CreateProductRequestVariantsInnerApplicationsInner>;
46
46
  /**
47
- * Existing images to use as this variant's flat images
47
+ * Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the warehouse product provided. Accepts PNG and JPEG files.
48
48
  * @type {Array<CreateProductRequestVariantsInnerImagesInner>}
49
49
  * @memberof CreateProductRequestVariantsInner
50
50
  */
@@ -3,9 +3,9 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Product Catalog API
6
- * Manage Product Catalog For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
+ * Manage 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 warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.6.2
8
+ * The version of the OpenAPI document: 1.6.4
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,12 +18,14 @@ var runtime_1 = require("../runtime");
18
18
  var CreateProductRequestVariantsInnerApplicationsInner_1 = require("./CreateProductRequestVariantsInnerApplicationsInner");
19
19
  var CreateProductRequestVariantsInnerAttributesInner_1 = require("./CreateProductRequestVariantsInnerAttributesInner");
20
20
  var CreateProductRequestVariantsInnerImagesInner_1 = require("./CreateProductRequestVariantsInnerImagesInner");
21
- var Price_1 = require("./Price");
21
+ var CreateProductRequestVariantsInnerRetailPrice_1 = require("./CreateProductRequestVariantsInnerRetailPrice");
22
22
  /**
23
23
  * Check if a given object implements the CreateProductRequestVariantsInner interface.
24
24
  */
25
25
  function instanceOfCreateProductRequestVariantsInner(value) {
26
26
  var isInstance = true;
27
+ isInstance = isInstance && "attributes" in value;
28
+ isInstance = isInstance && "retailPrice" in value;
27
29
  return isInstance;
28
30
  }
29
31
  exports.instanceOfCreateProductRequestVariantsInner = instanceOfCreateProductRequestVariantsInner;
@@ -36,8 +38,8 @@ function CreateProductRequestVariantsInnerFromJSONTyped(json, ignoreDiscriminato
36
38
  return json;
37
39
  }
38
40
  return {
39
- 'attributes': !(0, runtime_1.exists)(json, 'attributes') ? undefined : (json['attributes'].map(CreateProductRequestVariantsInnerAttributesInner_1.CreateProductRequestVariantsInnerAttributesInnerFromJSON)),
40
- 'retailPrice': !(0, runtime_1.exists)(json, 'retailPrice') ? undefined : (0, Price_1.PriceFromJSON)(json['retailPrice']),
41
+ 'attributes': (json['attributes'].map(CreateProductRequestVariantsInnerAttributesInner_1.CreateProductRequestVariantsInnerAttributesInnerFromJSON)),
42
+ 'retailPrice': (0, CreateProductRequestVariantsInnerRetailPrice_1.CreateProductRequestVariantsInnerRetailPriceFromJSON)(json['retailPrice']),
41
43
  'sku': !(0, runtime_1.exists)(json, 'sku') ? undefined : json['sku'],
42
44
  'applications': !(0, runtime_1.exists)(json, 'applications') ? undefined : (json['applications'].map(CreateProductRequestVariantsInnerApplicationsInner_1.CreateProductRequestVariantsInnerApplicationsInnerFromJSON)),
43
45
  'images': !(0, runtime_1.exists)(json, 'images') ? undefined : (json['images'].map(CreateProductRequestVariantsInnerImagesInner_1.CreateProductRequestVariantsInnerImagesInnerFromJSON)),
@@ -52,8 +54,8 @@ function CreateProductRequestVariantsInnerToJSON(value) {
52
54
  return null;
53
55
  }
54
56
  return {
55
- 'attributes': value.attributes === undefined ? undefined : (value.attributes.map(CreateProductRequestVariantsInnerAttributesInner_1.CreateProductRequestVariantsInnerAttributesInnerToJSON)),
56
- 'retailPrice': (0, Price_1.PriceToJSON)(value.retailPrice),
57
+ 'attributes': (value.attributes.map(CreateProductRequestVariantsInnerAttributesInner_1.CreateProductRequestVariantsInnerAttributesInnerToJSON)),
58
+ 'retailPrice': (0, CreateProductRequestVariantsInnerRetailPrice_1.CreateProductRequestVariantsInnerRetailPriceToJSON)(value.retailPrice),
57
59
  'sku': value.sku,
58
60
  'applications': value.applications === undefined ? undefined : (value.applications.map(CreateProductRequestVariantsInnerApplicationsInner_1.CreateProductRequestVariantsInnerApplicationsInnerToJSON)),
59
61
  'images': value.images === undefined ? undefined : (value.images.map(CreateProductRequestVariantsInnerImagesInner_1.CreateProductRequestVariantsInnerImagesInnerToJSON)),