@teemill/gfn-catalog 1.3.0 → 2.0.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 (120) hide show
  1. package/.openapi-generator/FILES +7 -19
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +3 -3
  4. package/api.ts +1646 -0
  5. package/base.ts +86 -0
  6. package/common.ts +150 -0
  7. package/configuration.ts +110 -0
  8. package/dist/api.d.ts +1074 -0
  9. package/dist/api.js +1014 -0
  10. package/dist/base.d.ts +66 -0
  11. package/dist/base.js +65 -0
  12. package/dist/common.d.ts +65 -0
  13. package/dist/common.js +161 -0
  14. package/dist/configuration.d.ts +91 -0
  15. package/dist/configuration.js +43 -0
  16. package/dist/esm/api.d.ts +1074 -0
  17. package/dist/esm/api.js +995 -0
  18. package/dist/esm/base.d.ts +66 -0
  19. package/dist/esm/{models/AttributeThumbnail.js → base.js} +38 -26
  20. package/dist/esm/common.d.ts +65 -0
  21. package/dist/esm/common.js +149 -0
  22. package/dist/esm/configuration.d.ts +91 -0
  23. package/dist/esm/configuration.js +39 -0
  24. package/dist/esm/index.d.ts +13 -3
  25. package/dist/esm/index.js +13 -3
  26. package/dist/index.d.ts +13 -3
  27. package/dist/index.js +15 -5
  28. package/git_push.sh +57 -0
  29. package/{dist/models/Stock.d.ts → index.ts} +8 -21
  30. package/package.json +15 -3
  31. package/tsconfig.json +4 -6
  32. package/dist/apis/ProductsApi.d.ts +0 -35
  33. package/dist/apis/ProductsApi.js +0 -85
  34. package/dist/apis/VariantsApi.d.ts +0 -82
  35. package/dist/apis/VariantsApi.js +0 -229
  36. package/dist/apis/index.d.ts +0 -2
  37. package/dist/apis/index.js +0 -20
  38. package/dist/esm/apis/ProductsApi.d.ts +0 -35
  39. package/dist/esm/apis/ProductsApi.js +0 -81
  40. package/dist/esm/apis/VariantsApi.d.ts +0 -82
  41. package/dist/esm/apis/VariantsApi.js +0 -225
  42. package/dist/esm/apis/index.d.ts +0 -2
  43. package/dist/esm/apis/index.js +0 -4
  44. package/dist/esm/models/ApiError.d.ts +0 -37
  45. package/dist/esm/models/ApiError.js +0 -42
  46. package/dist/esm/models/Attribute.d.ts +0 -50
  47. package/dist/esm/models/Attribute.js +0 -49
  48. package/dist/esm/models/AttributeThumbnail.d.ts +0 -46
  49. package/dist/esm/models/Image.d.ts +0 -67
  50. package/dist/esm/models/Image.js +0 -50
  51. package/dist/esm/models/Product.d.ts +0 -67
  52. package/dist/esm/models/Product.js +0 -52
  53. package/dist/esm/models/ProductsResponse.d.ts +0 -38
  54. package/dist/esm/models/ProductsResponse.js +0 -41
  55. package/dist/esm/models/Stock.d.ts +0 -31
  56. package/dist/esm/models/Stock.js +0 -38
  57. package/dist/esm/models/StockResponse.d.ts +0 -38
  58. package/dist/esm/models/StockResponse.js +0 -41
  59. package/dist/esm/models/Variant.d.ts +0 -78
  60. package/dist/esm/models/Variant.js +0 -61
  61. package/dist/esm/models/VariantManufacturerOrigin.d.ts +0 -37
  62. package/dist/esm/models/VariantManufacturerOrigin.js +0 -40
  63. package/dist/esm/models/VariantProduct.d.ts +0 -37
  64. package/dist/esm/models/VariantProduct.js +0 -40
  65. package/dist/esm/models/VariantStock.d.ts +0 -50
  66. package/dist/esm/models/VariantStock.js +0 -45
  67. package/dist/esm/models/VariantsResponse.d.ts +0 -38
  68. package/dist/esm/models/VariantsResponse.js +0 -41
  69. package/dist/esm/models/index.d.ts +0 -13
  70. package/dist/esm/models/index.js +0 -15
  71. package/dist/esm/runtime.d.ts +0 -187
  72. package/dist/esm/runtime.js +0 -333
  73. package/dist/models/ApiError.d.ts +0 -37
  74. package/dist/models/ApiError.js +0 -49
  75. package/dist/models/Attribute.d.ts +0 -50
  76. package/dist/models/Attribute.js +0 -56
  77. package/dist/models/AttributeThumbnail.d.ts +0 -46
  78. package/dist/models/AttributeThumbnail.js +0 -55
  79. package/dist/models/Image.d.ts +0 -67
  80. package/dist/models/Image.js +0 -57
  81. package/dist/models/Product.d.ts +0 -67
  82. package/dist/models/Product.js +0 -59
  83. package/dist/models/ProductsResponse.d.ts +0 -38
  84. package/dist/models/ProductsResponse.js +0 -48
  85. package/dist/models/Stock.js +0 -45
  86. package/dist/models/StockResponse.d.ts +0 -38
  87. package/dist/models/StockResponse.js +0 -48
  88. package/dist/models/Variant.d.ts +0 -78
  89. package/dist/models/Variant.js +0 -68
  90. package/dist/models/VariantManufacturerOrigin.d.ts +0 -37
  91. package/dist/models/VariantManufacturerOrigin.js +0 -47
  92. package/dist/models/VariantProduct.d.ts +0 -37
  93. package/dist/models/VariantProduct.js +0 -47
  94. package/dist/models/VariantStock.d.ts +0 -50
  95. package/dist/models/VariantStock.js +0 -52
  96. package/dist/models/VariantsResponse.d.ts +0 -38
  97. package/dist/models/VariantsResponse.js +0 -48
  98. package/dist/models/index.d.ts +0 -13
  99. package/dist/models/index.js +0 -31
  100. package/dist/runtime.d.ts +0 -187
  101. package/dist/runtime.js +0 -349
  102. package/src/apis/ProductsApi.ts +0 -113
  103. package/src/apis/VariantsApi.ts +0 -342
  104. package/src/apis/index.ts +0 -4
  105. package/src/index.ts +0 -5
  106. package/src/models/ApiError.ts +0 -69
  107. package/src/models/Attribute.ts +0 -93
  108. package/src/models/AttributeThumbnail.ts +0 -80
  109. package/src/models/Image.ts +0 -108
  110. package/src/models/Product.ts +0 -109
  111. package/src/models/ProductsResponse.ts +0 -75
  112. package/src/models/Stock.ts +0 -60
  113. package/src/models/StockResponse.ts +0 -75
  114. package/src/models/Variant.ts +0 -149
  115. package/src/models/VariantManufacturerOrigin.ts +0 -68
  116. package/src/models/VariantProduct.ts +0 -68
  117. package/src/models/VariantStock.ts +0 -91
  118. package/src/models/VariantsResponse.ts +0 -75
  119. package/src/models/index.ts +0 -15
  120. package/src/runtime.ts +0 -441
@@ -1,31 +1,18 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
1
3
  /**
2
4
  * GFN Catalog API
3
5
  * 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
6
  *
5
- * The version of the OpenAPI document: 1.3.0
7
+ * The version of the OpenAPI document: 2.0.0
6
8
  * Contact: hello@teemill.com
7
9
  *
8
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
11
  * https://openapi-generator.tech
10
12
  * Do not edit the class manually.
11
13
  */
12
- /**
13
- *
14
- * @export
15
- * @interface Stock
16
- */
17
- export interface Stock {
18
- /**
19
- * Current stock level
20
- * @type {number}
21
- * @memberof Stock
22
- */
23
- level?: number;
24
- }
25
- /**
26
- * Check if a given object implements the Stock interface.
27
- */
28
- export declare function instanceOfStock(value: object): boolean;
29
- export declare function StockFromJSON(json: any): Stock;
30
- export declare function StockFromJSONTyped(json: any, ignoreDiscriminator: boolean): Stock;
31
- export declare function StockToJSON(value?: Stock | null): any;
14
+
15
+
16
+ export * from "./api";
17
+ export * from "./configuration";
18
+
package/package.json CHANGED
@@ -1,12 +1,20 @@
1
1
  {
2
2
  "name": "@teemill/gfn-catalog",
3
- "version": "1.3.0",
3
+ "version": "2.0.0",
4
4
  "description": "OpenAPI client for @teemill/gfn-catalog",
5
- "author": "OpenAPI-Generator",
5
+ "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
7
7
  "type": "git",
8
8
  "url": "https://github.com/Teemill/public-api.git"
9
9
  },
10
+ "keywords": [
11
+ "axios",
12
+ "typescript",
13
+ "openapi-client",
14
+ "openapi-generator",
15
+ "@teemill/gfn-catalog"
16
+ ],
17
+ "license": "Unlicense",
10
18
  "main": "./dist/index.js",
11
19
  "typings": "./dist/index.d.ts",
12
20
  "module": "./dist/esm/index.js",
@@ -15,7 +23,11 @@
15
23
  "build": "tsc && tsc -p tsconfig.esm.json",
16
24
  "prepare": "npm run build"
17
25
  },
26
+ "dependencies": {
27
+ "axios": "^1.6.1"
28
+ },
18
29
  "devDependencies": {
19
- "typescript": "^4.0"
30
+ "@types/node": "12.11.5 - 12.20.42",
31
+ "typescript": "^4.0 || ^5.0"
20
32
  }
21
33
  }
package/tsconfig.json CHANGED
@@ -1,14 +1,12 @@
1
1
  {
2
2
  "compilerOptions": {
3
3
  "declaration": true,
4
- "target": "es6",
4
+ "target": "ES6",
5
5
  "module": "commonjs",
6
- "moduleResolution": "node",
6
+ "noImplicitAny": true,
7
7
  "outDir": "dist",
8
- "lib": [
9
- "esnext",
10
- "dom"
11
- ],
8
+ "rootDir": ".",
9
+ "moduleResolution": "node",
12
10
  "typeRoots": [
13
11
  "node_modules/@types"
14
12
  ]
@@ -1,35 +0,0 @@
1
- /**
2
- * GFN Catalog API
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
- *
5
- * The version of the OpenAPI document: 1.3.0
6
- * Contact: hello@teemill.com
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import * as runtime from '../runtime';
13
- import type { ProductsResponse } from '../models/index';
14
- export interface ListProductsRequest {
15
- project: string;
16
- pageToken?: number;
17
- pageSize?: number;
18
- fields?: string;
19
- search?: string;
20
- }
21
- /**
22
- *
23
- */
24
- export declare class ProductsApi extends runtime.BaseAPI {
25
- /**
26
- * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
27
- * List GFN products
28
- */
29
- listProductsRaw(requestParameters: ListProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductsResponse>>;
30
- /**
31
- * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
32
- * List GFN products
33
- */
34
- listProducts(project: string, optionalParameters?: runtime.OptionalOnly<ListProductsRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductsResponse>;
35
- }
@@ -1,85 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * GFN Catalog API
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
- *
8
- * The version of the OpenAPI document: 1.3.0
9
- * Contact: hello@teemill.com
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
- return new (P || (P = Promise))(function (resolve, reject) {
18
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
- step((generator = generator.apply(thisArg, _arguments || [])).next());
22
- });
23
- };
24
- Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.ProductsApi = void 0;
26
- const runtime = require("../runtime");
27
- const index_1 = require("../models/index");
28
- /**
29
- *
30
- */
31
- class ProductsApi extends runtime.BaseAPI {
32
- /**
33
- * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
34
- * List GFN products
35
- */
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));
72
- });
73
- }
74
- /**
75
- * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
76
- * List GFN products
77
- */
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();
82
- });
83
- }
84
- }
85
- exports.ProductsApi = ProductsApi;
@@ -1,82 +0,0 @@
1
- /**
2
- * GFN Catalog API
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
- *
5
- * The version of the OpenAPI document: 1.3.0
6
- * Contact: hello@teemill.com
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import * as runtime from '../runtime';
13
- import type { StockResponse, Variant, VariantStock, VariantsResponse } from '../models/index';
14
- export interface GetStockRequest {
15
- project: string;
16
- variantId: string;
17
- fulfillmentProjects?: string;
18
- }
19
- export interface GetVariantRequest {
20
- project: string;
21
- variantId: string;
22
- fields?: string;
23
- }
24
- export interface ListStockRequest {
25
- project: string;
26
- fulfillmentProjects?: string;
27
- pageToken?: number;
28
- pageSize?: number;
29
- search?: string;
30
- }
31
- export interface ListVariantsRequest {
32
- project: string;
33
- pageToken?: number;
34
- pageSize?: number;
35
- fields?: string;
36
- search?: string;
37
- }
38
- /**
39
- *
40
- */
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>;
52
- /**
53
- * Gets a GFN variant by the given ID.
54
- * Get a GFN variant
55
- */
56
- getVariantRaw(requestParameters: GetVariantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Variant>>;
57
- /**
58
- * Gets a GFN variant by the given ID.
59
- * Get a GFN variant
60
- */
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>;
72
- /**
73
- * Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
74
- * List GFN variants
75
- */
76
- listVariantsRaw(requestParameters: ListVariantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantsResponse>>;
77
- /**
78
- * Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
79
- * List GFN variants
80
- */
81
- listVariants(project: string, optionalParameters?: runtime.OptionalOnly<ListVariantsRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VariantsResponse>;
82
- }
@@ -1,229 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * GFN Catalog API
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
- *
8
- * The version of the OpenAPI document: 1.3.0
9
- * Contact: hello@teemill.com
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
- return new (P || (P = Promise))(function (resolve, reject) {
18
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
- step((generator = generator.apply(thisArg, _arguments || [])).next());
22
- });
23
- };
24
- Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.VariantsApi = void 0;
26
- const runtime = require("../runtime");
27
- const index_1 = require("../models/index");
28
- /**
29
- *
30
- */
31
- class VariantsApi extends runtime.BaseAPI {
32
- /**
33
- * Gets the stock level for the GFN variant with the given ID.
34
- * Get GFN variant stock
35
- */
36
- getStockRaw(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 getStock.');
40
- }
41
- if (requestParameters.variantId === null || requestParameters.variantId === undefined) {
42
- throw new runtime.RequiredError('variantId', 'Required parameter requestParameters.variantId was null or undefined when calling getStock.');
43
- }
44
- const queryParameters = {};
45
- if (requestParameters.project !== undefined) {
46
- queryParameters['project'] = requestParameters.project;
47
- }
48
- if (requestParameters.fulfillmentProjects !== undefined) {
49
- queryParameters['fulfillmentProjects'] = requestParameters.fulfillmentProjects;
50
- }
51
- const headerParameters = {};
52
- if (this.configuration && this.configuration.accessToken) {
53
- // oauth required
54
- headerParameters["Authorization"] = yield this.configuration.accessToken("session-oauth", []);
55
- }
56
- if (this.configuration && this.configuration.apiKey) {
57
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
58
- }
59
- const response = yield this.request({
60
- path: `/v1/gfn/catalog/stock/{variantId}`.replace(`{${"variantId"}}`, encodeURIComponent(String(requestParameters.variantId))),
61
- method: 'GET',
62
- headers: headerParameters,
63
- query: queryParameters,
64
- }, initOverrides);
65
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.VariantStockFromJSON)(jsonValue));
66
- });
67
- }
68
- /**
69
- * Gets the stock level for the GFN variant with the given ID.
70
- * Get GFN variant stock
71
- */
72
- getStock(project, variantId, optionalParameters = {}, initOverrides) {
73
- return __awaiter(this, void 0, void 0, function* () {
74
- const response = yield this.getStockRaw(Object.assign({ project: project, variantId: variantId }, optionalParameters), initOverrides);
75
- return yield response.value();
76
- });
77
- }
78
- /**
79
- * Gets a GFN variant by the given ID.
80
- * Get a GFN variant
81
- */
82
- getVariantRaw(requestParameters, initOverrides) {
83
- return __awaiter(this, void 0, void 0, function* () {
84
- if (requestParameters.project === null || requestParameters.project === undefined) {
85
- throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling getVariant.');
86
- }
87
- if (requestParameters.variantId === null || requestParameters.variantId === undefined) {
88
- throw new runtime.RequiredError('variantId', 'Required parameter requestParameters.variantId was null or undefined when calling getVariant.');
89
- }
90
- const queryParameters = {};
91
- if (requestParameters.project !== undefined) {
92
- queryParameters['project'] = requestParameters.project;
93
- }
94
- if (requestParameters.fields !== undefined) {
95
- queryParameters['fields'] = requestParameters.fields;
96
- }
97
- const headerParameters = {};
98
- if (this.configuration && this.configuration.accessToken) {
99
- // oauth required
100
- headerParameters["Authorization"] = yield this.configuration.accessToken("session-oauth", []);
101
- }
102
- if (this.configuration && this.configuration.apiKey) {
103
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
104
- }
105
- const response = yield this.request({
106
- path: `/v1/gfn/catalog/variants/{variantId}`.replace(`{${"variantId"}}`, encodeURIComponent(String(requestParameters.variantId))),
107
- method: 'GET',
108
- headers: headerParameters,
109
- query: queryParameters,
110
- }, initOverrides);
111
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.VariantFromJSON)(jsonValue));
112
- });
113
- }
114
- /**
115
- * Gets a GFN variant by the given ID.
116
- * Get a GFN variant
117
- */
118
- getVariant(project, variantId, optionalParameters = {}, initOverrides) {
119
- return __awaiter(this, void 0, void 0, function* () {
120
- const response = yield this.getVariantRaw(Object.assign({ project: project, variantId: variantId }, optionalParameters), initOverrides);
121
- return yield response.value();
122
- });
123
- }
124
- /**
125
- * Lists the stock levels for all GFN variants available to the project.
126
- * List GFN variant stock
127
- */
128
- listStockRaw(requestParameters, initOverrides) {
129
- return __awaiter(this, void 0, void 0, function* () {
130
- if (requestParameters.project === null || requestParameters.project === undefined) {
131
- throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling listStock.');
132
- }
133
- const queryParameters = {};
134
- if (requestParameters.project !== undefined) {
135
- queryParameters['project'] = requestParameters.project;
136
- }
137
- if (requestParameters.fulfillmentProjects !== undefined) {
138
- queryParameters['fulfillmentProjects'] = requestParameters.fulfillmentProjects;
139
- }
140
- if (requestParameters.pageToken !== undefined) {
141
- queryParameters['pageToken'] = requestParameters.pageToken;
142
- }
143
- if (requestParameters.pageSize !== undefined) {
144
- queryParameters['pageSize'] = requestParameters.pageSize;
145
- }
146
- if (requestParameters.search !== undefined) {
147
- queryParameters['search'] = requestParameters.search;
148
- }
149
- const headerParameters = {};
150
- if (this.configuration && this.configuration.accessToken) {
151
- // oauth required
152
- headerParameters["Authorization"] = yield this.configuration.accessToken("session-oauth", []);
153
- }
154
- if (this.configuration && this.configuration.apiKey) {
155
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
156
- }
157
- const response = yield this.request({
158
- path: `/v1/gfn/catalog/stock`,
159
- method: 'GET',
160
- headers: headerParameters,
161
- query: queryParameters,
162
- }, initOverrides);
163
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StockResponseFromJSON)(jsonValue));
164
- });
165
- }
166
- /**
167
- * Lists the stock levels for all GFN variants available to the project.
168
- * List GFN variant stock
169
- */
170
- listStock(project, optionalParameters = {}, initOverrides) {
171
- return __awaiter(this, void 0, void 0, function* () {
172
- const response = yield this.listStockRaw(Object.assign({ project: project }, optionalParameters), initOverrides);
173
- return yield response.value();
174
- });
175
- }
176
- /**
177
- * Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
178
- * List GFN variants
179
- */
180
- listVariantsRaw(requestParameters, initOverrides) {
181
- return __awaiter(this, void 0, void 0, function* () {
182
- if (requestParameters.project === null || requestParameters.project === undefined) {
183
- throw new runtime.RequiredError('project', 'Required parameter requestParameters.project was null or undefined when calling listVariants.');
184
- }
185
- const queryParameters = {};
186
- if (requestParameters.project !== undefined) {
187
- queryParameters['project'] = requestParameters.project;
188
- }
189
- if (requestParameters.pageToken !== undefined) {
190
- queryParameters['pageToken'] = requestParameters.pageToken;
191
- }
192
- if (requestParameters.pageSize !== undefined) {
193
- queryParameters['pageSize'] = requestParameters.pageSize;
194
- }
195
- if (requestParameters.fields !== undefined) {
196
- queryParameters['fields'] = requestParameters.fields;
197
- }
198
- if (requestParameters.search !== undefined) {
199
- queryParameters['search'] = requestParameters.search;
200
- }
201
- const headerParameters = {};
202
- if (this.configuration && this.configuration.accessToken) {
203
- // oauth required
204
- headerParameters["Authorization"] = yield this.configuration.accessToken("session-oauth", []);
205
- }
206
- if (this.configuration && this.configuration.apiKey) {
207
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
208
- }
209
- const response = yield this.request({
210
- path: `/v1/gfn/catalog/variants`,
211
- method: 'GET',
212
- headers: headerParameters,
213
- query: queryParameters,
214
- }, initOverrides);
215
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.VariantsResponseFromJSON)(jsonValue));
216
- });
217
- }
218
- /**
219
- * Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
220
- * List GFN variants
221
- */
222
- listVariants(project, optionalParameters = {}, initOverrides) {
223
- return __awaiter(this, void 0, void 0, function* () {
224
- const response = yield this.listVariantsRaw(Object.assign({ project: project }, optionalParameters), initOverrides);
225
- return yield response.value();
226
- });
227
- }
228
- }
229
- exports.VariantsApi = VariantsApi;
@@ -1,2 +0,0 @@
1
- export * from './ProductsApi';
2
- export * from './VariantsApi';
@@ -1,20 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- /* tslint:disable */
18
- /* eslint-disable */
19
- __exportStar(require("./ProductsApi"), exports);
20
- __exportStar(require("./VariantsApi"), exports);
@@ -1,35 +0,0 @@
1
- /**
2
- * GFN Catalog API
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
- *
5
- * The version of the OpenAPI document: 1.3.0
6
- * Contact: hello@teemill.com
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import * as runtime from '../runtime';
13
- import type { ProductsResponse } from '../models/index';
14
- export interface ListProductsRequest {
15
- project: string;
16
- pageToken?: number;
17
- pageSize?: number;
18
- fields?: string;
19
- search?: string;
20
- }
21
- /**
22
- *
23
- */
24
- export declare class ProductsApi extends runtime.BaseAPI {
25
- /**
26
- * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
27
- * List GFN products
28
- */
29
- listProductsRaw(requestParameters: ListProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductsResponse>>;
30
- /**
31
- * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
32
- * List GFN products
33
- */
34
- listProducts(project: string, optionalParameters?: runtime.OptionalOnly<ListProductsRequest>, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductsResponse>;
35
- }