@teemill/gfn-catalog 2.1.0 → 3.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.
- package/README.md +2 -2
- package/api.ts +228 -14
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +153 -11
- package/dist/api.js +104 -6
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +153 -11
- package/dist/esm/api.js +104 -6
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/gfn-catalog@
|
|
1
|
+
## @teemill/gfn-catalog@3.0.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). 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@
|
|
39
|
+
npm install @teemill/gfn-catalog@3.0.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 3.0.0
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -127,23 +127,42 @@ export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof
|
|
|
127
127
|
*/
|
|
128
128
|
export interface ExportTransactionsRequest {
|
|
129
129
|
/**
|
|
130
|
-
*
|
|
130
|
+
* Include only transactions from this statement
|
|
131
131
|
* @type {string}
|
|
132
132
|
* @memberof ExportTransactionsRequest
|
|
133
133
|
*/
|
|
134
|
-
'
|
|
134
|
+
'statement'?: string;
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
*
|
|
138
|
+
* @export
|
|
139
|
+
* @interface Fulfillment
|
|
140
|
+
*/
|
|
141
|
+
export interface Fulfillment {
|
|
142
|
+
/**
|
|
143
|
+
*
|
|
144
|
+
* @type {number}
|
|
145
|
+
* @memberof Fulfillment
|
|
146
|
+
*/
|
|
147
|
+
'id': number;
|
|
135
148
|
/**
|
|
136
|
-
*
|
|
149
|
+
*
|
|
137
150
|
* @type {string}
|
|
138
|
-
* @memberof
|
|
151
|
+
* @memberof Fulfillment
|
|
139
152
|
*/
|
|
140
|
-
'
|
|
153
|
+
'merchantRef': string;
|
|
141
154
|
/**
|
|
142
|
-
*
|
|
155
|
+
*
|
|
156
|
+
* @type {number}
|
|
157
|
+
* @memberof Fulfillment
|
|
158
|
+
*/
|
|
159
|
+
'total': number;
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
143
162
|
* @type {string}
|
|
144
|
-
* @memberof
|
|
163
|
+
* @memberof Fulfillment
|
|
145
164
|
*/
|
|
146
|
-
'
|
|
165
|
+
'createdAt': string;
|
|
147
166
|
}
|
|
148
167
|
/**
|
|
149
168
|
* Image description
|
|
@@ -194,6 +213,25 @@ export interface Image {
|
|
|
194
213
|
*/
|
|
195
214
|
'updatedAt'?: string;
|
|
196
215
|
}
|
|
216
|
+
/**
|
|
217
|
+
*
|
|
218
|
+
* @export
|
|
219
|
+
* @interface ListFulfillments200Response
|
|
220
|
+
*/
|
|
221
|
+
export interface ListFulfillments200Response {
|
|
222
|
+
/**
|
|
223
|
+
*
|
|
224
|
+
* @type {Array<Fulfillment>}
|
|
225
|
+
* @memberof ListFulfillments200Response
|
|
226
|
+
*/
|
|
227
|
+
'fulfillments'?: Array<Fulfillment>;
|
|
228
|
+
/**
|
|
229
|
+
*
|
|
230
|
+
* @type {number}
|
|
231
|
+
* @memberof ListFulfillments200Response
|
|
232
|
+
*/
|
|
233
|
+
'nextPageToken'?: number | null;
|
|
234
|
+
}
|
|
197
235
|
/**
|
|
198
236
|
*
|
|
199
237
|
* @export
|
|
@@ -423,6 +461,24 @@ export interface Transaction {
|
|
|
423
461
|
* @memberof Transaction
|
|
424
462
|
*/
|
|
425
463
|
'createdAt': string;
|
|
464
|
+
/**
|
|
465
|
+
*
|
|
466
|
+
* @type {number}
|
|
467
|
+
* @memberof Transaction
|
|
468
|
+
*/
|
|
469
|
+
'fulfillmentId'?: number;
|
|
470
|
+
/**
|
|
471
|
+
*
|
|
472
|
+
* @type {number}
|
|
473
|
+
* @memberof Transaction
|
|
474
|
+
*/
|
|
475
|
+
'orderId'?: number;
|
|
476
|
+
/**
|
|
477
|
+
*
|
|
478
|
+
* @type {string}
|
|
479
|
+
* @memberof Transaction
|
|
480
|
+
*/
|
|
481
|
+
'description'?: string;
|
|
426
482
|
}
|
|
427
483
|
|
|
428
484
|
export const TransactionTypeEnum = {
|
|
@@ -1093,6 +1149,65 @@ export const TransactionsApiAxiosParamCreator = function (configuration?: Config
|
|
|
1093
1149
|
options: localVarRequestOptions,
|
|
1094
1150
|
};
|
|
1095
1151
|
},
|
|
1152
|
+
/**
|
|
1153
|
+
* Lists all the fulfillments in the project with GFN transactions
|
|
1154
|
+
* @summary Lists the GFN fulfillments of the project
|
|
1155
|
+
* @param {string} project What project it is
|
|
1156
|
+
* @param {number} [pageToken] Page reference token
|
|
1157
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1158
|
+
* @param {string} [statementId]
|
|
1159
|
+
* @param {*} [options] Override http request option.
|
|
1160
|
+
* @throws {RequiredError}
|
|
1161
|
+
*/
|
|
1162
|
+
listFulfillments: async (project: string, pageToken?: number, pageSize?: number, statementId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1163
|
+
// verify required parameter 'project' is not null or undefined
|
|
1164
|
+
assertParamExists('listFulfillments', 'project', project)
|
|
1165
|
+
const localVarPath = `/v1/gfn/transactions/fulfillments`;
|
|
1166
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1167
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1168
|
+
let baseOptions;
|
|
1169
|
+
if (configuration) {
|
|
1170
|
+
baseOptions = configuration.baseOptions;
|
|
1171
|
+
}
|
|
1172
|
+
|
|
1173
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1174
|
+
const localVarHeaderParameter = {} as any;
|
|
1175
|
+
const localVarQueryParameter = {} as any;
|
|
1176
|
+
|
|
1177
|
+
// authentication session-oauth required
|
|
1178
|
+
// oauth required
|
|
1179
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1180
|
+
|
|
1181
|
+
// authentication api-key required
|
|
1182
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1183
|
+
|
|
1184
|
+
if (project !== undefined) {
|
|
1185
|
+
localVarQueryParameter['project'] = project;
|
|
1186
|
+
}
|
|
1187
|
+
|
|
1188
|
+
if (pageToken !== undefined) {
|
|
1189
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1190
|
+
}
|
|
1191
|
+
|
|
1192
|
+
if (pageSize !== undefined) {
|
|
1193
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1194
|
+
}
|
|
1195
|
+
|
|
1196
|
+
if (statementId !== undefined) {
|
|
1197
|
+
localVarQueryParameter['statementId'] = statementId;
|
|
1198
|
+
}
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1203
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1204
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1205
|
+
|
|
1206
|
+
return {
|
|
1207
|
+
url: toPathString(localVarUrlObj),
|
|
1208
|
+
options: localVarRequestOptions,
|
|
1209
|
+
};
|
|
1210
|
+
},
|
|
1096
1211
|
/**
|
|
1097
1212
|
* Lists all GFN transactions available to the project
|
|
1098
1213
|
* @summary List GFN transactions
|
|
@@ -1100,10 +1215,12 @@ export const TransactionsApiAxiosParamCreator = function (configuration?: Config
|
|
|
1100
1215
|
* @param {number} [pageToken] Page reference token
|
|
1101
1216
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1102
1217
|
* @param {string} [statementId]
|
|
1218
|
+
* @param {string} [fulfillmentId]
|
|
1219
|
+
* @param {string} [search] Search by fulfillment id
|
|
1103
1220
|
* @param {*} [options] Override http request option.
|
|
1104
1221
|
* @throws {RequiredError}
|
|
1105
1222
|
*/
|
|
1106
|
-
listTransactions: async (project: string, pageToken?: number, pageSize?: number, statementId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1223
|
+
listTransactions: async (project: string, pageToken?: number, pageSize?: number, statementId?: string, fulfillmentId?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1107
1224
|
// verify required parameter 'project' is not null or undefined
|
|
1108
1225
|
assertParamExists('listTransactions', 'project', project)
|
|
1109
1226
|
const localVarPath = `/v1/gfn/transactions`;
|
|
@@ -1141,6 +1258,14 @@ export const TransactionsApiAxiosParamCreator = function (configuration?: Config
|
|
|
1141
1258
|
localVarQueryParameter['statementId'] = statementId;
|
|
1142
1259
|
}
|
|
1143
1260
|
|
|
1261
|
+
if (fulfillmentId !== undefined) {
|
|
1262
|
+
localVarQueryParameter['fulfillmentId'] = fulfillmentId;
|
|
1263
|
+
}
|
|
1264
|
+
|
|
1265
|
+
if (search !== undefined) {
|
|
1266
|
+
localVarQueryParameter['search'] = search;
|
|
1267
|
+
}
|
|
1268
|
+
|
|
1144
1269
|
|
|
1145
1270
|
|
|
1146
1271
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1176,6 +1301,22 @@ export const TransactionsApiFp = function(configuration?: Configuration) {
|
|
|
1176
1301
|
const localVarOperationServerBasePath = operationServerMap['TransactionsApi.exportTransactions']?.[localVarOperationServerIndex]?.url;
|
|
1177
1302
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1178
1303
|
},
|
|
1304
|
+
/**
|
|
1305
|
+
* Lists all the fulfillments in the project with GFN transactions
|
|
1306
|
+
* @summary Lists the GFN fulfillments of the project
|
|
1307
|
+
* @param {string} project What project it is
|
|
1308
|
+
* @param {number} [pageToken] Page reference token
|
|
1309
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1310
|
+
* @param {string} [statementId]
|
|
1311
|
+
* @param {*} [options] Override http request option.
|
|
1312
|
+
* @throws {RequiredError}
|
|
1313
|
+
*/
|
|
1314
|
+
async listFulfillments(project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFulfillments200Response>> {
|
|
1315
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listFulfillments(project, pageToken, pageSize, statementId, options);
|
|
1316
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1317
|
+
const localVarOperationServerBasePath = operationServerMap['TransactionsApi.listFulfillments']?.[localVarOperationServerIndex]?.url;
|
|
1318
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1319
|
+
},
|
|
1179
1320
|
/**
|
|
1180
1321
|
* Lists all GFN transactions available to the project
|
|
1181
1322
|
* @summary List GFN transactions
|
|
@@ -1183,11 +1324,13 @@ export const TransactionsApiFp = function(configuration?: Configuration) {
|
|
|
1183
1324
|
* @param {number} [pageToken] Page reference token
|
|
1184
1325
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1185
1326
|
* @param {string} [statementId]
|
|
1327
|
+
* @param {string} [fulfillmentId]
|
|
1328
|
+
* @param {string} [search] Search by fulfillment id
|
|
1186
1329
|
* @param {*} [options] Override http request option.
|
|
1187
1330
|
* @throws {RequiredError}
|
|
1188
1331
|
*/
|
|
1189
|
-
async listTransactions(project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactions200Response>> {
|
|
1190
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTransactions(project, pageToken, pageSize, statementId, options);
|
|
1332
|
+
async listTransactions(project: string, pageToken?: number, pageSize?: number, statementId?: string, fulfillmentId?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactions200Response>> {
|
|
1333
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTransactions(project, pageToken, pageSize, statementId, fulfillmentId, search, options);
|
|
1191
1334
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1192
1335
|
const localVarOperationServerBasePath = operationServerMap['TransactionsApi.listTransactions']?.[localVarOperationServerIndex]?.url;
|
|
1193
1336
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1212,6 +1355,16 @@ export const TransactionsApiFactory = function (configuration?: Configuration, b
|
|
|
1212
1355
|
exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
1213
1356
|
return localVarFp.exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(axios, basePath));
|
|
1214
1357
|
},
|
|
1358
|
+
/**
|
|
1359
|
+
* Lists all the fulfillments in the project with GFN transactions
|
|
1360
|
+
* @summary Lists the GFN fulfillments of the project
|
|
1361
|
+
* @param {TransactionsApiListFulfillmentsRequest} requestParameters Request parameters.
|
|
1362
|
+
* @param {*} [options] Override http request option.
|
|
1363
|
+
* @throws {RequiredError}
|
|
1364
|
+
*/
|
|
1365
|
+
listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFulfillments200Response> {
|
|
1366
|
+
return localVarFp.listFulfillments(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(axios, basePath));
|
|
1367
|
+
},
|
|
1215
1368
|
/**
|
|
1216
1369
|
* Lists all GFN transactions available to the project
|
|
1217
1370
|
* @summary List GFN transactions
|
|
@@ -1220,7 +1373,7 @@ export const TransactionsApiFactory = function (configuration?: Configuration, b
|
|
|
1220
1373
|
* @throws {RequiredError}
|
|
1221
1374
|
*/
|
|
1222
1375
|
listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransactions200Response> {
|
|
1223
|
-
return localVarFp.listTransactions(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(axios, basePath));
|
|
1376
|
+
return localVarFp.listTransactions(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, requestParameters.fulfillmentId, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
1224
1377
|
},
|
|
1225
1378
|
};
|
|
1226
1379
|
};
|
|
@@ -1246,6 +1399,41 @@ export interface TransactionsApiExportTransactionsRequest {
|
|
|
1246
1399
|
readonly exportTransactionsRequest: ExportTransactionsRequest
|
|
1247
1400
|
}
|
|
1248
1401
|
|
|
1402
|
+
/**
|
|
1403
|
+
* Request parameters for listFulfillments operation in TransactionsApi.
|
|
1404
|
+
* @export
|
|
1405
|
+
* @interface TransactionsApiListFulfillmentsRequest
|
|
1406
|
+
*/
|
|
1407
|
+
export interface TransactionsApiListFulfillmentsRequest {
|
|
1408
|
+
/**
|
|
1409
|
+
* What project it is
|
|
1410
|
+
* @type {string}
|
|
1411
|
+
* @memberof TransactionsApiListFulfillments
|
|
1412
|
+
*/
|
|
1413
|
+
readonly project: string
|
|
1414
|
+
|
|
1415
|
+
/**
|
|
1416
|
+
* Page reference token
|
|
1417
|
+
* @type {number}
|
|
1418
|
+
* @memberof TransactionsApiListFulfillments
|
|
1419
|
+
*/
|
|
1420
|
+
readonly pageToken?: number
|
|
1421
|
+
|
|
1422
|
+
/**
|
|
1423
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1424
|
+
* @type {number}
|
|
1425
|
+
* @memberof TransactionsApiListFulfillments
|
|
1426
|
+
*/
|
|
1427
|
+
readonly pageSize?: number
|
|
1428
|
+
|
|
1429
|
+
/**
|
|
1430
|
+
*
|
|
1431
|
+
* @type {string}
|
|
1432
|
+
* @memberof TransactionsApiListFulfillments
|
|
1433
|
+
*/
|
|
1434
|
+
readonly statementId?: string
|
|
1435
|
+
}
|
|
1436
|
+
|
|
1249
1437
|
/**
|
|
1250
1438
|
* Request parameters for listTransactions operation in TransactionsApi.
|
|
1251
1439
|
* @export
|
|
@@ -1279,6 +1467,20 @@ export interface TransactionsApiListTransactionsRequest {
|
|
|
1279
1467
|
* @memberof TransactionsApiListTransactions
|
|
1280
1468
|
*/
|
|
1281
1469
|
readonly statementId?: string
|
|
1470
|
+
|
|
1471
|
+
/**
|
|
1472
|
+
*
|
|
1473
|
+
* @type {string}
|
|
1474
|
+
* @memberof TransactionsApiListTransactions
|
|
1475
|
+
*/
|
|
1476
|
+
readonly fulfillmentId?: string
|
|
1477
|
+
|
|
1478
|
+
/**
|
|
1479
|
+
* Search by fulfillment id
|
|
1480
|
+
* @type {string}
|
|
1481
|
+
* @memberof TransactionsApiListTransactions
|
|
1482
|
+
*/
|
|
1483
|
+
readonly search?: string
|
|
1282
1484
|
}
|
|
1283
1485
|
|
|
1284
1486
|
/**
|
|
@@ -1300,6 +1502,18 @@ export class TransactionsApi extends BaseAPI {
|
|
|
1300
1502
|
return TransactionsApiFp(this.configuration).exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1301
1503
|
}
|
|
1302
1504
|
|
|
1505
|
+
/**
|
|
1506
|
+
* Lists all the fulfillments in the project with GFN transactions
|
|
1507
|
+
* @summary Lists the GFN fulfillments of the project
|
|
1508
|
+
* @param {TransactionsApiListFulfillmentsRequest} requestParameters Request parameters.
|
|
1509
|
+
* @param {*} [options] Override http request option.
|
|
1510
|
+
* @throws {RequiredError}
|
|
1511
|
+
* @memberof TransactionsApi
|
|
1512
|
+
*/
|
|
1513
|
+
public listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig) {
|
|
1514
|
+
return TransactionsApiFp(this.configuration).listFulfillments(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(this.axios, this.basePath));
|
|
1515
|
+
}
|
|
1516
|
+
|
|
1303
1517
|
/**
|
|
1304
1518
|
* Lists all GFN transactions available to the project
|
|
1305
1519
|
* @summary List GFN transactions
|
|
@@ -1309,7 +1523,7 @@ export class TransactionsApi extends BaseAPI {
|
|
|
1309
1523
|
* @memberof TransactionsApi
|
|
1310
1524
|
*/
|
|
1311
1525
|
public listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig) {
|
|
1312
|
-
return TransactionsApiFp(this.configuration).listTransactions(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(this.axios, this.basePath));
|
|
1526
|
+
return TransactionsApiFp(this.configuration).listTransactions(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, requestParameters.fulfillmentId, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
1313
1527
|
}
|
|
1314
1528
|
}
|
|
1315
1529
|
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 3.0.0
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 3.0.0
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 3.0.0
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -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:
|
|
5
|
+
* The version of the OpenAPI document: 3.0.0
|
|
6
6
|
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -116,23 +116,42 @@ export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof
|
|
|
116
116
|
*/
|
|
117
117
|
export interface ExportTransactionsRequest {
|
|
118
118
|
/**
|
|
119
|
-
*
|
|
119
|
+
* Include only transactions from this statement
|
|
120
120
|
* @type {string}
|
|
121
121
|
* @memberof ExportTransactionsRequest
|
|
122
122
|
*/
|
|
123
|
-
'
|
|
123
|
+
'statement'?: string;
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
*
|
|
127
|
+
* @export
|
|
128
|
+
* @interface Fulfillment
|
|
129
|
+
*/
|
|
130
|
+
export interface Fulfillment {
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @type {number}
|
|
134
|
+
* @memberof Fulfillment
|
|
135
|
+
*/
|
|
136
|
+
'id': number;
|
|
124
137
|
/**
|
|
125
|
-
*
|
|
138
|
+
*
|
|
126
139
|
* @type {string}
|
|
127
|
-
* @memberof
|
|
140
|
+
* @memberof Fulfillment
|
|
128
141
|
*/
|
|
129
|
-
'
|
|
142
|
+
'merchantRef': string;
|
|
130
143
|
/**
|
|
131
|
-
*
|
|
144
|
+
*
|
|
145
|
+
* @type {number}
|
|
146
|
+
* @memberof Fulfillment
|
|
147
|
+
*/
|
|
148
|
+
'total': number;
|
|
149
|
+
/**
|
|
150
|
+
*
|
|
132
151
|
* @type {string}
|
|
133
|
-
* @memberof
|
|
152
|
+
* @memberof Fulfillment
|
|
134
153
|
*/
|
|
135
|
-
'
|
|
154
|
+
'createdAt': string;
|
|
136
155
|
}
|
|
137
156
|
/**
|
|
138
157
|
* Image description
|
|
@@ -183,6 +202,25 @@ export interface Image {
|
|
|
183
202
|
*/
|
|
184
203
|
'updatedAt'?: string;
|
|
185
204
|
}
|
|
205
|
+
/**
|
|
206
|
+
*
|
|
207
|
+
* @export
|
|
208
|
+
* @interface ListFulfillments200Response
|
|
209
|
+
*/
|
|
210
|
+
export interface ListFulfillments200Response {
|
|
211
|
+
/**
|
|
212
|
+
*
|
|
213
|
+
* @type {Array<Fulfillment>}
|
|
214
|
+
* @memberof ListFulfillments200Response
|
|
215
|
+
*/
|
|
216
|
+
'fulfillments'?: Array<Fulfillment>;
|
|
217
|
+
/**
|
|
218
|
+
*
|
|
219
|
+
* @type {number}
|
|
220
|
+
* @memberof ListFulfillments200Response
|
|
221
|
+
*/
|
|
222
|
+
'nextPageToken'?: number | null;
|
|
223
|
+
}
|
|
186
224
|
/**
|
|
187
225
|
*
|
|
188
226
|
* @export
|
|
@@ -412,6 +450,24 @@ export interface Transaction {
|
|
|
412
450
|
* @memberof Transaction
|
|
413
451
|
*/
|
|
414
452
|
'createdAt': string;
|
|
453
|
+
/**
|
|
454
|
+
*
|
|
455
|
+
* @type {number}
|
|
456
|
+
* @memberof Transaction
|
|
457
|
+
*/
|
|
458
|
+
'fulfillmentId'?: number;
|
|
459
|
+
/**
|
|
460
|
+
*
|
|
461
|
+
* @type {number}
|
|
462
|
+
* @memberof Transaction
|
|
463
|
+
*/
|
|
464
|
+
'orderId'?: number;
|
|
465
|
+
/**
|
|
466
|
+
*
|
|
467
|
+
* @type {string}
|
|
468
|
+
* @memberof Transaction
|
|
469
|
+
*/
|
|
470
|
+
'description'?: string;
|
|
415
471
|
}
|
|
416
472
|
export declare const TransactionTypeEnum: {
|
|
417
473
|
readonly Blank: "blank";
|
|
@@ -830,6 +886,17 @@ export declare const TransactionsApiAxiosParamCreator: (configuration?: Configur
|
|
|
830
886
|
* @throws {RequiredError}
|
|
831
887
|
*/
|
|
832
888
|
exportTransactions: (project: string, exportTransactionsRequest: ExportTransactionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
889
|
+
/**
|
|
890
|
+
* Lists all the fulfillments in the project with GFN transactions
|
|
891
|
+
* @summary Lists the GFN fulfillments of the project
|
|
892
|
+
* @param {string} project What project it is
|
|
893
|
+
* @param {number} [pageToken] Page reference token
|
|
894
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
895
|
+
* @param {string} [statementId]
|
|
896
|
+
* @param {*} [options] Override http request option.
|
|
897
|
+
* @throws {RequiredError}
|
|
898
|
+
*/
|
|
899
|
+
listFulfillments: (project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
833
900
|
/**
|
|
834
901
|
* Lists all GFN transactions available to the project
|
|
835
902
|
* @summary List GFN transactions
|
|
@@ -837,10 +904,12 @@ export declare const TransactionsApiAxiosParamCreator: (configuration?: Configur
|
|
|
837
904
|
* @param {number} [pageToken] Page reference token
|
|
838
905
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
839
906
|
* @param {string} [statementId]
|
|
907
|
+
* @param {string} [fulfillmentId]
|
|
908
|
+
* @param {string} [search] Search by fulfillment id
|
|
840
909
|
* @param {*} [options] Override http request option.
|
|
841
910
|
* @throws {RequiredError}
|
|
842
911
|
*/
|
|
843
|
-
listTransactions: (project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
912
|
+
listTransactions: (project: string, pageToken?: number, pageSize?: number, statementId?: string, fulfillmentId?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
844
913
|
};
|
|
845
914
|
/**
|
|
846
915
|
* TransactionsApi - functional programming interface
|
|
@@ -856,6 +925,17 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
|
|
|
856
925
|
* @throws {RequiredError}
|
|
857
926
|
*/
|
|
858
927
|
exportTransactions(project: string, exportTransactionsRequest: ExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
928
|
+
/**
|
|
929
|
+
* Lists all the fulfillments in the project with GFN transactions
|
|
930
|
+
* @summary Lists the GFN fulfillments of the project
|
|
931
|
+
* @param {string} project What project it is
|
|
932
|
+
* @param {number} [pageToken] Page reference token
|
|
933
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
934
|
+
* @param {string} [statementId]
|
|
935
|
+
* @param {*} [options] Override http request option.
|
|
936
|
+
* @throws {RequiredError}
|
|
937
|
+
*/
|
|
938
|
+
listFulfillments(project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFulfillments200Response>>;
|
|
859
939
|
/**
|
|
860
940
|
* Lists all GFN transactions available to the project
|
|
861
941
|
* @summary List GFN transactions
|
|
@@ -863,10 +943,12 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
|
|
|
863
943
|
* @param {number} [pageToken] Page reference token
|
|
864
944
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
865
945
|
* @param {string} [statementId]
|
|
946
|
+
* @param {string} [fulfillmentId]
|
|
947
|
+
* @param {string} [search] Search by fulfillment id
|
|
866
948
|
* @param {*} [options] Override http request option.
|
|
867
949
|
* @throws {RequiredError}
|
|
868
950
|
*/
|
|
869
|
-
listTransactions(project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactions200Response>>;
|
|
951
|
+
listTransactions(project: string, pageToken?: number, pageSize?: number, statementId?: string, fulfillmentId?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactions200Response>>;
|
|
870
952
|
};
|
|
871
953
|
/**
|
|
872
954
|
* TransactionsApi - factory interface
|
|
@@ -881,6 +963,14 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
|
|
|
881
963
|
* @throws {RequiredError}
|
|
882
964
|
*/
|
|
883
965
|
exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
966
|
+
/**
|
|
967
|
+
* Lists all the fulfillments in the project with GFN transactions
|
|
968
|
+
* @summary Lists the GFN fulfillments of the project
|
|
969
|
+
* @param {TransactionsApiListFulfillmentsRequest} requestParameters Request parameters.
|
|
970
|
+
* @param {*} [options] Override http request option.
|
|
971
|
+
* @throws {RequiredError}
|
|
972
|
+
*/
|
|
973
|
+
listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFulfillments200Response>;
|
|
884
974
|
/**
|
|
885
975
|
* Lists all GFN transactions available to the project
|
|
886
976
|
* @summary List GFN transactions
|
|
@@ -909,6 +999,37 @@ export interface TransactionsApiExportTransactionsRequest {
|
|
|
909
999
|
*/
|
|
910
1000
|
readonly exportTransactionsRequest: ExportTransactionsRequest;
|
|
911
1001
|
}
|
|
1002
|
+
/**
|
|
1003
|
+
* Request parameters for listFulfillments operation in TransactionsApi.
|
|
1004
|
+
* @export
|
|
1005
|
+
* @interface TransactionsApiListFulfillmentsRequest
|
|
1006
|
+
*/
|
|
1007
|
+
export interface TransactionsApiListFulfillmentsRequest {
|
|
1008
|
+
/**
|
|
1009
|
+
* What project it is
|
|
1010
|
+
* @type {string}
|
|
1011
|
+
* @memberof TransactionsApiListFulfillments
|
|
1012
|
+
*/
|
|
1013
|
+
readonly project: string;
|
|
1014
|
+
/**
|
|
1015
|
+
* Page reference token
|
|
1016
|
+
* @type {number}
|
|
1017
|
+
* @memberof TransactionsApiListFulfillments
|
|
1018
|
+
*/
|
|
1019
|
+
readonly pageToken?: number;
|
|
1020
|
+
/**
|
|
1021
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1022
|
+
* @type {number}
|
|
1023
|
+
* @memberof TransactionsApiListFulfillments
|
|
1024
|
+
*/
|
|
1025
|
+
readonly pageSize?: number;
|
|
1026
|
+
/**
|
|
1027
|
+
*
|
|
1028
|
+
* @type {string}
|
|
1029
|
+
* @memberof TransactionsApiListFulfillments
|
|
1030
|
+
*/
|
|
1031
|
+
readonly statementId?: string;
|
|
1032
|
+
}
|
|
912
1033
|
/**
|
|
913
1034
|
* Request parameters for listTransactions operation in TransactionsApi.
|
|
914
1035
|
* @export
|
|
@@ -939,6 +1060,18 @@ export interface TransactionsApiListTransactionsRequest {
|
|
|
939
1060
|
* @memberof TransactionsApiListTransactions
|
|
940
1061
|
*/
|
|
941
1062
|
readonly statementId?: string;
|
|
1063
|
+
/**
|
|
1064
|
+
*
|
|
1065
|
+
* @type {string}
|
|
1066
|
+
* @memberof TransactionsApiListTransactions
|
|
1067
|
+
*/
|
|
1068
|
+
readonly fulfillmentId?: string;
|
|
1069
|
+
/**
|
|
1070
|
+
* Search by fulfillment id
|
|
1071
|
+
* @type {string}
|
|
1072
|
+
* @memberof TransactionsApiListTransactions
|
|
1073
|
+
*/
|
|
1074
|
+
readonly search?: string;
|
|
942
1075
|
}
|
|
943
1076
|
/**
|
|
944
1077
|
* TransactionsApi - object-oriented interface
|
|
@@ -956,6 +1089,15 @@ export declare class TransactionsApi extends BaseAPI {
|
|
|
956
1089
|
* @memberof TransactionsApi
|
|
957
1090
|
*/
|
|
958
1091
|
exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
1092
|
+
/**
|
|
1093
|
+
* Lists all the fulfillments in the project with GFN transactions
|
|
1094
|
+
* @summary Lists the GFN fulfillments of the project
|
|
1095
|
+
* @param {TransactionsApiListFulfillmentsRequest} requestParameters Request parameters.
|
|
1096
|
+
* @param {*} [options] Override http request option.
|
|
1097
|
+
* @throws {RequiredError}
|
|
1098
|
+
* @memberof TransactionsApi
|
|
1099
|
+
*/
|
|
1100
|
+
listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFulfillments200Response, any>>;
|
|
959
1101
|
/**
|
|
960
1102
|
* Lists all GFN transactions available to the project
|
|
961
1103
|
* @summary List GFN transactions
|