@teemill/pickfaces 0.15.0 → 0.15.2

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
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Pickfaces API
3
- * Manage Teemill Pickfaces. Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
3
+ * Use this API to access your pickfaces. You must have the warehouse module installed to access this API. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
4
4
  *
5
- * The version of the OpenAPI document: 0.15.0
5
+ * The version of the OpenAPI document: 0.15.2
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -606,23 +606,6 @@ export declare const PickfacesApiAxiosParamCreator: (configuration?: Configurati
606
606
  * @throws {RequiredError}
607
607
  */
608
608
  createPickface: (project: string, createPickfaceRequest: CreatePickfaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
609
- /**
610
- * Delete a Pickface
611
- * @summary Delete Pickface
612
- * @param {string} project What project it is
613
- * @param {string} pickfaceId Unique identifier of a pickface
614
- * @param {*} [options] Override http request option.
615
- * @throws {RequiredError}
616
- */
617
- deletePickface: (project: string, pickfaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
618
- /**
619
- * Export pickfaces as a CSV file
620
- * @summary Export pickfaces
621
- * @param {string} project What project it is
622
- * @param {*} [options] Override http request option.
623
- * @throws {RequiredError}
624
- */
625
- exportPickfaces: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
626
609
  /**
627
610
  * Get a pickface
628
611
  * @summary Get pickface
@@ -633,118 +616,17 @@ export declare const PickfacesApiAxiosParamCreator: (configuration?: Configurati
633
616
  */
634
617
  getPickface: (project: string, pickfaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
635
618
  /**
636
- * Lists pickface container models
637
- * @summary Get pickface container models
638
- * @param {string} project What project it is
639
- * @param {*} [options] Override http request option.
640
- * @throws {RequiredError}
641
- */
642
- getPickfaceContainerModels: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
643
- /**
644
- * Lists all pickfaces available paginated into chunks
619
+ * Lists all available pickfaces paginated into chunks
645
620
  * @summary List pickfaces
646
621
  * @param {string} project What project it is
647
622
  * @param {string} [search] Search term to filter based on pickface code
648
623
  * @param {number} [pageToken] Page reference token
649
624
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
650
- * @param {Array<GetPickfacesFiltersEnum>} [filters] Filters to apply to the request
651
- * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
652
- * @param {*} [options] Override http request option.
653
- * @throws {RequiredError}
654
- */
655
- getPickfaces: (project: string, search?: string, pageToken?: number, pageSize?: number, filters?: Array<GetPickfacesFiltersEnum>, sortBy?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
656
- /**
657
- * Issue an empty pickface
658
- * @summary Issue empty pickface
659
- * @param {string} project What project it is
660
- * @param {string} pickfaceId Unique identifier of a pickface
661
- * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
662
- * @param {*} [options] Override http request option.
663
- * @throws {RequiredError}
664
- */
665
- issueEmptyPickface: (project: string, pickfaceId: string, issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
666
- /**
667
- * Issue a pickface with wrong contents
668
- * @summary Issue wrong contents pickface
669
- * @param {string} project What project it is
670
- * @param {string} pickfaceId Unique identifier of a pickface
671
- * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
672
- * @param {*} [options] Override http request option.
673
- * @throws {RequiredError}
674
- */
675
- issueWrongContentsPickface: (project: string, pickfaceId: string, issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
676
- /**
677
- * Get a list of pickface logs
678
- * @summary Get pickface logs
679
- * @param {string} project What project it is
680
- * @param {string} pickfaceId Unique identifier of a pickface
681
- * @param {number} [pageToken] Page reference token
682
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
683
- * @param {*} [options] Override http request option.
684
- * @throws {RequiredError}
685
- */
686
- listPickfaceLogs: (project: string, pickfaceId: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
687
- /**
688
- * Move stock from one pickface to another in a single transaction
689
- * @summary Move stock
690
- * @param {string} project What project it is
691
- * @param {string} pickfaceId Unique identifier of a pickface
692
- * @param {MoveStockRequest} moveStockRequest Move stock from one pickface to another
693
- * @param {*} [options] Override http request option.
694
- * @throws {RequiredError}
695
- */
696
- moveStock: (project: string, pickfaceId: string, moveStockRequest: MoveStockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
697
- /**
698
- * Print a pickface label
699
- * @summary Print pickface label
700
- * @param {string} project What project it is
701
- * @param {string} pickfaceId Unique identifier of a pickface
702
- * @param {string} deviceRef Unique identifier of a warehouse device
703
- * @param {*} [options] Override http request option.
704
- * @throws {RequiredError}
705
- */
706
- printPickfaceLabel: (project: string, pickfaceId: string, deviceRef: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
707
- /**
708
- * Print pickface labels
709
- * @summary Print pickface Labels
710
- * @param {string} project What project it is
711
- * @param {string} deviceRef Unique identifier of a warehouse device
712
- * @param {Array<string>} ids List of pickface ids
713
- * @param {*} [options] Override http request option.
714
- * @throws {RequiredError}
715
- */
716
- printPickfaceLabels: (project: string, deviceRef: string, ids: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
717
- /**
718
- * Resolves an issue on a pickface
719
- * @summary Resolve pickface issue
720
- * @param {string} project What project it is
721
- * @param {string} pickfaceId Unique identifier of a pickface
722
- * @param {*} [options] Override http request option.
723
- * @throws {RequiredError}
724
- */
725
- resolvePickfaceIssue: (project: string, pickfaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
726
- /**
727
- * Suggest pickfaces for putting away stock
728
- * @summary Suggest pickfaces
729
- * @param {string} project What project it is
730
- * @param {string} variantRef Unique identifier of a warehouse variant
731
- * @param {number} quantity Number of variants
732
- * @param {number} [pageToken] Page reference token
733
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
734
- * @param {*} [options] Override http request option.
735
- * @throws {RequiredError}
736
- */
737
- suggestPickfaces: (project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
738
- /**
739
- * Update a Pickface
740
- * @summary Update Pickface
741
- * @param {string} project What project it is
742
- * @param {string} pickfaceId Unique identifier of a pickface
743
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
625
+ * @param {Array<GetPickfacesSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
744
626
  * @param {*} [options] Override http request option.
745
627
  * @throws {RequiredError}
746
628
  */
747
- updatePickface: (project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
629
+ getPickfaces: (project: string, search?: string, pageToken?: number, pageSize?: number, sortBy?: Array<GetPickfacesSortByEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
748
630
  };
749
631
  /**
750
632
  * PickfacesApi - functional programming interface
@@ -760,23 +642,6 @@ export declare const PickfacesApiFp: (configuration?: Configuration) => {
760
642
  * @throws {RequiredError}
761
643
  */
762
644
  createPickface(project: string, createPickfaceRequest: CreatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
763
- /**
764
- * Delete a Pickface
765
- * @summary Delete Pickface
766
- * @param {string} project What project it is
767
- * @param {string} pickfaceId Unique identifier of a pickface
768
- * @param {*} [options] Override http request option.
769
- * @throws {RequiredError}
770
- */
771
- deletePickface(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
772
- /**
773
- * Export pickfaces as a CSV file
774
- * @summary Export pickfaces
775
- * @param {string} project What project it is
776
- * @param {*} [options] Override http request option.
777
- * @throws {RequiredError}
778
- */
779
- exportPickfaces(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
780
645
  /**
781
646
  * Get a pickface
782
647
  * @summary Get pickface
@@ -787,118 +652,17 @@ export declare const PickfacesApiFp: (configuration?: Configuration) => {
787
652
  */
788
653
  getPickface(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
789
654
  /**
790
- * Lists pickface container models
791
- * @summary Get pickface container models
792
- * @param {string} project What project it is
793
- * @param {*} [options] Override http request option.
794
- * @throws {RequiredError}
795
- */
796
- getPickfaceContainerModels(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContainerModels>>;
797
- /**
798
- * Lists all pickfaces available paginated into chunks
655
+ * Lists all available pickfaces paginated into chunks
799
656
  * @summary List pickfaces
800
657
  * @param {string} project What project it is
801
658
  * @param {string} [search] Search term to filter based on pickface code
802
659
  * @param {number} [pageToken] Page reference token
803
660
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
804
- * @param {Array<GetPickfacesFiltersEnum>} [filters] Filters to apply to the request
805
- * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
806
- * @param {*} [options] Override http request option.
807
- * @throws {RequiredError}
808
- */
809
- getPickfaces(project: string, search?: string, pageToken?: number, pageSize?: number, filters?: Array<GetPickfacesFiltersEnum>, sortBy?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPickfaces200Response>>;
810
- /**
811
- * Issue an empty pickface
812
- * @summary Issue empty pickface
813
- * @param {string} project What project it is
814
- * @param {string} pickfaceId Unique identifier of a pickface
815
- * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
816
- * @param {*} [options] Override http request option.
817
- * @throws {RequiredError}
818
- */
819
- issueEmptyPickface(project: string, pickfaceId: string, issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
820
- /**
821
- * Issue a pickface with wrong contents
822
- * @summary Issue wrong contents pickface
823
- * @param {string} project What project it is
824
- * @param {string} pickfaceId Unique identifier of a pickface
825
- * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
826
- * @param {*} [options] Override http request option.
827
- * @throws {RequiredError}
828
- */
829
- issueWrongContentsPickface(project: string, pickfaceId: string, issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
830
- /**
831
- * Get a list of pickface logs
832
- * @summary Get pickface logs
833
- * @param {string} project What project it is
834
- * @param {string} pickfaceId Unique identifier of a pickface
835
- * @param {number} [pageToken] Page reference token
836
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
661
+ * @param {Array<GetPickfacesSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
837
662
  * @param {*} [options] Override http request option.
838
663
  * @throws {RequiredError}
839
664
  */
840
- listPickfaceLogs(project: string, pickfaceId: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaceLogs200Response>>;
841
- /**
842
- * Move stock from one pickface to another in a single transaction
843
- * @summary Move stock
844
- * @param {string} project What project it is
845
- * @param {string} pickfaceId Unique identifier of a pickface
846
- * @param {MoveStockRequest} moveStockRequest Move stock from one pickface to another
847
- * @param {*} [options] Override http request option.
848
- * @throws {RequiredError}
849
- */
850
- moveStock(project: string, pickfaceId: string, moveStockRequest: MoveStockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
851
- /**
852
- * Print a pickface label
853
- * @summary Print pickface label
854
- * @param {string} project What project it is
855
- * @param {string} pickfaceId Unique identifier of a pickface
856
- * @param {string} deviceRef Unique identifier of a warehouse device
857
- * @param {*} [options] Override http request option.
858
- * @throws {RequiredError}
859
- */
860
- printPickfaceLabel(project: string, pickfaceId: string, deviceRef: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
861
- /**
862
- * Print pickface labels
863
- * @summary Print pickface Labels
864
- * @param {string} project What project it is
865
- * @param {string} deviceRef Unique identifier of a warehouse device
866
- * @param {Array<string>} ids List of pickface ids
867
- * @param {*} [options] Override http request option.
868
- * @throws {RequiredError}
869
- */
870
- printPickfaceLabels(project: string, deviceRef: string, ids: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
871
- /**
872
- * Resolves an issue on a pickface
873
- * @summary Resolve pickface issue
874
- * @param {string} project What project it is
875
- * @param {string} pickfaceId Unique identifier of a pickface
876
- * @param {*} [options] Override http request option.
877
- * @throws {RequiredError}
878
- */
879
- resolvePickfaceIssue(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
880
- /**
881
- * Suggest pickfaces for putting away stock
882
- * @summary Suggest pickfaces
883
- * @param {string} project What project it is
884
- * @param {string} variantRef Unique identifier of a warehouse variant
885
- * @param {number} quantity Number of variants
886
- * @param {number} [pageToken] Page reference token
887
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
888
- * @param {*} [options] Override http request option.
889
- * @throws {RequiredError}
890
- */
891
- suggestPickfaces(project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPickfaces200Response>>;
892
- /**
893
- * Update a Pickface
894
- * @summary Update Pickface
895
- * @param {string} project What project it is
896
- * @param {string} pickfaceId Unique identifier of a pickface
897
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
898
- * @param {*} [options] Override http request option.
899
- * @throws {RequiredError}
900
- */
901
- updatePickface(project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
665
+ getPickfaces(project: string, search?: string, pageToken?: number, pageSize?: number, sortBy?: Array<GetPickfacesSortByEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPickfaces200Response>>;
902
666
  };
903
667
  /**
904
668
  * PickfacesApi - factory interface
@@ -913,22 +677,6 @@ export declare const PickfacesApiFactory: (configuration?: Configuration, basePa
913
677
  * @throws {RequiredError}
914
678
  */
915
679
  createPickface(requestParameters: PickfacesApiCreatePickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
916
- /**
917
- * Delete a Pickface
918
- * @summary Delete Pickface
919
- * @param {PickfacesApiDeletePickfaceRequest} requestParameters Request parameters.
920
- * @param {*} [options] Override http request option.
921
- * @throws {RequiredError}
922
- */
923
- deletePickface(requestParameters: PickfacesApiDeletePickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
924
- /**
925
- * Export pickfaces as a CSV file
926
- * @summary Export pickfaces
927
- * @param {PickfacesApiExportPickfacesRequest} requestParameters Request parameters.
928
- * @param {*} [options] Override http request option.
929
- * @throws {RequiredError}
930
- */
931
- exportPickfaces(requestParameters: PickfacesApiExportPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
932
680
  /**
933
681
  * Get a pickface
934
682
  * @summary Get pickface
@@ -938,93 +686,13 @@ export declare const PickfacesApiFactory: (configuration?: Configuration, basePa
938
686
  */
939
687
  getPickface(requestParameters: PickfacesApiGetPickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
940
688
  /**
941
- * Lists pickface container models
942
- * @summary Get pickface container models
943
- * @param {PickfacesApiGetPickfaceContainerModelsRequest} requestParameters Request parameters.
944
- * @param {*} [options] Override http request option.
945
- * @throws {RequiredError}
946
- */
947
- getPickfaceContainerModels(requestParameters: PickfacesApiGetPickfaceContainerModelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ContainerModels>;
948
- /**
949
- * Lists all pickfaces available paginated into chunks
689
+ * Lists all available pickfaces paginated into chunks
950
690
  * @summary List pickfaces
951
691
  * @param {PickfacesApiGetPickfacesRequest} requestParameters Request parameters.
952
692
  * @param {*} [options] Override http request option.
953
693
  * @throws {RequiredError}
954
694
  */
955
695
  getPickfaces(requestParameters: PickfacesApiGetPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPickfaces200Response>;
956
- /**
957
- * Issue an empty pickface
958
- * @summary Issue empty pickface
959
- * @param {PickfacesApiIssueEmptyPickfaceRequest} requestParameters Request parameters.
960
- * @param {*} [options] Override http request option.
961
- * @throws {RequiredError}
962
- */
963
- issueEmptyPickface(requestParameters: PickfacesApiIssueEmptyPickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
964
- /**
965
- * Issue a pickface with wrong contents
966
- * @summary Issue wrong contents pickface
967
- * @param {PickfacesApiIssueWrongContentsPickfaceRequest} requestParameters Request parameters.
968
- * @param {*} [options] Override http request option.
969
- * @throws {RequiredError}
970
- */
971
- issueWrongContentsPickface(requestParameters: PickfacesApiIssueWrongContentsPickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
972
- /**
973
- * Get a list of pickface logs
974
- * @summary Get pickface logs
975
- * @param {PickfacesApiListPickfaceLogsRequest} requestParameters Request parameters.
976
- * @param {*} [options] Override http request option.
977
- * @throws {RequiredError}
978
- */
979
- listPickfaceLogs(requestParameters: PickfacesApiListPickfaceLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaceLogs200Response>;
980
- /**
981
- * Move stock from one pickface to another in a single transaction
982
- * @summary Move stock
983
- * @param {PickfacesApiMoveStockRequest} requestParameters Request parameters.
984
- * @param {*} [options] Override http request option.
985
- * @throws {RequiredError}
986
- */
987
- moveStock(requestParameters: PickfacesApiMoveStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
988
- /**
989
- * Print a pickface label
990
- * @summary Print pickface label
991
- * @param {PickfacesApiPrintPickfaceLabelRequest} requestParameters Request parameters.
992
- * @param {*} [options] Override http request option.
993
- * @throws {RequiredError}
994
- */
995
- printPickfaceLabel(requestParameters: PickfacesApiPrintPickfaceLabelRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
996
- /**
997
- * Print pickface labels
998
- * @summary Print pickface Labels
999
- * @param {PickfacesApiPrintPickfaceLabelsRequest} requestParameters Request parameters.
1000
- * @param {*} [options] Override http request option.
1001
- * @throws {RequiredError}
1002
- */
1003
- printPickfaceLabels(requestParameters: PickfacesApiPrintPickfaceLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
1004
- /**
1005
- * Resolves an issue on a pickface
1006
- * @summary Resolve pickface issue
1007
- * @param {PickfacesApiResolvePickfaceIssueRequest} requestParameters Request parameters.
1008
- * @param {*} [options] Override http request option.
1009
- * @throws {RequiredError}
1010
- */
1011
- resolvePickfaceIssue(requestParameters: PickfacesApiResolvePickfaceIssueRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
1012
- /**
1013
- * Suggest pickfaces for putting away stock
1014
- * @summary Suggest pickfaces
1015
- * @param {PickfacesApiSuggestPickfacesRequest} requestParameters Request parameters.
1016
- * @param {*} [options] Override http request option.
1017
- * @throws {RequiredError}
1018
- */
1019
- suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPickfaces200Response>;
1020
- /**
1021
- * Update a Pickface
1022
- * @summary Update Pickface
1023
- * @param {PickfacesApiUpdatePickfaceRequest} requestParameters Request parameters.
1024
- * @param {*} [options] Override http request option.
1025
- * @throws {RequiredError}
1026
- */
1027
- updatePickface(requestParameters: PickfacesApiUpdatePickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
1028
696
  };
1029
697
  /**
1030
698
  * Request parameters for createPickface operation in PickfacesApi.
@@ -1045,38 +713,6 @@ export interface PickfacesApiCreatePickfaceRequest {
1045
713
  */
1046
714
  readonly createPickfaceRequest: CreatePickfaceRequest;
1047
715
  }
1048
- /**
1049
- * Request parameters for deletePickface operation in PickfacesApi.
1050
- * @export
1051
- * @interface PickfacesApiDeletePickfaceRequest
1052
- */
1053
- export interface PickfacesApiDeletePickfaceRequest {
1054
- /**
1055
- * What project it is
1056
- * @type {string}
1057
- * @memberof PickfacesApiDeletePickface
1058
- */
1059
- readonly project: string;
1060
- /**
1061
- * Unique identifier of a pickface
1062
- * @type {string}
1063
- * @memberof PickfacesApiDeletePickface
1064
- */
1065
- readonly pickfaceId: string;
1066
- }
1067
- /**
1068
- * Request parameters for exportPickfaces operation in PickfacesApi.
1069
- * @export
1070
- * @interface PickfacesApiExportPickfacesRequest
1071
- */
1072
- export interface PickfacesApiExportPickfacesRequest {
1073
- /**
1074
- * What project it is
1075
- * @type {string}
1076
- * @memberof PickfacesApiExportPickfaces
1077
- */
1078
- readonly project: string;
1079
- }
1080
716
  /**
1081
717
  * Request parameters for getPickface operation in PickfacesApi.
1082
718
  * @export
@@ -1096,19 +732,6 @@ export interface PickfacesApiGetPickfaceRequest {
1096
732
  */
1097
733
  readonly pickfaceId: string;
1098
734
  }
1099
- /**
1100
- * Request parameters for getPickfaceContainerModels operation in PickfacesApi.
1101
- * @export
1102
- * @interface PickfacesApiGetPickfaceContainerModelsRequest
1103
- */
1104
- export interface PickfacesApiGetPickfaceContainerModelsRequest {
1105
- /**
1106
- * What project it is
1107
- * @type {string}
1108
- * @memberof PickfacesApiGetPickfaceContainerModels
1109
- */
1110
- readonly project: string;
1111
- }
1112
735
  /**
1113
736
  * Request parameters for getPickfaces operation in PickfacesApi.
1114
737
  * @export
@@ -1139,255 +762,12 @@ export interface PickfacesApiGetPickfacesRequest {
1139
762
  * @memberof PickfacesApiGetPickfaces
1140
763
  */
1141
764
  readonly pageSize?: number;
1142
- /**
1143
- * Filters to apply to the request
1144
- * @type {Array<'empty' | 'flagged'>}
1145
- * @memberof PickfacesApiGetPickfaces
1146
- */
1147
- readonly filters?: Array<GetPickfacesFiltersEnum>;
1148
765
  /**
1149
766
  * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1150
- * @type {Array<string>}
767
+ * @type {Array<'+available' | '-available' | '+wip' | '-wip' | '+total' | '-total' | '+fullness' | '-fullness' | '+restocked' | '-restocked' | '+picked' | '-picked'>}
1151
768
  * @memberof PickfacesApiGetPickfaces
1152
769
  */
1153
- readonly sortBy?: Array<string>;
1154
- }
1155
- /**
1156
- * Request parameters for issueEmptyPickface operation in PickfacesApi.
1157
- * @export
1158
- * @interface PickfacesApiIssueEmptyPickfaceRequest
1159
- */
1160
- export interface PickfacesApiIssueEmptyPickfaceRequest {
1161
- /**
1162
- * What project it is
1163
- * @type {string}
1164
- * @memberof PickfacesApiIssueEmptyPickface
1165
- */
1166
- readonly project: string;
1167
- /**
1168
- * Unique identifier of a pickface
1169
- * @type {string}
1170
- * @memberof PickfacesApiIssueEmptyPickface
1171
- */
1172
- readonly pickfaceId: string;
1173
- /**
1174
- * pickface issue schema
1175
- * @type {IssueEmptyPickfaceRequest}
1176
- * @memberof PickfacesApiIssueEmptyPickface
1177
- */
1178
- readonly issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest;
1179
- }
1180
- /**
1181
- * Request parameters for issueWrongContentsPickface operation in PickfacesApi.
1182
- * @export
1183
- * @interface PickfacesApiIssueWrongContentsPickfaceRequest
1184
- */
1185
- export interface PickfacesApiIssueWrongContentsPickfaceRequest {
1186
- /**
1187
- * What project it is
1188
- * @type {string}
1189
- * @memberof PickfacesApiIssueWrongContentsPickface
1190
- */
1191
- readonly project: string;
1192
- /**
1193
- * Unique identifier of a pickface
1194
- * @type {string}
1195
- * @memberof PickfacesApiIssueWrongContentsPickface
1196
- */
1197
- readonly pickfaceId: string;
1198
- /**
1199
- * pickface issue schema
1200
- * @type {IssueWrongContentsPickfaceRequest}
1201
- * @memberof PickfacesApiIssueWrongContentsPickface
1202
- */
1203
- readonly issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest;
1204
- }
1205
- /**
1206
- * Request parameters for listPickfaceLogs operation in PickfacesApi.
1207
- * @export
1208
- * @interface PickfacesApiListPickfaceLogsRequest
1209
- */
1210
- export interface PickfacesApiListPickfaceLogsRequest {
1211
- /**
1212
- * What project it is
1213
- * @type {string}
1214
- * @memberof PickfacesApiListPickfaceLogs
1215
- */
1216
- readonly project: string;
1217
- /**
1218
- * Unique identifier of a pickface
1219
- * @type {string}
1220
- * @memberof PickfacesApiListPickfaceLogs
1221
- */
1222
- readonly pickfaceId: string;
1223
- /**
1224
- * Page reference token
1225
- * @type {number}
1226
- * @memberof PickfacesApiListPickfaceLogs
1227
- */
1228
- readonly pageToken?: number;
1229
- /**
1230
- * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1231
- * @type {number}
1232
- * @memberof PickfacesApiListPickfaceLogs
1233
- */
1234
- readonly pageSize?: number;
1235
- }
1236
- /**
1237
- * Request parameters for moveStock operation in PickfacesApi.
1238
- * @export
1239
- * @interface PickfacesApiMoveStockRequest
1240
- */
1241
- export interface PickfacesApiMoveStockRequest {
1242
- /**
1243
- * What project it is
1244
- * @type {string}
1245
- * @memberof PickfacesApiMoveStock
1246
- */
1247
- readonly project: string;
1248
- /**
1249
- * Unique identifier of a pickface
1250
- * @type {string}
1251
- * @memberof PickfacesApiMoveStock
1252
- */
1253
- readonly pickfaceId: string;
1254
- /**
1255
- * Move stock from one pickface to another
1256
- * @type {MoveStockRequest}
1257
- * @memberof PickfacesApiMoveStock
1258
- */
1259
- readonly moveStockRequest: MoveStockRequest;
1260
- }
1261
- /**
1262
- * Request parameters for printPickfaceLabel operation in PickfacesApi.
1263
- * @export
1264
- * @interface PickfacesApiPrintPickfaceLabelRequest
1265
- */
1266
- export interface PickfacesApiPrintPickfaceLabelRequest {
1267
- /**
1268
- * What project it is
1269
- * @type {string}
1270
- * @memberof PickfacesApiPrintPickfaceLabel
1271
- */
1272
- readonly project: string;
1273
- /**
1274
- * Unique identifier of a pickface
1275
- * @type {string}
1276
- * @memberof PickfacesApiPrintPickfaceLabel
1277
- */
1278
- readonly pickfaceId: string;
1279
- /**
1280
- * Unique identifier of a warehouse device
1281
- * @type {string}
1282
- * @memberof PickfacesApiPrintPickfaceLabel
1283
- */
1284
- readonly deviceRef: string;
1285
- }
1286
- /**
1287
- * Request parameters for printPickfaceLabels operation in PickfacesApi.
1288
- * @export
1289
- * @interface PickfacesApiPrintPickfaceLabelsRequest
1290
- */
1291
- export interface PickfacesApiPrintPickfaceLabelsRequest {
1292
- /**
1293
- * What project it is
1294
- * @type {string}
1295
- * @memberof PickfacesApiPrintPickfaceLabels
1296
- */
1297
- readonly project: string;
1298
- /**
1299
- * Unique identifier of a warehouse device
1300
- * @type {string}
1301
- * @memberof PickfacesApiPrintPickfaceLabels
1302
- */
1303
- readonly deviceRef: string;
1304
- /**
1305
- * List of pickface ids
1306
- * @type {Array<string>}
1307
- * @memberof PickfacesApiPrintPickfaceLabels
1308
- */
1309
- readonly ids: Array<string>;
1310
- }
1311
- /**
1312
- * Request parameters for resolvePickfaceIssue operation in PickfacesApi.
1313
- * @export
1314
- * @interface PickfacesApiResolvePickfaceIssueRequest
1315
- */
1316
- export interface PickfacesApiResolvePickfaceIssueRequest {
1317
- /**
1318
- * What project it is
1319
- * @type {string}
1320
- * @memberof PickfacesApiResolvePickfaceIssue
1321
- */
1322
- readonly project: string;
1323
- /**
1324
- * Unique identifier of a pickface
1325
- * @type {string}
1326
- * @memberof PickfacesApiResolvePickfaceIssue
1327
- */
1328
- readonly pickfaceId: string;
1329
- }
1330
- /**
1331
- * Request parameters for suggestPickfaces operation in PickfacesApi.
1332
- * @export
1333
- * @interface PickfacesApiSuggestPickfacesRequest
1334
- */
1335
- export interface PickfacesApiSuggestPickfacesRequest {
1336
- /**
1337
- * What project it is
1338
- * @type {string}
1339
- * @memberof PickfacesApiSuggestPickfaces
1340
- */
1341
- readonly project: string;
1342
- /**
1343
- * Unique identifier of a warehouse variant
1344
- * @type {string}
1345
- * @memberof PickfacesApiSuggestPickfaces
1346
- */
1347
- readonly variantRef: string;
1348
- /**
1349
- * Number of variants
1350
- * @type {number}
1351
- * @memberof PickfacesApiSuggestPickfaces
1352
- */
1353
- readonly quantity: number;
1354
- /**
1355
- * Page reference token
1356
- * @type {number}
1357
- * @memberof PickfacesApiSuggestPickfaces
1358
- */
1359
- readonly pageToken?: number;
1360
- /**
1361
- * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1362
- * @type {number}
1363
- * @memberof PickfacesApiSuggestPickfaces
1364
- */
1365
- readonly pageSize?: number;
1366
- }
1367
- /**
1368
- * Request parameters for updatePickface operation in PickfacesApi.
1369
- * @export
1370
- * @interface PickfacesApiUpdatePickfaceRequest
1371
- */
1372
- export interface PickfacesApiUpdatePickfaceRequest {
1373
- /**
1374
- * What project it is
1375
- * @type {string}
1376
- * @memberof PickfacesApiUpdatePickface
1377
- */
1378
- readonly project: string;
1379
- /**
1380
- * Unique identifier of a pickface
1381
- * @type {string}
1382
- * @memberof PickfacesApiUpdatePickface
1383
- */
1384
- readonly pickfaceId: string;
1385
- /**
1386
- * Update pickface schema
1387
- * @type {UpdatePickfaceRequest}
1388
- * @memberof PickfacesApiUpdatePickface
1389
- */
1390
- readonly updatePickfaceRequest: UpdatePickfaceRequest;
770
+ readonly sortBy?: Array<GetPickfacesSortByEnum>;
1391
771
  }
1392
772
  /**
1393
773
  * PickfacesApi - object-oriented interface
@@ -1405,24 +785,6 @@ export declare class PickfacesApi extends BaseAPI {
1405
785
  * @memberof PickfacesApi
1406
786
  */
1407
787
  createPickface(requestParameters: PickfacesApiCreatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1408
- /**
1409
- * Delete a Pickface
1410
- * @summary Delete Pickface
1411
- * @param {PickfacesApiDeletePickfaceRequest} requestParameters Request parameters.
1412
- * @param {*} [options] Override http request option.
1413
- * @throws {RequiredError}
1414
- * @memberof PickfacesApi
1415
- */
1416
- deletePickface(requestParameters: PickfacesApiDeletePickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1417
- /**
1418
- * Export pickfaces as a CSV file
1419
- * @summary Export pickfaces
1420
- * @param {PickfacesApiExportPickfacesRequest} requestParameters Request parameters.
1421
- * @param {*} [options] Override http request option.
1422
- * @throws {RequiredError}
1423
- * @memberof PickfacesApi
1424
- */
1425
- exportPickfaces(requestParameters: PickfacesApiExportPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
1426
788
  /**
1427
789
  * Get a pickface
1428
790
  * @summary Get pickface
@@ -1433,16 +795,7 @@ export declare class PickfacesApi extends BaseAPI {
1433
795
  */
1434
796
  getPickface(requestParameters: PickfacesApiGetPickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1435
797
  /**
1436
- * Lists pickface container models
1437
- * @summary Get pickface container models
1438
- * @param {PickfacesApiGetPickfaceContainerModelsRequest} requestParameters Request parameters.
1439
- * @param {*} [options] Override http request option.
1440
- * @throws {RequiredError}
1441
- * @memberof PickfacesApi
1442
- */
1443
- getPickfaceContainerModels(requestParameters: PickfacesApiGetPickfaceContainerModelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ContainerModels, any>>;
1444
- /**
1445
- * Lists all pickfaces available paginated into chunks
798
+ * Lists all available pickfaces paginated into chunks
1446
799
  * @summary List pickfaces
1447
800
  * @param {PickfacesApiGetPickfacesRequest} requestParameters Request parameters.
1448
801
  * @param {*} [options] Override http request option.
@@ -1450,93 +803,22 @@ export declare class PickfacesApi extends BaseAPI {
1450
803
  * @memberof PickfacesApi
1451
804
  */
1452
805
  getPickfaces(requestParameters: PickfacesApiGetPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPickfaces200Response, any>>;
1453
- /**
1454
- * Issue an empty pickface
1455
- * @summary Issue empty pickface
1456
- * @param {PickfacesApiIssueEmptyPickfaceRequest} requestParameters Request parameters.
1457
- * @param {*} [options] Override http request option.
1458
- * @throws {RequiredError}
1459
- * @memberof PickfacesApi
1460
- */
1461
- issueEmptyPickface(requestParameters: PickfacesApiIssueEmptyPickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1462
- /**
1463
- * Issue a pickface with wrong contents
1464
- * @summary Issue wrong contents pickface
1465
- * @param {PickfacesApiIssueWrongContentsPickfaceRequest} requestParameters Request parameters.
1466
- * @param {*} [options] Override http request option.
1467
- * @throws {RequiredError}
1468
- * @memberof PickfacesApi
1469
- */
1470
- issueWrongContentsPickface(requestParameters: PickfacesApiIssueWrongContentsPickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1471
- /**
1472
- * Get a list of pickface logs
1473
- * @summary Get pickface logs
1474
- * @param {PickfacesApiListPickfaceLogsRequest} requestParameters Request parameters.
1475
- * @param {*} [options] Override http request option.
1476
- * @throws {RequiredError}
1477
- * @memberof PickfacesApi
1478
- */
1479
- listPickfaceLogs(requestParameters: PickfacesApiListPickfaceLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPickfaceLogs200Response, any>>;
1480
- /**
1481
- * Move stock from one pickface to another in a single transaction
1482
- * @summary Move stock
1483
- * @param {PickfacesApiMoveStockRequest} requestParameters Request parameters.
1484
- * @param {*} [options] Override http request option.
1485
- * @throws {RequiredError}
1486
- * @memberof PickfacesApi
1487
- */
1488
- moveStock(requestParameters: PickfacesApiMoveStockRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1489
- /**
1490
- * Print a pickface label
1491
- * @summary Print pickface label
1492
- * @param {PickfacesApiPrintPickfaceLabelRequest} requestParameters Request parameters.
1493
- * @param {*} [options] Override http request option.
1494
- * @throws {RequiredError}
1495
- * @memberof PickfacesApi
1496
- */
1497
- printPickfaceLabel(requestParameters: PickfacesApiPrintPickfaceLabelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1498
- /**
1499
- * Print pickface labels
1500
- * @summary Print pickface Labels
1501
- * @param {PickfacesApiPrintPickfaceLabelsRequest} requestParameters Request parameters.
1502
- * @param {*} [options] Override http request option.
1503
- * @throws {RequiredError}
1504
- * @memberof PickfacesApi
1505
- */
1506
- printPickfaceLabels(requestParameters: PickfacesApiPrintPickfaceLabelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1507
- /**
1508
- * Resolves an issue on a pickface
1509
- * @summary Resolve pickface issue
1510
- * @param {PickfacesApiResolvePickfaceIssueRequest} requestParameters Request parameters.
1511
- * @param {*} [options] Override http request option.
1512
- * @throws {RequiredError}
1513
- * @memberof PickfacesApi
1514
- */
1515
- resolvePickfaceIssue(requestParameters: PickfacesApiResolvePickfaceIssueRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1516
- /**
1517
- * Suggest pickfaces for putting away stock
1518
- * @summary Suggest pickfaces
1519
- * @param {PickfacesApiSuggestPickfacesRequest} requestParameters Request parameters.
1520
- * @param {*} [options] Override http request option.
1521
- * @throws {RequiredError}
1522
- * @memberof PickfacesApi
1523
- */
1524
- suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPickfaces200Response, any>>;
1525
- /**
1526
- * Update a Pickface
1527
- * @summary Update Pickface
1528
- * @param {PickfacesApiUpdatePickfaceRequest} requestParameters Request parameters.
1529
- * @param {*} [options] Override http request option.
1530
- * @throws {RequiredError}
1531
- * @memberof PickfacesApi
1532
- */
1533
- updatePickface(requestParameters: PickfacesApiUpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
1534
806
  }
1535
807
  /**
1536
808
  * @export
1537
809
  */
1538
- export declare const GetPickfacesFiltersEnum: {
1539
- readonly Empty: "empty";
1540
- readonly Flagged: "flagged";
810
+ export declare const GetPickfacesSortByEnum: {
811
+ readonly Available: "+available";
812
+ readonly Available2: "-available";
813
+ readonly Wip: "+wip";
814
+ readonly Wip2: "-wip";
815
+ readonly Total: "+total";
816
+ readonly Total2: "-total";
817
+ readonly Fullness: "+fullness";
818
+ readonly Fullness2: "-fullness";
819
+ readonly Restocked: "+restocked";
820
+ readonly Restocked2: "-restocked";
821
+ readonly Picked: "+picked";
822
+ readonly Picked2: "-picked";
1541
823
  };
1542
- export type GetPickfacesFiltersEnum = typeof GetPickfacesFiltersEnum[keyof typeof GetPickfacesFiltersEnum];
824
+ export type GetPickfacesSortByEnum = typeof GetPickfacesSortByEnum[keyof typeof GetPickfacesSortByEnum];