@teemill/gfn-catalog 1.2.0 → 1.4.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.
- package/.openapi-generator/FILES +10 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +2 -2
- package/dist/apis/ProductsApi.d.ts +1 -1
- package/dist/apis/ProductsApi.js +47 -128
- package/dist/apis/StatementsApi.d.ts +48 -0
- package/dist/apis/StatementsApi.js +127 -0
- package/dist/apis/TransactionsApi.d.ts +48 -0
- package/dist/apis/TransactionsApi.js +129 -0
- package/dist/apis/VariantsApi.d.ts +19 -2
- package/dist/apis/VariantsApi.js +170 -245
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/esm/apis/ProductsApi.d.ts +35 -0
- package/dist/esm/apis/ProductsApi.js +81 -0
- package/dist/esm/apis/StatementsApi.d.ts +48 -0
- package/dist/esm/apis/StatementsApi.js +123 -0
- package/dist/esm/apis/TransactionsApi.d.ts +48 -0
- package/dist/esm/apis/TransactionsApi.js +125 -0
- package/dist/esm/apis/VariantsApi.d.ts +82 -0
- package/dist/esm/apis/VariantsApi.js +225 -0
- package/dist/esm/apis/index.d.ts +4 -0
- package/dist/esm/apis/index.js +6 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/models/ApiError.d.ts +37 -0
- package/dist/esm/models/ApiError.js +42 -0
- package/dist/esm/models/ApiValidationError.d.ts +39 -0
- package/dist/esm/models/ApiValidationError.js +44 -0
- package/dist/esm/models/Attribute.d.ts +50 -0
- package/dist/esm/models/Attribute.js +49 -0
- package/dist/esm/models/AttributeThumbnail.d.ts +46 -0
- package/dist/esm/models/AttributeThumbnail.js +48 -0
- package/dist/esm/models/ExportTransactionsRequest.d.ts +43 -0
- package/dist/esm/models/ExportTransactionsRequest.js +42 -0
- package/dist/esm/models/Image.d.ts +67 -0
- package/dist/esm/models/Image.js +50 -0
- package/dist/esm/models/ListStatements200Response.d.ts +38 -0
- package/dist/esm/models/ListStatements200Response.js +41 -0
- package/dist/esm/models/ListTransactions200Response.d.ts +38 -0
- package/dist/esm/models/ListTransactions200Response.js +41 -0
- package/dist/esm/models/Product.d.ts +67 -0
- package/dist/esm/models/Product.js +52 -0
- package/dist/esm/models/ProductsResponse.d.ts +38 -0
- package/dist/esm/models/ProductsResponse.js +41 -0
- package/dist/esm/models/Statement.d.ts +61 -0
- package/dist/esm/models/Statement.js +60 -0
- package/dist/esm/models/Stock.d.ts +31 -0
- package/dist/esm/models/Stock.js +38 -0
- package/dist/esm/models/StockResponse.d.ts +38 -0
- package/dist/esm/models/StockResponse.js +41 -0
- package/dist/esm/models/Transaction.d.ts +68 -0
- package/dist/esm/models/Transaction.js +61 -0
- package/dist/esm/models/TransactionOrder.d.ts +37 -0
- package/dist/esm/models/TransactionOrder.js +44 -0
- package/dist/esm/models/Variant.d.ts +78 -0
- package/dist/esm/models/Variant.js +61 -0
- package/dist/esm/models/VariantManufacturerOrigin.d.ts +37 -0
- package/dist/esm/models/VariantManufacturerOrigin.js +40 -0
- package/dist/esm/models/VariantProduct.d.ts +37 -0
- package/dist/esm/models/VariantProduct.js +40 -0
- package/dist/esm/models/VariantStock.d.ts +50 -0
- package/dist/esm/models/VariantStock.js +45 -0
- package/dist/esm/models/VariantsResponse.d.ts +38 -0
- package/dist/esm/models/VariantsResponse.js +41 -0
- package/dist/esm/models/index.d.ts +20 -0
- package/dist/esm/models/index.js +22 -0
- package/dist/esm/runtime.d.ts +187 -0
- package/dist/esm/runtime.js +333 -0
- package/dist/models/ApiError.d.ts +2 -2
- package/dist/models/ApiError.js +2 -2
- package/dist/models/ApiValidationError.d.ts +39 -0
- package/dist/models/ApiValidationError.js +51 -0
- package/dist/models/Attribute.d.ts +2 -2
- package/dist/models/Attribute.js +4 -4
- package/dist/models/AttributeThumbnail.d.ts +2 -2
- package/dist/models/AttributeThumbnail.js +1 -1
- package/dist/models/ExportTransactionsRequest.d.ts +43 -0
- package/dist/models/ExportTransactionsRequest.js +49 -0
- package/dist/models/Image.d.ts +2 -2
- package/dist/models/Image.js +1 -1
- package/dist/models/ListStatements200Response.d.ts +38 -0
- package/dist/models/ListStatements200Response.js +48 -0
- package/dist/models/ListTransactions200Response.d.ts +38 -0
- package/dist/models/ListTransactions200Response.js +48 -0
- package/dist/models/Product.d.ts +2 -2
- package/dist/models/Product.js +2 -2
- package/dist/models/ProductsResponse.d.ts +2 -2
- package/dist/models/ProductsResponse.js +2 -2
- package/dist/models/Statement.d.ts +61 -0
- package/dist/models/Statement.js +67 -0
- package/dist/models/Stock.d.ts +2 -2
- package/dist/models/Stock.js +1 -1
- package/dist/models/StockResponse.d.ts +2 -2
- package/dist/models/StockResponse.js +2 -2
- package/dist/models/Transaction.d.ts +68 -0
- package/dist/models/Transaction.js +68 -0
- package/dist/models/TransactionOrder.d.ts +37 -0
- package/dist/models/TransactionOrder.js +51 -0
- package/dist/models/Variant.d.ts +4 -4
- package/dist/models/Variant.js +8 -8
- package/dist/models/VariantManufacturerOrigin.d.ts +2 -2
- package/dist/models/VariantManufacturerOrigin.js +1 -1
- package/dist/models/VariantProduct.d.ts +2 -2
- package/dist/models/VariantProduct.js +1 -1
- package/dist/models/VariantStock.d.ts +2 -2
- package/dist/models/VariantStock.js +2 -2
- package/dist/models/VariantsResponse.d.ts +2 -2
- package/dist/models/VariantsResponse.js +2 -2
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +223 -439
- package/package.json +5 -3
- package/src/apis/ProductsApi.ts +4 -1
- package/src/apis/StatementsApi.ts +177 -0
- package/src/apis/TransactionsApi.ts +180 -0
- package/src/apis/VariantsApi.ts +87 -1
- package/src/apis/index.ts +2 -0
- package/src/models/ApiError.ts +3 -3
- package/src/models/ApiValidationError.ts +70 -0
- package/src/models/Attribute.ts +4 -4
- package/src/models/AttributeThumbnail.ts +2 -2
- package/src/models/ExportTransactionsRequest.ts +76 -0
- package/src/models/Image.ts +2 -2
- package/src/models/ListStatements200Response.ts +75 -0
- package/src/models/ListTransactions200Response.ts +75 -0
- package/src/models/Product.ts +3 -3
- package/src/models/ProductsResponse.ts +2 -2
- package/src/models/Statement.ts +106 -0
- package/src/models/Stock.ts +2 -2
- package/src/models/StockResponse.ts +2 -2
- package/src/models/Transaction.ts +120 -0
- package/src/models/TransactionOrder.ts +70 -0
- package/src/models/Variant.ts +16 -16
- package/src/models/VariantManufacturerOrigin.ts +2 -2
- package/src/models/VariantProduct.ts +2 -2
- package/src/models/VariantStock.ts +2 -2
- package/src/models/VariantsResponse.ts +2 -2
- package/src/models/index.ts +7 -0
- package/src/runtime.ts +1 -1
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +2 -2
|
@@ -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.
|
|
5
|
+
* The version of the OpenAPI document: 1.4.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,7 +10,12 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { StockResponse, 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;
|
|
@@ -18,8 +23,10 @@ export interface GetVariantRequest {
|
|
|
18
23
|
}
|
|
19
24
|
export interface ListStockRequest {
|
|
20
25
|
project: string;
|
|
26
|
+
fulfillmentProjects?: string;
|
|
21
27
|
pageToken?: number;
|
|
22
28
|
pageSize?: number;
|
|
29
|
+
search?: string;
|
|
23
30
|
}
|
|
24
31
|
export interface ListVariantsRequest {
|
|
25
32
|
project: string;
|
|
@@ -32,6 +39,16 @@ export interface ListVariantsRequest {
|
|
|
32
39
|
*
|
|
33
40
|
*/
|
|
34
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>;
|
|
35
52
|
/**
|
|
36
53
|
* Gets a GFN variant by the given ID.
|
|
37
54
|
* Get a GFN variant
|
package/dist/apis/VariantsApi.js
CHANGED
|
@@ -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.
|
|
8
|
+
* The version of the OpenAPI document: 1.4.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,258 +21,209 @@ 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.VariantsApi = void 0;
|
|
79
|
-
|
|
80
|
-
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const index_1 = require("../models/index");
|
|
81
28
|
/**
|
|
82
29
|
*
|
|
83
30
|
*/
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
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_1, variantId_1) {
|
|
73
|
+
return __awaiter(this, arguments, void 0, function* (project, variantId, optionalParameters = {}, initOverrides) {
|
|
74
|
+
const response = yield this.getStockRaw(Object.assign({ project: project, variantId: variantId }, optionalParameters), initOverrides);
|
|
75
|
+
return yield response.value();
|
|
76
|
+
});
|
|
88
77
|
}
|
|
89
78
|
/**
|
|
90
79
|
* Gets a GFN variant by the given ID.
|
|
91
80
|
* Get a GFN variant
|
|
92
81
|
*/
|
|
93
|
-
|
|
94
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
124
|
-
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
|
|
125
|
-
}
|
|
126
|
-
return [4 /*yield*/, this.request({
|
|
127
|
-
path: "/v1/gfn/catalog/variants/{variantId}".replace("{".concat("variantId", "}"), encodeURIComponent(String(requestParameters.variantId))),
|
|
128
|
-
method: 'GET',
|
|
129
|
-
headers: headerParameters,
|
|
130
|
-
query: queryParameters,
|
|
131
|
-
}, initOverrides)];
|
|
132
|
-
case 3:
|
|
133
|
-
response = _c.sent();
|
|
134
|
-
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.VariantFromJSON)(jsonValue); })];
|
|
135
|
-
}
|
|
136
|
-
});
|
|
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));
|
|
137
112
|
});
|
|
138
|
-
}
|
|
113
|
+
}
|
|
139
114
|
/**
|
|
140
115
|
* Gets a GFN variant by the given ID.
|
|
141
116
|
* Get a GFN variant
|
|
142
117
|
*/
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
return __generator(this, function (_a) {
|
|
148
|
-
switch (_a.label) {
|
|
149
|
-
case 0: return [4 /*yield*/, this.getVariantRaw(__assign({ project: project, variantId: variantId }, optionalParameters), initOverrides)];
|
|
150
|
-
case 1:
|
|
151
|
-
response = _a.sent();
|
|
152
|
-
return [4 /*yield*/, response.value()];
|
|
153
|
-
case 2: return [2 /*return*/, _a.sent()];
|
|
154
|
-
}
|
|
155
|
-
});
|
|
118
|
+
getVariant(project_1, variantId_1) {
|
|
119
|
+
return __awaiter(this, arguments, void 0, function* (project, variantId, optionalParameters = {}, initOverrides) {
|
|
120
|
+
const response = yield this.getVariantRaw(Object.assign({ project: project, variantId: variantId }, optionalParameters), initOverrides);
|
|
121
|
+
return yield response.value();
|
|
156
122
|
});
|
|
157
|
-
}
|
|
123
|
+
}
|
|
158
124
|
/**
|
|
159
125
|
* Lists the stock levels for all GFN variants available to the project.
|
|
160
126
|
* List GFN variant stock
|
|
161
127
|
*/
|
|
162
|
-
|
|
163
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
headers: headerParameters,
|
|
199
|
-
query: queryParameters,
|
|
200
|
-
}, initOverrides)];
|
|
201
|
-
case 3:
|
|
202
|
-
response = _c.sent();
|
|
203
|
-
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.StockResponseFromJSON)(jsonValue); })];
|
|
204
|
-
}
|
|
205
|
-
});
|
|
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));
|
|
206
164
|
});
|
|
207
|
-
}
|
|
165
|
+
}
|
|
208
166
|
/**
|
|
209
167
|
* Lists the stock levels for all GFN variants available to the project.
|
|
210
168
|
* List GFN variant stock
|
|
211
169
|
*/
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
return __generator(this, function (_a) {
|
|
217
|
-
switch (_a.label) {
|
|
218
|
-
case 0: return [4 /*yield*/, this.listStockRaw(__assign({ project: project }, optionalParameters), initOverrides)];
|
|
219
|
-
case 1:
|
|
220
|
-
response = _a.sent();
|
|
221
|
-
return [4 /*yield*/, response.value()];
|
|
222
|
-
case 2: return [2 /*return*/, _a.sent()];
|
|
223
|
-
}
|
|
224
|
-
});
|
|
170
|
+
listStock(project_1) {
|
|
171
|
+
return __awaiter(this, arguments, void 0, function* (project, optionalParameters = {}, initOverrides) {
|
|
172
|
+
const response = yield this.listStockRaw(Object.assign({ project: project }, optionalParameters), initOverrides);
|
|
173
|
+
return yield response.value();
|
|
225
174
|
});
|
|
226
|
-
}
|
|
175
|
+
}
|
|
227
176
|
/**
|
|
228
177
|
* Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
|
|
229
178
|
* List GFN variants
|
|
230
179
|
*/
|
|
231
|
-
|
|
232
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
if (this.configuration && this.configuration.apiKey) {
|
|
268
|
-
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
|
|
269
|
-
}
|
|
270
|
-
return [4 /*yield*/, this.request({
|
|
271
|
-
path: "/v1/gfn/catalog/variants",
|
|
272
|
-
method: 'GET',
|
|
273
|
-
headers: headerParameters,
|
|
274
|
-
query: queryParameters,
|
|
275
|
-
}, initOverrides)];
|
|
276
|
-
case 3:
|
|
277
|
-
response = _c.sent();
|
|
278
|
-
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.VariantsResponseFromJSON)(jsonValue); })];
|
|
279
|
-
}
|
|
280
|
-
});
|
|
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));
|
|
281
216
|
});
|
|
282
|
-
}
|
|
217
|
+
}
|
|
283
218
|
/**
|
|
284
219
|
* Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
|
|
285
220
|
* List GFN variants
|
|
286
221
|
*/
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
return __generator(this, function (_a) {
|
|
292
|
-
switch (_a.label) {
|
|
293
|
-
case 0: return [4 /*yield*/, this.listVariantsRaw(__assign({ project: project }, optionalParameters), initOverrides)];
|
|
294
|
-
case 1:
|
|
295
|
-
response = _a.sent();
|
|
296
|
-
return [4 /*yield*/, response.value()];
|
|
297
|
-
case 2: return [2 /*return*/, _a.sent()];
|
|
298
|
-
}
|
|
299
|
-
});
|
|
222
|
+
listVariants(project_1) {
|
|
223
|
+
return __awaiter(this, arguments, void 0, function* (project, optionalParameters = {}, initOverrides) {
|
|
224
|
+
const response = yield this.listVariantsRaw(Object.assign({ project: project }, optionalParameters), initOverrides);
|
|
225
|
+
return yield response.value();
|
|
300
226
|
});
|
|
301
|
-
}
|
|
302
|
-
|
|
303
|
-
}(runtime.BaseAPI));
|
|
227
|
+
}
|
|
228
|
+
}
|
|
304
229
|
exports.VariantsApi = VariantsApi;
|
package/dist/apis/index.d.ts
CHANGED
package/dist/apis/index.js
CHANGED
|
@@ -17,4 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
/* tslint:disable */
|
|
18
18
|
/* eslint-disable */
|
|
19
19
|
__exportStar(require("./ProductsApi"), exports);
|
|
20
|
+
__exportStar(require("./StatementsApi"), exports);
|
|
21
|
+
__exportStar(require("./TransactionsApi"), exports);
|
|
20
22
|
__exportStar(require("./VariantsApi"), exports);
|
|
@@ -0,0 +1,35 @@
|
|
|
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.4.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
|
+
}
|