@teemill/gfn-catalog 1.1.0 → 1.3.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 (95) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +2 -2
  4. package/dist/apis/ProductsApi.d.ts +1 -1
  5. package/dist/apis/ProductsApi.js +47 -128
  6. package/dist/apis/VariantsApi.d.ts +34 -2
  7. package/dist/apis/VariantsApi.js +180 -186
  8. package/dist/esm/apis/ProductsApi.d.ts +35 -0
  9. package/dist/esm/apis/ProductsApi.js +81 -0
  10. package/dist/esm/apis/VariantsApi.d.ts +82 -0
  11. package/dist/esm/apis/VariantsApi.js +225 -0
  12. package/dist/esm/apis/index.d.ts +2 -0
  13. package/dist/esm/apis/index.js +4 -0
  14. package/dist/esm/index.d.ts +3 -0
  15. package/dist/esm/index.js +5 -0
  16. package/dist/esm/models/ApiError.d.ts +37 -0
  17. package/dist/esm/models/ApiError.js +42 -0
  18. package/dist/esm/models/Attribute.d.ts +50 -0
  19. package/dist/esm/models/Attribute.js +49 -0
  20. package/dist/esm/models/AttributeThumbnail.d.ts +46 -0
  21. package/dist/esm/models/AttributeThumbnail.js +48 -0
  22. package/dist/esm/models/Image.d.ts +67 -0
  23. package/dist/esm/models/Image.js +50 -0
  24. package/dist/esm/models/Product.d.ts +67 -0
  25. package/dist/esm/models/Product.js +52 -0
  26. package/dist/esm/models/ProductsResponse.d.ts +38 -0
  27. package/dist/esm/models/ProductsResponse.js +41 -0
  28. package/dist/esm/models/Stock.d.ts +31 -0
  29. package/dist/esm/models/Stock.js +38 -0
  30. package/dist/esm/models/StockResponse.d.ts +38 -0
  31. package/dist/esm/models/StockResponse.js +41 -0
  32. package/dist/esm/models/Variant.d.ts +78 -0
  33. package/dist/esm/models/Variant.js +61 -0
  34. package/dist/esm/models/VariantManufacturerOrigin.d.ts +37 -0
  35. package/dist/esm/models/VariantManufacturerOrigin.js +40 -0
  36. package/dist/esm/models/VariantProduct.d.ts +37 -0
  37. package/dist/esm/models/VariantProduct.js +40 -0
  38. package/dist/esm/models/VariantStock.d.ts +50 -0
  39. package/dist/esm/models/VariantStock.js +45 -0
  40. package/dist/esm/models/VariantsResponse.d.ts +38 -0
  41. package/dist/esm/models/VariantsResponse.js +41 -0
  42. package/dist/esm/models/index.d.ts +13 -0
  43. package/dist/esm/models/index.js +15 -0
  44. package/dist/esm/runtime.d.ts +187 -0
  45. package/dist/esm/runtime.js +333 -0
  46. package/dist/models/ApiError.d.ts +1 -1
  47. package/dist/models/ApiError.js +1 -1
  48. package/dist/models/Attribute.d.ts +1 -1
  49. package/dist/models/Attribute.js +2 -2
  50. package/dist/models/AttributeThumbnail.d.ts +1 -1
  51. package/dist/models/AttributeThumbnail.js +1 -1
  52. package/dist/models/Image.d.ts +1 -1
  53. package/dist/models/Image.js +1 -1
  54. package/dist/models/Product.d.ts +1 -1
  55. package/dist/models/Product.js +1 -1
  56. package/dist/models/ProductsResponse.d.ts +1 -1
  57. package/dist/models/ProductsResponse.js +2 -2
  58. package/dist/models/Stock.d.ts +31 -0
  59. package/dist/models/Stock.js +45 -0
  60. package/dist/models/StockResponse.d.ts +38 -0
  61. package/dist/models/StockResponse.js +48 -0
  62. package/dist/models/Variant.d.ts +11 -4
  63. package/dist/models/Variant.js +10 -7
  64. package/dist/models/VariantManufacturerOrigin.d.ts +37 -0
  65. package/dist/models/VariantManufacturerOrigin.js +47 -0
  66. package/dist/models/VariantProduct.d.ts +1 -1
  67. package/dist/models/VariantProduct.js +1 -1
  68. package/dist/models/VariantStock.d.ts +23 -4
  69. package/dist/models/VariantStock.js +10 -3
  70. package/dist/models/VariantsResponse.d.ts +1 -1
  71. package/dist/models/VariantsResponse.js +2 -2
  72. package/dist/models/index.d.ts +3 -0
  73. package/dist/models/index.js +3 -0
  74. package/dist/runtime.d.ts +1 -1
  75. package/dist/runtime.js +223 -439
  76. package/package.json +4 -2
  77. package/src/apis/ProductsApi.ts +1 -1
  78. package/src/apis/VariantsApi.ts +157 -1
  79. package/src/models/ApiError.ts +1 -1
  80. package/src/models/Attribute.ts +1 -1
  81. package/src/models/AttributeThumbnail.ts +1 -1
  82. package/src/models/Image.ts +1 -1
  83. package/src/models/Product.ts +1 -1
  84. package/src/models/ProductsResponse.ts +1 -1
  85. package/src/models/Stock.ts +60 -0
  86. package/src/models/StockResponse.ts +75 -0
  87. package/src/models/Variant.ts +25 -11
  88. package/src/models/VariantManufacturerOrigin.ts +68 -0
  89. package/src/models/VariantProduct.ts +1 -1
  90. package/src/models/VariantStock.ts +37 -6
  91. package/src/models/VariantsResponse.ts +1 -1
  92. package/src/models/index.ts +3 -0
  93. package/src/runtime.ts +1 -1
  94. package/tsconfig.esm.json +7 -0
  95. package/tsconfig.json +2 -2
@@ -12,10 +12,14 @@ src/models/AttributeThumbnail.ts
12
12
  src/models/Image.ts
13
13
  src/models/Product.ts
14
14
  src/models/ProductsResponse.ts
15
+ src/models/Stock.ts
16
+ src/models/StockResponse.ts
15
17
  src/models/Variant.ts
18
+ src/models/VariantManufacturerOrigin.ts
16
19
  src/models/VariantProduct.ts
17
20
  src/models/VariantStock.ts
18
21
  src/models/VariantsResponse.ts
19
22
  src/models/index.ts
20
23
  src/runtime.ts
24
+ tsconfig.esm.json
21
25
  tsconfig.json
@@ -1 +1 @@
1
- 7.4.0
1
+ 7.5.0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/gfn-catalog@1.1.0
1
+ ## @teemill/gfn-catalog@1.3.0
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
 
@@ -36,7 +36,7 @@ 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/gfn-catalog@1.1.0 --save
39
+ npm install @teemill/gfn-catalog@1.3.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -2,7 +2,7 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 1.1.0
5
+ * The version of the OpenAPI document: 1.3.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,39 +5,13 @@
5
5
  * GFN Catalog API
6
6
  * Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
7
7
  *
8
- * The version of the OpenAPI document: 1.1.0
8
+ * The version of the OpenAPI document: 1.3.0
9
9
  * Contact: hello@teemill.com
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
12
  * https://openapi-generator.tech
13
13
  * Do not edit the class manually.
14
14
  */
15
- var __extends = (this && this.__extends) || (function () {
16
- var extendStatics = function (d, b) {
17
- extendStatics = Object.setPrototypeOf ||
18
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
19
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
20
- return extendStatics(d, b);
21
- };
22
- return function (d, b) {
23
- if (typeof b !== "function" && b !== null)
24
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
25
- extendStatics(d, b);
26
- function __() { this.constructor = d; }
27
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
- };
29
- })();
30
- var __assign = (this && this.__assign) || function () {
31
- __assign = Object.assign || function(t) {
32
- for (var s, i = 1, n = arguments.length; i < n; i++) {
33
- s = arguments[i];
34
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
35
- t[p] = s[p];
36
- }
37
- return t;
38
- };
39
- return __assign.apply(this, arguments);
40
- };
41
15
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
42
16
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
43
17
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -47,120 +21,65 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
47
21
  step((generator = generator.apply(thisArg, _arguments || [])).next());
48
22
  });
49
23
  };
50
- var __generator = (this && this.__generator) || function (thisArg, body) {
51
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
- return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
- function verb(n) { return function (v) { return step([n, v]); }; }
54
- function step(op) {
55
- if (f) throw new TypeError("Generator is already executing.");
56
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
57
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
58
- if (y = 0, t) op = [op[0] & 2, t.value];
59
- switch (op[0]) {
60
- case 0: case 1: t = op; break;
61
- case 4: _.label++; return { value: op[1], done: false };
62
- case 5: _.label++; y = op[1]; op = [0]; continue;
63
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
64
- default:
65
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
66
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
67
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
68
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
69
- if (t[2]) _.ops.pop();
70
- _.trys.pop(); continue;
71
- }
72
- op = body.call(thisArg, _);
73
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
74
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
- }
76
- };
77
24
  Object.defineProperty(exports, "__esModule", { value: true });
78
25
  exports.ProductsApi = void 0;
79
- var runtime = require("../runtime");
80
- var index_1 = require("../models/index");
26
+ const runtime = require("../runtime");
27
+ const index_1 = require("../models/index");
81
28
  /**
82
29
  *
83
30
  */
84
- var ProductsApi = /** @class */ (function (_super) {
85
- __extends(ProductsApi, _super);
86
- function ProductsApi() {
87
- return _super !== null && _super.apply(this, arguments) || this;
88
- }
31
+ class ProductsApi extends runtime.BaseAPI {
89
32
  /**
90
33
  * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
91
34
  * List GFN products
92
35
  */
93
- ProductsApi.prototype.listProductsRaw = function (requestParameters, initOverrides) {
94
- return __awaiter(this, void 0, void 0, function () {
95
- var queryParameters, headerParameters, _a, _b, response;
96
- return __generator(this, function (_c) {
97
- switch (_c.label) {
98
- case 0:
99
- if (requestParameters.project === null || requestParameters.project === undefined) {
100
- throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling listProducts.');
101
- }
102
- queryParameters = {};
103
- if (requestParameters.project !== undefined) {
104
- queryParameters['project'] = requestParameters.project;
105
- }
106
- if (requestParameters.pageToken !== undefined) {
107
- queryParameters['pageToken'] = requestParameters.pageToken;
108
- }
109
- if (requestParameters.pageSize !== undefined) {
110
- queryParameters['pageSize'] = requestParameters.pageSize;
111
- }
112
- if (requestParameters.fields !== undefined) {
113
- queryParameters['fields'] = requestParameters.fields;
114
- }
115
- if (requestParameters.search !== undefined) {
116
- queryParameters['search'] = requestParameters.search;
117
- }
118
- headerParameters = {};
119
- if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
120
- // oauth required
121
- _a = headerParameters;
122
- _b = "Authorization";
123
- return [4 /*yield*/, this.configuration.accessToken("session-oauth", [])];
124
- case 1:
125
- // oauth required
126
- _a[_b] = _c.sent();
127
- _c.label = 2;
128
- case 2:
129
- if (this.configuration && this.configuration.apiKey) {
130
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
131
- }
132
- return [4 /*yield*/, this.request({
133
- path: "/v1/gfn/catalog/products",
134
- method: 'GET',
135
- headers: headerParameters,
136
- query: queryParameters,
137
- }, initOverrides)];
138
- case 3:
139
- response = _c.sent();
140
- return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.ProductsResponseFromJSON)(jsonValue); })];
141
- }
142
- });
36
+ listProductsRaw(requestParameters, initOverrides) {
37
+ return __awaiter(this, void 0, void 0, function* () {
38
+ if (requestParameters.project === null || requestParameters.project === undefined) {
39
+ throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling listProducts.');
40
+ }
41
+ const queryParameters = {};
42
+ if (requestParameters.project !== undefined) {
43
+ queryParameters['project'] = requestParameters.project;
44
+ }
45
+ if (requestParameters.pageToken !== undefined) {
46
+ queryParameters['pageToken'] = requestParameters.pageToken;
47
+ }
48
+ if (requestParameters.pageSize !== undefined) {
49
+ queryParameters['pageSize'] = requestParameters.pageSize;
50
+ }
51
+ if (requestParameters.fields !== undefined) {
52
+ queryParameters['fields'] = requestParameters.fields;
53
+ }
54
+ if (requestParameters.search !== undefined) {
55
+ queryParameters['search'] = requestParameters.search;
56
+ }
57
+ const headerParameters = {};
58
+ if (this.configuration && this.configuration.accessToken) {
59
+ // oauth required
60
+ headerParameters["Authorization"] = yield this.configuration.accessToken("session-oauth", []);
61
+ }
62
+ if (this.configuration && this.configuration.apiKey) {
63
+ headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
64
+ }
65
+ const response = yield this.request({
66
+ path: `/v1/gfn/catalog/products`,
67
+ method: 'GET',
68
+ headers: headerParameters,
69
+ query: queryParameters,
70
+ }, initOverrides);
71
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ProductsResponseFromJSON)(jsonValue));
143
72
  });
144
- };
73
+ }
145
74
  /**
146
75
  * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
147
76
  * List GFN products
148
77
  */
149
- ProductsApi.prototype.listProducts = function (project, optionalParameters, initOverrides) {
150
- if (optionalParameters === void 0) { optionalParameters = {}; }
151
- return __awaiter(this, void 0, void 0, function () {
152
- var response;
153
- return __generator(this, function (_a) {
154
- switch (_a.label) {
155
- case 0: return [4 /*yield*/, this.listProductsRaw(__assign({ project: project }, optionalParameters), initOverrides)];
156
- case 1:
157
- response = _a.sent();
158
- return [4 /*yield*/, response.value()];
159
- case 2: return [2 /*return*/, _a.sent()];
160
- }
161
- });
78
+ listProducts(project, optionalParameters = {}, initOverrides) {
79
+ return __awaiter(this, void 0, void 0, function* () {
80
+ const response = yield this.listProductsRaw(Object.assign({ project: project }, optionalParameters), initOverrides);
81
+ return yield response.value();
162
82
  });
163
- };
164
- return ProductsApi;
165
- }(runtime.BaseAPI));
83
+ }
84
+ }
166
85
  exports.ProductsApi = ProductsApi;
@@ -2,7 +2,7 @@
2
2
  * GFN Catalog API
3
3
  * Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
4
4
  *
5
- * The version of the OpenAPI document: 1.1.0
5
+ * The version of the OpenAPI document: 1.3.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,12 +10,24 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { Variant, VariantsResponse } from '../models/index';
13
+ import type { StockResponse, Variant, VariantStock, VariantsResponse } from '../models/index';
14
+ export interface GetStockRequest {
15
+ project: string;
16
+ variantId: string;
17
+ fulfillmentProjects?: string;
18
+ }
14
19
  export interface GetVariantRequest {
15
20
  project: string;
16
21
  variantId: string;
17
22
  fields?: string;
18
23
  }
24
+ export interface ListStockRequest {
25
+ project: string;
26
+ fulfillmentProjects?: string;
27
+ pageToken?: number;
28
+ pageSize?: number;
29
+ search?: string;
30
+ }
19
31
  export interface ListVariantsRequest {
20
32
  project: string;
21
33
  pageToken?: number;
@@ -27,6 +39,16 @@ export interface ListVariantsRequest {
27
39
  *
28
40
  */
29
41
  export declare class VariantsApi extends runtime.BaseAPI {
42
+ /**
43
+ * Gets the stock level for the GFN variant with the given ID.
44
+ * Get GFN variant stock
45
+ */
46
+ getStockRaw(requestParameters: GetStockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantStock>>;
47
+ /**
48
+ * Gets the stock level for the GFN variant with the given ID.
49
+ * Get GFN variant stock
50
+ */
51
+ getStock(project: string, variantId: string, optionalParameters?: runtime.OptionalOnly<GetStockRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantStock>;
30
52
  /**
31
53
  * Gets a GFN variant by the given ID.
32
54
  * Get a GFN variant
@@ -37,6 +59,16 @@ export declare class VariantsApi extends runtime.BaseAPI {
37
59
  * Get a GFN variant
38
60
  */
39
61
  getVariant(project: string, variantId: string, optionalParameters?: runtime.OptionalOnly<GetVariantRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Variant>;
62
+ /**
63
+ * Lists the stock levels for all GFN variants available to the project.
64
+ * List GFN variant stock
65
+ */
66
+ listStockRaw(requestParameters: ListStockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StockResponse>>;
67
+ /**
68
+ * Lists the stock levels for all GFN variants available to the project.
69
+ * List GFN variant stock
70
+ */
71
+ listStock(project: string, optionalParameters?: runtime.OptionalOnly<ListStockRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StockResponse>;
40
72
  /**
41
73
  * Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
42
74
  * List GFN variants