@teemill/gfn-catalog 3.9.1 → 3.9.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/VERSION +1 -1
- package/README.md +2 -2
- package/api.ts +197 -32
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +195 -30
- package/dist/api.js +15 -15
- 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 +195 -30
- package/dist/esm/api.js +15 -15
- 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/docs/ApiError.md +3 -2
- package/docs/ApiValidationError.md +3 -2
- package/docs/Fulfillment.md +5 -4
- package/docs/Image.md +7 -7
- package/docs/Location.md +1 -0
- package/docs/Product.md +9 -8
- package/docs/ProductBrand.md +1 -0
- package/docs/ProductsApi.md +2 -2
- package/docs/Statement.md +9 -8
- package/docs/StatementsApi.md +2 -2
- package/docs/Stock.md +2 -1
- package/docs/Transaction.md +12 -11
- package/docs/TransactionsApi.md +10 -10
- package/docs/Variant.md +7 -6
- package/docs/VariantProduct.md +1 -0
- package/docs/VariantStock.md +6 -5
- package/index.ts +1 -1
- package/package.json +2 -2
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog
|
|
3
3
|
* Use this API to access the Global Fulfillment 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: 3.9.
|
|
5
|
+
* The version of the OpenAPI document: 3.9.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,12 +13,30 @@ import type { Configuration } from './configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
* Represents an error returned by the API.
|
|
18
|
+
*/
|
|
16
19
|
export interface ApiError {
|
|
20
|
+
/**
|
|
21
|
+
* A machine-readable error code identifying the type of error.
|
|
22
|
+
*/
|
|
17
23
|
'code'?: string;
|
|
24
|
+
/**
|
|
25
|
+
* A human-readable message providing more details about the error.
|
|
26
|
+
*/
|
|
18
27
|
'message': string;
|
|
19
28
|
}
|
|
29
|
+
/**
|
|
30
|
+
* Represents a validation error returned by the API, including field-level error details.
|
|
31
|
+
*/
|
|
20
32
|
export interface ApiValidationError {
|
|
33
|
+
/**
|
|
34
|
+
* A human-readable summary of the validation error.
|
|
35
|
+
*/
|
|
21
36
|
'message': string;
|
|
37
|
+
/**
|
|
38
|
+
* A map of field names to arrays of validation error messages.
|
|
39
|
+
*/
|
|
22
40
|
'errors': {
|
|
23
41
|
[key: string]: Array<string>;
|
|
24
42
|
};
|
|
@@ -57,28 +75,58 @@ export interface ExportTransactionsRequest {
|
|
|
57
75
|
*/
|
|
58
76
|
'statement'?: string;
|
|
59
77
|
}
|
|
78
|
+
/**
|
|
79
|
+
* A GFN fulfillment summary showing the total cost of transactions.
|
|
80
|
+
*/
|
|
60
81
|
export interface Fulfillment {
|
|
82
|
+
/**
|
|
83
|
+
* The identifier of the fulfillment.
|
|
84
|
+
*/
|
|
61
85
|
'id': number;
|
|
86
|
+
/**
|
|
87
|
+
* The merchant\'s reference for this fulfillment.
|
|
88
|
+
*/
|
|
62
89
|
'merchantRef': string;
|
|
90
|
+
/**
|
|
91
|
+
* The total cost of all transactions for this fulfillment.
|
|
92
|
+
*/
|
|
63
93
|
'total': number;
|
|
94
|
+
/**
|
|
95
|
+
* The timestamp when the fulfillment was created.
|
|
96
|
+
*/
|
|
64
97
|
'createdAt': string;
|
|
65
98
|
}
|
|
66
99
|
/**
|
|
67
|
-
*
|
|
100
|
+
* An image associated with a product or variant.
|
|
68
101
|
*/
|
|
69
102
|
export interface Image {
|
|
70
103
|
/**
|
|
71
|
-
*
|
|
104
|
+
* The unique identifier of the image.
|
|
72
105
|
*/
|
|
73
106
|
'id'?: string;
|
|
107
|
+
/**
|
|
108
|
+
* The URL of the image.
|
|
109
|
+
*/
|
|
74
110
|
'src': string;
|
|
111
|
+
/**
|
|
112
|
+
* Alternative text for the image.
|
|
113
|
+
*/
|
|
75
114
|
'alt'?: string;
|
|
76
115
|
/**
|
|
77
116
|
* List of variant Ids
|
|
78
117
|
*/
|
|
79
118
|
'variantIds'?: Array<string>;
|
|
119
|
+
/**
|
|
120
|
+
* The display order of the image.
|
|
121
|
+
*/
|
|
80
122
|
'sortOrder'?: number;
|
|
123
|
+
/**
|
|
124
|
+
* The timestamp when the image was created.
|
|
125
|
+
*/
|
|
81
126
|
'createdAt'?: string;
|
|
127
|
+
/**
|
|
128
|
+
* The timestamp when the image was last updated.
|
|
129
|
+
*/
|
|
82
130
|
'updatedAt'?: string;
|
|
83
131
|
}
|
|
84
132
|
export interface ListFulfillments200Response {
|
|
@@ -93,6 +141,9 @@ export interface ListTransactions200Response {
|
|
|
93
141
|
'transactions'?: Array<Transaction>;
|
|
94
142
|
'nextPageToken'?: number | null;
|
|
95
143
|
}
|
|
144
|
+
/**
|
|
145
|
+
* A stock location showing the number of units available at a specific warehouse location.
|
|
146
|
+
*/
|
|
96
147
|
export interface Location {
|
|
97
148
|
/**
|
|
98
149
|
* The total number of units available at the location
|
|
@@ -103,22 +154,40 @@ export interface Location {
|
|
|
103
154
|
*/
|
|
104
155
|
'country': string;
|
|
105
156
|
}
|
|
157
|
+
/**
|
|
158
|
+
* A warehouse product available in the Global Fulfillment Network catalog.
|
|
159
|
+
*/
|
|
106
160
|
export interface Product {
|
|
107
161
|
/**
|
|
108
|
-
*
|
|
162
|
+
* The unique identifier of the product.
|
|
109
163
|
*/
|
|
110
164
|
'id': string;
|
|
111
165
|
/**
|
|
112
|
-
* A reference to
|
|
166
|
+
* A URI reference to this product resource.
|
|
113
167
|
*/
|
|
114
168
|
'ref'?: string;
|
|
169
|
+
/**
|
|
170
|
+
* The display title of the product.
|
|
171
|
+
*/
|
|
115
172
|
'title': string;
|
|
173
|
+
/**
|
|
174
|
+
* The style code identifying this product type.
|
|
175
|
+
*/
|
|
116
176
|
'styleCode'?: string;
|
|
177
|
+
/**
|
|
178
|
+
* The material composition of the product.
|
|
179
|
+
*/
|
|
117
180
|
'material'?: string;
|
|
181
|
+
/**
|
|
182
|
+
* A description of the product.
|
|
183
|
+
*/
|
|
118
184
|
'description'?: string;
|
|
185
|
+
/**
|
|
186
|
+
* Product specifications.
|
|
187
|
+
*/
|
|
119
188
|
'specifications'?: string;
|
|
120
189
|
/**
|
|
121
|
-
*
|
|
190
|
+
* The available attributes (e.g. Colour, Size) for this product.
|
|
122
191
|
*/
|
|
123
192
|
'attributes': Array<ProductAttribute>;
|
|
124
193
|
/**
|
|
@@ -155,6 +224,9 @@ export interface ProductAttributeValuesInner {
|
|
|
155
224
|
*/
|
|
156
225
|
'value': string;
|
|
157
226
|
}
|
|
227
|
+
/**
|
|
228
|
+
* The brand that manufactures or supplies this product.
|
|
229
|
+
*/
|
|
158
230
|
export interface ProductBrand {
|
|
159
231
|
/**
|
|
160
232
|
* the name of the brand that manufactures/supplies the product
|
|
@@ -188,53 +260,107 @@ export interface ProductsResponse {
|
|
|
188
260
|
'products'?: Array<Product>;
|
|
189
261
|
'nextPageToken'?: number | null;
|
|
190
262
|
}
|
|
263
|
+
/**
|
|
264
|
+
* A GFN billing statement summarising fulfillment costs over a period.
|
|
265
|
+
*/
|
|
191
266
|
export interface Statement {
|
|
192
267
|
/**
|
|
193
|
-
*
|
|
268
|
+
* The unique identifier of the statement.
|
|
194
269
|
*/
|
|
195
270
|
'id': string;
|
|
196
271
|
/**
|
|
197
|
-
* A reference to
|
|
272
|
+
* A URI reference to this statement resource.
|
|
198
273
|
*/
|
|
199
274
|
'ref': string;
|
|
275
|
+
/**
|
|
276
|
+
* The total cost of all transactions in this statement.
|
|
277
|
+
*/
|
|
200
278
|
'total': number;
|
|
279
|
+
/**
|
|
280
|
+
* The start date of the billing period.
|
|
281
|
+
*/
|
|
201
282
|
'startDate': string;
|
|
283
|
+
/**
|
|
284
|
+
* The end date of the billing period.
|
|
285
|
+
*/
|
|
202
286
|
'endDate': string;
|
|
287
|
+
/**
|
|
288
|
+
* The timestamp when the statement was created.
|
|
289
|
+
*/
|
|
203
290
|
'createdAt': string;
|
|
291
|
+
/**
|
|
292
|
+
* The number of fulfillments included in this statement.
|
|
293
|
+
*/
|
|
204
294
|
'fulfillmentCount': number;
|
|
295
|
+
/**
|
|
296
|
+
* The timestamp when the statement was issued.
|
|
297
|
+
*/
|
|
205
298
|
'issuedAt'?: string;
|
|
206
299
|
}
|
|
300
|
+
/**
|
|
301
|
+
* Stock availability information including total level and per-location breakdown.
|
|
302
|
+
*/
|
|
207
303
|
export interface Stock {
|
|
208
304
|
/**
|
|
209
305
|
* Current stock level
|
|
210
306
|
*/
|
|
211
307
|
'level'?: number;
|
|
308
|
+
/**
|
|
309
|
+
* Stock levels broken down by warehouse location.
|
|
310
|
+
*/
|
|
212
311
|
'locations'?: Array<Location>;
|
|
213
312
|
}
|
|
214
313
|
export interface StockResponse {
|
|
215
314
|
'variants'?: Array<VariantStock>;
|
|
216
315
|
'nextPageToken'?: number | null;
|
|
217
316
|
}
|
|
317
|
+
/**
|
|
318
|
+
* A GFN transaction representing a cost incurred for a fulfillment (blank, application, or shipping).
|
|
319
|
+
*/
|
|
218
320
|
export interface Transaction {
|
|
219
321
|
/**
|
|
220
|
-
*
|
|
322
|
+
* The unique identifier of the transaction.
|
|
221
323
|
*/
|
|
222
324
|
'id': string;
|
|
223
325
|
/**
|
|
224
|
-
* A reference to
|
|
326
|
+
* A URI reference to this transaction resource.
|
|
225
327
|
*/
|
|
226
328
|
'ref': string;
|
|
227
329
|
/**
|
|
228
|
-
* A reference to the
|
|
330
|
+
* A reference to the statement this transaction belongs to. Null if not yet included in a statement.
|
|
229
331
|
*/
|
|
230
332
|
'statement'?: string | null;
|
|
333
|
+
/**
|
|
334
|
+
* The cost of this transaction.
|
|
335
|
+
*/
|
|
231
336
|
'cost'?: number;
|
|
337
|
+
/**
|
|
338
|
+
* The number of units this transaction covers.
|
|
339
|
+
*/
|
|
232
340
|
'quantity': number;
|
|
341
|
+
/**
|
|
342
|
+
* The type of transaction: \'blank\' for base product cost, \'application\' for design application cost, \'shipping\' for shipping cost.
|
|
343
|
+
*/
|
|
233
344
|
'type'?: TransactionTypeEnum;
|
|
345
|
+
/**
|
|
346
|
+
* Whether this transaction is subject to tax.
|
|
347
|
+
*/
|
|
234
348
|
'taxable'?: boolean;
|
|
349
|
+
/**
|
|
350
|
+
* The timestamp when the transaction was created.
|
|
351
|
+
*/
|
|
235
352
|
'createdAt': string;
|
|
353
|
+
/**
|
|
354
|
+
* The identifier of the fulfillment this transaction relates to.
|
|
355
|
+
*/
|
|
236
356
|
'fulfillmentId'?: number;
|
|
357
|
+
/**
|
|
358
|
+
* The identifier of the order this transaction relates to.
|
|
359
|
+
*/
|
|
237
360
|
'orderId'?: number;
|
|
361
|
+
/**
|
|
362
|
+
* A human-readable description of the transaction.
|
|
363
|
+
*/
|
|
238
364
|
'description'?: string;
|
|
239
365
|
}
|
|
240
366
|
export declare const TransactionTypeEnum: {
|
|
@@ -243,25 +369,34 @@ export declare const TransactionTypeEnum: {
|
|
|
243
369
|
readonly Shipping: "shipping";
|
|
244
370
|
};
|
|
245
371
|
export type TransactionTypeEnum = typeof TransactionTypeEnum[keyof typeof TransactionTypeEnum];
|
|
372
|
+
/**
|
|
373
|
+
* A specific colour/size combination of a GFN catalog product.
|
|
374
|
+
*/
|
|
246
375
|
export interface Variant {
|
|
247
376
|
/**
|
|
248
|
-
*
|
|
377
|
+
* The unique identifier of the variant.
|
|
249
378
|
*/
|
|
250
379
|
'id'?: string;
|
|
251
380
|
/**
|
|
252
|
-
* A reference to
|
|
381
|
+
* A URI reference to this variant resource.
|
|
253
382
|
*/
|
|
254
383
|
'ref'?: string;
|
|
255
384
|
'product'?: VariantProduct;
|
|
385
|
+
/**
|
|
386
|
+
* The stock keeping unit code for this variant.
|
|
387
|
+
*/
|
|
256
388
|
'sku': string;
|
|
257
389
|
/**
|
|
258
|
-
*
|
|
390
|
+
* The attributes (e.g. Colour, Size) that define this variant.
|
|
259
391
|
*/
|
|
260
392
|
'attributes': Array<Attribute>;
|
|
261
393
|
'manufacturerOrigin'?: VariantManufacturerOrigin;
|
|
394
|
+
/**
|
|
395
|
+
* The stock levels for this variant.
|
|
396
|
+
*/
|
|
262
397
|
'stock'?: Stock;
|
|
263
398
|
/**
|
|
264
|
-
*
|
|
399
|
+
* Product images for this variant.
|
|
265
400
|
*/
|
|
266
401
|
'images'?: Array<Image>;
|
|
267
402
|
}
|
|
@@ -278,6 +413,9 @@ export interface VariantManufacturerOrigin {
|
|
|
278
413
|
*/
|
|
279
414
|
'name'?: string;
|
|
280
415
|
}
|
|
416
|
+
/**
|
|
417
|
+
* A reference to the product this variant belongs to.
|
|
418
|
+
*/
|
|
281
419
|
export interface VariantProduct {
|
|
282
420
|
/**
|
|
283
421
|
* Unique object identifier
|
|
@@ -292,24 +430,33 @@ export interface VariantProduct {
|
|
|
292
430
|
*/
|
|
293
431
|
'ref'?: string;
|
|
294
432
|
}
|
|
433
|
+
/**
|
|
434
|
+
* Stock information for a specific variant, including per-location breakdown.
|
|
435
|
+
*/
|
|
295
436
|
export interface VariantStock {
|
|
296
437
|
/**
|
|
297
|
-
*
|
|
438
|
+
* The unique identifier of the variant.
|
|
298
439
|
*/
|
|
299
440
|
'id'?: string;
|
|
300
441
|
/**
|
|
301
442
|
* The product name of the variant stock
|
|
302
443
|
*/
|
|
303
444
|
'name'?: string;
|
|
445
|
+
/**
|
|
446
|
+
* A unique identifier for a specific variant (product + colour + size).
|
|
447
|
+
*/
|
|
304
448
|
'sku'?: string;
|
|
305
449
|
/**
|
|
306
|
-
* A reference to
|
|
450
|
+
* A URI reference to this variant resource.
|
|
307
451
|
*/
|
|
308
452
|
'ref'?: string;
|
|
309
453
|
/**
|
|
310
|
-
* A reference to the
|
|
454
|
+
* A URI reference to the product this variant belongs to.
|
|
311
455
|
*/
|
|
312
456
|
'productRef'?: string;
|
|
457
|
+
/**
|
|
458
|
+
* The stock levels for this variant.
|
|
459
|
+
*/
|
|
313
460
|
'stock'?: Stock;
|
|
314
461
|
}
|
|
315
462
|
export interface VariantsResponse {
|
|
@@ -324,7 +471,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
324
471
|
* Gets a GFN product by the given ID.
|
|
325
472
|
* @summary Get a GFN product
|
|
326
473
|
* @param {string} project What project it is
|
|
327
|
-
* @param {string} productId
|
|
474
|
+
* @param {string} productId The unique identifier of the GFN catalog product.
|
|
328
475
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
329
476
|
* @param {*} [options] Override http request option.
|
|
330
477
|
* @throws {RequiredError}
|
|
@@ -351,7 +498,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
351
498
|
* Gets a GFN product by the given ID.
|
|
352
499
|
* @summary Get a GFN product
|
|
353
500
|
* @param {string} project What project it is
|
|
354
|
-
* @param {string} productId
|
|
501
|
+
* @param {string} productId The unique identifier of the GFN catalog product.
|
|
355
502
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
356
503
|
* @param {*} [options] Override http request option.
|
|
357
504
|
* @throws {RequiredError}
|
|
@@ -399,6 +546,9 @@ export interface ProductsApiGetProductRequest {
|
|
|
399
546
|
* What project it is
|
|
400
547
|
*/
|
|
401
548
|
readonly project: string;
|
|
549
|
+
/**
|
|
550
|
+
* The unique identifier of the GFN catalog product.
|
|
551
|
+
*/
|
|
402
552
|
readonly productId: string;
|
|
403
553
|
/**
|
|
404
554
|
* Filter response fields to only include a subset of the resource.
|
|
@@ -459,7 +609,7 @@ export declare const StatementsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
459
609
|
* Gets a GFN statement by the given ID.
|
|
460
610
|
* @summary Get a GFN statement
|
|
461
611
|
* @param {string} project What project it is
|
|
462
|
-
* @param {string} statementId
|
|
612
|
+
* @param {string} statementId The unique identifier of the GFN statement.
|
|
463
613
|
* @param {*} [options] Override http request option.
|
|
464
614
|
* @throws {RequiredError}
|
|
465
615
|
*/
|
|
@@ -484,7 +634,7 @@ export declare const StatementsApiFp: (configuration?: Configuration) => {
|
|
|
484
634
|
* Gets a GFN statement by the given ID.
|
|
485
635
|
* @summary Get a GFN statement
|
|
486
636
|
* @param {string} project What project it is
|
|
487
|
-
* @param {string} statementId
|
|
637
|
+
* @param {string} statementId The unique identifier of the GFN statement.
|
|
488
638
|
* @param {*} [options] Override http request option.
|
|
489
639
|
* @throws {RequiredError}
|
|
490
640
|
*/
|
|
@@ -530,6 +680,9 @@ export interface StatementsApiGetStatementRequest {
|
|
|
530
680
|
* What project it is
|
|
531
681
|
*/
|
|
532
682
|
readonly project: string;
|
|
683
|
+
/**
|
|
684
|
+
* The unique identifier of the GFN statement.
|
|
685
|
+
*/
|
|
533
686
|
readonly statementId: string;
|
|
534
687
|
}
|
|
535
688
|
/**
|
|
@@ -591,7 +744,7 @@ export declare const TransactionsApiAxiosParamCreator: (configuration?: Configur
|
|
|
591
744
|
* Gets a GFN transaction by the given ID.
|
|
592
745
|
* @summary Get a GFN transaction
|
|
593
746
|
* @param {string} project What project it is
|
|
594
|
-
* @param {string} transactionId
|
|
747
|
+
* @param {string} transactionId The unique identifier of the GFN transaction.
|
|
595
748
|
* @param {*} [options] Override http request option.
|
|
596
749
|
* @throws {RequiredError}
|
|
597
750
|
*/
|
|
@@ -602,7 +755,7 @@ export declare const TransactionsApiAxiosParamCreator: (configuration?: Configur
|
|
|
602
755
|
* @param {string} project What project it is
|
|
603
756
|
* @param {number} [pageToken] Page reference token
|
|
604
757
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
605
|
-
* @param {string} [statementId]
|
|
758
|
+
* @param {string} [statementId] Filter fulfillments by statement ID.
|
|
606
759
|
* @param {*} [options] Override http request option.
|
|
607
760
|
* @throws {RequiredError}
|
|
608
761
|
*/
|
|
@@ -613,8 +766,8 @@ export declare const TransactionsApiAxiosParamCreator: (configuration?: Configur
|
|
|
613
766
|
* @param {string} project What project it is
|
|
614
767
|
* @param {number} [pageToken] Page reference token
|
|
615
768
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
616
|
-
* @param {string} [statementId]
|
|
617
|
-
* @param {string} [fulfillmentId]
|
|
769
|
+
* @param {string} [statementId] Filter transactions by statement ID.
|
|
770
|
+
* @param {string} [fulfillmentId] Filter transactions by fulfillment ID.
|
|
618
771
|
* @param {string} [search] Search by fulfillment id
|
|
619
772
|
* @param {*} [options] Override http request option.
|
|
620
773
|
* @throws {RequiredError}
|
|
@@ -638,7 +791,7 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
|
|
|
638
791
|
* Gets a GFN transaction by the given ID.
|
|
639
792
|
* @summary Get a GFN transaction
|
|
640
793
|
* @param {string} project What project it is
|
|
641
|
-
* @param {string} transactionId
|
|
794
|
+
* @param {string} transactionId The unique identifier of the GFN transaction.
|
|
642
795
|
* @param {*} [options] Override http request option.
|
|
643
796
|
* @throws {RequiredError}
|
|
644
797
|
*/
|
|
@@ -649,7 +802,7 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
|
|
|
649
802
|
* @param {string} project What project it is
|
|
650
803
|
* @param {number} [pageToken] Page reference token
|
|
651
804
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
652
|
-
* @param {string} [statementId]
|
|
805
|
+
* @param {string} [statementId] Filter fulfillments by statement ID.
|
|
653
806
|
* @param {*} [options] Override http request option.
|
|
654
807
|
* @throws {RequiredError}
|
|
655
808
|
*/
|
|
@@ -660,8 +813,8 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
|
|
|
660
813
|
* @param {string} project What project it is
|
|
661
814
|
* @param {number} [pageToken] Page reference token
|
|
662
815
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
663
|
-
* @param {string} [statementId]
|
|
664
|
-
* @param {string} [fulfillmentId]
|
|
816
|
+
* @param {string} [statementId] Filter transactions by statement ID.
|
|
817
|
+
* @param {string} [fulfillmentId] Filter transactions by fulfillment ID.
|
|
665
818
|
* @param {string} [search] Search by fulfillment id
|
|
666
819
|
* @param {*} [options] Override http request option.
|
|
667
820
|
* @throws {RequiredError}
|
|
@@ -726,6 +879,9 @@ export interface TransactionsApiGetTransactionRequest {
|
|
|
726
879
|
* What project it is
|
|
727
880
|
*/
|
|
728
881
|
readonly project: string;
|
|
882
|
+
/**
|
|
883
|
+
* The unique identifier of the GFN transaction.
|
|
884
|
+
*/
|
|
729
885
|
readonly transactionId: string;
|
|
730
886
|
}
|
|
731
887
|
/**
|
|
@@ -744,6 +900,9 @@ export interface TransactionsApiListFulfillmentsRequest {
|
|
|
744
900
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
745
901
|
*/
|
|
746
902
|
readonly pageSize?: number;
|
|
903
|
+
/**
|
|
904
|
+
* Filter fulfillments by statement ID.
|
|
905
|
+
*/
|
|
747
906
|
readonly statementId?: string;
|
|
748
907
|
}
|
|
749
908
|
/**
|
|
@@ -762,7 +921,13 @@ export interface TransactionsApiListTransactionsRequest {
|
|
|
762
921
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
763
922
|
*/
|
|
764
923
|
readonly pageSize?: number;
|
|
924
|
+
/**
|
|
925
|
+
* Filter transactions by statement ID.
|
|
926
|
+
*/
|
|
765
927
|
readonly statementId?: string;
|
|
928
|
+
/**
|
|
929
|
+
* Filter transactions by fulfillment ID.
|
|
930
|
+
*/
|
|
766
931
|
readonly fulfillmentId?: string;
|
|
767
932
|
/**
|
|
768
933
|
* Search by fulfillment id
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.9.
|
|
7
|
+
* The version of the OpenAPI document: 3.9.4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -29,12 +29,12 @@ import { BASE_PATH, BaseAPI, operationServerMap } from './base';
|
|
|
29
29
|
export const AttributeThumbnailTypeEnum = {
|
|
30
30
|
Text: 'text',
|
|
31
31
|
Color: 'color',
|
|
32
|
-
Image: 'image'
|
|
32
|
+
Image: 'image',
|
|
33
33
|
};
|
|
34
34
|
export const TransactionTypeEnum = {
|
|
35
35
|
Blank: 'blank',
|
|
36
36
|
Application: 'application',
|
|
37
|
-
Shipping: 'shipping'
|
|
37
|
+
Shipping: 'shipping',
|
|
38
38
|
};
|
|
39
39
|
/**
|
|
40
40
|
* ProductsApi - axios parameter creator
|
|
@@ -45,7 +45,7 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
45
45
|
* Gets a GFN product by the given ID.
|
|
46
46
|
* @summary Get a GFN product
|
|
47
47
|
* @param {string} project What project it is
|
|
48
|
-
* @param {string} productId
|
|
48
|
+
* @param {string} productId The unique identifier of the GFN catalog product.
|
|
49
49
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
51
51
|
* @throws {RequiredError}
|
|
@@ -151,7 +151,7 @@ export const ProductsApiFp = function (configuration) {
|
|
|
151
151
|
* Gets a GFN product by the given ID.
|
|
152
152
|
* @summary Get a GFN product
|
|
153
153
|
* @param {string} project What project it is
|
|
154
|
-
* @param {string} productId
|
|
154
|
+
* @param {string} productId The unique identifier of the GFN catalog product.
|
|
155
155
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
156
156
|
* @param {*} [options] Override http request option.
|
|
157
157
|
* @throws {RequiredError}
|
|
@@ -249,7 +249,7 @@ export const StatementsApiAxiosParamCreator = function (configuration) {
|
|
|
249
249
|
* Gets a GFN statement by the given ID.
|
|
250
250
|
* @summary Get a GFN statement
|
|
251
251
|
* @param {string} project What project it is
|
|
252
|
-
* @param {string} statementId
|
|
252
|
+
* @param {string} statementId The unique identifier of the GFN statement.
|
|
253
253
|
* @param {*} [options] Override http request option.
|
|
254
254
|
* @throws {RequiredError}
|
|
255
255
|
*/
|
|
@@ -347,7 +347,7 @@ export const StatementsApiFp = function (configuration) {
|
|
|
347
347
|
* Gets a GFN statement by the given ID.
|
|
348
348
|
* @summary Get a GFN statement
|
|
349
349
|
* @param {string} project What project it is
|
|
350
|
-
* @param {string} statementId
|
|
350
|
+
* @param {string} statementId The unique identifier of the GFN statement.
|
|
351
351
|
* @param {*} [options] Override http request option.
|
|
352
352
|
* @throws {RequiredError}
|
|
353
353
|
*/
|
|
@@ -485,7 +485,7 @@ export const TransactionsApiAxiosParamCreator = function (configuration) {
|
|
|
485
485
|
* Gets a GFN transaction by the given ID.
|
|
486
486
|
* @summary Get a GFN transaction
|
|
487
487
|
* @param {string} project What project it is
|
|
488
|
-
* @param {string} transactionId
|
|
488
|
+
* @param {string} transactionId The unique identifier of the GFN transaction.
|
|
489
489
|
* @param {*} [options] Override http request option.
|
|
490
490
|
* @throws {RequiredError}
|
|
491
491
|
*/
|
|
@@ -528,7 +528,7 @@ export const TransactionsApiAxiosParamCreator = function (configuration) {
|
|
|
528
528
|
* @param {string} project What project it is
|
|
529
529
|
* @param {number} [pageToken] Page reference token
|
|
530
530
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
531
|
-
* @param {string} [statementId]
|
|
531
|
+
* @param {string} [statementId] Filter fulfillments by statement ID.
|
|
532
532
|
* @param {*} [options] Override http request option.
|
|
533
533
|
* @throws {RequiredError}
|
|
534
534
|
*/
|
|
@@ -577,8 +577,8 @@ export const TransactionsApiAxiosParamCreator = function (configuration) {
|
|
|
577
577
|
* @param {string} project What project it is
|
|
578
578
|
* @param {number} [pageToken] Page reference token
|
|
579
579
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
580
|
-
* @param {string} [statementId]
|
|
581
|
-
* @param {string} [fulfillmentId]
|
|
580
|
+
* @param {string} [statementId] Filter transactions by statement ID.
|
|
581
|
+
* @param {string} [fulfillmentId] Filter transactions by fulfillment ID.
|
|
582
582
|
* @param {string} [search] Search by fulfillment id
|
|
583
583
|
* @param {*} [options] Override http request option.
|
|
584
584
|
* @throws {RequiredError}
|
|
@@ -657,7 +657,7 @@ export const TransactionsApiFp = function (configuration) {
|
|
|
657
657
|
* Gets a GFN transaction by the given ID.
|
|
658
658
|
* @summary Get a GFN transaction
|
|
659
659
|
* @param {string} project What project it is
|
|
660
|
-
* @param {string} transactionId
|
|
660
|
+
* @param {string} transactionId The unique identifier of the GFN transaction.
|
|
661
661
|
* @param {*} [options] Override http request option.
|
|
662
662
|
* @throws {RequiredError}
|
|
663
663
|
*/
|
|
@@ -676,7 +676,7 @@ export const TransactionsApiFp = function (configuration) {
|
|
|
676
676
|
* @param {string} project What project it is
|
|
677
677
|
* @param {number} [pageToken] Page reference token
|
|
678
678
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
679
|
-
* @param {string} [statementId]
|
|
679
|
+
* @param {string} [statementId] Filter fulfillments by statement ID.
|
|
680
680
|
* @param {*} [options] Override http request option.
|
|
681
681
|
* @throws {RequiredError}
|
|
682
682
|
*/
|
|
@@ -695,8 +695,8 @@ export const TransactionsApiFp = function (configuration) {
|
|
|
695
695
|
* @param {string} project What project it is
|
|
696
696
|
* @param {number} [pageToken] Page reference token
|
|
697
697
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
698
|
-
* @param {string} [statementId]
|
|
699
|
-
* @param {string} [fulfillmentId]
|
|
698
|
+
* @param {string} [statementId] Filter transactions by statement ID.
|
|
699
|
+
* @param {string} [fulfillmentId] Filter transactions by fulfillment ID.
|
|
700
700
|
* @param {string} [search] Search by fulfillment id
|
|
701
701
|
* @param {*} [options] Override http request option.
|
|
702
702
|
* @throws {RequiredError}
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog
|
|
3
3
|
* Use this API to access the Global Fulfillment 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: 3.9.
|
|
5
|
+
* The version of the OpenAPI document: 3.9.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.9.
|
|
7
|
+
* The version of the OpenAPI document: 3.9.4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog
|
|
3
3
|
* Use this API to access the Global Fulfillment 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: 3.9.
|
|
5
|
+
* The version of the OpenAPI document: 3.9.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.9.
|
|
7
|
+
* The version of the OpenAPI document: 3.9.4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog
|
|
3
3
|
* Use this API to access the Global Fulfillment 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: 3.9.
|
|
5
|
+
* The version of the OpenAPI document: 3.9.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* GFN Catalog
|
|
4
4
|
* Use this API to access the Global Fulfillment 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.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 3.9.
|
|
6
|
+
* The version of the OpenAPI document: 3.9.4
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|