@teemill/pickfaces 0.24.1 → 0.27.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.
Files changed (53) hide show
  1. package/README.md +75 -2
  2. package/api.ts +87 -109
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +84 -109
  7. package/dist/api.js +7 -3
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +84 -109
  15. package/dist/esm/api.js +6 -2
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/ApiError.md +22 -0
  27. package/docs/ContainerType.md +31 -0
  28. package/docs/ContainerTypes.md +20 -0
  29. package/docs/CreatePickfaceRequest.md +30 -0
  30. package/docs/ExportPickfaces202Response.md +20 -0
  31. package/docs/IssueEmptyPickfaceRequest.md +20 -0
  32. package/docs/IssueWrongContentsPickfaceRequest.md +22 -0
  33. package/docs/ListPickfaceLogs200Response.md +22 -0
  34. package/docs/ListPickfaces200Response.md +22 -0
  35. package/docs/MoveStockRequest.md +24 -0
  36. package/docs/Pickface.md +44 -0
  37. package/docs/PickfaceContainerType.md +22 -0
  38. package/docs/PickfaceContentsInner.md +26 -0
  39. package/docs/PickfaceContentsInnerMetadata.md +29 -0
  40. package/docs/PickfaceContentsInnerQuantity.md +24 -0
  41. package/docs/PickfaceIssue.md +23 -0
  42. package/docs/PickfaceLog.md +28 -0
  43. package/docs/PickfaceZone.md +24 -0
  44. package/docs/PickfacesApi.md +957 -0
  45. package/docs/UpdatePickfaceRequest.md +35 -0
  46. package/docs/UpdatePickfaceRequestContentsInner.md +22 -0
  47. package/docs/UpdatePickfaceRequestContentsInnerQuantity.md +22 -0
  48. package/docs/UpdatePickfaceRequestContentsInnerQuantityAvailable.md +23 -0
  49. package/docs/UpdatePickfaceRequestContentsInnerQuantityReserved.md +23 -0
  50. package/docs/VariantAttribute.md +24 -0
  51. package/docs/VariantAttributeThumbnail.md +23 -0
  52. package/index.ts +1 -1
  53. package/package.json +1 -1
package/dist/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.24.1
5
+ * The version of the OpenAPI document: 0.27.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -250,79 +250,79 @@ export interface Pickface {
250
250
  * @type {string}
251
251
  * @memberof Pickface
252
252
  */
253
- 'id'?: string;
253
+ 'id': string;
254
254
  /**
255
255
  * A reference to the resource location
256
256
  * @type {string}
257
257
  * @memberof Pickface
258
258
  */
259
- 'ref'?: string;
259
+ 'ref': string;
260
260
  /**
261
261
  *
262
262
  * @type {PickfaceZone}
263
263
  * @memberof Pickface
264
264
  */
265
- 'zone'?: PickfaceZone | null;
265
+ 'zone': PickfaceZone | null;
266
266
  /**
267
267
  * The human readable location of the pickface, if a name is provided this will be the name.
268
268
  * @type {string}
269
269
  * @memberof Pickface
270
270
  */
271
- 'code'?: string;
271
+ 'code': string;
272
272
  /**
273
273
  *
274
274
  * @type {boolean}
275
275
  * @memberof Pickface
276
276
  */
277
- 'enabled'?: boolean;
277
+ 'enabled': boolean;
278
278
  /**
279
279
  * Whether the pickface can contain mixed contents.
280
280
  * @type {boolean}
281
281
  * @memberof Pickface
282
282
  */
283
- 'mixedContents'?: boolean;
283
+ 'mixedContents': boolean;
284
284
  /**
285
285
  * Whether the pickface is used for bulk storage and not for picking
286
286
  * @type {boolean}
287
287
  * @memberof Pickface
288
288
  */
289
- 'bulk'?: boolean;
289
+ 'bulk': boolean;
290
290
  /**
291
291
  *
292
292
  * @type {PickfaceContainerType}
293
293
  * @memberof Pickface
294
294
  */
295
- 'containerType'?: PickfaceContainerType;
295
+ 'containerType': PickfaceContainerType;
296
296
  /**
297
297
  * The percentage of the pickface that has been taken up by its contents
298
298
  * @type {number}
299
299
  * @memberof Pickface
300
300
  */
301
- 'fullness'?: number;
301
+ 'fullness': number;
302
302
  /**
303
303
  *
304
- * @type {PickfaceLastPicked}
304
+ * @type {PickfaceLog}
305
305
  * @memberof Pickface
306
306
  */
307
- 'lastPicked'?: PickfaceLastPicked;
307
+ 'lastPicked': PickfaceLog | null;
308
308
  /**
309
309
  *
310
- * @type {PickfaceLastRestocked}
310
+ * @type {PickfaceLog}
311
311
  * @memberof Pickface
312
312
  */
313
- 'lastRestocked'?: PickfaceLastRestocked;
313
+ 'lastRestocked': PickfaceLog | null;
314
314
  /**
315
315
  *
316
316
  * @type {PickfaceIssue}
317
317
  * @memberof Pickface
318
318
  */
319
- 'issue'?: PickfaceIssue | null;
319
+ 'issue': PickfaceIssue | null;
320
320
  /**
321
321
  *
322
322
  * @type {Array<PickfaceContentsInner>}
323
323
  * @memberof Pickface
324
324
  */
325
- 'contents'?: Array<PickfaceContentsInner>;
325
+ 'contents': Array<PickfaceContentsInner>;
326
326
  }
327
327
  /**
328
328
  *
@@ -354,25 +354,25 @@ export interface PickfaceContentsInner {
354
354
  * @type {string}
355
355
  * @memberof PickfaceContentsInner
356
356
  */
357
- 'variantRef'?: string;
357
+ 'variantRef': string;
358
358
  /**
359
359
  * 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.
360
360
  * @type {string}
361
361
  * @memberof PickfaceContentsInner
362
362
  */
363
- 'ownerProjectId'?: string | null;
363
+ 'ownerProjectId': string | null;
364
364
  /**
365
365
  *
366
366
  * @type {PickfaceContentsInnerQuantity}
367
367
  * @memberof PickfaceContentsInner
368
368
  */
369
- 'quantity'?: PickfaceContentsInnerQuantity;
369
+ 'quantity': PickfaceContentsInnerQuantity;
370
370
  /**
371
371
  *
372
372
  * @type {PickfaceContentsInnerMetadata}
373
373
  * @memberof PickfaceContentsInner
374
374
  */
375
- 'metadata'?: PickfaceContentsInnerMetadata | null;
375
+ 'metadata': PickfaceContentsInnerMetadata | null;
376
376
  }
377
377
  /**
378
378
  * Any additional metadata
@@ -385,13 +385,13 @@ export interface PickfaceContentsInnerMetadata {
385
385
  * @type {string}
386
386
  * @memberof PickfaceContentsInnerMetadata
387
387
  */
388
- 'title'?: string | null;
388
+ 'title': string | null;
389
389
  /**
390
390
  * The SKU of the product
391
391
  * @type {string}
392
392
  * @memberof PickfaceContentsInnerMetadata
393
393
  */
394
- 'sku'?: string | null;
394
+ 'sku': string | null;
395
395
  /**
396
396
  * The image of the front of the product
397
397
  * @type {string}
@@ -455,80 +455,6 @@ export interface PickfaceIssue {
455
455
  */
456
456
  'ref'?: string;
457
457
  }
458
- /**
459
- *
460
- * @export
461
- * @interface PickfaceLastPicked
462
- */
463
- export interface PickfaceLastPicked {
464
- /**
465
- * Unique object identifier
466
- * @type {string}
467
- * @memberof PickfaceLastPicked
468
- */
469
- 'id'?: string;
470
- /**
471
- * A reference to the resource location
472
- * @type {string}
473
- * @memberof PickfaceLastPicked
474
- */
475
- 'userRef'?: string;
476
- /**
477
- * The action that was taken
478
- * @type {string}
479
- * @memberof PickfaceLastPicked
480
- */
481
- 'action'?: string;
482
- /**
483
- * The reason for the action
484
- * @type {string}
485
- * @memberof PickfaceLastPicked
486
- */
487
- 'reason'?: string | null;
488
- /**
489
- * ISO 8601 Created at timestamp
490
- * @type {string}
491
- * @memberof PickfaceLastPicked
492
- */
493
- 'createdAt'?: string;
494
- }
495
- /**
496
- *
497
- * @export
498
- * @interface PickfaceLastRestocked
499
- */
500
- export interface PickfaceLastRestocked {
501
- /**
502
- * Unique object identifier
503
- * @type {string}
504
- * @memberof PickfaceLastRestocked
505
- */
506
- 'id'?: string;
507
- /**
508
- * A reference to the resource location
509
- * @type {string}
510
- * @memberof PickfaceLastRestocked
511
- */
512
- 'userRef'?: string;
513
- /**
514
- * The action that was taken
515
- * @type {string}
516
- * @memberof PickfaceLastRestocked
517
- */
518
- 'action'?: string;
519
- /**
520
- * The reason for the action
521
- * @type {string}
522
- * @memberof PickfaceLastRestocked
523
- */
524
- 'reason'?: string | null;
525
- /**
526
- * ISO 8601 Created at timestamp
527
- * @type {string}
528
- * @memberof PickfaceLastRestocked
529
- */
530
- 'createdAt'?: string;
531
- }
532
458
  /**
533
459
  *
534
460
  * @export
@@ -540,31 +466,31 @@ export interface PickfaceLog {
540
466
  * @type {string}
541
467
  * @memberof PickfaceLog
542
468
  */
543
- 'id'?: string;
469
+ 'id': string;
544
470
  /**
545
471
  * A reference to the resource location
546
472
  * @type {string}
547
473
  * @memberof PickfaceLog
548
474
  */
549
- 'userRef'?: string;
475
+ 'userRef': string;
550
476
  /**
551
477
  * The action that was taken
552
478
  * @type {string}
553
479
  * @memberof PickfaceLog
554
480
  */
555
- 'action'?: string;
481
+ 'action': string;
556
482
  /**
557
483
  * The reason for the action
558
484
  * @type {string}
559
485
  * @memberof PickfaceLog
560
486
  */
561
- 'reason'?: string | null;
487
+ 'reason': string | null;
562
488
  /**
563
489
  * ISO 8601 Created at timestamp
564
490
  * @type {string}
565
491
  * @memberof PickfaceLog
566
492
  */
567
- 'createdAt'?: string;
493
+ 'createdAt': string;
568
494
  }
569
495
  /**
570
496
  *
@@ -602,7 +528,7 @@ export interface UpdatePickfaceRequest {
602
528
  * @type {boolean}
603
529
  * @memberof UpdatePickfaceRequest
604
530
  */
605
- 'enabled'?: boolean;
531
+ 'enabled': boolean;
606
532
  /**
607
533
  * Unique object identifier
608
534
  * @type {string}
@@ -639,6 +565,12 @@ export interface UpdatePickfaceRequest {
639
565
  * @memberof UpdatePickfaceRequest
640
566
  */
641
567
  'contents'?: Array<UpdatePickfaceRequestContentsInner> | null;
568
+ /**
569
+ * Unique object identifier
570
+ * @type {string}
571
+ * @memberof UpdatePickfaceRequest
572
+ */
573
+ 'purchaseOrderId'?: string;
642
574
  }
643
575
  /**
644
576
  *
@@ -666,23 +598,66 @@ export interface UpdatePickfaceRequestContentsInner {
666
598
  */
667
599
  export interface UpdatePickfaceRequestContentsInnerQuantity {
668
600
  /**
669
- * The operation to perform on the pickface
670
- * @type {string}
601
+ *
602
+ * @type {UpdatePickfaceRequestContentsInnerQuantityAvailable}
671
603
  * @memberof UpdatePickfaceRequestContentsInnerQuantity
672
604
  */
673
- 'operation': UpdatePickfaceRequestContentsInnerQuantityOperationEnum;
605
+ 'available'?: UpdatePickfaceRequestContentsInnerQuantityAvailable | null;
674
606
  /**
675
- * The value to use with the operation
676
- * @type {number}
607
+ *
608
+ * @type {UpdatePickfaceRequestContentsInnerQuantityReserved}
677
609
  * @memberof UpdatePickfaceRequestContentsInnerQuantity
678
610
  */
611
+ 'reserved'?: UpdatePickfaceRequestContentsInnerQuantityReserved | null;
612
+ }
613
+ /**
614
+ * The amount to add or subtract from the available stock on the pickface
615
+ * @export
616
+ * @interface UpdatePickfaceRequestContentsInnerQuantityAvailable
617
+ */
618
+ export interface UpdatePickfaceRequestContentsInnerQuantityAvailable {
619
+ /**
620
+ *
621
+ * @type {string}
622
+ * @memberof UpdatePickfaceRequestContentsInnerQuantityAvailable
623
+ */
624
+ 'operation'?: UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum;
625
+ /**
626
+ *
627
+ * @type {number}
628
+ * @memberof UpdatePickfaceRequestContentsInnerQuantityAvailable
629
+ */
630
+ 'value': number;
631
+ }
632
+ export declare const UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum: {
633
+ readonly Add: "add";
634
+ readonly Subtract: "subtract";
635
+ };
636
+ export type UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum];
637
+ /**
638
+ * The amount to add or subtract from the reserved stock on the pickface. Note that you cannot subtract more than the amount of stock that has been reserved for PodOS orders.
639
+ * @export
640
+ * @interface UpdatePickfaceRequestContentsInnerQuantityReserved
641
+ */
642
+ export interface UpdatePickfaceRequestContentsInnerQuantityReserved {
643
+ /**
644
+ *
645
+ * @type {string}
646
+ * @memberof UpdatePickfaceRequestContentsInnerQuantityReserved
647
+ */
648
+ 'operation'?: UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum;
649
+ /**
650
+ *
651
+ * @type {number}
652
+ * @memberof UpdatePickfaceRequestContentsInnerQuantityReserved
653
+ */
679
654
  'value': number;
680
655
  }
681
- export declare const UpdatePickfaceRequestContentsInnerQuantityOperationEnum: {
656
+ export declare const UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum: {
682
657
  readonly Add: "add";
683
658
  readonly Subtract: "subtract";
684
659
  };
685
- export type UpdatePickfaceRequestContentsInnerQuantityOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum];
660
+ export type UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum];
686
661
  /**
687
662
  *
688
663
  * @export
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Pickfaces API
6
6
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
7
7
  *
8
- * The version of the OpenAPI document: 0.24.1
8
+ * The version of the OpenAPI document: 0.27.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,14 +22,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.ListPickfacesSortByEnum = exports.PickfacesApi = exports.PickfacesApiFactory = exports.PickfacesApiFp = exports.PickfacesApiAxiosParamCreator = exports.VariantAttributeThumbnailTypeEnum = exports.UpdatePickfaceRequestContentsInnerQuantityOperationEnum = void 0;
25
+ exports.ListPickfacesSortByEnum = exports.PickfacesApi = exports.PickfacesApiFactory = exports.PickfacesApiFp = exports.PickfacesApiAxiosParamCreator = exports.VariantAttributeThumbnailTypeEnum = exports.UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum = exports.UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = void 0;
26
26
  const axios_1 = require("axios");
27
27
  // Some imports not used depending on template conditions
28
28
  // @ts-ignore
29
29
  const common_1 = require("./common");
30
30
  // @ts-ignore
31
31
  const base_1 = require("./base");
32
- exports.UpdatePickfaceRequestContentsInnerQuantityOperationEnum = {
32
+ exports.UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = {
33
+ Add: 'add',
34
+ Subtract: 'subtract'
35
+ };
36
+ exports.UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum = {
33
37
  Add: 'add',
34
38
  Subtract: 'subtract'
35
39
  };
package/dist/base.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.24.1
5
+ * The version of the OpenAPI document: 0.27.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Pickfaces API
6
6
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
7
7
  *
8
- * The version of the OpenAPI document: 0.24.1
8
+ * The version of the OpenAPI document: 0.27.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.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.24.1
5
+ * The version of the OpenAPI document: 0.27.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Pickfaces API
6
6
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
7
7
  *
8
- * The version of the OpenAPI document: 0.24.1
8
+ * The version of the OpenAPI document: 0.27.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.24.1
5
+ * The version of the OpenAPI document: 0.27.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Pickfaces API
6
6
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
7
7
  *
8
- * The version of the OpenAPI document: 0.24.1
8
+ * The version of the OpenAPI document: 0.27.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).