@teemill/pickfaces 0.30.0 → 0.31.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/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Pickfaces API
5
5
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
6
6
  *
7
- * The version of the OpenAPI document: 0.30.0
7
+ * The version of the OpenAPI document: 0.31.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,650 +23,331 @@ import type { RequestArgs } from './base';
23
23
  // @ts-ignore
24
24
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
25
 
26
- /**
27
- *
28
- * @export
29
- * @interface ApiError
30
- */
31
26
  export interface ApiError {
32
- /**
33
- *
34
- * @type {string}
35
- * @memberof ApiError
36
- */
37
27
  'code'?: string;
38
- /**
39
- *
40
- * @type {string}
41
- * @memberof ApiError
42
- */
43
28
  'message': string;
44
29
  }
45
30
  /**
46
31
  * The factory container the pickface is within
47
- * @export
48
- * @interface ContainerType
49
32
  */
50
33
  export interface ContainerType {
51
34
  /**
52
35
  * Unique object identifier
53
- * @type {string}
54
- * @memberof ContainerType
55
36
  */
56
37
  'id': string;
57
38
  /**
58
39
  * A reference to the resource location
59
- * @type {string}
60
- * @memberof ContainerType
61
40
  */
62
41
  'ref': string;
63
- /**
64
- *
65
- * @type {string}
66
- * @memberof ContainerType
67
- */
68
42
  'name': string;
69
43
  /**
70
44
  * The width of the container in millimetres
71
- * @type {number}
72
- * @memberof ContainerType
73
45
  */
74
46
  'width'?: number;
75
47
  /**
76
48
  * The depth of the container in millimetres
77
- * @type {number}
78
- * @memberof ContainerType
79
49
  */
80
50
  'depth'?: number;
81
51
  /**
82
52
  * The height of the container in millimetres
83
- * @type {number}
84
- * @memberof ContainerType
85
53
  */
86
54
  'height'?: number;
87
55
  }
88
- /**
89
- *
90
- * @export
91
- * @interface ContainerTypes
92
- */
93
56
  export interface ContainerTypes {
94
- /**
95
- *
96
- * @type {Array<ContainerType>}
97
- * @memberof ContainerTypes
98
- */
99
57
  'containerTypes'?: Array<ContainerType>;
100
58
  }
101
- /**
102
- *
103
- * @export
104
- * @interface CreatePickfaceRequest
105
- */
106
59
  export interface CreatePickfaceRequest {
107
60
  /**
108
61
  * A human readable location for the pickface i.e. \"1 Wf 49\"
109
- * @type {string}
110
- * @memberof CreatePickfaceRequest
111
62
  */
112
63
  'location': string;
113
64
  /**
114
65
  * A user defined name for the pickface, if this is not provided the location will be used as the name.
115
- * @type {string}
116
- * @memberof CreatePickfaceRequest
117
66
  */
118
67
  'name'?: string | null;
119
68
  /**
120
69
  * Use \'Pickfaces API\' > \'List pickface container types\' to get a list of available options.
121
- * @type {string}
122
- * @memberof CreatePickfaceRequest
123
70
  */
124
71
  'containerTypeId': string;
125
72
  /**
126
73
  * Whether the pickface is used for bulk storage
127
- * @type {boolean}
128
- * @memberof CreatePickfaceRequest
129
74
  */
130
75
  'bulk'?: boolean;
131
76
  /**
132
77
  * Whether the pickface can contain mixed contents.
133
- * @type {boolean}
134
- * @memberof CreatePickfaceRequest
135
78
  */
136
79
  'mixedContents'?: boolean;
137
80
  /**
138
81
  * Typically this field is left empty. Use \'Zones API\' > \'List warehouse zones\' to get a list of available options.
139
- * @type {string}
140
- * @memberof CreatePickfaceRequest
141
82
  */
142
83
  'zoneId'?: string;
143
84
  /**
144
- * The distance from the nearest label printer to the pickface in meters. This is used for put away recommendations.
145
- * @type {number}
146
- * @memberof CreatePickfaceRequest
85
+ * The distance from the nearest label printer to the pickface in centimeters. This is used for put away recommendations.
147
86
  */
148
87
  'distanceFromLabelPrinter'?: number | null;
149
88
  }
150
- /**
151
- *
152
- * @export
153
- * @interface ExportPickfaces202Response
154
- */
155
89
  export interface ExportPickfaces202Response {
156
90
  /**
157
91
  * A message describing the export status
158
- * @type {string}
159
- * @memberof ExportPickfaces202Response
160
92
  */
161
93
  'message'?: string;
162
94
  }
163
- /**
164
- *
165
- * @export
166
- * @interface InlineObject
167
- */
168
- export interface InlineObject {
169
- /**
170
- *
171
- * @type {Array<Pickface>}
172
- * @memberof InlineObject
173
- */
174
- 'pickfaces'?: Array<Pickface>;
175
- /**
176
- * The token referencing the next page number
177
- * @type {number}
178
- * @memberof InlineObject
179
- */
180
- 'nextPageToken'?: number | null;
181
- }
182
- /**
183
- *
184
- * @export
185
- * @interface IssueEmptyPickfaceRequest
186
- */
187
95
  export interface IssueEmptyPickfaceRequest {
188
96
  /**
189
97
  * A reference to the resource location
190
- * @type {string}
191
- * @memberof IssueEmptyPickfaceRequest
192
98
  */
193
99
  'issueRef'?: string;
194
100
  }
195
- /**
196
- *
197
- * @export
198
- * @interface IssueWrongContentsPickfaceRequest
199
- */
200
101
  export interface IssueWrongContentsPickfaceRequest {
201
102
  /**
202
103
  * A reference to the resource location
203
- * @type {string}
204
- * @memberof IssueWrongContentsPickfaceRequest
205
104
  */
206
105
  'issueRef'?: string;
207
106
  /**
208
107
  * A reference to the resource location
209
- * @type {string}
210
- * @memberof IssueWrongContentsPickfaceRequest
211
108
  */
212
109
  'variantRef'?: string;
213
110
  }
214
- /**
215
- *
216
- * @export
217
- * @interface ListPickfaceLogs200Response
218
- */
219
111
  export interface ListPickfaceLogs200Response {
112
+ 'logs'?: Array<PickfaceLog>;
220
113
  /**
221
- *
222
- * @type {Array<PickfaceLog>}
223
- * @memberof ListPickfaceLogs200Response
114
+ * The token referencing the next page number
224
115
  */
225
- 'logs'?: Array<PickfaceLog>;
116
+ 'nextPageToken'?: number | null;
117
+ }
118
+ export interface ListPickfaces200Response {
119
+ 'pickfaces'?: Array<Pickface>;
226
120
  /**
227
121
  * The token referencing the next page number
228
- * @type {number}
229
- * @memberof ListPickfaceLogs200Response
230
122
  */
231
123
  'nextPageToken'?: number | null;
232
124
  }
233
- /**
234
- *
235
- * @export
236
- * @interface MoveStockRequest
237
- */
238
125
  export interface MoveStockRequest {
239
126
  /**
240
127
  * The variant to move from the pickface
241
- * @type {string}
242
- * @memberof MoveStockRequest
243
128
  */
244
129
  'variantRef': string;
245
130
  /**
246
131
  * The quantity to move from the pickface
247
- * @type {number}
248
- * @memberof MoveStockRequest
249
132
  */
250
133
  'quantity': number;
251
134
  /**
252
135
  * The pickface to move the stock to
253
- * @type {string}
254
- * @memberof MoveStockRequest
255
136
  */
256
137
  'toPickfaceRef': string;
257
138
  }
258
- /**
259
- *
260
- * @export
261
- * @interface Pickface
262
- */
263
139
  export interface Pickface {
264
140
  /**
265
141
  * Unique object identifier
266
- * @type {string}
267
- * @memberof Pickface
268
142
  */
269
143
  'id': string;
270
144
  /**
271
145
  * A reference to the resource location
272
- * @type {string}
273
- * @memberof Pickface
274
146
  */
275
147
  'ref': string;
276
148
  /**
277
149
  * The barcode of the pickface
278
- * @type {string}
279
- * @memberof Pickface
280
150
  */
281
151
  'barcode': string;
282
- /**
283
- *
284
- * @type {PickfaceZone}
285
- * @memberof Pickface
286
- */
287
152
  'zone': PickfaceZone | null;
288
153
  /**
289
154
  * The human readable location of the pickface, if a name is provided this will be the name.
290
- * @type {string}
291
- * @memberof Pickface
292
155
  */
293
156
  'code': string;
294
- /**
295
- *
296
- * @type {boolean}
297
- * @memberof Pickface
298
- */
299
157
  'enabled': boolean;
300
158
  /**
301
159
  * Whether the pickface can contain mixed contents.
302
- * @type {boolean}
303
- * @memberof Pickface
304
160
  */
305
161
  'mixedContents': boolean;
306
162
  /**
307
163
  * Whether the pickface is used for bulk storage and not for picking
308
- * @type {boolean}
309
- * @memberof Pickface
310
164
  */
311
165
  'bulk': boolean;
312
- /**
313
- *
314
- * @type {PickfaceContainerType}
315
- * @memberof Pickface
316
- */
317
166
  'containerType': PickfaceContainerType;
318
167
  /**
319
168
  * The percentage of the pickface that has been taken up by its contents
320
- * @type {number}
321
- * @memberof Pickface
322
169
  */
323
170
  'fullness': number;
324
171
  /**
325
172
  * The last time the pickface was picked from
326
- * @type {PickfaceLog}
327
- * @memberof Pickface
328
173
  */
329
174
  'lastPicked': PickfaceLog | null;
330
175
  /**
331
176
  * The last time the pickface was restocked
332
- * @type {PickfaceLog}
333
- * @memberof Pickface
334
177
  */
335
178
  'lastRestocked': PickfaceLog | null;
336
- /**
337
- *
338
- * @type {PickfaceIssue}
339
- * @memberof Pickface
340
- */
341
179
  'issue': PickfaceIssue | null;
342
- /**
343
- *
344
- * @type {Array<PickfaceContentsInner>}
345
- * @memberof Pickface
346
- */
347
180
  'contents': Array<PickfaceContentsInner>;
348
181
  /**
349
- * The distance from the nearest label printer to the pickface in meters.
350
- * @type {number}
351
- * @memberof Pickface
182
+ * The distance from the nearest label printer to the pickface in centimeters.
352
183
  */
353
184
  'distanceFromLabelPrinter': number | null;
354
185
  }
355
- /**
356
- *
357
- * @export
358
- * @interface PickfaceContainerType
359
- */
360
186
  export interface PickfaceContainerType {
361
187
  /**
362
188
  * Unique object identifier
363
- * @type {string}
364
- * @memberof PickfaceContainerType
365
189
  */
366
190
  'id'?: string;
367
191
  /**
368
192
  * A reference to the resource location
369
- * @type {string}
370
- * @memberof PickfaceContainerType
371
193
  */
372
194
  'ref'?: string;
373
195
  }
374
- /**
375
- *
376
- * @export
377
- * @interface PickfaceContentsInner
378
- */
379
196
  export interface PickfaceContentsInner {
380
197
  /**
381
198
  * A reference to the resource location
382
- * @type {string}
383
- * @memberof PickfaceContentsInner
384
199
  */
385
200
  'variantRef': string;
386
201
  /**
387
202
  * The ID of the project that the contents belongs to. For example, if you had a 3PL item this would be the project that created the product.
388
- * @type {string}
389
- * @memberof PickfaceContentsInner
390
203
  */
391
204
  'ownerProjectId': string | null;
392
- /**
393
- *
394
- * @type {PickfaceContentsInnerQuantity}
395
- * @memberof PickfaceContentsInner
396
- */
397
205
  'quantity': PickfaceContentsInnerQuantity;
398
- /**
399
- *
400
- * @type {PickfaceContentsInnerMetadata}
401
- * @memberof PickfaceContentsInner
402
- */
403
206
  'metadata': PickfaceContentsInnerMetadata | null;
404
207
  }
405
208
  /**
406
209
  * Any additional metadata
407
- * @export
408
- * @interface PickfaceContentsInnerMetadata
409
210
  */
410
211
  export interface PickfaceContentsInnerMetadata {
411
212
  /**
412
213
  * The title of the product
413
- * @type {string}
414
- * @memberof PickfaceContentsInnerMetadata
415
214
  */
416
215
  'title': string | null;
417
216
  /**
418
217
  * The SKU of the product
419
- * @type {string}
420
- * @memberof PickfaceContentsInnerMetadata
421
218
  */
422
219
  'sku': string | null;
423
220
  /**
424
221
  * The image of the front of the product
425
- * @type {string}
426
- * @memberof PickfaceContentsInnerMetadata
427
222
  */
428
223
  'frontImage'?: string | null;
429
224
  /**
430
225
  * The image of the back of the product
431
- * @type {string}
432
- * @memberof PickfaceContentsInnerMetadata
433
226
  */
434
227
  'backImage'?: string | null;
435
228
  /**
436
229
  * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`.
437
- * @type {Array<VariantAttribute>}
438
- * @memberof PickfaceContentsInnerMetadata
439
230
  */
440
231
  'attributes'?: Array<VariantAttribute>;
441
232
  }
442
- /**
443
- *
444
- * @export
445
- * @interface PickfaceContentsInnerQuantity
446
- */
447
233
  export interface PickfaceContentsInnerQuantity {
448
234
  /**
449
235
  * How many are in the box
450
- * @type {number}
451
- * @memberof PickfaceContentsInnerQuantity
452
236
  */
453
237
  'total'?: number;
454
238
  /**
455
239
  * How many are available to reserve
456
- * @type {number}
457
- * @memberof PickfaceContentsInnerQuantity
458
240
  */
459
241
  'available'?: number;
460
242
  /**
461
243
  * How many are pending some action e.g. to be picked
462
- * @type {number}
463
- * @memberof PickfaceContentsInnerQuantity
464
244
  */
465
245
  'reserved'?: number;
466
246
  /**
467
247
  * The amount of stock in the pickface that is awaiting some interaction with a third party system, e.g. a custom ordering system. This value does not interact with PodOS systems.
468
- * @type {number}
469
- * @memberof PickfaceContentsInnerQuantity
470
248
  */
471
249
  'ZWip'?: number;
472
250
  }
473
251
  /**
474
252
  * The open issue for the pickface
475
- * @export
476
- * @interface PickfaceIssue
477
253
  */
478
254
  export interface PickfaceIssue {
479
255
  /**
480
256
  * Unique object identifier
481
- * @type {string}
482
- * @memberof PickfaceIssue
483
257
  */
484
258
  'id'?: string;
485
259
  /**
486
260
  * A reference to the resource location
487
- * @type {string}
488
- * @memberof PickfaceIssue
489
261
  */
490
262
  'ref'?: string;
491
263
  }
492
- /**
493
- *
494
- * @export
495
- * @interface PickfaceLog
496
- */
497
264
  export interface PickfaceLog {
498
265
  /**
499
266
  * Unique object identifier
500
- * @type {string}
501
- * @memberof PickfaceLog
502
267
  */
503
268
  'id': string;
504
269
  /**
505
270
  * A reference to the resource location
506
- * @type {string}
507
- * @memberof PickfaceLog
508
271
  */
509
272
  'userRef': string;
510
273
  /**
511
274
  * The action that was taken
512
- * @type {string}
513
- * @memberof PickfaceLog
514
275
  */
515
276
  'action': string;
516
277
  /**
517
278
  * The reason for the action
518
- * @type {string}
519
- * @memberof PickfaceLog
520
279
  */
521
280
  'reason': string | null;
522
281
  /**
523
282
  * ISO 8601 Created at timestamp
524
- * @type {string}
525
- * @memberof PickfaceLog
526
283
  */
527
284
  'createdAt': string;
528
285
  }
529
- /**
530
- *
531
- * @export
532
- * @interface PickfaceZone
533
- */
534
286
  export interface PickfaceZone {
535
287
  /**
536
288
  * Unique object identifier
537
- * @type {string}
538
- * @memberof PickfaceZone
539
289
  */
540
290
  'id'?: string;
541
291
  /**
542
292
  * A reference to the resource location
543
- * @type {string}
544
- * @memberof PickfaceZone
545
293
  */
546
294
  'ref'?: string;
547
295
  /**
548
296
  * The name of the zone the pickface is in
549
- * @type {string}
550
- * @memberof PickfaceZone
551
297
  */
552
298
  'name'?: string;
553
299
  }
554
300
  /**
555
301
  * A list of updates to apply to the pickface.
556
- * @export
557
- * @interface UpdatePickfaceRequest
558
302
  */
559
303
  export interface UpdatePickfaceRequest {
560
- /**
561
- *
562
- * @type {boolean}
563
- * @memberof UpdatePickfaceRequest
564
- */
565
304
  'enabled': boolean;
566
305
  /**
567
306
  * Unique object identifier
568
- * @type {string}
569
- * @memberof UpdatePickfaceRequest
570
307
  */
571
308
  'containerTypeId'?: string;
572
309
  /**
573
310
  * Unique object identifier
574
- * @type {string}
575
- * @memberof UpdatePickfaceRequest
576
311
  */
577
312
  'zoneId'?: string | null;
578
313
  /**
579
314
  * Whether the pickface can contain mixed contents.
580
- * @type {boolean}
581
- * @memberof UpdatePickfaceRequest
582
315
  */
583
316
  'mixedContents'?: boolean;
584
317
  /**
585
318
  * Whether the pickface is used for bulk storage
586
- * @type {boolean}
587
- * @memberof UpdatePickfaceRequest
588
319
  */
589
320
  'bulk'?: boolean;
590
321
  /**
591
322
  * A user defined name for the pickface, if this is not provided the location will be used as the name.
592
- * @type {string}
593
- * @memberof UpdatePickfaceRequest
594
323
  */
595
324
  'name'?: string | null;
596
325
  /**
597
- * The distance from the nearest label printer to the pickface in meters. This is used for put away recommendations.
598
- * @type {number}
599
- * @memberof UpdatePickfaceRequest
326
+ * The distance from the nearest label printer to the pickface in centimeters. This is used for put away recommendations.
600
327
  */
601
328
  'distanceFromLabelPrinter'?: number | null;
602
- /**
603
- *
604
- * @type {Array<UpdatePickfaceRequestContentsInner>}
605
- * @memberof UpdatePickfaceRequest
606
- */
607
329
  'contents'?: Array<UpdatePickfaceRequestContentsInner> | null;
608
330
  /**
609
331
  * Unique object identifier
610
- * @type {string}
611
- * @memberof UpdatePickfaceRequest
612
332
  */
613
333
  'purchaseOrderId'?: string;
614
334
  }
615
- /**
616
- *
617
- * @export
618
- * @interface UpdatePickfaceRequestContentsInner
619
- */
620
335
  export interface UpdatePickfaceRequestContentsInner {
621
336
  /**
622
337
  * The variant to add or subtract from the pickface
623
- * @type {string}
624
- * @memberof UpdatePickfaceRequestContentsInner
625
338
  */
626
339
  'variantRef': string;
627
- /**
628
- *
629
- * @type {UpdatePickfaceRequestContentsInnerQuantity}
630
- * @memberof UpdatePickfaceRequestContentsInner
631
- */
632
340
  'quantity': UpdatePickfaceRequestContentsInnerQuantity;
633
341
  }
634
- /**
635
- *
636
- * @export
637
- * @interface UpdatePickfaceRequestContentsInnerQuantity
638
- */
639
342
  export interface UpdatePickfaceRequestContentsInnerQuantity {
640
- /**
641
- *
642
- * @type {UpdatePickfaceRequestContentsInnerQuantityAvailable}
643
- * @memberof UpdatePickfaceRequestContentsInnerQuantity
644
- */
645
343
  'available'?: UpdatePickfaceRequestContentsInnerQuantityAvailable | null;
646
- /**
647
- *
648
- * @type {UpdatePickfaceRequestContentsInnerQuantityZWip}
649
- * @memberof UpdatePickfaceRequestContentsInnerQuantity
650
- */
651
344
  'ZWip'?: UpdatePickfaceRequestContentsInnerQuantityZWip | null;
652
345
  }
653
346
  /**
654
347
  * The amount to add or subtract from the available stock on the pickface
655
- * @export
656
- * @interface UpdatePickfaceRequestContentsInnerQuantityAvailable
657
348
  */
658
349
  export interface UpdatePickfaceRequestContentsInnerQuantityAvailable {
659
- /**
660
- *
661
- * @type {string}
662
- * @memberof UpdatePickfaceRequestContentsInnerQuantityAvailable
663
- */
664
350
  'operation'?: UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum;
665
- /**
666
- *
667
- * @type {number}
668
- * @memberof UpdatePickfaceRequestContentsInnerQuantityAvailable
669
- */
670
351
  'value': number;
671
352
  }
672
353
 
@@ -680,21 +361,9 @@ export type UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = t
680
361
 
681
362
  /**
682
363
  * The amount to add or subtract from the Z WIP stock on the pickface.
683
- * @export
684
- * @interface UpdatePickfaceRequestContentsInnerQuantityZWip
685
364
  */
686
365
  export interface UpdatePickfaceRequestContentsInnerQuantityZWip {
687
- /**
688
- *
689
- * @type {string}
690
- * @memberof UpdatePickfaceRequestContentsInnerQuantityZWip
691
- */
692
366
  'operation'?: UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum;
693
- /**
694
- *
695
- * @type {number}
696
- * @memberof UpdatePickfaceRequestContentsInnerQuantityZWip
697
- */
698
367
  'value': number;
699
368
  }
700
369
 
@@ -706,104 +375,51 @@ export const UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum = {
706
375
 
707
376
  export type UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum];
708
377
 
709
- /**
710
- *
711
- * @export
712
- * @interface UpdatePickfacesRequest
713
- */
714
378
  export interface UpdatePickfacesRequest {
715
- /**
716
- *
717
- * @type {Array<UpdatePickfacesRequestPickfacesInner>}
718
- * @memberof UpdatePickfacesRequest
719
- */
720
379
  'pickfaces': Array<UpdatePickfacesRequestPickfacesInner>;
721
380
  }
722
- /**
723
- *
724
- * @export
725
- * @interface UpdatePickfacesRequestPickfacesInner
726
- */
727
381
  export interface UpdatePickfacesRequestPickfacesInner {
728
382
  /**
729
383
  * Unique object identifier
730
- * @type {string}
731
- * @memberof UpdatePickfacesRequestPickfacesInner
732
384
  */
733
385
  'id': string;
734
386
  /**
735
387
  * A user defined name for the pickface, if this is not provided the location will be used as the name.
736
- * @type {string}
737
- * @memberof UpdatePickfacesRequestPickfacesInner
738
388
  */
739
389
  'name'?: string | null;
740
390
  /**
741
391
  * Whether the pickface is enabled
742
- * @type {boolean}
743
- * @memberof UpdatePickfacesRequestPickfacesInner
744
392
  */
745
393
  'enabled'?: boolean;
746
394
  /**
747
395
  * Whether the pickface can contain mixed contents.
748
- * @type {boolean}
749
- * @memberof UpdatePickfacesRequestPickfacesInner
750
396
  */
751
397
  'mixedContents'?: boolean;
752
398
  /**
753
399
  * Whether the pickface is used for bulk storage
754
- * @type {boolean}
755
- * @memberof UpdatePickfacesRequestPickfacesInner
756
400
  */
757
401
  'bulk'?: boolean;
758
402
  /**
759
- * The distance from the nearest label printer to the pickface in meters. This is used for put away recommendations.
760
- * @type {number}
761
- * @memberof UpdatePickfacesRequestPickfacesInner
403
+ * The distance from the nearest label printer to the pickface in centimeters. This is used for put away recommendations.
762
404
  */
763
405
  'distanceFromLabelPrinter'?: number | null;
764
406
  }
765
- /**
766
- *
767
- * @export
768
- * @interface VariantAttribute
769
- */
770
407
  export interface VariantAttribute {
771
408
  /**
772
409
  * Attribute name
773
- * @type {string}
774
- * @memberof VariantAttribute
775
410
  */
776
411
  'name': string;
777
412
  /**
778
413
  * Attribute value
779
- * @type {string}
780
- * @memberof VariantAttribute
781
414
  */
782
415
  'value': string;
783
- /**
784
- *
785
- * @type {VariantAttributeThumbnail}
786
- * @memberof VariantAttribute
787
- */
788
416
  'thumbnail'?: VariantAttributeThumbnail;
789
417
  }
790
418
  /**
791
419
  * Attribute thumbnail
792
- * @export
793
- * @interface VariantAttributeThumbnail
794
420
  */
795
421
  export interface VariantAttributeThumbnail {
796
- /**
797
- *
798
- * @type {string}
799
- * @memberof VariantAttributeThumbnail
800
- */
801
422
  'type': VariantAttributeThumbnailTypeEnum;
802
- /**
803
- *
804
- * @type {string}
805
- * @memberof VariantAttributeThumbnail
806
- */
807
423
  'value': string;
808
424
  }
809
425
 
@@ -818,10 +434,57 @@ export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnail
818
434
 
819
435
  /**
820
436
  * PickfacesApi - axios parameter creator
821
- * @export
822
437
  */
823
438
  export const PickfacesApiAxiosParamCreator = function (configuration?: Configuration) {
824
439
  return {
440
+ /**
441
+ * Mark stock as checked in a pickface
442
+ * @summary Mark stock as checked
443
+ * @param {string} project The project ID
444
+ * @param {string} pickfaceId Unique identifier of a pickface
445
+ * @param {*} [options] Override http request option.
446
+ * @throws {RequiredError}
447
+ */
448
+ checkedStock: async (project: string, pickfaceId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
449
+ // verify required parameter 'project' is not null or undefined
450
+ assertParamExists('checkedStock', 'project', project)
451
+ // verify required parameter 'pickfaceId' is not null or undefined
452
+ assertParamExists('checkedStock', 'pickfaceId', pickfaceId)
453
+ const localVarPath = `/v1/pickfaces/{pickfaceId}/stock/checked`
454
+ .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
455
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
456
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
457
+ let baseOptions;
458
+ if (configuration) {
459
+ baseOptions = configuration.baseOptions;
460
+ }
461
+
462
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
463
+ const localVarHeaderParameter = {} as any;
464
+ const localVarQueryParameter = {} as any;
465
+
466
+ // authentication session-oauth required
467
+ // oauth required
468
+ await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
469
+
470
+ // authentication api-key required
471
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
472
+
473
+ if (project !== undefined) {
474
+ localVarQueryParameter['project'] = project;
475
+ }
476
+
477
+
478
+
479
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
480
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
481
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
482
+
483
+ return {
484
+ url: toPathString(localVarUrlObj),
485
+ options: localVarRequestOptions,
486
+ };
487
+ },
825
488
  /**
826
489
  * Create a Pickface
827
490
  * @summary Create Pickface
@@ -1705,11 +1368,24 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1705
1368
 
1706
1369
  /**
1707
1370
  * PickfacesApi - functional programming interface
1708
- * @export
1709
1371
  */
1710
1372
  export const PickfacesApiFp = function(configuration?: Configuration) {
1711
1373
  const localVarAxiosParamCreator = PickfacesApiAxiosParamCreator(configuration)
1712
1374
  return {
1375
+ /**
1376
+ * Mark stock as checked in a pickface
1377
+ * @summary Mark stock as checked
1378
+ * @param {string} project The project ID
1379
+ * @param {string} pickfaceId Unique identifier of a pickface
1380
+ * @param {*} [options] Override http request option.
1381
+ * @throws {RequiredError}
1382
+ */
1383
+ async checkedStock(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
1384
+ const localVarAxiosArgs = await localVarAxiosParamCreator.checkedStock(project, pickfaceId, options);
1385
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1386
+ const localVarOperationServerBasePath = operationServerMap['PickfacesApi.checkedStock']?.[localVarOperationServerIndex]?.url;
1387
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1388
+ },
1713
1389
  /**
1714
1390
  * Create a Pickface
1715
1391
  * @summary Create Pickface
@@ -1838,7 +1514,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1838
1514
  * @param {*} [options] Override http request option.
1839
1515
  * @throws {RequiredError}
1840
1516
  */
1841
- async listPickfaces(project: string, search?: string, pageToken?: number, pageSize?: number, sortBy?: Array<ListPickfacesSortByEnum>, updatedStart?: string, updatedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>> {
1517
+ async listPickfaces(project: string, search?: string, pageToken?: number, pageSize?: number, sortBy?: Array<ListPickfacesSortByEnum>, updatedStart?: string, updatedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>> {
1842
1518
  const localVarAxiosArgs = await localVarAxiosParamCreator.listPickfaces(project, search, pageToken, pageSize, sortBy, updatedStart, updatedEnd, options);
1843
1519
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1844
1520
  const localVarOperationServerBasePath = operationServerMap['PickfacesApi.listPickfaces']?.[localVarOperationServerIndex]?.url;
@@ -1916,7 +1592,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1916
1592
  * @param {*} [options] Override http request option.
1917
1593
  * @throws {RequiredError}
1918
1594
  */
1919
- async suggestPickfaces(project: string, variantRef: string, quantity: number, sellThroughRate?: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>> {
1595
+ async suggestPickfaces(project: string, variantRef: string, quantity: number, sellThroughRate?: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>> {
1920
1596
  const localVarAxiosArgs = await localVarAxiosParamCreator.suggestPickfaces(project, variantRef, quantity, sellThroughRate, pageToken, pageSize, options);
1921
1597
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1922
1598
  const localVarOperationServerBasePath = operationServerMap['PickfacesApi.suggestPickfaces']?.[localVarOperationServerIndex]?.url;
@@ -1945,7 +1621,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1945
1621
  * @param {*} [options] Override http request option.
1946
1622
  * @throws {RequiredError}
1947
1623
  */
1948
- async updatePickfaces(project: string, updatePickfacesRequest: UpdatePickfacesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>> {
1624
+ async updatePickfaces(project: string, updatePickfacesRequest: UpdatePickfacesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>> {
1949
1625
  const localVarAxiosArgs = await localVarAxiosParamCreator.updatePickfaces(project, updatePickfacesRequest, options);
1950
1626
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1951
1627
  const localVarOperationServerBasePath = operationServerMap['PickfacesApi.updatePickfaces']?.[localVarOperationServerIndex]?.url;
@@ -1956,11 +1632,20 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1956
1632
 
1957
1633
  /**
1958
1634
  * PickfacesApi - factory interface
1959
- * @export
1960
1635
  */
1961
1636
  export const PickfacesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1962
1637
  const localVarFp = PickfacesApiFp(configuration)
1963
1638
  return {
1639
+ /**
1640
+ * Mark stock as checked in a pickface
1641
+ * @summary Mark stock as checked
1642
+ * @param {PickfacesApiCheckedStockRequest} requestParameters Request parameters.
1643
+ * @param {*} [options] Override http request option.
1644
+ * @throws {RequiredError}
1645
+ */
1646
+ checkedStock(requestParameters: PickfacesApiCheckedStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1647
+ return localVarFp.checkedStock(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(axios, basePath));
1648
+ },
1964
1649
  /**
1965
1650
  * Create a Pickface
1966
1651
  * @summary Create Pickface
@@ -2048,7 +1733,7 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
2048
1733
  * @param {*} [options] Override http request option.
2049
1734
  * @throws {RequiredError}
2050
1735
  */
2051
- listPickfaces(requestParameters: PickfacesApiListPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject> {
1736
+ listPickfaces(requestParameters: PickfacesApiListPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaces200Response> {
2052
1737
  return localVarFp.listPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, requestParameters.updatedStart, requestParameters.updatedEnd, options).then((request) => request(axios, basePath));
2053
1738
  },
2054
1739
  /**
@@ -2098,7 +1783,7 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
2098
1783
  * @param {*} [options] Override http request option.
2099
1784
  * @throws {RequiredError}
2100
1785
  */
2101
- suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject> {
1786
+ suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaces200Response> {
2102
1787
  return localVarFp.suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.sellThroughRate, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
2103
1788
  },
2104
1789
  /**
@@ -2118,481 +1803,373 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
2118
1803
  * @param {*} [options] Override http request option.
2119
1804
  * @throws {RequiredError}
2120
1805
  */
2121
- updatePickfaces(requestParameters: PickfacesApiUpdatePickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject> {
1806
+ updatePickfaces(requestParameters: PickfacesApiUpdatePickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaces200Response> {
2122
1807
  return localVarFp.updatePickfaces(requestParameters.project, requestParameters.updatePickfacesRequest, options).then((request) => request(axios, basePath));
2123
1808
  },
2124
1809
  };
2125
1810
  };
2126
1811
 
1812
+ /**
1813
+ * Request parameters for checkedStock operation in PickfacesApi.
1814
+ */
1815
+ export interface PickfacesApiCheckedStockRequest {
1816
+ /**
1817
+ * The project ID
1818
+ */
1819
+ readonly project: string
1820
+
1821
+ /**
1822
+ * Unique identifier of a pickface
1823
+ */
1824
+ readonly pickfaceId: string
1825
+ }
1826
+
2127
1827
  /**
2128
1828
  * Request parameters for createPickface operation in PickfacesApi.
2129
- * @export
2130
- * @interface PickfacesApiCreatePickfaceRequest
2131
1829
  */
2132
1830
  export interface PickfacesApiCreatePickfaceRequest {
2133
1831
  /**
2134
1832
  * The project ID
2135
- * @type {string}
2136
- * @memberof PickfacesApiCreatePickface
2137
1833
  */
2138
1834
  readonly project: string
2139
1835
 
2140
1836
  /**
2141
1837
  * Create pickface schema
2142
- * @type {CreatePickfaceRequest}
2143
- * @memberof PickfacesApiCreatePickface
2144
1838
  */
2145
1839
  readonly createPickfaceRequest: CreatePickfaceRequest
2146
1840
  }
2147
1841
 
2148
1842
  /**
2149
1843
  * Request parameters for deletePickface operation in PickfacesApi.
2150
- * @export
2151
- * @interface PickfacesApiDeletePickfaceRequest
2152
1844
  */
2153
1845
  export interface PickfacesApiDeletePickfaceRequest {
2154
1846
  /**
2155
1847
  * The project ID
2156
- * @type {string}
2157
- * @memberof PickfacesApiDeletePickface
2158
1848
  */
2159
1849
  readonly project: string
2160
1850
 
2161
1851
  /**
2162
1852
  * Unique identifier of a pickface
2163
- * @type {string}
2164
- * @memberof PickfacesApiDeletePickface
2165
1853
  */
2166
1854
  readonly pickfaceId: string
2167
1855
  }
2168
1856
 
2169
1857
  /**
2170
1858
  * Request parameters for exportPickfaces operation in PickfacesApi.
2171
- * @export
2172
- * @interface PickfacesApiExportPickfacesRequest
2173
1859
  */
2174
1860
  export interface PickfacesApiExportPickfacesRequest {
2175
1861
  /**
2176
1862
  * The project ID
2177
- * @type {string}
2178
- * @memberof PickfacesApiExportPickfaces
2179
1863
  */
2180
1864
  readonly project: string
2181
1865
 
2182
1866
  /**
2183
1867
  * Search term to filter based on pickface code
2184
- * @type {string}
2185
- * @memberof PickfacesApiExportPickfaces
2186
1868
  */
2187
1869
  readonly search?: string
2188
1870
  }
2189
1871
 
2190
1872
  /**
2191
1873
  * Request parameters for getPickface operation in PickfacesApi.
2192
- * @export
2193
- * @interface PickfacesApiGetPickfaceRequest
2194
1874
  */
2195
1875
  export interface PickfacesApiGetPickfaceRequest {
2196
1876
  /**
2197
1877
  * The project ID
2198
- * @type {string}
2199
- * @memberof PickfacesApiGetPickface
2200
1878
  */
2201
1879
  readonly project: string
2202
1880
 
2203
1881
  /**
2204
1882
  * Unique identifier of a pickface
2205
- * @type {string}
2206
- * @memberof PickfacesApiGetPickface
2207
1883
  */
2208
1884
  readonly pickfaceId: string
2209
1885
  }
2210
1886
 
2211
1887
  /**
2212
1888
  * Request parameters for issueEmptyPickface operation in PickfacesApi.
2213
- * @export
2214
- * @interface PickfacesApiIssueEmptyPickfaceRequest
2215
1889
  */
2216
1890
  export interface PickfacesApiIssueEmptyPickfaceRequest {
2217
1891
  /**
2218
1892
  * The project ID
2219
- * @type {string}
2220
- * @memberof PickfacesApiIssueEmptyPickface
2221
1893
  */
2222
1894
  readonly project: string
2223
1895
 
2224
1896
  /**
2225
1897
  * Unique identifier of a pickface
2226
- * @type {string}
2227
- * @memberof PickfacesApiIssueEmptyPickface
2228
1898
  */
2229
1899
  readonly pickfaceId: string
2230
1900
 
2231
1901
  /**
2232
1902
  * pickface issue schema
2233
- * @type {IssueEmptyPickfaceRequest}
2234
- * @memberof PickfacesApiIssueEmptyPickface
2235
1903
  */
2236
1904
  readonly issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest
2237
1905
  }
2238
1906
 
2239
1907
  /**
2240
1908
  * Request parameters for issueWrongContentsPickface operation in PickfacesApi.
2241
- * @export
2242
- * @interface PickfacesApiIssueWrongContentsPickfaceRequest
2243
1909
  */
2244
1910
  export interface PickfacesApiIssueWrongContentsPickfaceRequest {
2245
1911
  /**
2246
1912
  * The project ID
2247
- * @type {string}
2248
- * @memberof PickfacesApiIssueWrongContentsPickface
2249
1913
  */
2250
1914
  readonly project: string
2251
1915
 
2252
1916
  /**
2253
1917
  * Unique identifier of a pickface
2254
- * @type {string}
2255
- * @memberof PickfacesApiIssueWrongContentsPickface
2256
1918
  */
2257
1919
  readonly pickfaceId: string
2258
1920
 
2259
1921
  /**
2260
1922
  * pickface issue schema
2261
- * @type {IssueWrongContentsPickfaceRequest}
2262
- * @memberof PickfacesApiIssueWrongContentsPickface
2263
1923
  */
2264
1924
  readonly issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest
2265
1925
  }
2266
1926
 
2267
1927
  /**
2268
1928
  * Request parameters for listPickfaceContainerTypes operation in PickfacesApi.
2269
- * @export
2270
- * @interface PickfacesApiListPickfaceContainerTypesRequest
2271
1929
  */
2272
1930
  export interface PickfacesApiListPickfaceContainerTypesRequest {
2273
1931
  /**
2274
1932
  * The project ID
2275
- * @type {string}
2276
- * @memberof PickfacesApiListPickfaceContainerTypes
2277
1933
  */
2278
1934
  readonly project: string
2279
1935
  }
2280
1936
 
2281
1937
  /**
2282
1938
  * Request parameters for listPickfaceLogs operation in PickfacesApi.
2283
- * @export
2284
- * @interface PickfacesApiListPickfaceLogsRequest
2285
1939
  */
2286
1940
  export interface PickfacesApiListPickfaceLogsRequest {
2287
1941
  /**
2288
1942
  * The project ID
2289
- * @type {string}
2290
- * @memberof PickfacesApiListPickfaceLogs
2291
1943
  */
2292
1944
  readonly project: string
2293
1945
 
2294
1946
  /**
2295
1947
  * Unique identifier of a pickface
2296
- * @type {string}
2297
- * @memberof PickfacesApiListPickfaceLogs
2298
1948
  */
2299
1949
  readonly pickfaceId: string
2300
1950
 
2301
1951
  /**
2302
1952
  * Page reference token
2303
- * @type {number}
2304
- * @memberof PickfacesApiListPickfaceLogs
2305
1953
  */
2306
1954
  readonly pageToken?: number
2307
1955
 
2308
1956
  /**
2309
1957
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2310
- * @type {number}
2311
- * @memberof PickfacesApiListPickfaceLogs
2312
1958
  */
2313
1959
  readonly pageSize?: number
2314
1960
  }
2315
1961
 
2316
1962
  /**
2317
1963
  * Request parameters for listPickfaces operation in PickfacesApi.
2318
- * @export
2319
- * @interface PickfacesApiListPickfacesRequest
2320
1964
  */
2321
1965
  export interface PickfacesApiListPickfacesRequest {
2322
1966
  /**
2323
1967
  * The project ID
2324
- * @type {string}
2325
- * @memberof PickfacesApiListPickfaces
2326
1968
  */
2327
1969
  readonly project: string
2328
1970
 
2329
1971
  /**
2330
1972
  * Search term to filter based on pickface code
2331
- * @type {string}
2332
- * @memberof PickfacesApiListPickfaces
2333
1973
  */
2334
1974
  readonly search?: string
2335
1975
 
2336
1976
  /**
2337
1977
  * Page reference token
2338
- * @type {number}
2339
- * @memberof PickfacesApiListPickfaces
2340
1978
  */
2341
1979
  readonly pageToken?: number
2342
1980
 
2343
1981
  /**
2344
1982
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2345
- * @type {number}
2346
- * @memberof PickfacesApiListPickfaces
2347
1983
  */
2348
1984
  readonly pageSize?: number
2349
1985
 
2350
1986
  /**
2351
1987
  * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2352
- * @type {Array<'+available' | '-available' | '+wip' | '-wip' | '+total' | '-total' | '+fullness' | '-fullness' | '+restocked' | '-restocked' | '+picked' | '-picked'>}
2353
- * @memberof PickfacesApiListPickfaces
2354
1988
  */
2355
1989
  readonly sortBy?: Array<ListPickfacesSortByEnum>
2356
1990
 
2357
1991
  /**
2358
1992
  * Start of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string
2359
- * @type {string}
2360
- * @memberof PickfacesApiListPickfaces
2361
1993
  */
2362
1994
  readonly updatedStart?: string
2363
1995
 
2364
1996
  /**
2365
1997
  * End of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string
2366
- * @type {string}
2367
- * @memberof PickfacesApiListPickfaces
2368
1998
  */
2369
1999
  readonly updatedEnd?: string
2370
2000
  }
2371
2001
 
2372
2002
  /**
2373
2003
  * Request parameters for moveStock operation in PickfacesApi.
2374
- * @export
2375
- * @interface PickfacesApiMoveStockRequest
2376
2004
  */
2377
2005
  export interface PickfacesApiMoveStockRequest {
2378
2006
  /**
2379
2007
  * The project ID
2380
- * @type {string}
2381
- * @memberof PickfacesApiMoveStock
2382
2008
  */
2383
2009
  readonly project: string
2384
2010
 
2385
2011
  /**
2386
2012
  * Unique identifier of a pickface
2387
- * @type {string}
2388
- * @memberof PickfacesApiMoveStock
2389
2013
  */
2390
2014
  readonly pickfaceId: string
2391
2015
 
2392
2016
  /**
2393
2017
  * Move stock from one pickface to another
2394
- * @type {MoveStockRequest}
2395
- * @memberof PickfacesApiMoveStock
2396
2018
  */
2397
2019
  readonly moveStockRequest: MoveStockRequest
2398
2020
  }
2399
2021
 
2400
2022
  /**
2401
2023
  * Request parameters for printPickfaceLabel operation in PickfacesApi.
2402
- * @export
2403
- * @interface PickfacesApiPrintPickfaceLabelRequest
2404
2024
  */
2405
2025
  export interface PickfacesApiPrintPickfaceLabelRequest {
2406
2026
  /**
2407
2027
  * The project ID
2408
- * @type {string}
2409
- * @memberof PickfacesApiPrintPickfaceLabel
2410
2028
  */
2411
2029
  readonly project: string
2412
2030
 
2413
2031
  /**
2414
2032
  * Unique identifier of a pickface
2415
- * @type {string}
2416
- * @memberof PickfacesApiPrintPickfaceLabel
2417
2033
  */
2418
2034
  readonly pickfaceId: string
2419
2035
 
2420
2036
  /**
2421
2037
  * Unique identifier of a warehouse device
2422
- * @type {string}
2423
- * @memberof PickfacesApiPrintPickfaceLabel
2424
2038
  */
2425
2039
  readonly deviceRef: string
2426
2040
  }
2427
2041
 
2428
2042
  /**
2429
2043
  * Request parameters for printPickfaceLabels operation in PickfacesApi.
2430
- * @export
2431
- * @interface PickfacesApiPrintPickfaceLabelsRequest
2432
2044
  */
2433
2045
  export interface PickfacesApiPrintPickfaceLabelsRequest {
2434
2046
  /**
2435
2047
  * The project ID
2436
- * @type {string}
2437
- * @memberof PickfacesApiPrintPickfaceLabels
2438
2048
  */
2439
2049
  readonly project: string
2440
2050
 
2441
2051
  /**
2442
2052
  * Unique identifier of a warehouse device
2443
- * @type {string}
2444
- * @memberof PickfacesApiPrintPickfaceLabels
2445
2053
  */
2446
2054
  readonly deviceRef: string
2447
2055
 
2448
2056
  /**
2449
2057
  * Search term to filter based on pickface code
2450
- * @type {string}
2451
- * @memberof PickfacesApiPrintPickfaceLabels
2452
2058
  */
2453
2059
  readonly search?: string
2454
2060
 
2455
2061
  /**
2456
2062
  * List of pickface ids
2457
- * @type {Array<string>}
2458
- * @memberof PickfacesApiPrintPickfaceLabels
2459
2063
  */
2460
2064
  readonly ids?: Array<string> | null
2461
2065
  }
2462
2066
 
2463
2067
  /**
2464
2068
  * Request parameters for resolvePickfaceIssue operation in PickfacesApi.
2465
- * @export
2466
- * @interface PickfacesApiResolvePickfaceIssueRequest
2467
2069
  */
2468
2070
  export interface PickfacesApiResolvePickfaceIssueRequest {
2469
2071
  /**
2470
2072
  * The project ID
2471
- * @type {string}
2472
- * @memberof PickfacesApiResolvePickfaceIssue
2473
2073
  */
2474
2074
  readonly project: string
2475
2075
 
2476
2076
  /**
2477
2077
  * Unique identifier of a pickface
2478
- * @type {string}
2479
- * @memberof PickfacesApiResolvePickfaceIssue
2480
2078
  */
2481
2079
  readonly pickfaceId: string
2482
2080
  }
2483
2081
 
2484
2082
  /**
2485
2083
  * Request parameters for suggestPickfaces operation in PickfacesApi.
2486
- * @export
2487
- * @interface PickfacesApiSuggestPickfacesRequest
2488
2084
  */
2489
2085
  export interface PickfacesApiSuggestPickfacesRequest {
2490
2086
  /**
2491
2087
  * The project ID
2492
- * @type {string}
2493
- * @memberof PickfacesApiSuggestPickfaces
2494
2088
  */
2495
2089
  readonly project: string
2496
2090
 
2497
2091
  /**
2498
2092
  * Unique identifier of a warehouse variant
2499
- * @type {string}
2500
- * @memberof PickfacesApiSuggestPickfaces
2501
2093
  */
2502
2094
  readonly variantRef: string
2503
2095
 
2504
2096
  /**
2505
2097
  * Number of variants
2506
- * @type {number}
2507
- * @memberof PickfacesApiSuggestPickfaces
2508
2098
  */
2509
2099
  readonly quantity: number
2510
2100
 
2511
2101
  /**
2512
2102
  * The sell through rate of the variant to use when suggesting pickfaces
2513
- * @type {number}
2514
- * @memberof PickfacesApiSuggestPickfaces
2515
2103
  */
2516
2104
  readonly sellThroughRate?: number
2517
2105
 
2518
2106
  /**
2519
2107
  * Page reference token
2520
- * @type {number}
2521
- * @memberof PickfacesApiSuggestPickfaces
2522
2108
  */
2523
2109
  readonly pageToken?: number
2524
2110
 
2525
2111
  /**
2526
2112
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2527
- * @type {number}
2528
- * @memberof PickfacesApiSuggestPickfaces
2529
2113
  */
2530
2114
  readonly pageSize?: number
2531
2115
  }
2532
2116
 
2533
2117
  /**
2534
2118
  * Request parameters for updatePickface operation in PickfacesApi.
2535
- * @export
2536
- * @interface PickfacesApiUpdatePickfaceRequest
2537
2119
  */
2538
2120
  export interface PickfacesApiUpdatePickfaceRequest {
2539
2121
  /**
2540
2122
  * The project ID
2541
- * @type {string}
2542
- * @memberof PickfacesApiUpdatePickface
2543
2123
  */
2544
2124
  readonly project: string
2545
2125
 
2546
2126
  /**
2547
2127
  * Unique identifier of a pickface
2548
- * @type {string}
2549
- * @memberof PickfacesApiUpdatePickface
2550
2128
  */
2551
2129
  readonly pickfaceId: string
2552
2130
 
2553
2131
  /**
2554
2132
  * Update pickface schema
2555
- * @type {UpdatePickfaceRequest}
2556
- * @memberof PickfacesApiUpdatePickface
2557
2133
  */
2558
2134
  readonly updatePickfaceRequest: UpdatePickfaceRequest
2559
2135
  }
2560
2136
 
2561
2137
  /**
2562
2138
  * Request parameters for updatePickfaces operation in PickfacesApi.
2563
- * @export
2564
- * @interface PickfacesApiUpdatePickfacesRequest
2565
2139
  */
2566
2140
  export interface PickfacesApiUpdatePickfacesRequest {
2567
2141
  /**
2568
2142
  * The project ID
2569
- * @type {string}
2570
- * @memberof PickfacesApiUpdatePickfaces
2571
2143
  */
2572
2144
  readonly project: string
2573
2145
 
2574
2146
  /**
2575
2147
  * Update pickfaces in bulk schema
2576
- * @type {UpdatePickfacesRequest}
2577
- * @memberof PickfacesApiUpdatePickfaces
2578
2148
  */
2579
2149
  readonly updatePickfacesRequest: UpdatePickfacesRequest
2580
2150
  }
2581
2151
 
2582
2152
  /**
2583
2153
  * PickfacesApi - object-oriented interface
2584
- * @export
2585
- * @class PickfacesApi
2586
- * @extends {BaseAPI}
2587
2154
  */
2588
2155
  export class PickfacesApi extends BaseAPI {
2156
+ /**
2157
+ * Mark stock as checked in a pickface
2158
+ * @summary Mark stock as checked
2159
+ * @param {PickfacesApiCheckedStockRequest} requestParameters Request parameters.
2160
+ * @param {*} [options] Override http request option.
2161
+ * @throws {RequiredError}
2162
+ */
2163
+ public checkedStock(requestParameters: PickfacesApiCheckedStockRequest, options?: RawAxiosRequestConfig) {
2164
+ return PickfacesApiFp(this.configuration).checkedStock(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
2165
+ }
2166
+
2589
2167
  /**
2590
2168
  * Create a Pickface
2591
2169
  * @summary Create Pickface
2592
2170
  * @param {PickfacesApiCreatePickfaceRequest} requestParameters Request parameters.
2593
2171
  * @param {*} [options] Override http request option.
2594
2172
  * @throws {RequiredError}
2595
- * @memberof PickfacesApi
2596
2173
  */
2597
2174
  public createPickface(requestParameters: PickfacesApiCreatePickfaceRequest, options?: RawAxiosRequestConfig) {
2598
2175
  return PickfacesApiFp(this.configuration).createPickface(requestParameters.project, requestParameters.createPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
@@ -2604,7 +2181,6 @@ export class PickfacesApi extends BaseAPI {
2604
2181
  * @param {PickfacesApiDeletePickfaceRequest} requestParameters Request parameters.
2605
2182
  * @param {*} [options] Override http request option.
2606
2183
  * @throws {RequiredError}
2607
- * @memberof PickfacesApi
2608
2184
  */
2609
2185
  public deletePickface(requestParameters: PickfacesApiDeletePickfaceRequest, options?: RawAxiosRequestConfig) {
2610
2186
  return PickfacesApiFp(this.configuration).deletePickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
@@ -2616,7 +2192,6 @@ export class PickfacesApi extends BaseAPI {
2616
2192
  * @param {PickfacesApiExportPickfacesRequest} requestParameters Request parameters.
2617
2193
  * @param {*} [options] Override http request option.
2618
2194
  * @throws {RequiredError}
2619
- * @memberof PickfacesApi
2620
2195
  */
2621
2196
  public exportPickfaces(requestParameters: PickfacesApiExportPickfacesRequest, options?: RawAxiosRequestConfig) {
2622
2197
  return PickfacesApiFp(this.configuration).exportPickfaces(requestParameters.project, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
@@ -2628,7 +2203,6 @@ export class PickfacesApi extends BaseAPI {
2628
2203
  * @param {PickfacesApiGetPickfaceRequest} requestParameters Request parameters.
2629
2204
  * @param {*} [options] Override http request option.
2630
2205
  * @throws {RequiredError}
2631
- * @memberof PickfacesApi
2632
2206
  */
2633
2207
  public getPickface(requestParameters: PickfacesApiGetPickfaceRequest, options?: RawAxiosRequestConfig) {
2634
2208
  return PickfacesApiFp(this.configuration).getPickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
@@ -2640,7 +2214,6 @@ export class PickfacesApi extends BaseAPI {
2640
2214
  * @param {PickfacesApiIssueEmptyPickfaceRequest} requestParameters Request parameters.
2641
2215
  * @param {*} [options] Override http request option.
2642
2216
  * @throws {RequiredError}
2643
- * @memberof PickfacesApi
2644
2217
  */
2645
2218
  public issueEmptyPickface(requestParameters: PickfacesApiIssueEmptyPickfaceRequest, options?: RawAxiosRequestConfig) {
2646
2219
  return PickfacesApiFp(this.configuration).issueEmptyPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueEmptyPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
@@ -2652,7 +2225,6 @@ export class PickfacesApi extends BaseAPI {
2652
2225
  * @param {PickfacesApiIssueWrongContentsPickfaceRequest} requestParameters Request parameters.
2653
2226
  * @param {*} [options] Override http request option.
2654
2227
  * @throws {RequiredError}
2655
- * @memberof PickfacesApi
2656
2228
  */
2657
2229
  public issueWrongContentsPickface(requestParameters: PickfacesApiIssueWrongContentsPickfaceRequest, options?: RawAxiosRequestConfig) {
2658
2230
  return PickfacesApiFp(this.configuration).issueWrongContentsPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueWrongContentsPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
@@ -2664,7 +2236,6 @@ export class PickfacesApi extends BaseAPI {
2664
2236
  * @param {PickfacesApiListPickfaceContainerTypesRequest} requestParameters Request parameters.
2665
2237
  * @param {*} [options] Override http request option.
2666
2238
  * @throws {RequiredError}
2667
- * @memberof PickfacesApi
2668
2239
  */
2669
2240
  public listPickfaceContainerTypes(requestParameters: PickfacesApiListPickfaceContainerTypesRequest, options?: RawAxiosRequestConfig) {
2670
2241
  return PickfacesApiFp(this.configuration).listPickfaceContainerTypes(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
@@ -2676,7 +2247,6 @@ export class PickfacesApi extends BaseAPI {
2676
2247
  * @param {PickfacesApiListPickfaceLogsRequest} requestParameters Request parameters.
2677
2248
  * @param {*} [options] Override http request option.
2678
2249
  * @throws {RequiredError}
2679
- * @memberof PickfacesApi
2680
2250
  */
2681
2251
  public listPickfaceLogs(requestParameters: PickfacesApiListPickfaceLogsRequest, options?: RawAxiosRequestConfig) {
2682
2252
  return PickfacesApiFp(this.configuration).listPickfaceLogs(requestParameters.project, requestParameters.pickfaceId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
@@ -2688,7 +2258,6 @@ export class PickfacesApi extends BaseAPI {
2688
2258
  * @param {PickfacesApiListPickfacesRequest} requestParameters Request parameters.
2689
2259
  * @param {*} [options] Override http request option.
2690
2260
  * @throws {RequiredError}
2691
- * @memberof PickfacesApi
2692
2261
  */
2693
2262
  public listPickfaces(requestParameters: PickfacesApiListPickfacesRequest, options?: RawAxiosRequestConfig) {
2694
2263
  return PickfacesApiFp(this.configuration).listPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, requestParameters.updatedStart, requestParameters.updatedEnd, options).then((request) => request(this.axios, this.basePath));
@@ -2700,7 +2269,6 @@ export class PickfacesApi extends BaseAPI {
2700
2269
  * @param {PickfacesApiMoveStockRequest} requestParameters Request parameters.
2701
2270
  * @param {*} [options] Override http request option.
2702
2271
  * @throws {RequiredError}
2703
- * @memberof PickfacesApi
2704
2272
  */
2705
2273
  public moveStock(requestParameters: PickfacesApiMoveStockRequest, options?: RawAxiosRequestConfig) {
2706
2274
  return PickfacesApiFp(this.configuration).moveStock(requestParameters.project, requestParameters.pickfaceId, requestParameters.moveStockRequest, options).then((request) => request(this.axios, this.basePath));
@@ -2712,7 +2280,6 @@ export class PickfacesApi extends BaseAPI {
2712
2280
  * @param {PickfacesApiPrintPickfaceLabelRequest} requestParameters Request parameters.
2713
2281
  * @param {*} [options] Override http request option.
2714
2282
  * @throws {RequiredError}
2715
- * @memberof PickfacesApi
2716
2283
  */
2717
2284
  public printPickfaceLabel(requestParameters: PickfacesApiPrintPickfaceLabelRequest, options?: RawAxiosRequestConfig) {
2718
2285
  return PickfacesApiFp(this.configuration).printPickfaceLabel(requestParameters.project, requestParameters.pickfaceId, requestParameters.deviceRef, options).then((request) => request(this.axios, this.basePath));
@@ -2724,7 +2291,6 @@ export class PickfacesApi extends BaseAPI {
2724
2291
  * @param {PickfacesApiPrintPickfaceLabelsRequest} requestParameters Request parameters.
2725
2292
  * @param {*} [options] Override http request option.
2726
2293
  * @throws {RequiredError}
2727
- * @memberof PickfacesApi
2728
2294
  */
2729
2295
  public printPickfaceLabels(requestParameters: PickfacesApiPrintPickfaceLabelsRequest, options?: RawAxiosRequestConfig) {
2730
2296
  return PickfacesApiFp(this.configuration).printPickfaceLabels(requestParameters.project, requestParameters.deviceRef, requestParameters.search, requestParameters.ids, options).then((request) => request(this.axios, this.basePath));
@@ -2736,7 +2302,6 @@ export class PickfacesApi extends BaseAPI {
2736
2302
  * @param {PickfacesApiResolvePickfaceIssueRequest} requestParameters Request parameters.
2737
2303
  * @param {*} [options] Override http request option.
2738
2304
  * @throws {RequiredError}
2739
- * @memberof PickfacesApi
2740
2305
  */
2741
2306
  public resolvePickfaceIssue(requestParameters: PickfacesApiResolvePickfaceIssueRequest, options?: RawAxiosRequestConfig) {
2742
2307
  return PickfacesApiFp(this.configuration).resolvePickfaceIssue(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
@@ -2748,7 +2313,6 @@ export class PickfacesApi extends BaseAPI {
2748
2313
  * @param {PickfacesApiSuggestPickfacesRequest} requestParameters Request parameters.
2749
2314
  * @param {*} [options] Override http request option.
2750
2315
  * @throws {RequiredError}
2751
- * @memberof PickfacesApi
2752
2316
  */
2753
2317
  public suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig) {
2754
2318
  return PickfacesApiFp(this.configuration).suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.sellThroughRate, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
@@ -2760,7 +2324,6 @@ export class PickfacesApi extends BaseAPI {
2760
2324
  * @param {PickfacesApiUpdatePickfaceRequest} requestParameters Request parameters.
2761
2325
  * @param {*} [options] Override http request option.
2762
2326
  * @throws {RequiredError}
2763
- * @memberof PickfacesApi
2764
2327
  */
2765
2328
  public updatePickface(requestParameters: PickfacesApiUpdatePickfaceRequest, options?: RawAxiosRequestConfig) {
2766
2329
  return PickfacesApiFp(this.configuration).updatePickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.updatePickfaceRequest, options).then((request) => request(this.axios, this.basePath));
@@ -2772,16 +2335,12 @@ export class PickfacesApi extends BaseAPI {
2772
2335
  * @param {PickfacesApiUpdatePickfacesRequest} requestParameters Request parameters.
2773
2336
  * @param {*} [options] Override http request option.
2774
2337
  * @throws {RequiredError}
2775
- * @memberof PickfacesApi
2776
2338
  */
2777
2339
  public updatePickfaces(requestParameters: PickfacesApiUpdatePickfacesRequest, options?: RawAxiosRequestConfig) {
2778
2340
  return PickfacesApiFp(this.configuration).updatePickfaces(requestParameters.project, requestParameters.updatePickfacesRequest, options).then((request) => request(this.axios, this.basePath));
2779
2341
  }
2780
2342
  }
2781
2343
 
2782
- /**
2783
- * @export
2784
- */
2785
2344
  export const ListPickfacesSortByEnum = {
2786
2345
  Available: '+available',
2787
2346
  Available2: '-available',