@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/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.30.0
5
+ * The version of the OpenAPI document: 0.31.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,650 +13,331 @@ 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
- *
18
- * @export
19
- * @interface ApiError
20
- */
21
16
  export interface ApiError {
22
- /**
23
- *
24
- * @type {string}
25
- * @memberof ApiError
26
- */
27
17
  'code'?: string;
28
- /**
29
- *
30
- * @type {string}
31
- * @memberof ApiError
32
- */
33
18
  'message': string;
34
19
  }
35
20
  /**
36
21
  * The factory container the pickface is within
37
- * @export
38
- * @interface ContainerType
39
22
  */
40
23
  export interface ContainerType {
41
24
  /**
42
25
  * Unique object identifier
43
- * @type {string}
44
- * @memberof ContainerType
45
26
  */
46
27
  'id': string;
47
28
  /**
48
29
  * A reference to the resource location
49
- * @type {string}
50
- * @memberof ContainerType
51
30
  */
52
31
  'ref': string;
53
- /**
54
- *
55
- * @type {string}
56
- * @memberof ContainerType
57
- */
58
32
  'name': string;
59
33
  /**
60
34
  * The width of the container in millimetres
61
- * @type {number}
62
- * @memberof ContainerType
63
35
  */
64
36
  'width'?: number;
65
37
  /**
66
38
  * The depth of the container in millimetres
67
- * @type {number}
68
- * @memberof ContainerType
69
39
  */
70
40
  'depth'?: number;
71
41
  /**
72
42
  * The height of the container in millimetres
73
- * @type {number}
74
- * @memberof ContainerType
75
43
  */
76
44
  'height'?: number;
77
45
  }
78
- /**
79
- *
80
- * @export
81
- * @interface ContainerTypes
82
- */
83
46
  export interface ContainerTypes {
84
- /**
85
- *
86
- * @type {Array<ContainerType>}
87
- * @memberof ContainerTypes
88
- */
89
47
  'containerTypes'?: Array<ContainerType>;
90
48
  }
91
- /**
92
- *
93
- * @export
94
- * @interface CreatePickfaceRequest
95
- */
96
49
  export interface CreatePickfaceRequest {
97
50
  /**
98
51
  * A human readable location for the pickface i.e. \"1 Wf 49\"
99
- * @type {string}
100
- * @memberof CreatePickfaceRequest
101
52
  */
102
53
  'location': string;
103
54
  /**
104
55
  * A user defined name for the pickface, if this is not provided the location will be used as the name.
105
- * @type {string}
106
- * @memberof CreatePickfaceRequest
107
56
  */
108
57
  'name'?: string | null;
109
58
  /**
110
59
  * Use \'Pickfaces API\' > \'List pickface container types\' to get a list of available options.
111
- * @type {string}
112
- * @memberof CreatePickfaceRequest
113
60
  */
114
61
  'containerTypeId': string;
115
62
  /**
116
63
  * Whether the pickface is used for bulk storage
117
- * @type {boolean}
118
- * @memberof CreatePickfaceRequest
119
64
  */
120
65
  'bulk'?: boolean;
121
66
  /**
122
67
  * Whether the pickface can contain mixed contents.
123
- * @type {boolean}
124
- * @memberof CreatePickfaceRequest
125
68
  */
126
69
  'mixedContents'?: boolean;
127
70
  /**
128
71
  * Typically this field is left empty. Use \'Zones API\' > \'List warehouse zones\' to get a list of available options.
129
- * @type {string}
130
- * @memberof CreatePickfaceRequest
131
72
  */
132
73
  'zoneId'?: string;
133
74
  /**
134
- * The distance from the nearest label printer to the pickface in meters. This is used for put away recommendations.
135
- * @type {number}
136
- * @memberof CreatePickfaceRequest
75
+ * The distance from the nearest label printer to the pickface in centimeters. This is used for put away recommendations.
137
76
  */
138
77
  'distanceFromLabelPrinter'?: number | null;
139
78
  }
140
- /**
141
- *
142
- * @export
143
- * @interface ExportPickfaces202Response
144
- */
145
79
  export interface ExportPickfaces202Response {
146
80
  /**
147
81
  * A message describing the export status
148
- * @type {string}
149
- * @memberof ExportPickfaces202Response
150
82
  */
151
83
  'message'?: string;
152
84
  }
153
- /**
154
- *
155
- * @export
156
- * @interface InlineObject
157
- */
158
- export interface InlineObject {
159
- /**
160
- *
161
- * @type {Array<Pickface>}
162
- * @memberof InlineObject
163
- */
164
- 'pickfaces'?: Array<Pickface>;
165
- /**
166
- * The token referencing the next page number
167
- * @type {number}
168
- * @memberof InlineObject
169
- */
170
- 'nextPageToken'?: number | null;
171
- }
172
- /**
173
- *
174
- * @export
175
- * @interface IssueEmptyPickfaceRequest
176
- */
177
85
  export interface IssueEmptyPickfaceRequest {
178
86
  /**
179
87
  * A reference to the resource location
180
- * @type {string}
181
- * @memberof IssueEmptyPickfaceRequest
182
88
  */
183
89
  'issueRef'?: string;
184
90
  }
185
- /**
186
- *
187
- * @export
188
- * @interface IssueWrongContentsPickfaceRequest
189
- */
190
91
  export interface IssueWrongContentsPickfaceRequest {
191
92
  /**
192
93
  * A reference to the resource location
193
- * @type {string}
194
- * @memberof IssueWrongContentsPickfaceRequest
195
94
  */
196
95
  'issueRef'?: string;
197
96
  /**
198
97
  * A reference to the resource location
199
- * @type {string}
200
- * @memberof IssueWrongContentsPickfaceRequest
201
98
  */
202
99
  'variantRef'?: string;
203
100
  }
204
- /**
205
- *
206
- * @export
207
- * @interface ListPickfaceLogs200Response
208
- */
209
101
  export interface ListPickfaceLogs200Response {
102
+ 'logs'?: Array<PickfaceLog>;
210
103
  /**
211
- *
212
- * @type {Array<PickfaceLog>}
213
- * @memberof ListPickfaceLogs200Response
104
+ * The token referencing the next page number
214
105
  */
215
- 'logs'?: Array<PickfaceLog>;
106
+ 'nextPageToken'?: number | null;
107
+ }
108
+ export interface ListPickfaces200Response {
109
+ 'pickfaces'?: Array<Pickface>;
216
110
  /**
217
111
  * The token referencing the next page number
218
- * @type {number}
219
- * @memberof ListPickfaceLogs200Response
220
112
  */
221
113
  'nextPageToken'?: number | null;
222
114
  }
223
- /**
224
- *
225
- * @export
226
- * @interface MoveStockRequest
227
- */
228
115
  export interface MoveStockRequest {
229
116
  /**
230
117
  * The variant to move from the pickface
231
- * @type {string}
232
- * @memberof MoveStockRequest
233
118
  */
234
119
  'variantRef': string;
235
120
  /**
236
121
  * The quantity to move from the pickface
237
- * @type {number}
238
- * @memberof MoveStockRequest
239
122
  */
240
123
  'quantity': number;
241
124
  /**
242
125
  * The pickface to move the stock to
243
- * @type {string}
244
- * @memberof MoveStockRequest
245
126
  */
246
127
  'toPickfaceRef': string;
247
128
  }
248
- /**
249
- *
250
- * @export
251
- * @interface Pickface
252
- */
253
129
  export interface Pickface {
254
130
  /**
255
131
  * Unique object identifier
256
- * @type {string}
257
- * @memberof Pickface
258
132
  */
259
133
  'id': string;
260
134
  /**
261
135
  * A reference to the resource location
262
- * @type {string}
263
- * @memberof Pickface
264
136
  */
265
137
  'ref': string;
266
138
  /**
267
139
  * The barcode of the pickface
268
- * @type {string}
269
- * @memberof Pickface
270
140
  */
271
141
  'barcode': string;
272
- /**
273
- *
274
- * @type {PickfaceZone}
275
- * @memberof Pickface
276
- */
277
142
  'zone': PickfaceZone | null;
278
143
  /**
279
144
  * The human readable location of the pickface, if a name is provided this will be the name.
280
- * @type {string}
281
- * @memberof Pickface
282
145
  */
283
146
  'code': string;
284
- /**
285
- *
286
- * @type {boolean}
287
- * @memberof Pickface
288
- */
289
147
  'enabled': boolean;
290
148
  /**
291
149
  * Whether the pickface can contain mixed contents.
292
- * @type {boolean}
293
- * @memberof Pickface
294
150
  */
295
151
  'mixedContents': boolean;
296
152
  /**
297
153
  * Whether the pickface is used for bulk storage and not for picking
298
- * @type {boolean}
299
- * @memberof Pickface
300
154
  */
301
155
  'bulk': boolean;
302
- /**
303
- *
304
- * @type {PickfaceContainerType}
305
- * @memberof Pickface
306
- */
307
156
  'containerType': PickfaceContainerType;
308
157
  /**
309
158
  * The percentage of the pickface that has been taken up by its contents
310
- * @type {number}
311
- * @memberof Pickface
312
159
  */
313
160
  'fullness': number;
314
161
  /**
315
162
  * The last time the pickface was picked from
316
- * @type {PickfaceLog}
317
- * @memberof Pickface
318
163
  */
319
164
  'lastPicked': PickfaceLog | null;
320
165
  /**
321
166
  * The last time the pickface was restocked
322
- * @type {PickfaceLog}
323
- * @memberof Pickface
324
167
  */
325
168
  'lastRestocked': PickfaceLog | null;
326
- /**
327
- *
328
- * @type {PickfaceIssue}
329
- * @memberof Pickface
330
- */
331
169
  'issue': PickfaceIssue | null;
332
- /**
333
- *
334
- * @type {Array<PickfaceContentsInner>}
335
- * @memberof Pickface
336
- */
337
170
  'contents': Array<PickfaceContentsInner>;
338
171
  /**
339
- * The distance from the nearest label printer to the pickface in meters.
340
- * @type {number}
341
- * @memberof Pickface
172
+ * The distance from the nearest label printer to the pickface in centimeters.
342
173
  */
343
174
  'distanceFromLabelPrinter': number | null;
344
175
  }
345
- /**
346
- *
347
- * @export
348
- * @interface PickfaceContainerType
349
- */
350
176
  export interface PickfaceContainerType {
351
177
  /**
352
178
  * Unique object identifier
353
- * @type {string}
354
- * @memberof PickfaceContainerType
355
179
  */
356
180
  'id'?: string;
357
181
  /**
358
182
  * A reference to the resource location
359
- * @type {string}
360
- * @memberof PickfaceContainerType
361
183
  */
362
184
  'ref'?: string;
363
185
  }
364
- /**
365
- *
366
- * @export
367
- * @interface PickfaceContentsInner
368
- */
369
186
  export interface PickfaceContentsInner {
370
187
  /**
371
188
  * A reference to the resource location
372
- * @type {string}
373
- * @memberof PickfaceContentsInner
374
189
  */
375
190
  'variantRef': string;
376
191
  /**
377
192
  * 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.
378
- * @type {string}
379
- * @memberof PickfaceContentsInner
380
193
  */
381
194
  'ownerProjectId': string | null;
382
- /**
383
- *
384
- * @type {PickfaceContentsInnerQuantity}
385
- * @memberof PickfaceContentsInner
386
- */
387
195
  'quantity': PickfaceContentsInnerQuantity;
388
- /**
389
- *
390
- * @type {PickfaceContentsInnerMetadata}
391
- * @memberof PickfaceContentsInner
392
- */
393
196
  'metadata': PickfaceContentsInnerMetadata | null;
394
197
  }
395
198
  /**
396
199
  * Any additional metadata
397
- * @export
398
- * @interface PickfaceContentsInnerMetadata
399
200
  */
400
201
  export interface PickfaceContentsInnerMetadata {
401
202
  /**
402
203
  * The title of the product
403
- * @type {string}
404
- * @memberof PickfaceContentsInnerMetadata
405
204
  */
406
205
  'title': string | null;
407
206
  /**
408
207
  * The SKU of the product
409
- * @type {string}
410
- * @memberof PickfaceContentsInnerMetadata
411
208
  */
412
209
  'sku': string | null;
413
210
  /**
414
211
  * The image of the front of the product
415
- * @type {string}
416
- * @memberof PickfaceContentsInnerMetadata
417
212
  */
418
213
  'frontImage'?: string | null;
419
214
  /**
420
215
  * The image of the back of the product
421
- * @type {string}
422
- * @memberof PickfaceContentsInnerMetadata
423
216
  */
424
217
  'backImage'?: string | null;
425
218
  /**
426
219
  * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`.
427
- * @type {Array<VariantAttribute>}
428
- * @memberof PickfaceContentsInnerMetadata
429
220
  */
430
221
  'attributes'?: Array<VariantAttribute>;
431
222
  }
432
- /**
433
- *
434
- * @export
435
- * @interface PickfaceContentsInnerQuantity
436
- */
437
223
  export interface PickfaceContentsInnerQuantity {
438
224
  /**
439
225
  * How many are in the box
440
- * @type {number}
441
- * @memberof PickfaceContentsInnerQuantity
442
226
  */
443
227
  'total'?: number;
444
228
  /**
445
229
  * How many are available to reserve
446
- * @type {number}
447
- * @memberof PickfaceContentsInnerQuantity
448
230
  */
449
231
  'available'?: number;
450
232
  /**
451
233
  * How many are pending some action e.g. to be picked
452
- * @type {number}
453
- * @memberof PickfaceContentsInnerQuantity
454
234
  */
455
235
  'reserved'?: number;
456
236
  /**
457
237
  * 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.
458
- * @type {number}
459
- * @memberof PickfaceContentsInnerQuantity
460
238
  */
461
239
  'ZWip'?: number;
462
240
  }
463
241
  /**
464
242
  * The open issue for the pickface
465
- * @export
466
- * @interface PickfaceIssue
467
243
  */
468
244
  export interface PickfaceIssue {
469
245
  /**
470
246
  * Unique object identifier
471
- * @type {string}
472
- * @memberof PickfaceIssue
473
247
  */
474
248
  'id'?: string;
475
249
  /**
476
250
  * A reference to the resource location
477
- * @type {string}
478
- * @memberof PickfaceIssue
479
251
  */
480
252
  'ref'?: string;
481
253
  }
482
- /**
483
- *
484
- * @export
485
- * @interface PickfaceLog
486
- */
487
254
  export interface PickfaceLog {
488
255
  /**
489
256
  * Unique object identifier
490
- * @type {string}
491
- * @memberof PickfaceLog
492
257
  */
493
258
  'id': string;
494
259
  /**
495
260
  * A reference to the resource location
496
- * @type {string}
497
- * @memberof PickfaceLog
498
261
  */
499
262
  'userRef': string;
500
263
  /**
501
264
  * The action that was taken
502
- * @type {string}
503
- * @memberof PickfaceLog
504
265
  */
505
266
  'action': string;
506
267
  /**
507
268
  * The reason for the action
508
- * @type {string}
509
- * @memberof PickfaceLog
510
269
  */
511
270
  'reason': string | null;
512
271
  /**
513
272
  * ISO 8601 Created at timestamp
514
- * @type {string}
515
- * @memberof PickfaceLog
516
273
  */
517
274
  'createdAt': string;
518
275
  }
519
- /**
520
- *
521
- * @export
522
- * @interface PickfaceZone
523
- */
524
276
  export interface PickfaceZone {
525
277
  /**
526
278
  * Unique object identifier
527
- * @type {string}
528
- * @memberof PickfaceZone
529
279
  */
530
280
  'id'?: string;
531
281
  /**
532
282
  * A reference to the resource location
533
- * @type {string}
534
- * @memberof PickfaceZone
535
283
  */
536
284
  'ref'?: string;
537
285
  /**
538
286
  * The name of the zone the pickface is in
539
- * @type {string}
540
- * @memberof PickfaceZone
541
287
  */
542
288
  'name'?: string;
543
289
  }
544
290
  /**
545
291
  * A list of updates to apply to the pickface.
546
- * @export
547
- * @interface UpdatePickfaceRequest
548
292
  */
549
293
  export interface UpdatePickfaceRequest {
550
- /**
551
- *
552
- * @type {boolean}
553
- * @memberof UpdatePickfaceRequest
554
- */
555
294
  'enabled': boolean;
556
295
  /**
557
296
  * Unique object identifier
558
- * @type {string}
559
- * @memberof UpdatePickfaceRequest
560
297
  */
561
298
  'containerTypeId'?: string;
562
299
  /**
563
300
  * Unique object identifier
564
- * @type {string}
565
- * @memberof UpdatePickfaceRequest
566
301
  */
567
302
  'zoneId'?: string | null;
568
303
  /**
569
304
  * Whether the pickface can contain mixed contents.
570
- * @type {boolean}
571
- * @memberof UpdatePickfaceRequest
572
305
  */
573
306
  'mixedContents'?: boolean;
574
307
  /**
575
308
  * Whether the pickface is used for bulk storage
576
- * @type {boolean}
577
- * @memberof UpdatePickfaceRequest
578
309
  */
579
310
  'bulk'?: boolean;
580
311
  /**
581
312
  * A user defined name for the pickface, if this is not provided the location will be used as the name.
582
- * @type {string}
583
- * @memberof UpdatePickfaceRequest
584
313
  */
585
314
  'name'?: string | null;
586
315
  /**
587
- * The distance from the nearest label printer to the pickface in meters. This is used for put away recommendations.
588
- * @type {number}
589
- * @memberof UpdatePickfaceRequest
316
+ * The distance from the nearest label printer to the pickface in centimeters. This is used for put away recommendations.
590
317
  */
591
318
  'distanceFromLabelPrinter'?: number | null;
592
- /**
593
- *
594
- * @type {Array<UpdatePickfaceRequestContentsInner>}
595
- * @memberof UpdatePickfaceRequest
596
- */
597
319
  'contents'?: Array<UpdatePickfaceRequestContentsInner> | null;
598
320
  /**
599
321
  * Unique object identifier
600
- * @type {string}
601
- * @memberof UpdatePickfaceRequest
602
322
  */
603
323
  'purchaseOrderId'?: string;
604
324
  }
605
- /**
606
- *
607
- * @export
608
- * @interface UpdatePickfaceRequestContentsInner
609
- */
610
325
  export interface UpdatePickfaceRequestContentsInner {
611
326
  /**
612
327
  * The variant to add or subtract from the pickface
613
- * @type {string}
614
- * @memberof UpdatePickfaceRequestContentsInner
615
328
  */
616
329
  'variantRef': string;
617
- /**
618
- *
619
- * @type {UpdatePickfaceRequestContentsInnerQuantity}
620
- * @memberof UpdatePickfaceRequestContentsInner
621
- */
622
330
  'quantity': UpdatePickfaceRequestContentsInnerQuantity;
623
331
  }
624
- /**
625
- *
626
- * @export
627
- * @interface UpdatePickfaceRequestContentsInnerQuantity
628
- */
629
332
  export interface UpdatePickfaceRequestContentsInnerQuantity {
630
- /**
631
- *
632
- * @type {UpdatePickfaceRequestContentsInnerQuantityAvailable}
633
- * @memberof UpdatePickfaceRequestContentsInnerQuantity
634
- */
635
333
  'available'?: UpdatePickfaceRequestContentsInnerQuantityAvailable | null;
636
- /**
637
- *
638
- * @type {UpdatePickfaceRequestContentsInnerQuantityZWip}
639
- * @memberof UpdatePickfaceRequestContentsInnerQuantity
640
- */
641
334
  'ZWip'?: UpdatePickfaceRequestContentsInnerQuantityZWip | null;
642
335
  }
643
336
  /**
644
337
  * The amount to add or subtract from the available stock on the pickface
645
- * @export
646
- * @interface UpdatePickfaceRequestContentsInnerQuantityAvailable
647
338
  */
648
339
  export interface UpdatePickfaceRequestContentsInnerQuantityAvailable {
649
- /**
650
- *
651
- * @type {string}
652
- * @memberof UpdatePickfaceRequestContentsInnerQuantityAvailable
653
- */
654
340
  'operation'?: UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum;
655
- /**
656
- *
657
- * @type {number}
658
- * @memberof UpdatePickfaceRequestContentsInnerQuantityAvailable
659
- */
660
341
  'value': number;
661
342
  }
662
343
  export declare const UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum: {
@@ -667,21 +348,9 @@ export declare const UpdatePickfaceRequestContentsInnerQuantityAvailableOperatio
667
348
  export type UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum];
668
349
  /**
669
350
  * The amount to add or subtract from the Z WIP stock on the pickface.
670
- * @export
671
- * @interface UpdatePickfaceRequestContentsInnerQuantityZWip
672
351
  */
673
352
  export interface UpdatePickfaceRequestContentsInnerQuantityZWip {
674
- /**
675
- *
676
- * @type {string}
677
- * @memberof UpdatePickfaceRequestContentsInnerQuantityZWip
678
- */
679
353
  'operation'?: UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum;
680
- /**
681
- *
682
- * @type {number}
683
- * @memberof UpdatePickfaceRequestContentsInnerQuantityZWip
684
- */
685
354
  'value': number;
686
355
  }
687
356
  export declare const UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum: {
@@ -690,104 +359,51 @@ export declare const UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum
690
359
  readonly Set: "set";
691
360
  };
692
361
  export type UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum];
693
- /**
694
- *
695
- * @export
696
- * @interface UpdatePickfacesRequest
697
- */
698
362
  export interface UpdatePickfacesRequest {
699
- /**
700
- *
701
- * @type {Array<UpdatePickfacesRequestPickfacesInner>}
702
- * @memberof UpdatePickfacesRequest
703
- */
704
363
  'pickfaces': Array<UpdatePickfacesRequestPickfacesInner>;
705
364
  }
706
- /**
707
- *
708
- * @export
709
- * @interface UpdatePickfacesRequestPickfacesInner
710
- */
711
365
  export interface UpdatePickfacesRequestPickfacesInner {
712
366
  /**
713
367
  * Unique object identifier
714
- * @type {string}
715
- * @memberof UpdatePickfacesRequestPickfacesInner
716
368
  */
717
369
  'id': string;
718
370
  /**
719
371
  * A user defined name for the pickface, if this is not provided the location will be used as the name.
720
- * @type {string}
721
- * @memberof UpdatePickfacesRequestPickfacesInner
722
372
  */
723
373
  'name'?: string | null;
724
374
  /**
725
375
  * Whether the pickface is enabled
726
- * @type {boolean}
727
- * @memberof UpdatePickfacesRequestPickfacesInner
728
376
  */
729
377
  'enabled'?: boolean;
730
378
  /**
731
379
  * Whether the pickface can contain mixed contents.
732
- * @type {boolean}
733
- * @memberof UpdatePickfacesRequestPickfacesInner
734
380
  */
735
381
  'mixedContents'?: boolean;
736
382
  /**
737
383
  * Whether the pickface is used for bulk storage
738
- * @type {boolean}
739
- * @memberof UpdatePickfacesRequestPickfacesInner
740
384
  */
741
385
  'bulk'?: boolean;
742
386
  /**
743
- * The distance from the nearest label printer to the pickface in meters. This is used for put away recommendations.
744
- * @type {number}
745
- * @memberof UpdatePickfacesRequestPickfacesInner
387
+ * The distance from the nearest label printer to the pickface in centimeters. This is used for put away recommendations.
746
388
  */
747
389
  'distanceFromLabelPrinter'?: number | null;
748
390
  }
749
- /**
750
- *
751
- * @export
752
- * @interface VariantAttribute
753
- */
754
391
  export interface VariantAttribute {
755
392
  /**
756
393
  * Attribute name
757
- * @type {string}
758
- * @memberof VariantAttribute
759
394
  */
760
395
  'name': string;
761
396
  /**
762
397
  * Attribute value
763
- * @type {string}
764
- * @memberof VariantAttribute
765
398
  */
766
399
  'value': string;
767
- /**
768
- *
769
- * @type {VariantAttributeThumbnail}
770
- * @memberof VariantAttribute
771
- */
772
400
  'thumbnail'?: VariantAttributeThumbnail;
773
401
  }
774
402
  /**
775
403
  * Attribute thumbnail
776
- * @export
777
- * @interface VariantAttributeThumbnail
778
404
  */
779
405
  export interface VariantAttributeThumbnail {
780
- /**
781
- *
782
- * @type {string}
783
- * @memberof VariantAttributeThumbnail
784
- */
785
406
  'type': VariantAttributeThumbnailTypeEnum;
786
- /**
787
- *
788
- * @type {string}
789
- * @memberof VariantAttributeThumbnail
790
- */
791
407
  'value': string;
792
408
  }
793
409
  export declare const VariantAttributeThumbnailTypeEnum: {
@@ -798,9 +414,17 @@ export declare const VariantAttributeThumbnailTypeEnum: {
798
414
  export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
799
415
  /**
800
416
  * PickfacesApi - axios parameter creator
801
- * @export
802
417
  */
803
418
  export declare const PickfacesApiAxiosParamCreator: (configuration?: Configuration) => {
419
+ /**
420
+ * Mark stock as checked in a pickface
421
+ * @summary Mark stock as checked
422
+ * @param {string} project The project ID
423
+ * @param {string} pickfaceId Unique identifier of a pickface
424
+ * @param {*} [options] Override http request option.
425
+ * @throws {RequiredError}
426
+ */
427
+ checkedStock: (project: string, pickfaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
804
428
  /**
805
429
  * Create a Pickface
806
430
  * @summary Create Pickface
@@ -965,9 +589,17 @@ export declare const PickfacesApiAxiosParamCreator: (configuration?: Configurati
965
589
  };
966
590
  /**
967
591
  * PickfacesApi - functional programming interface
968
- * @export
969
592
  */
970
593
  export declare const PickfacesApiFp: (configuration?: Configuration) => {
594
+ /**
595
+ * Mark stock as checked in a pickface
596
+ * @summary Mark stock as checked
597
+ * @param {string} project The project ID
598
+ * @param {string} pickfaceId Unique identifier of a pickface
599
+ * @param {*} [options] Override http request option.
600
+ * @throws {RequiredError}
601
+ */
602
+ checkedStock(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
971
603
  /**
972
604
  * Create a Pickface
973
605
  * @summary Create Pickface
@@ -1056,7 +688,7 @@ export declare const PickfacesApiFp: (configuration?: Configuration) => {
1056
688
  * @param {*} [options] Override http request option.
1057
689
  * @throws {RequiredError}
1058
690
  */
1059
- 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>>;
691
+ 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>>;
1060
692
  /**
1061
693
  * Move stock from one pickface to another in a single transaction
1062
694
  * @summary Move stock
@@ -1109,7 +741,7 @@ export declare const PickfacesApiFp: (configuration?: Configuration) => {
1109
741
  * @param {*} [options] Override http request option.
1110
742
  * @throws {RequiredError}
1111
743
  */
1112
- suggestPickfaces(project: string, variantRef: string, quantity: number, sellThroughRate?: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>>;
744
+ suggestPickfaces(project: string, variantRef: string, quantity: number, sellThroughRate?: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>>;
1113
745
  /**
1114
746
  * Update a Pickface
1115
747
  * @summary Update Pickface
@@ -1128,13 +760,20 @@ export declare const PickfacesApiFp: (configuration?: Configuration) => {
1128
760
  * @param {*} [options] Override http request option.
1129
761
  * @throws {RequiredError}
1130
762
  */
1131
- updatePickfaces(project: string, updatePickfacesRequest: UpdatePickfacesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>>;
763
+ updatePickfaces(project: string, updatePickfacesRequest: UpdatePickfacesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>>;
1132
764
  };
1133
765
  /**
1134
766
  * PickfacesApi - factory interface
1135
- * @export
1136
767
  */
1137
768
  export declare const PickfacesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
769
+ /**
770
+ * Mark stock as checked in a pickface
771
+ * @summary Mark stock as checked
772
+ * @param {PickfacesApiCheckedStockRequest} requestParameters Request parameters.
773
+ * @param {*} [options] Override http request option.
774
+ * @throws {RequiredError}
775
+ */
776
+ checkedStock(requestParameters: PickfacesApiCheckedStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1138
777
  /**
1139
778
  * Create a Pickface
1140
779
  * @summary Create Pickface
@@ -1206,7 +845,7 @@ export declare const PickfacesApiFactory: (configuration?: Configuration, basePa
1206
845
  * @param {*} [options] Override http request option.
1207
846
  * @throws {RequiredError}
1208
847
  */
1209
- listPickfaces(requestParameters: PickfacesApiListPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
848
+ listPickfaces(requestParameters: PickfacesApiListPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaces200Response>;
1210
849
  /**
1211
850
  * Move stock from one pickface to another in a single transaction
1212
851
  * @summary Move stock
@@ -1246,7 +885,7 @@ export declare const PickfacesApiFactory: (configuration?: Configuration, basePa
1246
885
  * @param {*} [options] Override http request option.
1247
886
  * @throws {RequiredError}
1248
887
  */
1249
- suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
888
+ suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaces200Response>;
1250
889
  /**
1251
890
  * Update a Pickface
1252
891
  * @summary Update Pickface
@@ -1262,428 +901,315 @@ export declare const PickfacesApiFactory: (configuration?: Configuration, basePa
1262
901
  * @param {*} [options] Override http request option.
1263
902
  * @throws {RequiredError}
1264
903
  */
1265
- updatePickfaces(requestParameters: PickfacesApiUpdatePickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
904
+ updatePickfaces(requestParameters: PickfacesApiUpdatePickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaces200Response>;
1266
905
  };
906
+ /**
907
+ * Request parameters for checkedStock operation in PickfacesApi.
908
+ */
909
+ export interface PickfacesApiCheckedStockRequest {
910
+ /**
911
+ * The project ID
912
+ */
913
+ readonly project: string;
914
+ /**
915
+ * Unique identifier of a pickface
916
+ */
917
+ readonly pickfaceId: string;
918
+ }
1267
919
  /**
1268
920
  * Request parameters for createPickface operation in PickfacesApi.
1269
- * @export
1270
- * @interface PickfacesApiCreatePickfaceRequest
1271
921
  */
1272
922
  export interface PickfacesApiCreatePickfaceRequest {
1273
923
  /**
1274
924
  * The project ID
1275
- * @type {string}
1276
- * @memberof PickfacesApiCreatePickface
1277
925
  */
1278
926
  readonly project: string;
1279
927
  /**
1280
928
  * Create pickface schema
1281
- * @type {CreatePickfaceRequest}
1282
- * @memberof PickfacesApiCreatePickface
1283
929
  */
1284
930
  readonly createPickfaceRequest: CreatePickfaceRequest;
1285
931
  }
1286
932
  /**
1287
933
  * Request parameters for deletePickface operation in PickfacesApi.
1288
- * @export
1289
- * @interface PickfacesApiDeletePickfaceRequest
1290
934
  */
1291
935
  export interface PickfacesApiDeletePickfaceRequest {
1292
936
  /**
1293
937
  * The project ID
1294
- * @type {string}
1295
- * @memberof PickfacesApiDeletePickface
1296
938
  */
1297
939
  readonly project: string;
1298
940
  /**
1299
941
  * Unique identifier of a pickface
1300
- * @type {string}
1301
- * @memberof PickfacesApiDeletePickface
1302
942
  */
1303
943
  readonly pickfaceId: string;
1304
944
  }
1305
945
  /**
1306
946
  * Request parameters for exportPickfaces operation in PickfacesApi.
1307
- * @export
1308
- * @interface PickfacesApiExportPickfacesRequest
1309
947
  */
1310
948
  export interface PickfacesApiExportPickfacesRequest {
1311
949
  /**
1312
950
  * The project ID
1313
- * @type {string}
1314
- * @memberof PickfacesApiExportPickfaces
1315
951
  */
1316
952
  readonly project: string;
1317
953
  /**
1318
954
  * Search term to filter based on pickface code
1319
- * @type {string}
1320
- * @memberof PickfacesApiExportPickfaces
1321
955
  */
1322
956
  readonly search?: string;
1323
957
  }
1324
958
  /**
1325
959
  * Request parameters for getPickface operation in PickfacesApi.
1326
- * @export
1327
- * @interface PickfacesApiGetPickfaceRequest
1328
960
  */
1329
961
  export interface PickfacesApiGetPickfaceRequest {
1330
962
  /**
1331
963
  * The project ID
1332
- * @type {string}
1333
- * @memberof PickfacesApiGetPickface
1334
964
  */
1335
965
  readonly project: string;
1336
966
  /**
1337
967
  * Unique identifier of a pickface
1338
- * @type {string}
1339
- * @memberof PickfacesApiGetPickface
1340
968
  */
1341
969
  readonly pickfaceId: string;
1342
970
  }
1343
971
  /**
1344
972
  * Request parameters for issueEmptyPickface operation in PickfacesApi.
1345
- * @export
1346
- * @interface PickfacesApiIssueEmptyPickfaceRequest
1347
973
  */
1348
974
  export interface PickfacesApiIssueEmptyPickfaceRequest {
1349
975
  /**
1350
976
  * The project ID
1351
- * @type {string}
1352
- * @memberof PickfacesApiIssueEmptyPickface
1353
977
  */
1354
978
  readonly project: string;
1355
979
  /**
1356
980
  * Unique identifier of a pickface
1357
- * @type {string}
1358
- * @memberof PickfacesApiIssueEmptyPickface
1359
981
  */
1360
982
  readonly pickfaceId: string;
1361
983
  /**
1362
984
  * pickface issue schema
1363
- * @type {IssueEmptyPickfaceRequest}
1364
- * @memberof PickfacesApiIssueEmptyPickface
1365
985
  */
1366
986
  readonly issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest;
1367
987
  }
1368
988
  /**
1369
989
  * Request parameters for issueWrongContentsPickface operation in PickfacesApi.
1370
- * @export
1371
- * @interface PickfacesApiIssueWrongContentsPickfaceRequest
1372
990
  */
1373
991
  export interface PickfacesApiIssueWrongContentsPickfaceRequest {
1374
992
  /**
1375
993
  * The project ID
1376
- * @type {string}
1377
- * @memberof PickfacesApiIssueWrongContentsPickface
1378
994
  */
1379
995
  readonly project: string;
1380
996
  /**
1381
997
  * Unique identifier of a pickface
1382
- * @type {string}
1383
- * @memberof PickfacesApiIssueWrongContentsPickface
1384
998
  */
1385
999
  readonly pickfaceId: string;
1386
1000
  /**
1387
1001
  * pickface issue schema
1388
- * @type {IssueWrongContentsPickfaceRequest}
1389
- * @memberof PickfacesApiIssueWrongContentsPickface
1390
1002
  */
1391
1003
  readonly issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest;
1392
1004
  }
1393
1005
  /**
1394
1006
  * Request parameters for listPickfaceContainerTypes operation in PickfacesApi.
1395
- * @export
1396
- * @interface PickfacesApiListPickfaceContainerTypesRequest
1397
1007
  */
1398
1008
  export interface PickfacesApiListPickfaceContainerTypesRequest {
1399
1009
  /**
1400
1010
  * The project ID
1401
- * @type {string}
1402
- * @memberof PickfacesApiListPickfaceContainerTypes
1403
1011
  */
1404
1012
  readonly project: string;
1405
1013
  }
1406
1014
  /**
1407
1015
  * Request parameters for listPickfaceLogs operation in PickfacesApi.
1408
- * @export
1409
- * @interface PickfacesApiListPickfaceLogsRequest
1410
1016
  */
1411
1017
  export interface PickfacesApiListPickfaceLogsRequest {
1412
1018
  /**
1413
1019
  * The project ID
1414
- * @type {string}
1415
- * @memberof PickfacesApiListPickfaceLogs
1416
1020
  */
1417
1021
  readonly project: string;
1418
1022
  /**
1419
1023
  * Unique identifier of a pickface
1420
- * @type {string}
1421
- * @memberof PickfacesApiListPickfaceLogs
1422
1024
  */
1423
1025
  readonly pickfaceId: string;
1424
1026
  /**
1425
1027
  * Page reference token
1426
- * @type {number}
1427
- * @memberof PickfacesApiListPickfaceLogs
1428
1028
  */
1429
1029
  readonly pageToken?: number;
1430
1030
  /**
1431
1031
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1432
- * @type {number}
1433
- * @memberof PickfacesApiListPickfaceLogs
1434
1032
  */
1435
1033
  readonly pageSize?: number;
1436
1034
  }
1437
1035
  /**
1438
1036
  * Request parameters for listPickfaces operation in PickfacesApi.
1439
- * @export
1440
- * @interface PickfacesApiListPickfacesRequest
1441
1037
  */
1442
1038
  export interface PickfacesApiListPickfacesRequest {
1443
1039
  /**
1444
1040
  * The project ID
1445
- * @type {string}
1446
- * @memberof PickfacesApiListPickfaces
1447
1041
  */
1448
1042
  readonly project: string;
1449
1043
  /**
1450
1044
  * Search term to filter based on pickface code
1451
- * @type {string}
1452
- * @memberof PickfacesApiListPickfaces
1453
1045
  */
1454
1046
  readonly search?: string;
1455
1047
  /**
1456
1048
  * Page reference token
1457
- * @type {number}
1458
- * @memberof PickfacesApiListPickfaces
1459
1049
  */
1460
1050
  readonly pageToken?: number;
1461
1051
  /**
1462
1052
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1463
- * @type {number}
1464
- * @memberof PickfacesApiListPickfaces
1465
1053
  */
1466
1054
  readonly pageSize?: number;
1467
1055
  /**
1468
1056
  * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1469
- * @type {Array<'+available' | '-available' | '+wip' | '-wip' | '+total' | '-total' | '+fullness' | '-fullness' | '+restocked' | '-restocked' | '+picked' | '-picked'>}
1470
- * @memberof PickfacesApiListPickfaces
1471
1057
  */
1472
1058
  readonly sortBy?: Array<ListPickfacesSortByEnum>;
1473
1059
  /**
1474
1060
  * Start of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string
1475
- * @type {string}
1476
- * @memberof PickfacesApiListPickfaces
1477
1061
  */
1478
1062
  readonly updatedStart?: string;
1479
1063
  /**
1480
1064
  * End of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string
1481
- * @type {string}
1482
- * @memberof PickfacesApiListPickfaces
1483
1065
  */
1484
1066
  readonly updatedEnd?: string;
1485
1067
  }
1486
1068
  /**
1487
1069
  * Request parameters for moveStock operation in PickfacesApi.
1488
- * @export
1489
- * @interface PickfacesApiMoveStockRequest
1490
1070
  */
1491
1071
  export interface PickfacesApiMoveStockRequest {
1492
1072
  /**
1493
1073
  * The project ID
1494
- * @type {string}
1495
- * @memberof PickfacesApiMoveStock
1496
1074
  */
1497
1075
  readonly project: string;
1498
1076
  /**
1499
1077
  * Unique identifier of a pickface
1500
- * @type {string}
1501
- * @memberof PickfacesApiMoveStock
1502
1078
  */
1503
1079
  readonly pickfaceId: string;
1504
1080
  /**
1505
1081
  * Move stock from one pickface to another
1506
- * @type {MoveStockRequest}
1507
- * @memberof PickfacesApiMoveStock
1508
1082
  */
1509
1083
  readonly moveStockRequest: MoveStockRequest;
1510
1084
  }
1511
1085
  /**
1512
1086
  * Request parameters for printPickfaceLabel operation in PickfacesApi.
1513
- * @export
1514
- * @interface PickfacesApiPrintPickfaceLabelRequest
1515
1087
  */
1516
1088
  export interface PickfacesApiPrintPickfaceLabelRequest {
1517
1089
  /**
1518
1090
  * The project ID
1519
- * @type {string}
1520
- * @memberof PickfacesApiPrintPickfaceLabel
1521
1091
  */
1522
1092
  readonly project: string;
1523
1093
  /**
1524
1094
  * Unique identifier of a pickface
1525
- * @type {string}
1526
- * @memberof PickfacesApiPrintPickfaceLabel
1527
1095
  */
1528
1096
  readonly pickfaceId: string;
1529
1097
  /**
1530
1098
  * Unique identifier of a warehouse device
1531
- * @type {string}
1532
- * @memberof PickfacesApiPrintPickfaceLabel
1533
1099
  */
1534
1100
  readonly deviceRef: string;
1535
1101
  }
1536
1102
  /**
1537
1103
  * Request parameters for printPickfaceLabels operation in PickfacesApi.
1538
- * @export
1539
- * @interface PickfacesApiPrintPickfaceLabelsRequest
1540
1104
  */
1541
1105
  export interface PickfacesApiPrintPickfaceLabelsRequest {
1542
1106
  /**
1543
1107
  * The project ID
1544
- * @type {string}
1545
- * @memberof PickfacesApiPrintPickfaceLabels
1546
1108
  */
1547
1109
  readonly project: string;
1548
1110
  /**
1549
1111
  * Unique identifier of a warehouse device
1550
- * @type {string}
1551
- * @memberof PickfacesApiPrintPickfaceLabels
1552
1112
  */
1553
1113
  readonly deviceRef: string;
1554
1114
  /**
1555
1115
  * Search term to filter based on pickface code
1556
- * @type {string}
1557
- * @memberof PickfacesApiPrintPickfaceLabels
1558
1116
  */
1559
1117
  readonly search?: string;
1560
1118
  /**
1561
1119
  * List of pickface ids
1562
- * @type {Array<string>}
1563
- * @memberof PickfacesApiPrintPickfaceLabels
1564
1120
  */
1565
1121
  readonly ids?: Array<string> | null;
1566
1122
  }
1567
1123
  /**
1568
1124
  * Request parameters for resolvePickfaceIssue operation in PickfacesApi.
1569
- * @export
1570
- * @interface PickfacesApiResolvePickfaceIssueRequest
1571
1125
  */
1572
1126
  export interface PickfacesApiResolvePickfaceIssueRequest {
1573
1127
  /**
1574
1128
  * The project ID
1575
- * @type {string}
1576
- * @memberof PickfacesApiResolvePickfaceIssue
1577
1129
  */
1578
1130
  readonly project: string;
1579
1131
  /**
1580
1132
  * Unique identifier of a pickface
1581
- * @type {string}
1582
- * @memberof PickfacesApiResolvePickfaceIssue
1583
1133
  */
1584
1134
  readonly pickfaceId: string;
1585
1135
  }
1586
1136
  /**
1587
1137
  * Request parameters for suggestPickfaces operation in PickfacesApi.
1588
- * @export
1589
- * @interface PickfacesApiSuggestPickfacesRequest
1590
1138
  */
1591
1139
  export interface PickfacesApiSuggestPickfacesRequest {
1592
1140
  /**
1593
1141
  * The project ID
1594
- * @type {string}
1595
- * @memberof PickfacesApiSuggestPickfaces
1596
1142
  */
1597
1143
  readonly project: string;
1598
1144
  /**
1599
1145
  * Unique identifier of a warehouse variant
1600
- * @type {string}
1601
- * @memberof PickfacesApiSuggestPickfaces
1602
1146
  */
1603
1147
  readonly variantRef: string;
1604
1148
  /**
1605
1149
  * Number of variants
1606
- * @type {number}
1607
- * @memberof PickfacesApiSuggestPickfaces
1608
1150
  */
1609
1151
  readonly quantity: number;
1610
1152
  /**
1611
1153
  * The sell through rate of the variant to use when suggesting pickfaces
1612
- * @type {number}
1613
- * @memberof PickfacesApiSuggestPickfaces
1614
1154
  */
1615
1155
  readonly sellThroughRate?: number;
1616
1156
  /**
1617
1157
  * Page reference token
1618
- * @type {number}
1619
- * @memberof PickfacesApiSuggestPickfaces
1620
1158
  */
1621
1159
  readonly pageToken?: number;
1622
1160
  /**
1623
1161
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1624
- * @type {number}
1625
- * @memberof PickfacesApiSuggestPickfaces
1626
1162
  */
1627
1163
  readonly pageSize?: number;
1628
1164
  }
1629
1165
  /**
1630
1166
  * Request parameters for updatePickface operation in PickfacesApi.
1631
- * @export
1632
- * @interface PickfacesApiUpdatePickfaceRequest
1633
1167
  */
1634
1168
  export interface PickfacesApiUpdatePickfaceRequest {
1635
1169
  /**
1636
1170
  * The project ID
1637
- * @type {string}
1638
- * @memberof PickfacesApiUpdatePickface
1639
1171
  */
1640
1172
  readonly project: string;
1641
1173
  /**
1642
1174
  * Unique identifier of a pickface
1643
- * @type {string}
1644
- * @memberof PickfacesApiUpdatePickface
1645
1175
  */
1646
1176
  readonly pickfaceId: string;
1647
1177
  /**
1648
1178
  * Update pickface schema
1649
- * @type {UpdatePickfaceRequest}
1650
- * @memberof PickfacesApiUpdatePickface
1651
1179
  */
1652
1180
  readonly updatePickfaceRequest: UpdatePickfaceRequest;
1653
1181
  }
1654
1182
  /**
1655
1183
  * Request parameters for updatePickfaces operation in PickfacesApi.
1656
- * @export
1657
- * @interface PickfacesApiUpdatePickfacesRequest
1658
1184
  */
1659
1185
  export interface PickfacesApiUpdatePickfacesRequest {
1660
1186
  /**
1661
1187
  * The project ID
1662
- * @type {string}
1663
- * @memberof PickfacesApiUpdatePickfaces
1664
1188
  */
1665
1189
  readonly project: string;
1666
1190
  /**
1667
1191
  * Update pickfaces in bulk schema
1668
- * @type {UpdatePickfacesRequest}
1669
- * @memberof PickfacesApiUpdatePickfaces
1670
1192
  */
1671
1193
  readonly updatePickfacesRequest: UpdatePickfacesRequest;
1672
1194
  }
1673
1195
  /**
1674
1196
  * PickfacesApi - object-oriented interface
1675
- * @export
1676
- * @class PickfacesApi
1677
- * @extends {BaseAPI}
1678
1197
  */
1679
1198
  export declare class PickfacesApi extends BaseAPI {
1199
+ /**
1200
+ * Mark stock as checked in a pickface
1201
+ * @summary Mark stock as checked
1202
+ * @param {PickfacesApiCheckedStockRequest} requestParameters Request parameters.
1203
+ * @param {*} [options] Override http request option.
1204
+ * @throws {RequiredError}
1205
+ */
1206
+ checkedStock(requestParameters: PickfacesApiCheckedStockRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1680
1207
  /**
1681
1208
  * Create a Pickface
1682
1209
  * @summary Create Pickface
1683
1210
  * @param {PickfacesApiCreatePickfaceRequest} requestParameters Request parameters.
1684
1211
  * @param {*} [options] Override http request option.
1685
1212
  * @throws {RequiredError}
1686
- * @memberof PickfacesApi
1687
1213
  */
1688
1214
  createPickface(requestParameters: PickfacesApiCreatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1689
1215
  /**
@@ -1692,7 +1218,6 @@ export declare class PickfacesApi extends BaseAPI {
1692
1218
  * @param {PickfacesApiDeletePickfaceRequest} requestParameters Request parameters.
1693
1219
  * @param {*} [options] Override http request option.
1694
1220
  * @throws {RequiredError}
1695
- * @memberof PickfacesApi
1696
1221
  */
1697
1222
  deletePickface(requestParameters: PickfacesApiDeletePickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1698
1223
  /**
@@ -1701,7 +1226,6 @@ export declare class PickfacesApi extends BaseAPI {
1701
1226
  * @param {PickfacesApiExportPickfacesRequest} requestParameters Request parameters.
1702
1227
  * @param {*} [options] Override http request option.
1703
1228
  * @throws {RequiredError}
1704
- * @memberof PickfacesApi
1705
1229
  */
1706
1230
  exportPickfaces(requestParameters: PickfacesApiExportPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
1707
1231
  /**
@@ -1710,7 +1234,6 @@ export declare class PickfacesApi extends BaseAPI {
1710
1234
  * @param {PickfacesApiGetPickfaceRequest} requestParameters Request parameters.
1711
1235
  * @param {*} [options] Override http request option.
1712
1236
  * @throws {RequiredError}
1713
- * @memberof PickfacesApi
1714
1237
  */
1715
1238
  getPickface(requestParameters: PickfacesApiGetPickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1716
1239
  /**
@@ -1719,7 +1242,6 @@ export declare class PickfacesApi extends BaseAPI {
1719
1242
  * @param {PickfacesApiIssueEmptyPickfaceRequest} requestParameters Request parameters.
1720
1243
  * @param {*} [options] Override http request option.
1721
1244
  * @throws {RequiredError}
1722
- * @memberof PickfacesApi
1723
1245
  */
1724
1246
  issueEmptyPickface(requestParameters: PickfacesApiIssueEmptyPickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1725
1247
  /**
@@ -1728,7 +1250,6 @@ export declare class PickfacesApi extends BaseAPI {
1728
1250
  * @param {PickfacesApiIssueWrongContentsPickfaceRequest} requestParameters Request parameters.
1729
1251
  * @param {*} [options] Override http request option.
1730
1252
  * @throws {RequiredError}
1731
- * @memberof PickfacesApi
1732
1253
  */
1733
1254
  issueWrongContentsPickface(requestParameters: PickfacesApiIssueWrongContentsPickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1734
1255
  /**
@@ -1737,7 +1258,6 @@ export declare class PickfacesApi extends BaseAPI {
1737
1258
  * @param {PickfacesApiListPickfaceContainerTypesRequest} requestParameters Request parameters.
1738
1259
  * @param {*} [options] Override http request option.
1739
1260
  * @throws {RequiredError}
1740
- * @memberof PickfacesApi
1741
1261
  */
1742
1262
  listPickfaceContainerTypes(requestParameters: PickfacesApiListPickfaceContainerTypesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ContainerTypes, any>>;
1743
1263
  /**
@@ -1746,7 +1266,6 @@ export declare class PickfacesApi extends BaseAPI {
1746
1266
  * @param {PickfacesApiListPickfaceLogsRequest} requestParameters Request parameters.
1747
1267
  * @param {*} [options] Override http request option.
1748
1268
  * @throws {RequiredError}
1749
- * @memberof PickfacesApi
1750
1269
  */
1751
1270
  listPickfaceLogs(requestParameters: PickfacesApiListPickfaceLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPickfaceLogs200Response, any>>;
1752
1271
  /**
@@ -1755,16 +1274,14 @@ export declare class PickfacesApi extends BaseAPI {
1755
1274
  * @param {PickfacesApiListPickfacesRequest} requestParameters Request parameters.
1756
1275
  * @param {*} [options] Override http request option.
1757
1276
  * @throws {RequiredError}
1758
- * @memberof PickfacesApi
1759
1277
  */
1760
- listPickfaces(requestParameters: PickfacesApiListPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
1278
+ listPickfaces(requestParameters: PickfacesApiListPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPickfaces200Response, any>>;
1761
1279
  /**
1762
1280
  * Move stock from one pickface to another in a single transaction
1763
1281
  * @summary Move stock
1764
1282
  * @param {PickfacesApiMoveStockRequest} requestParameters Request parameters.
1765
1283
  * @param {*} [options] Override http request option.
1766
1284
  * @throws {RequiredError}
1767
- * @memberof PickfacesApi
1768
1285
  */
1769
1286
  moveStock(requestParameters: PickfacesApiMoveStockRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1770
1287
  /**
@@ -1773,7 +1290,6 @@ export declare class PickfacesApi extends BaseAPI {
1773
1290
  * @param {PickfacesApiPrintPickfaceLabelRequest} requestParameters Request parameters.
1774
1291
  * @param {*} [options] Override http request option.
1775
1292
  * @throws {RequiredError}
1776
- * @memberof PickfacesApi
1777
1293
  */
1778
1294
  printPickfaceLabel(requestParameters: PickfacesApiPrintPickfaceLabelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1779
1295
  /**
@@ -1782,7 +1298,6 @@ export declare class PickfacesApi extends BaseAPI {
1782
1298
  * @param {PickfacesApiPrintPickfaceLabelsRequest} requestParameters Request parameters.
1783
1299
  * @param {*} [options] Override http request option.
1784
1300
  * @throws {RequiredError}
1785
- * @memberof PickfacesApi
1786
1301
  */
1787
1302
  printPickfaceLabels(requestParameters: PickfacesApiPrintPickfaceLabelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1788
1303
  /**
@@ -1791,7 +1306,6 @@ export declare class PickfacesApi extends BaseAPI {
1791
1306
  * @param {PickfacesApiResolvePickfaceIssueRequest} requestParameters Request parameters.
1792
1307
  * @param {*} [options] Override http request option.
1793
1308
  * @throws {RequiredError}
1794
- * @memberof PickfacesApi
1795
1309
  */
1796
1310
  resolvePickfaceIssue(requestParameters: PickfacesApiResolvePickfaceIssueRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1797
1311
  /**
@@ -1800,16 +1314,14 @@ export declare class PickfacesApi extends BaseAPI {
1800
1314
  * @param {PickfacesApiSuggestPickfacesRequest} requestParameters Request parameters.
1801
1315
  * @param {*} [options] Override http request option.
1802
1316
  * @throws {RequiredError}
1803
- * @memberof PickfacesApi
1804
1317
  */
1805
- suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
1318
+ suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPickfaces200Response, any>>;
1806
1319
  /**
1807
1320
  * Update a Pickface
1808
1321
  * @summary Update Pickface
1809
1322
  * @param {PickfacesApiUpdatePickfaceRequest} requestParameters Request parameters.
1810
1323
  * @param {*} [options] Override http request option.
1811
1324
  * @throws {RequiredError}
1812
- * @memberof PickfacesApi
1813
1325
  */
1814
1326
  updatePickface(requestParameters: PickfacesApiUpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1815
1327
  /**
@@ -1818,13 +1330,9 @@ export declare class PickfacesApi extends BaseAPI {
1818
1330
  * @param {PickfacesApiUpdatePickfacesRequest} requestParameters Request parameters.
1819
1331
  * @param {*} [options] Override http request option.
1820
1332
  * @throws {RequiredError}
1821
- * @memberof PickfacesApi
1822
1333
  */
1823
- updatePickfaces(requestParameters: PickfacesApiUpdatePickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
1334
+ updatePickfaces(requestParameters: PickfacesApiUpdatePickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPickfaces200Response, any>>;
1824
1335
  }
1825
- /**
1826
- * @export
1827
- */
1828
1336
  export declare const ListPickfacesSortByEnum: {
1829
1337
  readonly Available: "+available";
1830
1338
  readonly Available2: "-available";