@teemill/pickfaces 0.15.1 → 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/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Pickfaces API
5
5
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
6
  *
7
- * The version of the OpenAPI document: 0.15.1
7
+ * The version of the OpenAPI document: 0.15.2
8
8
  * Contact: hello@teemill.com
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -662,98 +662,6 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
662
662
  options: localVarRequestOptions,
663
663
  };
664
664
  },
665
- /**
666
- * Delete a Pickface
667
- * @summary Delete Pickface
668
- * @param {string} project What project it is
669
- * @param {string} pickfaceId Unique identifier of a pickface
670
- * @param {*} [options] Override http request option.
671
- * @throws {RequiredError}
672
- */
673
- deletePickface: async (project: string, pickfaceId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
674
- // verify required parameter 'project' is not null or undefined
675
- assertParamExists('deletePickface', 'project', project)
676
- // verify required parameter 'pickfaceId' is not null or undefined
677
- assertParamExists('deletePickface', 'pickfaceId', pickfaceId)
678
- const localVarPath = `/v1/pickfaces/{pickfaceId}`
679
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
680
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
681
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
682
- let baseOptions;
683
- if (configuration) {
684
- baseOptions = configuration.baseOptions;
685
- }
686
-
687
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
688
- const localVarHeaderParameter = {} as any;
689
- const localVarQueryParameter = {} as any;
690
-
691
- // authentication session-oauth required
692
- // oauth required
693
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
694
-
695
- // authentication api-key required
696
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
697
-
698
- if (project !== undefined) {
699
- localVarQueryParameter['project'] = project;
700
- }
701
-
702
-
703
-
704
- setSearchParams(localVarUrlObj, localVarQueryParameter);
705
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
706
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
707
-
708
- return {
709
- url: toPathString(localVarUrlObj),
710
- options: localVarRequestOptions,
711
- };
712
- },
713
- /**
714
- * Export pickfaces as a CSV file
715
- * @summary Export pickfaces
716
- * @param {string} project What project it is
717
- * @param {*} [options] Override http request option.
718
- * @throws {RequiredError}
719
- */
720
- exportPickfaces: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
721
- // verify required parameter 'project' is not null or undefined
722
- assertParamExists('exportPickfaces', 'project', project)
723
- const localVarPath = `/v1/pickfaces/export`;
724
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
725
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
726
- let baseOptions;
727
- if (configuration) {
728
- baseOptions = configuration.baseOptions;
729
- }
730
-
731
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
732
- const localVarHeaderParameter = {} as any;
733
- const localVarQueryParameter = {} as any;
734
-
735
- // authentication session-oauth required
736
- // oauth required
737
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
738
-
739
- // authentication api-key required
740
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
741
-
742
- if (project !== undefined) {
743
- localVarQueryParameter['project'] = project;
744
- }
745
-
746
-
747
-
748
- setSearchParams(localVarUrlObj, localVarQueryParameter);
749
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
750
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
751
-
752
- return {
753
- url: toPathString(localVarUrlObj),
754
- options: localVarRequestOptions,
755
- };
756
- },
757
665
  /**
758
666
  * Get a pickface
759
667
  * @summary Get pickface
@@ -793,50 +701,6 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
793
701
 
794
702
 
795
703
 
796
- setSearchParams(localVarUrlObj, localVarQueryParameter);
797
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
798
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
799
-
800
- return {
801
- url: toPathString(localVarUrlObj),
802
- options: localVarRequestOptions,
803
- };
804
- },
805
- /**
806
- * Lists pickface container models
807
- * @summary Get pickface container models
808
- * @param {string} project What project it is
809
- * @param {*} [options] Override http request option.
810
- * @throws {RequiredError}
811
- */
812
- getPickfaceContainerModels: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
813
- // verify required parameter 'project' is not null or undefined
814
- assertParamExists('getPickfaceContainerModels', 'project', project)
815
- const localVarPath = `/v1/pickfaces/container-models`;
816
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
817
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
818
- let baseOptions;
819
- if (configuration) {
820
- baseOptions = configuration.baseOptions;
821
- }
822
-
823
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
824
- const localVarHeaderParameter = {} as any;
825
- const localVarQueryParameter = {} as any;
826
-
827
- // authentication session-oauth required
828
- // oauth required
829
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
830
-
831
- // authentication api-key required
832
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
833
-
834
- if (project !== undefined) {
835
- localVarQueryParameter['project'] = project;
836
- }
837
-
838
-
839
-
840
704
  setSearchParams(localVarUrlObj, localVarQueryParameter);
841
705
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
842
706
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -910,1301 +774,186 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
910
774
  options: localVarRequestOptions,
911
775
  };
912
776
  },
777
+ }
778
+ };
779
+
780
+ /**
781
+ * PickfacesApi - functional programming interface
782
+ * @export
783
+ */
784
+ export const PickfacesApiFp = function(configuration?: Configuration) {
785
+ const localVarAxiosParamCreator = PickfacesApiAxiosParamCreator(configuration)
786
+ return {
913
787
  /**
914
- * Issue an empty pickface
915
- * @summary Issue empty pickface
788
+ * Create a Pickface
789
+ * @summary Create Pickface
916
790
  * @param {string} project What project it is
917
- * @param {string} pickfaceId Unique identifier of a pickface
918
- * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
791
+ * @param {CreatePickfaceRequest} createPickfaceRequest Create pickface schema
919
792
  * @param {*} [options] Override http request option.
920
793
  * @throws {RequiredError}
921
794
  */
922
- issueEmptyPickface: async (project: string, pickfaceId: string, issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
923
- // verify required parameter 'project' is not null or undefined
924
- assertParamExists('issueEmptyPickface', 'project', project)
925
- // verify required parameter 'pickfaceId' is not null or undefined
926
- assertParamExists('issueEmptyPickface', 'pickfaceId', pickfaceId)
927
- // verify required parameter 'issueEmptyPickfaceRequest' is not null or undefined
928
- assertParamExists('issueEmptyPickface', 'issueEmptyPickfaceRequest', issueEmptyPickfaceRequest)
929
- const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/empty`
930
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
931
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
932
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
933
- let baseOptions;
934
- if (configuration) {
935
- baseOptions = configuration.baseOptions;
936
- }
937
-
938
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
939
- const localVarHeaderParameter = {} as any;
940
- const localVarQueryParameter = {} as any;
941
-
942
- // authentication session-oauth required
943
- // oauth required
944
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
945
-
946
- // authentication api-key required
947
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
948
-
949
- if (project !== undefined) {
950
- localVarQueryParameter['project'] = project;
951
- }
952
-
953
-
954
-
955
- localVarHeaderParameter['Content-Type'] = 'application/json';
956
-
957
- setSearchParams(localVarUrlObj, localVarQueryParameter);
958
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
959
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
960
- localVarRequestOptions.data = serializeDataIfNeeded(issueEmptyPickfaceRequest, localVarRequestOptions, configuration)
961
-
962
- return {
963
- url: toPathString(localVarUrlObj),
964
- options: localVarRequestOptions,
965
- };
795
+ async createPickface(project: string, createPickfaceRequest: CreatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
796
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createPickface(project, createPickfaceRequest, options);
797
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
798
+ const localVarOperationServerBasePath = operationServerMap['PickfacesApi.createPickface']?.[localVarOperationServerIndex]?.url;
799
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
966
800
  },
967
801
  /**
968
- * Issue a pickface with wrong contents
969
- * @summary Issue wrong contents pickface
802
+ * Get a pickface
803
+ * @summary Get pickface
970
804
  * @param {string} project What project it is
971
805
  * @param {string} pickfaceId Unique identifier of a pickface
972
- * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
973
806
  * @param {*} [options] Override http request option.
974
807
  * @throws {RequiredError}
975
808
  */
976
- issueWrongContentsPickface: async (project: string, pickfaceId: string, issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
977
- // verify required parameter 'project' is not null or undefined
978
- assertParamExists('issueWrongContentsPickface', 'project', project)
979
- // verify required parameter 'pickfaceId' is not null or undefined
980
- assertParamExists('issueWrongContentsPickface', 'pickfaceId', pickfaceId)
981
- // verify required parameter 'issueWrongContentsPickfaceRequest' is not null or undefined
982
- assertParamExists('issueWrongContentsPickface', 'issueWrongContentsPickfaceRequest', issueWrongContentsPickfaceRequest)
983
- const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/wrong-contents`
984
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
985
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
986
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
987
- let baseOptions;
988
- if (configuration) {
989
- baseOptions = configuration.baseOptions;
990
- }
991
-
992
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
993
- const localVarHeaderParameter = {} as any;
994
- const localVarQueryParameter = {} as any;
995
-
996
- // authentication session-oauth required
997
- // oauth required
998
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
999
-
1000
- // authentication api-key required
1001
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1002
-
1003
- if (project !== undefined) {
1004
- localVarQueryParameter['project'] = project;
1005
- }
1006
-
1007
-
1008
-
1009
- localVarHeaderParameter['Content-Type'] = 'application/json';
1010
-
1011
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1012
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1013
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1014
- localVarRequestOptions.data = serializeDataIfNeeded(issueWrongContentsPickfaceRequest, localVarRequestOptions, configuration)
1015
-
1016
- return {
1017
- url: toPathString(localVarUrlObj),
1018
- options: localVarRequestOptions,
1019
- };
809
+ async getPickface(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
810
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPickface(project, pickfaceId, options);
811
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
812
+ const localVarOperationServerBasePath = operationServerMap['PickfacesApi.getPickface']?.[localVarOperationServerIndex]?.url;
813
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1020
814
  },
1021
815
  /**
1022
- * Get a list of pickface logs
1023
- * @summary Get pickface logs
816
+ * Lists all available pickfaces paginated into chunks
817
+ * @summary List pickfaces
1024
818
  * @param {string} project What project it is
1025
- * @param {string} pickfaceId Unique identifier of a pickface
819
+ * @param {string} [search] Search term to filter based on pickface code
1026
820
  * @param {number} [pageToken] Page reference token
1027
821
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
822
+ * @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.
1028
823
  * @param {*} [options] Override http request option.
1029
824
  * @throws {RequiredError}
1030
825
  */
1031
- listPickfaceLogs: async (project: string, pickfaceId: string, pageToken?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1032
- // verify required parameter 'project' is not null or undefined
1033
- assertParamExists('listPickfaceLogs', 'project', project)
1034
- // verify required parameter 'pickfaceId' is not null or undefined
1035
- assertParamExists('listPickfaceLogs', 'pickfaceId', pickfaceId)
1036
- const localVarPath = `/v1/pickfaces/{pickfaceId}/logs`
1037
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
1038
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1039
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1040
- let baseOptions;
1041
- if (configuration) {
1042
- baseOptions = configuration.baseOptions;
1043
- }
1044
-
1045
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1046
- const localVarHeaderParameter = {} as any;
1047
- const localVarQueryParameter = {} as any;
1048
-
1049
- // authentication session-oauth required
1050
- // oauth required
1051
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
1052
-
1053
- // authentication api-key required
1054
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1055
-
1056
- if (project !== undefined) {
1057
- localVarQueryParameter['project'] = project;
1058
- }
1059
-
1060
- if (pageToken !== undefined) {
1061
- localVarQueryParameter['pageToken'] = pageToken;
1062
- }
1063
-
1064
- if (pageSize !== undefined) {
1065
- localVarQueryParameter['pageSize'] = pageSize;
1066
- }
1067
-
1068
-
1069
-
1070
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1071
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1072
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1073
-
1074
- return {
1075
- url: toPathString(localVarUrlObj),
1076
- options: localVarRequestOptions,
1077
- };
1078
- },
1079
- /**
1080
- * Move stock from one pickface to another in a single transaction
1081
- * @summary Move stock
1082
- * @param {string} project What project it is
1083
- * @param {string} pickfaceId Unique identifier of a pickface
1084
- * @param {MoveStockRequest} moveStockRequest Move stock from one pickface to another
1085
- * @param {*} [options] Override http request option.
1086
- * @throws {RequiredError}
1087
- */
1088
- moveStock: async (project: string, pickfaceId: string, moveStockRequest: MoveStockRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1089
- // verify required parameter 'project' is not null or undefined
1090
- assertParamExists('moveStock', 'project', project)
1091
- // verify required parameter 'pickfaceId' is not null or undefined
1092
- assertParamExists('moveStock', 'pickfaceId', pickfaceId)
1093
- // verify required parameter 'moveStockRequest' is not null or undefined
1094
- assertParamExists('moveStock', 'moveStockRequest', moveStockRequest)
1095
- const localVarPath = `/v1/pickfaces/{pickfaceId}/stock/move`
1096
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
1097
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1098
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1099
- let baseOptions;
1100
- if (configuration) {
1101
- baseOptions = configuration.baseOptions;
1102
- }
1103
-
1104
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1105
- const localVarHeaderParameter = {} as any;
1106
- const localVarQueryParameter = {} as any;
1107
-
1108
- // authentication session-oauth required
1109
- // oauth required
1110
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
1111
-
1112
- // authentication api-key required
1113
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1114
-
1115
- if (project !== undefined) {
1116
- localVarQueryParameter['project'] = project;
1117
- }
1118
-
1119
-
1120
-
1121
- localVarHeaderParameter['Content-Type'] = 'application/json';
1122
-
1123
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1124
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1125
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1126
- localVarRequestOptions.data = serializeDataIfNeeded(moveStockRequest, localVarRequestOptions, configuration)
1127
-
1128
- return {
1129
- url: toPathString(localVarUrlObj),
1130
- options: localVarRequestOptions,
1131
- };
1132
- },
1133
- /**
1134
- * Print a pickface label
1135
- * @summary Print pickface label
1136
- * @param {string} project What project it is
1137
- * @param {string} pickfaceId Unique identifier of a pickface
1138
- * @param {string} deviceRef Unique identifier of a warehouse device
1139
- * @param {*} [options] Override http request option.
1140
- * @throws {RequiredError}
1141
- */
1142
- printPickfaceLabel: async (project: string, pickfaceId: string, deviceRef: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1143
- // verify required parameter 'project' is not null or undefined
1144
- assertParamExists('printPickfaceLabel', 'project', project)
1145
- // verify required parameter 'pickfaceId' is not null or undefined
1146
- assertParamExists('printPickfaceLabel', 'pickfaceId', pickfaceId)
1147
- // verify required parameter 'deviceRef' is not null or undefined
1148
- assertParamExists('printPickfaceLabel', 'deviceRef', deviceRef)
1149
- const localVarPath = `/v1/pickfaces/{pickfaceId}/print`
1150
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
1151
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1152
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1153
- let baseOptions;
1154
- if (configuration) {
1155
- baseOptions = configuration.baseOptions;
1156
- }
1157
-
1158
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1159
- const localVarHeaderParameter = {} as any;
1160
- const localVarQueryParameter = {} as any;
1161
-
1162
- // authentication session-oauth required
1163
- // oauth required
1164
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
1165
-
1166
- // authentication api-key required
1167
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1168
-
1169
- if (project !== undefined) {
1170
- localVarQueryParameter['project'] = project;
1171
- }
1172
-
1173
- if (deviceRef !== undefined) {
1174
- localVarQueryParameter['deviceRef'] = deviceRef;
1175
- }
1176
-
1177
-
1178
-
1179
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1180
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1181
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1182
-
1183
- return {
1184
- url: toPathString(localVarUrlObj),
1185
- options: localVarRequestOptions,
1186
- };
1187
- },
1188
- /**
1189
- * Print pickface labels
1190
- * @summary Print pickface Labels
1191
- * @param {string} project What project it is
1192
- * @param {string} deviceRef Unique identifier of a warehouse device
1193
- * @param {Array<string>} ids List of pickface ids
1194
- * @param {*} [options] Override http request option.
1195
- * @throws {RequiredError}
1196
- */
1197
- printPickfaceLabels: async (project: string, deviceRef: string, ids: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1198
- // verify required parameter 'project' is not null or undefined
1199
- assertParamExists('printPickfaceLabels', 'project', project)
1200
- // verify required parameter 'deviceRef' is not null or undefined
1201
- assertParamExists('printPickfaceLabels', 'deviceRef', deviceRef)
1202
- // verify required parameter 'ids' is not null or undefined
1203
- assertParamExists('printPickfaceLabels', 'ids', ids)
1204
- const localVarPath = `/v1/pickfaces/print`;
1205
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1206
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1207
- let baseOptions;
1208
- if (configuration) {
1209
- baseOptions = configuration.baseOptions;
1210
- }
1211
-
1212
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1213
- const localVarHeaderParameter = {} as any;
1214
- const localVarQueryParameter = {} as any;
1215
-
1216
- // authentication session-oauth required
1217
- // oauth required
1218
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
1219
-
1220
- // authentication api-key required
1221
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1222
-
1223
- if (project !== undefined) {
1224
- localVarQueryParameter['project'] = project;
1225
- }
1226
-
1227
- if (deviceRef !== undefined) {
1228
- localVarQueryParameter['deviceRef'] = deviceRef;
1229
- }
1230
-
1231
- if (ids) {
1232
- localVarQueryParameter['ids'] = ids;
1233
- }
1234
-
1235
-
1236
-
1237
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1238
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1239
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1240
-
1241
- return {
1242
- url: toPathString(localVarUrlObj),
1243
- options: localVarRequestOptions,
1244
- };
1245
- },
1246
- /**
1247
- * Resolves an issue on a pickface
1248
- * @summary Resolve pickface issue
1249
- * @param {string} project What project it is
1250
- * @param {string} pickfaceId Unique identifier of a pickface
1251
- * @param {*} [options] Override http request option.
1252
- * @throws {RequiredError}
1253
- */
1254
- resolvePickfaceIssue: async (project: string, pickfaceId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1255
- // verify required parameter 'project' is not null or undefined
1256
- assertParamExists('resolvePickfaceIssue', 'project', project)
1257
- // verify required parameter 'pickfaceId' is not null or undefined
1258
- assertParamExists('resolvePickfaceIssue', 'pickfaceId', pickfaceId)
1259
- const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/resolve`
1260
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
1261
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1262
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1263
- let baseOptions;
1264
- if (configuration) {
1265
- baseOptions = configuration.baseOptions;
1266
- }
1267
-
1268
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1269
- const localVarHeaderParameter = {} as any;
1270
- const localVarQueryParameter = {} as any;
1271
-
1272
- // authentication session-oauth required
1273
- // oauth required
1274
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
1275
-
1276
- // authentication api-key required
1277
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1278
-
1279
- if (project !== undefined) {
1280
- localVarQueryParameter['project'] = project;
1281
- }
1282
-
1283
-
1284
-
1285
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1286
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1287
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1288
-
1289
- return {
1290
- url: toPathString(localVarUrlObj),
1291
- options: localVarRequestOptions,
1292
- };
1293
- },
1294
- /**
1295
- * Suggest pickfaces for putting away stock
1296
- * @summary Suggest pickfaces
1297
- * @param {string} project What project it is
1298
- * @param {string} variantRef Unique identifier of a warehouse variant
1299
- * @param {number} quantity Number of variants
1300
- * @param {number} [pageToken] Page reference token
1301
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1302
- * @param {*} [options] Override http request option.
1303
- * @throws {RequiredError}
1304
- */
1305
- suggestPickfaces: async (project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1306
- // verify required parameter 'project' is not null or undefined
1307
- assertParamExists('suggestPickfaces', 'project', project)
1308
- // verify required parameter 'variantRef' is not null or undefined
1309
- assertParamExists('suggestPickfaces', 'variantRef', variantRef)
1310
- // verify required parameter 'quantity' is not null or undefined
1311
- assertParamExists('suggestPickfaces', 'quantity', quantity)
1312
- const localVarPath = `/v1/pickfaces/suggest`;
1313
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1314
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1315
- let baseOptions;
1316
- if (configuration) {
1317
- baseOptions = configuration.baseOptions;
1318
- }
1319
-
1320
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1321
- const localVarHeaderParameter = {} as any;
1322
- const localVarQueryParameter = {} as any;
1323
-
1324
- // authentication session-oauth required
1325
- // oauth required
1326
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
1327
-
1328
- // authentication api-key required
1329
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1330
-
1331
- if (project !== undefined) {
1332
- localVarQueryParameter['project'] = project;
1333
- }
1334
-
1335
- if (variantRef !== undefined) {
1336
- localVarQueryParameter['variantRef'] = variantRef;
1337
- }
1338
-
1339
- if (quantity !== undefined) {
1340
- localVarQueryParameter['quantity'] = quantity;
1341
- }
1342
-
1343
- if (pageToken !== undefined) {
1344
- localVarQueryParameter['pageToken'] = pageToken;
1345
- }
1346
-
1347
- if (pageSize !== undefined) {
1348
- localVarQueryParameter['pageSize'] = pageSize;
1349
- }
1350
-
1351
-
1352
-
1353
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1354
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1355
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1356
-
1357
- return {
1358
- url: toPathString(localVarUrlObj),
1359
- options: localVarRequestOptions,
1360
- };
1361
- },
1362
- /**
1363
- * Update a Pickface
1364
- * @summary Update Pickface
1365
- * @param {string} project What project it is
1366
- * @param {string} pickfaceId Unique identifier of a pickface
1367
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
1368
- * @param {*} [options] Override http request option.
1369
- * @throws {RequiredError}
1370
- */
1371
- updatePickface: async (project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1372
- // verify required parameter 'project' is not null or undefined
1373
- assertParamExists('updatePickface', 'project', project)
1374
- // verify required parameter 'pickfaceId' is not null or undefined
1375
- assertParamExists('updatePickface', 'pickfaceId', pickfaceId)
1376
- // verify required parameter 'updatePickfaceRequest' is not null or undefined
1377
- assertParamExists('updatePickface', 'updatePickfaceRequest', updatePickfaceRequest)
1378
- const localVarPath = `/v1/pickfaces/{pickfaceId}`
1379
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
1380
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1381
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1382
- let baseOptions;
1383
- if (configuration) {
1384
- baseOptions = configuration.baseOptions;
1385
- }
1386
-
1387
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
1388
- const localVarHeaderParameter = {} as any;
1389
- const localVarQueryParameter = {} as any;
1390
-
1391
- // authentication session-oauth required
1392
- // oauth required
1393
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
1394
-
1395
- // authentication api-key required
1396
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1397
-
1398
- if (project !== undefined) {
1399
- localVarQueryParameter['project'] = project;
1400
- }
1401
-
1402
-
1403
-
1404
- localVarHeaderParameter['Content-Type'] = 'application/json';
1405
-
1406
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1407
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1408
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1409
- localVarRequestOptions.data = serializeDataIfNeeded(updatePickfaceRequest, localVarRequestOptions, configuration)
1410
-
1411
- return {
1412
- url: toPathString(localVarUrlObj),
1413
- options: localVarRequestOptions,
1414
- };
1415
- },
1416
- }
1417
- };
1418
-
1419
- /**
1420
- * PickfacesApi - functional programming interface
1421
- * @export
1422
- */
1423
- export const PickfacesApiFp = function(configuration?: Configuration) {
1424
- const localVarAxiosParamCreator = PickfacesApiAxiosParamCreator(configuration)
1425
- return {
1426
- /**
1427
- * Create a Pickface
1428
- * @summary Create Pickface
1429
- * @param {string} project What project it is
1430
- * @param {CreatePickfaceRequest} createPickfaceRequest Create pickface schema
1431
- * @param {*} [options] Override http request option.
1432
- * @throws {RequiredError}
1433
- */
1434
- async createPickface(project: string, createPickfaceRequest: CreatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
1435
- const localVarAxiosArgs = await localVarAxiosParamCreator.createPickface(project, createPickfaceRequest, options);
1436
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1437
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.createPickface']?.[localVarOperationServerIndex]?.url;
1438
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1439
- },
1440
- /**
1441
- * Delete a Pickface
1442
- * @summary Delete Pickface
1443
- * @param {string} project What project it is
1444
- * @param {string} pickfaceId Unique identifier of a pickface
1445
- * @param {*} [options] Override http request option.
1446
- * @throws {RequiredError}
1447
- */
1448
- async deletePickface(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
1449
- const localVarAxiosArgs = await localVarAxiosParamCreator.deletePickface(project, pickfaceId, options);
1450
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1451
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.deletePickface']?.[localVarOperationServerIndex]?.url;
1452
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1453
- },
1454
- /**
1455
- * Export pickfaces as a CSV file
1456
- * @summary Export pickfaces
1457
- * @param {string} project What project it is
1458
- * @param {*} [options] Override http request option.
1459
- * @throws {RequiredError}
1460
- */
1461
- async exportPickfaces(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
1462
- const localVarAxiosArgs = await localVarAxiosParamCreator.exportPickfaces(project, options);
1463
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1464
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.exportPickfaces']?.[localVarOperationServerIndex]?.url;
1465
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1466
- },
1467
- /**
1468
- * Get a pickface
1469
- * @summary Get pickface
1470
- * @param {string} project What project it is
1471
- * @param {string} pickfaceId Unique identifier of a pickface
1472
- * @param {*} [options] Override http request option.
1473
- * @throws {RequiredError}
1474
- */
1475
- async getPickface(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
1476
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPickface(project, pickfaceId, options);
1477
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1478
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.getPickface']?.[localVarOperationServerIndex]?.url;
1479
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1480
- },
1481
- /**
1482
- * Lists pickface container models
1483
- * @summary Get pickface container models
1484
- * @param {string} project What project it is
1485
- * @param {*} [options] Override http request option.
1486
- * @throws {RequiredError}
1487
- */
1488
- async getPickfaceContainerModels(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContainerModels>> {
1489
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPickfaceContainerModels(project, options);
1490
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1491
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.getPickfaceContainerModels']?.[localVarOperationServerIndex]?.url;
1492
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1493
- },
1494
- /**
1495
- * Lists all available pickfaces paginated into chunks
1496
- * @summary List pickfaces
1497
- * @param {string} project What project it is
1498
- * @param {string} [search] Search term to filter based on pickface code
1499
- * @param {number} [pageToken] Page reference token
1500
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1501
- * @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.
1502
- * @param {*} [options] Override http request option.
1503
- * @throws {RequiredError}
1504
- */
1505
- async getPickfaces(project: string, search?: string, pageToken?: number, pageSize?: number, sortBy?: Array<GetPickfacesSortByEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPickfaces200Response>> {
1506
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPickfaces(project, search, pageToken, pageSize, sortBy, options);
1507
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1508
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.getPickfaces']?.[localVarOperationServerIndex]?.url;
1509
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1510
- },
1511
- /**
1512
- * Issue an empty pickface
1513
- * @summary Issue empty pickface
1514
- * @param {string} project What project it is
1515
- * @param {string} pickfaceId Unique identifier of a pickface
1516
- * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
1517
- * @param {*} [options] Override http request option.
1518
- * @throws {RequiredError}
1519
- */
1520
- async issueEmptyPickface(project: string, pickfaceId: string, issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
1521
- const localVarAxiosArgs = await localVarAxiosParamCreator.issueEmptyPickface(project, pickfaceId, issueEmptyPickfaceRequest, options);
1522
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1523
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.issueEmptyPickface']?.[localVarOperationServerIndex]?.url;
1524
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1525
- },
1526
- /**
1527
- * Issue a pickface with wrong contents
1528
- * @summary Issue wrong contents pickface
1529
- * @param {string} project What project it is
1530
- * @param {string} pickfaceId Unique identifier of a pickface
1531
- * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
1532
- * @param {*} [options] Override http request option.
1533
- * @throws {RequiredError}
1534
- */
1535
- async issueWrongContentsPickface(project: string, pickfaceId: string, issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
1536
- const localVarAxiosArgs = await localVarAxiosParamCreator.issueWrongContentsPickface(project, pickfaceId, issueWrongContentsPickfaceRequest, options);
1537
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1538
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.issueWrongContentsPickface']?.[localVarOperationServerIndex]?.url;
1539
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1540
- },
1541
- /**
1542
- * Get a list of pickface logs
1543
- * @summary Get pickface logs
1544
- * @param {string} project What project it is
1545
- * @param {string} pickfaceId Unique identifier of a pickface
1546
- * @param {number} [pageToken] Page reference token
1547
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1548
- * @param {*} [options] Override http request option.
1549
- * @throws {RequiredError}
1550
- */
1551
- async listPickfaceLogs(project: string, pickfaceId: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaceLogs200Response>> {
1552
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPickfaceLogs(project, pickfaceId, pageToken, pageSize, options);
1553
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1554
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.listPickfaceLogs']?.[localVarOperationServerIndex]?.url;
1555
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1556
- },
1557
- /**
1558
- * Move stock from one pickface to another in a single transaction
1559
- * @summary Move stock
1560
- * @param {string} project What project it is
1561
- * @param {string} pickfaceId Unique identifier of a pickface
1562
- * @param {MoveStockRequest} moveStockRequest Move stock from one pickface to another
1563
- * @param {*} [options] Override http request option.
1564
- * @throws {RequiredError}
1565
- */
1566
- async moveStock(project: string, pickfaceId: string, moveStockRequest: MoveStockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
1567
- const localVarAxiosArgs = await localVarAxiosParamCreator.moveStock(project, pickfaceId, moveStockRequest, options);
1568
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1569
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.moveStock']?.[localVarOperationServerIndex]?.url;
1570
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1571
- },
1572
- /**
1573
- * Print a pickface label
1574
- * @summary Print pickface label
1575
- * @param {string} project What project it is
1576
- * @param {string} pickfaceId Unique identifier of a pickface
1577
- * @param {string} deviceRef Unique identifier of a warehouse device
1578
- * @param {*} [options] Override http request option.
1579
- * @throws {RequiredError}
1580
- */
1581
- async printPickfaceLabel(project: string, pickfaceId: string, deviceRef: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
1582
- const localVarAxiosArgs = await localVarAxiosParamCreator.printPickfaceLabel(project, pickfaceId, deviceRef, options);
1583
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1584
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.printPickfaceLabel']?.[localVarOperationServerIndex]?.url;
1585
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1586
- },
1587
- /**
1588
- * Print pickface labels
1589
- * @summary Print pickface Labels
1590
- * @param {string} project What project it is
1591
- * @param {string} deviceRef Unique identifier of a warehouse device
1592
- * @param {Array<string>} ids List of pickface ids
1593
- * @param {*} [options] Override http request option.
1594
- * @throws {RequiredError}
1595
- */
1596
- async printPickfaceLabels(project: string, deviceRef: string, ids: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
1597
- const localVarAxiosArgs = await localVarAxiosParamCreator.printPickfaceLabels(project, deviceRef, ids, options);
1598
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1599
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.printPickfaceLabels']?.[localVarOperationServerIndex]?.url;
1600
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1601
- },
1602
- /**
1603
- * Resolves an issue on a pickface
1604
- * @summary Resolve pickface issue
1605
- * @param {string} project What project it is
1606
- * @param {string} pickfaceId Unique identifier of a pickface
1607
- * @param {*} [options] Override http request option.
1608
- * @throws {RequiredError}
1609
- */
1610
- async resolvePickfaceIssue(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
1611
- const localVarAxiosArgs = await localVarAxiosParamCreator.resolvePickfaceIssue(project, pickfaceId, options);
1612
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1613
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.resolvePickfaceIssue']?.[localVarOperationServerIndex]?.url;
1614
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1615
- },
1616
- /**
1617
- * Suggest pickfaces for putting away stock
1618
- * @summary Suggest pickfaces
1619
- * @param {string} project What project it is
1620
- * @param {string} variantRef Unique identifier of a warehouse variant
1621
- * @param {number} quantity Number of variants
1622
- * @param {number} [pageToken] Page reference token
1623
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1624
- * @param {*} [options] Override http request option.
1625
- * @throws {RequiredError}
1626
- */
1627
- async suggestPickfaces(project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPickfaces200Response>> {
1628
- const localVarAxiosArgs = await localVarAxiosParamCreator.suggestPickfaces(project, variantRef, quantity, pageToken, pageSize, options);
1629
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1630
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.suggestPickfaces']?.[localVarOperationServerIndex]?.url;
1631
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1632
- },
1633
- /**
1634
- * Update a Pickface
1635
- * @summary Update Pickface
1636
- * @param {string} project What project it is
1637
- * @param {string} pickfaceId Unique identifier of a pickface
1638
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
1639
- * @param {*} [options] Override http request option.
1640
- * @throws {RequiredError}
1641
- */
1642
- async updatePickface(project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
1643
- const localVarAxiosArgs = await localVarAxiosParamCreator.updatePickface(project, pickfaceId, updatePickfaceRequest, options);
1644
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1645
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.updatePickface']?.[localVarOperationServerIndex]?.url;
1646
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1647
- },
1648
- }
1649
- };
1650
-
1651
- /**
1652
- * PickfacesApi - factory interface
1653
- * @export
1654
- */
1655
- export const PickfacesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1656
- const localVarFp = PickfacesApiFp(configuration)
1657
- return {
1658
- /**
1659
- * Create a Pickface
1660
- * @summary Create Pickface
1661
- * @param {PickfacesApiCreatePickfaceRequest} requestParameters Request parameters.
1662
- * @param {*} [options] Override http request option.
1663
- * @throws {RequiredError}
1664
- */
1665
- createPickface(requestParameters: PickfacesApiCreatePickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
1666
- return localVarFp.createPickface(requestParameters.project, requestParameters.createPickfaceRequest, options).then((request) => request(axios, basePath));
1667
- },
1668
- /**
1669
- * Delete a Pickface
1670
- * @summary Delete Pickface
1671
- * @param {PickfacesApiDeletePickfaceRequest} requestParameters Request parameters.
1672
- * @param {*} [options] Override http request option.
1673
- * @throws {RequiredError}
1674
- */
1675
- deletePickface(requestParameters: PickfacesApiDeletePickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1676
- return localVarFp.deletePickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(axios, basePath));
1677
- },
1678
- /**
1679
- * Export pickfaces as a CSV file
1680
- * @summary Export pickfaces
1681
- * @param {PickfacesApiExportPickfacesRequest} requestParameters Request parameters.
1682
- * @param {*} [options] Override http request option.
1683
- * @throws {RequiredError}
1684
- */
1685
- exportPickfaces(requestParameters: PickfacesApiExportPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
1686
- return localVarFp.exportPickfaces(requestParameters.project, options).then((request) => request(axios, basePath));
1687
- },
1688
- /**
1689
- * Get a pickface
1690
- * @summary Get pickface
1691
- * @param {PickfacesApiGetPickfaceRequest} requestParameters Request parameters.
1692
- * @param {*} [options] Override http request option.
1693
- * @throws {RequiredError}
1694
- */
1695
- getPickface(requestParameters: PickfacesApiGetPickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
1696
- return localVarFp.getPickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(axios, basePath));
1697
- },
1698
- /**
1699
- * Lists pickface container models
1700
- * @summary Get pickface container models
1701
- * @param {PickfacesApiGetPickfaceContainerModelsRequest} requestParameters Request parameters.
1702
- * @param {*} [options] Override http request option.
1703
- * @throws {RequiredError}
1704
- */
1705
- getPickfaceContainerModels(requestParameters: PickfacesApiGetPickfaceContainerModelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ContainerModels> {
1706
- return localVarFp.getPickfaceContainerModels(requestParameters.project, options).then((request) => request(axios, basePath));
1707
- },
1708
- /**
1709
- * Lists all available pickfaces paginated into chunks
1710
- * @summary List pickfaces
1711
- * @param {PickfacesApiGetPickfacesRequest} requestParameters Request parameters.
1712
- * @param {*} [options] Override http request option.
1713
- * @throws {RequiredError}
1714
- */
1715
- getPickfaces(requestParameters: PickfacesApiGetPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPickfaces200Response> {
1716
- return localVarFp.getPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(axios, basePath));
1717
- },
1718
- /**
1719
- * Issue an empty pickface
1720
- * @summary Issue empty pickface
1721
- * @param {PickfacesApiIssueEmptyPickfaceRequest} requestParameters Request parameters.
1722
- * @param {*} [options] Override http request option.
1723
- * @throws {RequiredError}
1724
- */
1725
- issueEmptyPickface(requestParameters: PickfacesApiIssueEmptyPickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
1726
- return localVarFp.issueEmptyPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueEmptyPickfaceRequest, options).then((request) => request(axios, basePath));
1727
- },
1728
- /**
1729
- * Issue a pickface with wrong contents
1730
- * @summary Issue wrong contents pickface
1731
- * @param {PickfacesApiIssueWrongContentsPickfaceRequest} requestParameters Request parameters.
1732
- * @param {*} [options] Override http request option.
1733
- * @throws {RequiredError}
1734
- */
1735
- issueWrongContentsPickface(requestParameters: PickfacesApiIssueWrongContentsPickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
1736
- return localVarFp.issueWrongContentsPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueWrongContentsPickfaceRequest, options).then((request) => request(axios, basePath));
1737
- },
1738
- /**
1739
- * Get a list of pickface logs
1740
- * @summary Get pickface logs
1741
- * @param {PickfacesApiListPickfaceLogsRequest} requestParameters Request parameters.
1742
- * @param {*} [options] Override http request option.
1743
- * @throws {RequiredError}
1744
- */
1745
- listPickfaceLogs(requestParameters: PickfacesApiListPickfaceLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaceLogs200Response> {
1746
- return localVarFp.listPickfaceLogs(requestParameters.project, requestParameters.pickfaceId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1747
- },
1748
- /**
1749
- * Move stock from one pickface to another in a single transaction
1750
- * @summary Move stock
1751
- * @param {PickfacesApiMoveStockRequest} requestParameters Request parameters.
1752
- * @param {*} [options] Override http request option.
1753
- * @throws {RequiredError}
1754
- */
1755
- moveStock(requestParameters: PickfacesApiMoveStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
1756
- return localVarFp.moveStock(requestParameters.project, requestParameters.pickfaceId, requestParameters.moveStockRequest, options).then((request) => request(axios, basePath));
1757
- },
1758
- /**
1759
- * Print a pickface label
1760
- * @summary Print pickface label
1761
- * @param {PickfacesApiPrintPickfaceLabelRequest} requestParameters Request parameters.
1762
- * @param {*} [options] Override http request option.
1763
- * @throws {RequiredError}
1764
- */
1765
- printPickfaceLabel(requestParameters: PickfacesApiPrintPickfaceLabelRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1766
- return localVarFp.printPickfaceLabel(requestParameters.project, requestParameters.pickfaceId, requestParameters.deviceRef, options).then((request) => request(axios, basePath));
1767
- },
1768
- /**
1769
- * Print pickface labels
1770
- * @summary Print pickface Labels
1771
- * @param {PickfacesApiPrintPickfaceLabelsRequest} requestParameters Request parameters.
1772
- * @param {*} [options] Override http request option.
1773
- * @throws {RequiredError}
1774
- */
1775
- printPickfaceLabels(requestParameters: PickfacesApiPrintPickfaceLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1776
- return localVarFp.printPickfaceLabels(requestParameters.project, requestParameters.deviceRef, requestParameters.ids, options).then((request) => request(axios, basePath));
1777
- },
1778
- /**
1779
- * Resolves an issue on a pickface
1780
- * @summary Resolve pickface issue
1781
- * @param {PickfacesApiResolvePickfaceIssueRequest} requestParameters Request parameters.
1782
- * @param {*} [options] Override http request option.
1783
- * @throws {RequiredError}
1784
- */
1785
- resolvePickfaceIssue(requestParameters: PickfacesApiResolvePickfaceIssueRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
1786
- return localVarFp.resolvePickfaceIssue(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(axios, basePath));
1787
- },
1788
- /**
1789
- * Suggest pickfaces for putting away stock
1790
- * @summary Suggest pickfaces
1791
- * @param {PickfacesApiSuggestPickfacesRequest} requestParameters Request parameters.
1792
- * @param {*} [options] Override http request option.
1793
- * @throws {RequiredError}
1794
- */
1795
- suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPickfaces200Response> {
1796
- return localVarFp.suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1797
- },
1798
- /**
1799
- * Update a Pickface
1800
- * @summary Update Pickface
1801
- * @param {PickfacesApiUpdatePickfaceRequest} requestParameters Request parameters.
1802
- * @param {*} [options] Override http request option.
1803
- * @throws {RequiredError}
1804
- */
1805
- updatePickface(requestParameters: PickfacesApiUpdatePickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
1806
- return localVarFp.updatePickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.updatePickfaceRequest, options).then((request) => request(axios, basePath));
1807
- },
1808
- };
1809
- };
1810
-
1811
- /**
1812
- * Request parameters for createPickface operation in PickfacesApi.
1813
- * @export
1814
- * @interface PickfacesApiCreatePickfaceRequest
1815
- */
1816
- export interface PickfacesApiCreatePickfaceRequest {
1817
- /**
1818
- * What project it is
1819
- * @type {string}
1820
- * @memberof PickfacesApiCreatePickface
1821
- */
1822
- readonly project: string
1823
-
1824
- /**
1825
- * Create pickface schema
1826
- * @type {CreatePickfaceRequest}
1827
- * @memberof PickfacesApiCreatePickface
1828
- */
1829
- readonly createPickfaceRequest: CreatePickfaceRequest
1830
- }
1831
-
1832
- /**
1833
- * Request parameters for deletePickface operation in PickfacesApi.
1834
- * @export
1835
- * @interface PickfacesApiDeletePickfaceRequest
1836
- */
1837
- export interface PickfacesApiDeletePickfaceRequest {
1838
- /**
1839
- * What project it is
1840
- * @type {string}
1841
- * @memberof PickfacesApiDeletePickface
1842
- */
1843
- readonly project: string
1844
-
1845
- /**
1846
- * Unique identifier of a pickface
1847
- * @type {string}
1848
- * @memberof PickfacesApiDeletePickface
1849
- */
1850
- readonly pickfaceId: string
1851
- }
1852
-
1853
- /**
1854
- * Request parameters for exportPickfaces operation in PickfacesApi.
1855
- * @export
1856
- * @interface PickfacesApiExportPickfacesRequest
1857
- */
1858
- export interface PickfacesApiExportPickfacesRequest {
1859
- /**
1860
- * What project it is
1861
- * @type {string}
1862
- * @memberof PickfacesApiExportPickfaces
1863
- */
1864
- readonly project: string
1865
- }
1866
-
1867
- /**
1868
- * Request parameters for getPickface operation in PickfacesApi.
1869
- * @export
1870
- * @interface PickfacesApiGetPickfaceRequest
1871
- */
1872
- export interface PickfacesApiGetPickfaceRequest {
1873
- /**
1874
- * What project it is
1875
- * @type {string}
1876
- * @memberof PickfacesApiGetPickface
1877
- */
1878
- readonly project: string
1879
-
1880
- /**
1881
- * Unique identifier of a pickface
1882
- * @type {string}
1883
- * @memberof PickfacesApiGetPickface
1884
- */
1885
- readonly pickfaceId: string
1886
- }
1887
-
1888
- /**
1889
- * Request parameters for getPickfaceContainerModels operation in PickfacesApi.
1890
- * @export
1891
- * @interface PickfacesApiGetPickfaceContainerModelsRequest
1892
- */
1893
- export interface PickfacesApiGetPickfaceContainerModelsRequest {
1894
- /**
1895
- * What project it is
1896
- * @type {string}
1897
- * @memberof PickfacesApiGetPickfaceContainerModels
1898
- */
1899
- readonly project: string
1900
- }
1901
-
1902
- /**
1903
- * Request parameters for getPickfaces operation in PickfacesApi.
1904
- * @export
1905
- * @interface PickfacesApiGetPickfacesRequest
1906
- */
1907
- export interface PickfacesApiGetPickfacesRequest {
1908
- /**
1909
- * What project it is
1910
- * @type {string}
1911
- * @memberof PickfacesApiGetPickfaces
1912
- */
1913
- readonly project: string
1914
-
1915
- /**
1916
- * Search term to filter based on pickface code
1917
- * @type {string}
1918
- * @memberof PickfacesApiGetPickfaces
1919
- */
1920
- readonly search?: string
1921
-
1922
- /**
1923
- * Page reference token
1924
- * @type {number}
1925
- * @memberof PickfacesApiGetPickfaces
1926
- */
1927
- readonly pageToken?: number
1928
-
1929
- /**
1930
- * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1931
- * @type {number}
1932
- * @memberof PickfacesApiGetPickfaces
1933
- */
1934
- readonly pageSize?: number
1935
-
1936
- /**
1937
- * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1938
- * @type {Array<'+available' | '-available' | '+wip' | '-wip' | '+total' | '-total' | '+fullness' | '-fullness' | '+restocked' | '-restocked' | '+picked' | '-picked'>}
1939
- * @memberof PickfacesApiGetPickfaces
1940
- */
1941
- readonly sortBy?: Array<GetPickfacesSortByEnum>
1942
- }
1943
-
1944
- /**
1945
- * Request parameters for issueEmptyPickface operation in PickfacesApi.
1946
- * @export
1947
- * @interface PickfacesApiIssueEmptyPickfaceRequest
1948
- */
1949
- export interface PickfacesApiIssueEmptyPickfaceRequest {
1950
- /**
1951
- * What project it is
1952
- * @type {string}
1953
- * @memberof PickfacesApiIssueEmptyPickface
1954
- */
1955
- readonly project: string
1956
-
1957
- /**
1958
- * Unique identifier of a pickface
1959
- * @type {string}
1960
- * @memberof PickfacesApiIssueEmptyPickface
1961
- */
1962
- readonly pickfaceId: string
1963
-
1964
- /**
1965
- * pickface issue schema
1966
- * @type {IssueEmptyPickfaceRequest}
1967
- * @memberof PickfacesApiIssueEmptyPickface
1968
- */
1969
- readonly issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest
1970
- }
1971
-
1972
- /**
1973
- * Request parameters for issueWrongContentsPickface operation in PickfacesApi.
1974
- * @export
1975
- * @interface PickfacesApiIssueWrongContentsPickfaceRequest
1976
- */
1977
- export interface PickfacesApiIssueWrongContentsPickfaceRequest {
1978
- /**
1979
- * What project it is
1980
- * @type {string}
1981
- * @memberof PickfacesApiIssueWrongContentsPickface
1982
- */
1983
- readonly project: string
1984
-
1985
- /**
1986
- * Unique identifier of a pickface
1987
- * @type {string}
1988
- * @memberof PickfacesApiIssueWrongContentsPickface
1989
- */
1990
- readonly pickfaceId: string
1991
-
1992
- /**
1993
- * pickface issue schema
1994
- * @type {IssueWrongContentsPickfaceRequest}
1995
- * @memberof PickfacesApiIssueWrongContentsPickface
1996
- */
1997
- readonly issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest
1998
- }
1999
-
2000
- /**
2001
- * Request parameters for listPickfaceLogs operation in PickfacesApi.
2002
- * @export
2003
- * @interface PickfacesApiListPickfaceLogsRequest
2004
- */
2005
- export interface PickfacesApiListPickfaceLogsRequest {
2006
- /**
2007
- * What project it is
2008
- * @type {string}
2009
- * @memberof PickfacesApiListPickfaceLogs
2010
- */
2011
- readonly project: string
2012
-
2013
- /**
2014
- * Unique identifier of a pickface
2015
- * @type {string}
2016
- * @memberof PickfacesApiListPickfaceLogs
2017
- */
2018
- readonly pickfaceId: string
2019
-
2020
- /**
2021
- * Page reference token
2022
- * @type {number}
2023
- * @memberof PickfacesApiListPickfaceLogs
2024
- */
2025
- readonly pageToken?: number
2026
-
2027
- /**
2028
- * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2029
- * @type {number}
2030
- * @memberof PickfacesApiListPickfaceLogs
2031
- */
2032
- readonly pageSize?: number
2033
- }
2034
-
2035
- /**
2036
- * Request parameters for moveStock operation in PickfacesApi.
2037
- * @export
2038
- * @interface PickfacesApiMoveStockRequest
2039
- */
2040
- export interface PickfacesApiMoveStockRequest {
2041
- /**
2042
- * What project it is
2043
- * @type {string}
2044
- * @memberof PickfacesApiMoveStock
2045
- */
2046
- readonly project: string
2047
-
2048
- /**
2049
- * Unique identifier of a pickface
2050
- * @type {string}
2051
- * @memberof PickfacesApiMoveStock
2052
- */
2053
- readonly pickfaceId: string
2054
-
2055
- /**
2056
- * Move stock from one pickface to another
2057
- * @type {MoveStockRequest}
2058
- * @memberof PickfacesApiMoveStock
2059
- */
2060
- readonly moveStockRequest: MoveStockRequest
2061
- }
826
+ async getPickfaces(project: string, search?: string, pageToken?: number, pageSize?: number, sortBy?: Array<GetPickfacesSortByEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPickfaces200Response>> {
827
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPickfaces(project, search, pageToken, pageSize, sortBy, options);
828
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
829
+ const localVarOperationServerBasePath = operationServerMap['PickfacesApi.getPickfaces']?.[localVarOperationServerIndex]?.url;
830
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
831
+ },
832
+ }
833
+ };
2062
834
 
2063
835
  /**
2064
- * Request parameters for printPickfaceLabel operation in PickfacesApi.
836
+ * PickfacesApi - factory interface
2065
837
  * @export
2066
- * @interface PickfacesApiPrintPickfaceLabelRequest
2067
838
  */
2068
- export interface PickfacesApiPrintPickfaceLabelRequest {
2069
- /**
2070
- * What project it is
2071
- * @type {string}
2072
- * @memberof PickfacesApiPrintPickfaceLabel
2073
- */
2074
- readonly project: string
2075
-
2076
- /**
2077
- * Unique identifier of a pickface
2078
- * @type {string}
2079
- * @memberof PickfacesApiPrintPickfaceLabel
2080
- */
2081
- readonly pickfaceId: string
2082
-
2083
- /**
2084
- * Unique identifier of a warehouse device
2085
- * @type {string}
2086
- * @memberof PickfacesApiPrintPickfaceLabel
2087
- */
2088
- readonly deviceRef: string
2089
- }
839
+ export const PickfacesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
840
+ const localVarFp = PickfacesApiFp(configuration)
841
+ return {
842
+ /**
843
+ * Create a Pickface
844
+ * @summary Create Pickface
845
+ * @param {PickfacesApiCreatePickfaceRequest} requestParameters Request parameters.
846
+ * @param {*} [options] Override http request option.
847
+ * @throws {RequiredError}
848
+ */
849
+ createPickface(requestParameters: PickfacesApiCreatePickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
850
+ return localVarFp.createPickface(requestParameters.project, requestParameters.createPickfaceRequest, options).then((request) => request(axios, basePath));
851
+ },
852
+ /**
853
+ * Get a pickface
854
+ * @summary Get pickface
855
+ * @param {PickfacesApiGetPickfaceRequest} requestParameters Request parameters.
856
+ * @param {*} [options] Override http request option.
857
+ * @throws {RequiredError}
858
+ */
859
+ getPickface(requestParameters: PickfacesApiGetPickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
860
+ return localVarFp.getPickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(axios, basePath));
861
+ },
862
+ /**
863
+ * Lists all available pickfaces paginated into chunks
864
+ * @summary List pickfaces
865
+ * @param {PickfacesApiGetPickfacesRequest} requestParameters Request parameters.
866
+ * @param {*} [options] Override http request option.
867
+ * @throws {RequiredError}
868
+ */
869
+ getPickfaces(requestParameters: PickfacesApiGetPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPickfaces200Response> {
870
+ return localVarFp.getPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(axios, basePath));
871
+ },
872
+ };
873
+ };
2090
874
 
2091
875
  /**
2092
- * Request parameters for printPickfaceLabels operation in PickfacesApi.
876
+ * Request parameters for createPickface operation in PickfacesApi.
2093
877
  * @export
2094
- * @interface PickfacesApiPrintPickfaceLabelsRequest
878
+ * @interface PickfacesApiCreatePickfaceRequest
2095
879
  */
2096
- export interface PickfacesApiPrintPickfaceLabelsRequest {
880
+ export interface PickfacesApiCreatePickfaceRequest {
2097
881
  /**
2098
882
  * What project it is
2099
883
  * @type {string}
2100
- * @memberof PickfacesApiPrintPickfaceLabels
884
+ * @memberof PickfacesApiCreatePickface
2101
885
  */
2102
886
  readonly project: string
2103
887
 
2104
888
  /**
2105
- * Unique identifier of a warehouse device
2106
- * @type {string}
2107
- * @memberof PickfacesApiPrintPickfaceLabels
2108
- */
2109
- readonly deviceRef: string
2110
-
2111
- /**
2112
- * List of pickface ids
2113
- * @type {Array<string>}
2114
- * @memberof PickfacesApiPrintPickfaceLabels
889
+ * Create pickface schema
890
+ * @type {CreatePickfaceRequest}
891
+ * @memberof PickfacesApiCreatePickface
2115
892
  */
2116
- readonly ids: Array<string>
893
+ readonly createPickfaceRequest: CreatePickfaceRequest
2117
894
  }
2118
895
 
2119
896
  /**
2120
- * Request parameters for resolvePickfaceIssue operation in PickfacesApi.
897
+ * Request parameters for getPickface operation in PickfacesApi.
2121
898
  * @export
2122
- * @interface PickfacesApiResolvePickfaceIssueRequest
899
+ * @interface PickfacesApiGetPickfaceRequest
2123
900
  */
2124
- export interface PickfacesApiResolvePickfaceIssueRequest {
901
+ export interface PickfacesApiGetPickfaceRequest {
2125
902
  /**
2126
903
  * What project it is
2127
904
  * @type {string}
2128
- * @memberof PickfacesApiResolvePickfaceIssue
905
+ * @memberof PickfacesApiGetPickface
2129
906
  */
2130
907
  readonly project: string
2131
908
 
2132
909
  /**
2133
910
  * Unique identifier of a pickface
2134
911
  * @type {string}
2135
- * @memberof PickfacesApiResolvePickfaceIssue
912
+ * @memberof PickfacesApiGetPickface
2136
913
  */
2137
914
  readonly pickfaceId: string
2138
915
  }
2139
916
 
2140
917
  /**
2141
- * Request parameters for suggestPickfaces operation in PickfacesApi.
918
+ * Request parameters for getPickfaces operation in PickfacesApi.
2142
919
  * @export
2143
- * @interface PickfacesApiSuggestPickfacesRequest
920
+ * @interface PickfacesApiGetPickfacesRequest
2144
921
  */
2145
- export interface PickfacesApiSuggestPickfacesRequest {
922
+ export interface PickfacesApiGetPickfacesRequest {
2146
923
  /**
2147
924
  * What project it is
2148
925
  * @type {string}
2149
- * @memberof PickfacesApiSuggestPickfaces
926
+ * @memberof PickfacesApiGetPickfaces
2150
927
  */
2151
928
  readonly project: string
2152
929
 
2153
930
  /**
2154
- * Unique identifier of a warehouse variant
931
+ * Search term to filter based on pickface code
2155
932
  * @type {string}
2156
- * @memberof PickfacesApiSuggestPickfaces
2157
- */
2158
- readonly variantRef: string
2159
-
2160
- /**
2161
- * Number of variants
2162
- * @type {number}
2163
- * @memberof PickfacesApiSuggestPickfaces
933
+ * @memberof PickfacesApiGetPickfaces
2164
934
  */
2165
- readonly quantity: number
935
+ readonly search?: string
2166
936
 
2167
937
  /**
2168
938
  * Page reference token
2169
939
  * @type {number}
2170
- * @memberof PickfacesApiSuggestPickfaces
940
+ * @memberof PickfacesApiGetPickfaces
2171
941
  */
2172
942
  readonly pageToken?: number
2173
943
 
2174
944
  /**
2175
945
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2176
946
  * @type {number}
2177
- * @memberof PickfacesApiSuggestPickfaces
947
+ * @memberof PickfacesApiGetPickfaces
2178
948
  */
2179
949
  readonly pageSize?: number
2180
- }
2181
-
2182
- /**
2183
- * Request parameters for updatePickface operation in PickfacesApi.
2184
- * @export
2185
- * @interface PickfacesApiUpdatePickfaceRequest
2186
- */
2187
- export interface PickfacesApiUpdatePickfaceRequest {
2188
- /**
2189
- * What project it is
2190
- * @type {string}
2191
- * @memberof PickfacesApiUpdatePickface
2192
- */
2193
- readonly project: string
2194
-
2195
- /**
2196
- * Unique identifier of a pickface
2197
- * @type {string}
2198
- * @memberof PickfacesApiUpdatePickface
2199
- */
2200
- readonly pickfaceId: string
2201
950
 
2202
951
  /**
2203
- * Update pickface schema
2204
- * @type {UpdatePickfaceRequest}
2205
- * @memberof PickfacesApiUpdatePickface
952
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
953
+ * @type {Array<'+available' | '-available' | '+wip' | '-wip' | '+total' | '-total' | '+fullness' | '-fullness' | '+restocked' | '-restocked' | '+picked' | '-picked'>}
954
+ * @memberof PickfacesApiGetPickfaces
2206
955
  */
2207
- readonly updatePickfaceRequest: UpdatePickfaceRequest
956
+ readonly sortBy?: Array<GetPickfacesSortByEnum>
2208
957
  }
2209
958
 
2210
959
  /**
@@ -2226,30 +975,6 @@ export class PickfacesApi extends BaseAPI {
2226
975
  return PickfacesApiFp(this.configuration).createPickface(requestParameters.project, requestParameters.createPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
2227
976
  }
2228
977
 
2229
- /**
2230
- * Delete a Pickface
2231
- * @summary Delete Pickface
2232
- * @param {PickfacesApiDeletePickfaceRequest} requestParameters Request parameters.
2233
- * @param {*} [options] Override http request option.
2234
- * @throws {RequiredError}
2235
- * @memberof PickfacesApi
2236
- */
2237
- public deletePickface(requestParameters: PickfacesApiDeletePickfaceRequest, options?: RawAxiosRequestConfig) {
2238
- return PickfacesApiFp(this.configuration).deletePickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
2239
- }
2240
-
2241
- /**
2242
- * Export pickfaces as a CSV file
2243
- * @summary Export pickfaces
2244
- * @param {PickfacesApiExportPickfacesRequest} requestParameters Request parameters.
2245
- * @param {*} [options] Override http request option.
2246
- * @throws {RequiredError}
2247
- * @memberof PickfacesApi
2248
- */
2249
- public exportPickfaces(requestParameters: PickfacesApiExportPickfacesRequest, options?: RawAxiosRequestConfig) {
2250
- return PickfacesApiFp(this.configuration).exportPickfaces(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
2251
- }
2252
-
2253
978
  /**
2254
979
  * Get a pickface
2255
980
  * @summary Get pickface
@@ -2262,18 +987,6 @@ export class PickfacesApi extends BaseAPI {
2262
987
  return PickfacesApiFp(this.configuration).getPickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
2263
988
  }
2264
989
 
2265
- /**
2266
- * Lists pickface container models
2267
- * @summary Get pickface container models
2268
- * @param {PickfacesApiGetPickfaceContainerModelsRequest} requestParameters Request parameters.
2269
- * @param {*} [options] Override http request option.
2270
- * @throws {RequiredError}
2271
- * @memberof PickfacesApi
2272
- */
2273
- public getPickfaceContainerModels(requestParameters: PickfacesApiGetPickfaceContainerModelsRequest, options?: RawAxiosRequestConfig) {
2274
- return PickfacesApiFp(this.configuration).getPickfaceContainerModels(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
2275
- }
2276
-
2277
990
  /**
2278
991
  * Lists all available pickfaces paginated into chunks
2279
992
  * @summary List pickfaces
@@ -2285,114 +998,6 @@ export class PickfacesApi extends BaseAPI {
2285
998
  public getPickfaces(requestParameters: PickfacesApiGetPickfacesRequest, options?: RawAxiosRequestConfig) {
2286
999
  return PickfacesApiFp(this.configuration).getPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
2287
1000
  }
2288
-
2289
- /**
2290
- * Issue an empty pickface
2291
- * @summary Issue empty pickface
2292
- * @param {PickfacesApiIssueEmptyPickfaceRequest} requestParameters Request parameters.
2293
- * @param {*} [options] Override http request option.
2294
- * @throws {RequiredError}
2295
- * @memberof PickfacesApi
2296
- */
2297
- public issueEmptyPickface(requestParameters: PickfacesApiIssueEmptyPickfaceRequest, options?: RawAxiosRequestConfig) {
2298
- return PickfacesApiFp(this.configuration).issueEmptyPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueEmptyPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
2299
- }
2300
-
2301
- /**
2302
- * Issue a pickface with wrong contents
2303
- * @summary Issue wrong contents pickface
2304
- * @param {PickfacesApiIssueWrongContentsPickfaceRequest} requestParameters Request parameters.
2305
- * @param {*} [options] Override http request option.
2306
- * @throws {RequiredError}
2307
- * @memberof PickfacesApi
2308
- */
2309
- public issueWrongContentsPickface(requestParameters: PickfacesApiIssueWrongContentsPickfaceRequest, options?: RawAxiosRequestConfig) {
2310
- return PickfacesApiFp(this.configuration).issueWrongContentsPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueWrongContentsPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
2311
- }
2312
-
2313
- /**
2314
- * Get a list of pickface logs
2315
- * @summary Get pickface logs
2316
- * @param {PickfacesApiListPickfaceLogsRequest} requestParameters Request parameters.
2317
- * @param {*} [options] Override http request option.
2318
- * @throws {RequiredError}
2319
- * @memberof PickfacesApi
2320
- */
2321
- public listPickfaceLogs(requestParameters: PickfacesApiListPickfaceLogsRequest, options?: RawAxiosRequestConfig) {
2322
- return PickfacesApiFp(this.configuration).listPickfaceLogs(requestParameters.project, requestParameters.pickfaceId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
2323
- }
2324
-
2325
- /**
2326
- * Move stock from one pickface to another in a single transaction
2327
- * @summary Move stock
2328
- * @param {PickfacesApiMoveStockRequest} requestParameters Request parameters.
2329
- * @param {*} [options] Override http request option.
2330
- * @throws {RequiredError}
2331
- * @memberof PickfacesApi
2332
- */
2333
- public moveStock(requestParameters: PickfacesApiMoveStockRequest, options?: RawAxiosRequestConfig) {
2334
- return PickfacesApiFp(this.configuration).moveStock(requestParameters.project, requestParameters.pickfaceId, requestParameters.moveStockRequest, options).then((request) => request(this.axios, this.basePath));
2335
- }
2336
-
2337
- /**
2338
- * Print a pickface label
2339
- * @summary Print pickface label
2340
- * @param {PickfacesApiPrintPickfaceLabelRequest} requestParameters Request parameters.
2341
- * @param {*} [options] Override http request option.
2342
- * @throws {RequiredError}
2343
- * @memberof PickfacesApi
2344
- */
2345
- public printPickfaceLabel(requestParameters: PickfacesApiPrintPickfaceLabelRequest, options?: RawAxiosRequestConfig) {
2346
- return PickfacesApiFp(this.configuration).printPickfaceLabel(requestParameters.project, requestParameters.pickfaceId, requestParameters.deviceRef, options).then((request) => request(this.axios, this.basePath));
2347
- }
2348
-
2349
- /**
2350
- * Print pickface labels
2351
- * @summary Print pickface Labels
2352
- * @param {PickfacesApiPrintPickfaceLabelsRequest} requestParameters Request parameters.
2353
- * @param {*} [options] Override http request option.
2354
- * @throws {RequiredError}
2355
- * @memberof PickfacesApi
2356
- */
2357
- public printPickfaceLabels(requestParameters: PickfacesApiPrintPickfaceLabelsRequest, options?: RawAxiosRequestConfig) {
2358
- return PickfacesApiFp(this.configuration).printPickfaceLabels(requestParameters.project, requestParameters.deviceRef, requestParameters.ids, options).then((request) => request(this.axios, this.basePath));
2359
- }
2360
-
2361
- /**
2362
- * Resolves an issue on a pickface
2363
- * @summary Resolve pickface issue
2364
- * @param {PickfacesApiResolvePickfaceIssueRequest} requestParameters Request parameters.
2365
- * @param {*} [options] Override http request option.
2366
- * @throws {RequiredError}
2367
- * @memberof PickfacesApi
2368
- */
2369
- public resolvePickfaceIssue(requestParameters: PickfacesApiResolvePickfaceIssueRequest, options?: RawAxiosRequestConfig) {
2370
- return PickfacesApiFp(this.configuration).resolvePickfaceIssue(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
2371
- }
2372
-
2373
- /**
2374
- * Suggest pickfaces for putting away stock
2375
- * @summary Suggest pickfaces
2376
- * @param {PickfacesApiSuggestPickfacesRequest} requestParameters Request parameters.
2377
- * @param {*} [options] Override http request option.
2378
- * @throws {RequiredError}
2379
- * @memberof PickfacesApi
2380
- */
2381
- public suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig) {
2382
- return PickfacesApiFp(this.configuration).suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
2383
- }
2384
-
2385
- /**
2386
- * Update a Pickface
2387
- * @summary Update Pickface
2388
- * @param {PickfacesApiUpdatePickfaceRequest} requestParameters Request parameters.
2389
- * @param {*} [options] Override http request option.
2390
- * @throws {RequiredError}
2391
- * @memberof PickfacesApi
2392
- */
2393
- public updatePickface(requestParameters: PickfacesApiUpdatePickfaceRequest, options?: RawAxiosRequestConfig) {
2394
- return PickfacesApiFp(this.configuration).updatePickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.updatePickfaceRequest, options).then((request) => request(this.axios, this.basePath));
2395
- }
2396
1001
  }
2397
1002
 
2398
1003
  /**