@teemill/pickfaces 0.18.0 → 0.19.1
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/README.md +2 -2
- package/api.ts +165 -165
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +8 -2
- package/dist/api.d.ts +105 -105
- package/dist/api.js +96 -96
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +3 -2
- package/dist/esm/api.d.ts +105 -105
- package/dist/esm/api.js +95 -95
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +3 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/pickfaces@0.
|
|
1
|
+
## @teemill/pickfaces@0.19.1
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/pickfaces@0.
|
|
39
|
+
npm install @teemill/pickfaces@0.19.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Pickfaces API
|
|
5
5
|
* Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.19.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -136,25 +136,6 @@ export interface ExportPickfaces202Response {
|
|
|
136
136
|
*/
|
|
137
137
|
'message'?: string;
|
|
138
138
|
}
|
|
139
|
-
/**
|
|
140
|
-
*
|
|
141
|
-
* @export
|
|
142
|
-
* @interface GetPickfaces200Response
|
|
143
|
-
*/
|
|
144
|
-
export interface GetPickfaces200Response {
|
|
145
|
-
/**
|
|
146
|
-
*
|
|
147
|
-
* @type {Array<Pickface>}
|
|
148
|
-
* @memberof GetPickfaces200Response
|
|
149
|
-
*/
|
|
150
|
-
'pickfaces'?: Array<Pickface>;
|
|
151
|
-
/**
|
|
152
|
-
*
|
|
153
|
-
* @type {number}
|
|
154
|
-
* @memberof GetPickfaces200Response
|
|
155
|
-
*/
|
|
156
|
-
'nextPageToken'?: number;
|
|
157
|
-
}
|
|
158
139
|
/**
|
|
159
140
|
*
|
|
160
141
|
* @export
|
|
@@ -200,11 +181,30 @@ export interface ListPickfaceLogs200Response {
|
|
|
200
181
|
*/
|
|
201
182
|
'logs'?: Array<PickfaceLog>;
|
|
202
183
|
/**
|
|
203
|
-
*
|
|
184
|
+
* The token referencing the next page number
|
|
204
185
|
* @type {number}
|
|
205
186
|
* @memberof ListPickfaceLogs200Response
|
|
206
187
|
*/
|
|
207
|
-
'nextPageToken'?: number;
|
|
188
|
+
'nextPageToken'?: number | null;
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
*
|
|
192
|
+
* @export
|
|
193
|
+
* @interface ListPickfaces200Response
|
|
194
|
+
*/
|
|
195
|
+
export interface ListPickfaces200Response {
|
|
196
|
+
/**
|
|
197
|
+
*
|
|
198
|
+
* @type {Array<Pickface>}
|
|
199
|
+
* @memberof ListPickfaces200Response
|
|
200
|
+
*/
|
|
201
|
+
'pickfaces'?: Array<Pickface>;
|
|
202
|
+
/**
|
|
203
|
+
* The token referencing the next page number
|
|
204
|
+
* @type {number}
|
|
205
|
+
* @memberof ListPickfaces200Response
|
|
206
|
+
*/
|
|
207
|
+
'nextPageToken'?: number | null;
|
|
208
208
|
}
|
|
209
209
|
/**
|
|
210
210
|
*
|
|
@@ -877,20 +877,23 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
877
877
|
};
|
|
878
878
|
},
|
|
879
879
|
/**
|
|
880
|
-
*
|
|
881
|
-
* @summary
|
|
880
|
+
* Issue an empty pickface
|
|
881
|
+
* @summary Issue empty pickface
|
|
882
882
|
* @param {string} project What project it is
|
|
883
|
-
* @param {string}
|
|
884
|
-
* @param {
|
|
885
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
886
|
-
* @param {Array<GetPickfacesSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
883
|
+
* @param {string} pickfaceId Unique identifier of a pickface
|
|
884
|
+
* @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
|
|
887
885
|
* @param {*} [options] Override http request option.
|
|
888
886
|
* @throws {RequiredError}
|
|
889
887
|
*/
|
|
890
|
-
|
|
888
|
+
issueEmptyPickface: async (project: string, pickfaceId: string, issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
891
889
|
// verify required parameter 'project' is not null or undefined
|
|
892
|
-
assertParamExists('
|
|
893
|
-
|
|
890
|
+
assertParamExists('issueEmptyPickface', 'project', project)
|
|
891
|
+
// verify required parameter 'pickfaceId' is not null or undefined
|
|
892
|
+
assertParamExists('issueEmptyPickface', 'pickfaceId', pickfaceId)
|
|
893
|
+
// verify required parameter 'issueEmptyPickfaceRequest' is not null or undefined
|
|
894
|
+
assertParamExists('issueEmptyPickface', 'issueEmptyPickfaceRequest', issueEmptyPickfaceRequest)
|
|
895
|
+
const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/empty`
|
|
896
|
+
.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
|
|
894
897
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
895
898
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
896
899
|
let baseOptions;
|
|
@@ -898,7 +901,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
898
901
|
baseOptions = configuration.baseOptions;
|
|
899
902
|
}
|
|
900
903
|
|
|
901
|
-
const localVarRequestOptions = { method: '
|
|
904
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
902
905
|
const localVarHeaderParameter = {} as any;
|
|
903
906
|
const localVarQueryParameter = {} as any;
|
|
904
907
|
|
|
@@ -913,27 +916,14 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
913
916
|
localVarQueryParameter['project'] = project;
|
|
914
917
|
}
|
|
915
918
|
|
|
916
|
-
if (search !== undefined) {
|
|
917
|
-
localVarQueryParameter['search'] = search;
|
|
918
|
-
}
|
|
919
|
-
|
|
920
|
-
if (pageToken !== undefined) {
|
|
921
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
922
|
-
}
|
|
923
|
-
|
|
924
|
-
if (pageSize !== undefined) {
|
|
925
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
926
|
-
}
|
|
927
|
-
|
|
928
|
-
if (sortBy) {
|
|
929
|
-
localVarQueryParameter['sortBy'] = sortBy;
|
|
930
|
-
}
|
|
931
|
-
|
|
932
919
|
|
|
933
920
|
|
|
921
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
922
|
+
|
|
934
923
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
935
924
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
936
925
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
926
|
+
localVarRequestOptions.data = serializeDataIfNeeded(issueEmptyPickfaceRequest, localVarRequestOptions, configuration)
|
|
937
927
|
|
|
938
928
|
return {
|
|
939
929
|
url: toPathString(localVarUrlObj),
|
|
@@ -941,22 +931,22 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
941
931
|
};
|
|
942
932
|
},
|
|
943
933
|
/**
|
|
944
|
-
* Issue
|
|
945
|
-
* @summary Issue
|
|
934
|
+
* Issue a pickface with wrong contents
|
|
935
|
+
* @summary Issue wrong contents pickface
|
|
946
936
|
* @param {string} project What project it is
|
|
947
937
|
* @param {string} pickfaceId Unique identifier of a pickface
|
|
948
|
-
* @param {
|
|
938
|
+
* @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
|
|
949
939
|
* @param {*} [options] Override http request option.
|
|
950
940
|
* @throws {RequiredError}
|
|
951
941
|
*/
|
|
952
|
-
|
|
942
|
+
issueWrongContentsPickface: async (project: string, pickfaceId: string, issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
953
943
|
// verify required parameter 'project' is not null or undefined
|
|
954
|
-
assertParamExists('
|
|
944
|
+
assertParamExists('issueWrongContentsPickface', 'project', project)
|
|
955
945
|
// verify required parameter 'pickfaceId' is not null or undefined
|
|
956
|
-
assertParamExists('
|
|
957
|
-
// verify required parameter '
|
|
958
|
-
assertParamExists('
|
|
959
|
-
const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/
|
|
946
|
+
assertParamExists('issueWrongContentsPickface', 'pickfaceId', pickfaceId)
|
|
947
|
+
// verify required parameter 'issueWrongContentsPickfaceRequest' is not null or undefined
|
|
948
|
+
assertParamExists('issueWrongContentsPickface', 'issueWrongContentsPickfaceRequest', issueWrongContentsPickfaceRequest)
|
|
949
|
+
const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/wrong-contents`
|
|
960
950
|
.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
|
|
961
951
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
962
952
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -987,7 +977,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
987
977
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
988
978
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
989
979
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
990
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
980
|
+
localVarRequestOptions.data = serializeDataIfNeeded(issueWrongContentsPickfaceRequest, localVarRequestOptions, configuration)
|
|
991
981
|
|
|
992
982
|
return {
|
|
993
983
|
url: toPathString(localVarUrlObj),
|
|
@@ -995,22 +985,21 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
995
985
|
};
|
|
996
986
|
},
|
|
997
987
|
/**
|
|
998
|
-
*
|
|
999
|
-
* @summary
|
|
988
|
+
* Get a list of pickface logs
|
|
989
|
+
* @summary Get pickface logs
|
|
1000
990
|
* @param {string} project What project it is
|
|
1001
991
|
* @param {string} pickfaceId Unique identifier of a pickface
|
|
1002
|
-
* @param {
|
|
992
|
+
* @param {number} [pageToken] Page reference token
|
|
993
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1003
994
|
* @param {*} [options] Override http request option.
|
|
1004
995
|
* @throws {RequiredError}
|
|
1005
996
|
*/
|
|
1006
|
-
|
|
997
|
+
listPickfaceLogs: async (project: string, pickfaceId: string, pageToken?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1007
998
|
// verify required parameter 'project' is not null or undefined
|
|
1008
|
-
assertParamExists('
|
|
999
|
+
assertParamExists('listPickfaceLogs', 'project', project)
|
|
1009
1000
|
// verify required parameter 'pickfaceId' is not null or undefined
|
|
1010
|
-
assertParamExists('
|
|
1011
|
-
|
|
1012
|
-
assertParamExists('issueWrongContentsPickface', 'issueWrongContentsPickfaceRequest', issueWrongContentsPickfaceRequest)
|
|
1013
|
-
const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/wrong-contents`
|
|
1001
|
+
assertParamExists('listPickfaceLogs', 'pickfaceId', pickfaceId)
|
|
1002
|
+
const localVarPath = `/v1/pickfaces/{pickfaceId}/logs`
|
|
1014
1003
|
.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
|
|
1015
1004
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1016
1005
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1019,7 +1008,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1019
1008
|
baseOptions = configuration.baseOptions;
|
|
1020
1009
|
}
|
|
1021
1010
|
|
|
1022
|
-
const localVarRequestOptions = { method: '
|
|
1011
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1023
1012
|
const localVarHeaderParameter = {} as any;
|
|
1024
1013
|
const localVarQueryParameter = {} as any;
|
|
1025
1014
|
|
|
@@ -1034,14 +1023,19 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1034
1023
|
localVarQueryParameter['project'] = project;
|
|
1035
1024
|
}
|
|
1036
1025
|
|
|
1026
|
+
if (pageToken !== undefined) {
|
|
1027
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1028
|
+
}
|
|
1029
|
+
|
|
1030
|
+
if (pageSize !== undefined) {
|
|
1031
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1032
|
+
}
|
|
1037
1033
|
|
|
1038
|
-
|
|
1039
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1040
1034
|
|
|
1035
|
+
|
|
1041
1036
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1042
1037
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1043
1038
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1044
|
-
localVarRequestOptions.data = serializeDataIfNeeded(issueWrongContentsPickfaceRequest, localVarRequestOptions, configuration)
|
|
1045
1039
|
|
|
1046
1040
|
return {
|
|
1047
1041
|
url: toPathString(localVarUrlObj),
|
|
@@ -1049,22 +1043,20 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1049
1043
|
};
|
|
1050
1044
|
},
|
|
1051
1045
|
/**
|
|
1052
|
-
*
|
|
1053
|
-
* @summary
|
|
1046
|
+
* Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
|
|
1047
|
+
* @summary List pickfaces
|
|
1054
1048
|
* @param {string} project What project it is
|
|
1055
|
-
* @param {string}
|
|
1049
|
+
* @param {string} [search] Search term to filter based on pickface code
|
|
1056
1050
|
* @param {number} [pageToken] Page reference token
|
|
1057
1051
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1052
|
+
* @param {Array<ListPickfacesSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1058
1053
|
* @param {*} [options] Override http request option.
|
|
1059
1054
|
* @throws {RequiredError}
|
|
1060
1055
|
*/
|
|
1061
|
-
|
|
1056
|
+
listPickfaces: async (project: string, search?: string, pageToken?: number, pageSize?: number, sortBy?: Array<ListPickfacesSortByEnum>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1062
1057
|
// verify required parameter 'project' is not null or undefined
|
|
1063
|
-
assertParamExists('
|
|
1064
|
-
|
|
1065
|
-
assertParamExists('listPickfaceLogs', 'pickfaceId', pickfaceId)
|
|
1066
|
-
const localVarPath = `/v1/pickfaces/{pickfaceId}/logs`
|
|
1067
|
-
.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
|
|
1058
|
+
assertParamExists('listPickfaces', 'project', project)
|
|
1059
|
+
const localVarPath = `/v1/pickfaces`;
|
|
1068
1060
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1069
1061
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1070
1062
|
let baseOptions;
|
|
@@ -1087,6 +1079,10 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1087
1079
|
localVarQueryParameter['project'] = project;
|
|
1088
1080
|
}
|
|
1089
1081
|
|
|
1082
|
+
if (search !== undefined) {
|
|
1083
|
+
localVarQueryParameter['search'] = search;
|
|
1084
|
+
}
|
|
1085
|
+
|
|
1090
1086
|
if (pageToken !== undefined) {
|
|
1091
1087
|
localVarQueryParameter['pageToken'] = pageToken;
|
|
1092
1088
|
}
|
|
@@ -1095,6 +1091,10 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1095
1091
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
1096
1092
|
}
|
|
1097
1093
|
|
|
1094
|
+
if (sortBy) {
|
|
1095
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1096
|
+
}
|
|
1097
|
+
|
|
1098
1098
|
|
|
1099
1099
|
|
|
1100
1100
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1525,23 +1525,6 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
|
|
|
1525
1525
|
const localVarOperationServerBasePath = operationServerMap['PickfacesApi.getPickfaceContainerModels']?.[localVarOperationServerIndex]?.url;
|
|
1526
1526
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1527
1527
|
},
|
|
1528
|
-
/**
|
|
1529
|
-
* Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
|
|
1530
|
-
* @summary List pickfaces
|
|
1531
|
-
* @param {string} project What project it is
|
|
1532
|
-
* @param {string} [search] Search term to filter based on pickface code
|
|
1533
|
-
* @param {number} [pageToken] Page reference token
|
|
1534
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1535
|
-
* @param {Array<GetPickfacesSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1536
|
-
* @param {*} [options] Override http request option.
|
|
1537
|
-
* @throws {RequiredError}
|
|
1538
|
-
*/
|
|
1539
|
-
async getPickfaces(project: string, search?: string, pageToken?: number, pageSize?: number, sortBy?: Array<GetPickfacesSortByEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPickfaces200Response>> {
|
|
1540
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getPickfaces(project, search, pageToken, pageSize, sortBy, options);
|
|
1541
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1542
|
-
const localVarOperationServerBasePath = operationServerMap['PickfacesApi.getPickfaces']?.[localVarOperationServerIndex]?.url;
|
|
1543
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1544
|
-
},
|
|
1545
1528
|
/**
|
|
1546
1529
|
* Issue an empty pickface
|
|
1547
1530
|
* @summary Issue empty pickface
|
|
@@ -1588,6 +1571,23 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
|
|
|
1588
1571
|
const localVarOperationServerBasePath = operationServerMap['PickfacesApi.listPickfaceLogs']?.[localVarOperationServerIndex]?.url;
|
|
1589
1572
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1590
1573
|
},
|
|
1574
|
+
/**
|
|
1575
|
+
* Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
|
|
1576
|
+
* @summary List pickfaces
|
|
1577
|
+
* @param {string} project What project it is
|
|
1578
|
+
* @param {string} [search] Search term to filter based on pickface code
|
|
1579
|
+
* @param {number} [pageToken] Page reference token
|
|
1580
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1581
|
+
* @param {Array<ListPickfacesSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1582
|
+
* @param {*} [options] Override http request option.
|
|
1583
|
+
* @throws {RequiredError}
|
|
1584
|
+
*/
|
|
1585
|
+
async listPickfaces(project: string, search?: string, pageToken?: number, pageSize?: number, sortBy?: Array<ListPickfacesSortByEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>> {
|
|
1586
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPickfaces(project, search, pageToken, pageSize, sortBy, options);
|
|
1587
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1588
|
+
const localVarOperationServerBasePath = operationServerMap['PickfacesApi.listPickfaces']?.[localVarOperationServerIndex]?.url;
|
|
1589
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1590
|
+
},
|
|
1591
1591
|
/**
|
|
1592
1592
|
* Move stock from one pickface to another in a single transaction
|
|
1593
1593
|
* @summary Move stock
|
|
@@ -1659,7 +1659,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
|
|
|
1659
1659
|
* @param {*} [options] Override http request option.
|
|
1660
1660
|
* @throws {RequiredError}
|
|
1661
1661
|
*/
|
|
1662
|
-
async suggestPickfaces(project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1662
|
+
async suggestPickfaces(project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>> {
|
|
1663
1663
|
const localVarAxiosArgs = await localVarAxiosParamCreator.suggestPickfaces(project, variantRef, quantity, pageToken, pageSize, options);
|
|
1664
1664
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1665
1665
|
const localVarOperationServerBasePath = operationServerMap['PickfacesApi.suggestPickfaces']?.[localVarOperationServerIndex]?.url;
|
|
@@ -1740,16 +1740,6 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
|
|
|
1740
1740
|
getPickfaceContainerModels(requestParameters: PickfacesApiGetPickfaceContainerModelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ContainerModels> {
|
|
1741
1741
|
return localVarFp.getPickfaceContainerModels(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
1742
1742
|
},
|
|
1743
|
-
/**
|
|
1744
|
-
* Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
|
|
1745
|
-
* @summary List pickfaces
|
|
1746
|
-
* @param {PickfacesApiGetPickfacesRequest} requestParameters Request parameters.
|
|
1747
|
-
* @param {*} [options] Override http request option.
|
|
1748
|
-
* @throws {RequiredError}
|
|
1749
|
-
*/
|
|
1750
|
-
getPickfaces(requestParameters: PickfacesApiGetPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPickfaces200Response> {
|
|
1751
|
-
return localVarFp.getPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(axios, basePath));
|
|
1752
|
-
},
|
|
1753
1743
|
/**
|
|
1754
1744
|
* Issue an empty pickface
|
|
1755
1745
|
* @summary Issue empty pickface
|
|
@@ -1780,6 +1770,16 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
|
|
|
1780
1770
|
listPickfaceLogs(requestParameters: PickfacesApiListPickfaceLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaceLogs200Response> {
|
|
1781
1771
|
return localVarFp.listPickfaceLogs(requestParameters.project, requestParameters.pickfaceId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1782
1772
|
},
|
|
1773
|
+
/**
|
|
1774
|
+
* Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
|
|
1775
|
+
* @summary List pickfaces
|
|
1776
|
+
* @param {PickfacesApiListPickfacesRequest} requestParameters Request parameters.
|
|
1777
|
+
* @param {*} [options] Override http request option.
|
|
1778
|
+
* @throws {RequiredError}
|
|
1779
|
+
*/
|
|
1780
|
+
listPickfaces(requestParameters: PickfacesApiListPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaces200Response> {
|
|
1781
|
+
return localVarFp.listPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(axios, basePath));
|
|
1782
|
+
},
|
|
1783
1783
|
/**
|
|
1784
1784
|
* Move stock from one pickface to another in a single transaction
|
|
1785
1785
|
* @summary Move stock
|
|
@@ -1827,7 +1827,7 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
|
|
|
1827
1827
|
* @param {*} [options] Override http request option.
|
|
1828
1828
|
* @throws {RequiredError}
|
|
1829
1829
|
*/
|
|
1830
|
-
suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
1830
|
+
suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaces200Response> {
|
|
1831
1831
|
return localVarFp.suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1832
1832
|
},
|
|
1833
1833
|
/**
|
|
@@ -1941,48 +1941,6 @@ export interface PickfacesApiGetPickfaceContainerModelsRequest {
|
|
|
1941
1941
|
readonly project: string
|
|
1942
1942
|
}
|
|
1943
1943
|
|
|
1944
|
-
/**
|
|
1945
|
-
* Request parameters for getPickfaces operation in PickfacesApi.
|
|
1946
|
-
* @export
|
|
1947
|
-
* @interface PickfacesApiGetPickfacesRequest
|
|
1948
|
-
*/
|
|
1949
|
-
export interface PickfacesApiGetPickfacesRequest {
|
|
1950
|
-
/**
|
|
1951
|
-
* What project it is
|
|
1952
|
-
* @type {string}
|
|
1953
|
-
* @memberof PickfacesApiGetPickfaces
|
|
1954
|
-
*/
|
|
1955
|
-
readonly project: string
|
|
1956
|
-
|
|
1957
|
-
/**
|
|
1958
|
-
* Search term to filter based on pickface code
|
|
1959
|
-
* @type {string}
|
|
1960
|
-
* @memberof PickfacesApiGetPickfaces
|
|
1961
|
-
*/
|
|
1962
|
-
readonly search?: string
|
|
1963
|
-
|
|
1964
|
-
/**
|
|
1965
|
-
* Page reference token
|
|
1966
|
-
* @type {number}
|
|
1967
|
-
* @memberof PickfacesApiGetPickfaces
|
|
1968
|
-
*/
|
|
1969
|
-
readonly pageToken?: number
|
|
1970
|
-
|
|
1971
|
-
/**
|
|
1972
|
-
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1973
|
-
* @type {number}
|
|
1974
|
-
* @memberof PickfacesApiGetPickfaces
|
|
1975
|
-
*/
|
|
1976
|
-
readonly pageSize?: number
|
|
1977
|
-
|
|
1978
|
-
/**
|
|
1979
|
-
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1980
|
-
* @type {Array<'+available' | '-available' | '+wip' | '-wip' | '+total' | '-total' | '+fullness' | '-fullness' | '+restocked' | '-restocked' | '+picked' | '-picked'>}
|
|
1981
|
-
* @memberof PickfacesApiGetPickfaces
|
|
1982
|
-
*/
|
|
1983
|
-
readonly sortBy?: Array<GetPickfacesSortByEnum>
|
|
1984
|
-
}
|
|
1985
|
-
|
|
1986
1944
|
/**
|
|
1987
1945
|
* Request parameters for issueEmptyPickface operation in PickfacesApi.
|
|
1988
1946
|
* @export
|
|
@@ -2074,6 +2032,48 @@ export interface PickfacesApiListPickfaceLogsRequest {
|
|
|
2074
2032
|
readonly pageSize?: number
|
|
2075
2033
|
}
|
|
2076
2034
|
|
|
2035
|
+
/**
|
|
2036
|
+
* Request parameters for listPickfaces operation in PickfacesApi.
|
|
2037
|
+
* @export
|
|
2038
|
+
* @interface PickfacesApiListPickfacesRequest
|
|
2039
|
+
*/
|
|
2040
|
+
export interface PickfacesApiListPickfacesRequest {
|
|
2041
|
+
/**
|
|
2042
|
+
* What project it is
|
|
2043
|
+
* @type {string}
|
|
2044
|
+
* @memberof PickfacesApiListPickfaces
|
|
2045
|
+
*/
|
|
2046
|
+
readonly project: string
|
|
2047
|
+
|
|
2048
|
+
/**
|
|
2049
|
+
* Search term to filter based on pickface code
|
|
2050
|
+
* @type {string}
|
|
2051
|
+
* @memberof PickfacesApiListPickfaces
|
|
2052
|
+
*/
|
|
2053
|
+
readonly search?: string
|
|
2054
|
+
|
|
2055
|
+
/**
|
|
2056
|
+
* Page reference token
|
|
2057
|
+
* @type {number}
|
|
2058
|
+
* @memberof PickfacesApiListPickfaces
|
|
2059
|
+
*/
|
|
2060
|
+
readonly pageToken?: number
|
|
2061
|
+
|
|
2062
|
+
/**
|
|
2063
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2064
|
+
* @type {number}
|
|
2065
|
+
* @memberof PickfacesApiListPickfaces
|
|
2066
|
+
*/
|
|
2067
|
+
readonly pageSize?: number
|
|
2068
|
+
|
|
2069
|
+
/**
|
|
2070
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2071
|
+
* @type {Array<'+available' | '-available' | '+wip' | '-wip' | '+total' | '-total' | '+fullness' | '-fullness' | '+restocked' | '-restocked' | '+picked' | '-picked'>}
|
|
2072
|
+
* @memberof PickfacesApiListPickfaces
|
|
2073
|
+
*/
|
|
2074
|
+
readonly sortBy?: Array<ListPickfacesSortByEnum>
|
|
2075
|
+
}
|
|
2076
|
+
|
|
2077
2077
|
/**
|
|
2078
2078
|
* Request parameters for moveStock operation in PickfacesApi.
|
|
2079
2079
|
* @export
|
|
@@ -2323,18 +2323,6 @@ export class PickfacesApi extends BaseAPI {
|
|
|
2323
2323
|
return PickfacesApiFp(this.configuration).getPickfaceContainerModels(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
2324
2324
|
}
|
|
2325
2325
|
|
|
2326
|
-
/**
|
|
2327
|
-
* Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
|
|
2328
|
-
* @summary List pickfaces
|
|
2329
|
-
* @param {PickfacesApiGetPickfacesRequest} requestParameters Request parameters.
|
|
2330
|
-
* @param {*} [options] Override http request option.
|
|
2331
|
-
* @throws {RequiredError}
|
|
2332
|
-
* @memberof PickfacesApi
|
|
2333
|
-
*/
|
|
2334
|
-
public getPickfaces(requestParameters: PickfacesApiGetPickfacesRequest, options?: RawAxiosRequestConfig) {
|
|
2335
|
-
return PickfacesApiFp(this.configuration).getPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
|
|
2336
|
-
}
|
|
2337
|
-
|
|
2338
2326
|
/**
|
|
2339
2327
|
* Issue an empty pickface
|
|
2340
2328
|
* @summary Issue empty pickface
|
|
@@ -2371,6 +2359,18 @@ export class PickfacesApi extends BaseAPI {
|
|
|
2371
2359
|
return PickfacesApiFp(this.configuration).listPickfaceLogs(requestParameters.project, requestParameters.pickfaceId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
2372
2360
|
}
|
|
2373
2361
|
|
|
2362
|
+
/**
|
|
2363
|
+
* Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
|
|
2364
|
+
* @summary List pickfaces
|
|
2365
|
+
* @param {PickfacesApiListPickfacesRequest} requestParameters Request parameters.
|
|
2366
|
+
* @param {*} [options] Override http request option.
|
|
2367
|
+
* @throws {RequiredError}
|
|
2368
|
+
* @memberof PickfacesApi
|
|
2369
|
+
*/
|
|
2370
|
+
public listPickfaces(requestParameters: PickfacesApiListPickfacesRequest, options?: RawAxiosRequestConfig) {
|
|
2371
|
+
return PickfacesApiFp(this.configuration).listPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
|
|
2372
|
+
}
|
|
2373
|
+
|
|
2374
2374
|
/**
|
|
2375
2375
|
* Move stock from one pickface to another in a single transaction
|
|
2376
2376
|
* @summary Move stock
|
|
@@ -2447,7 +2447,7 @@ export class PickfacesApi extends BaseAPI {
|
|
|
2447
2447
|
/**
|
|
2448
2448
|
* @export
|
|
2449
2449
|
*/
|
|
2450
|
-
export const
|
|
2450
|
+
export const ListPickfacesSortByEnum = {
|
|
2451
2451
|
Available: '+available',
|
|
2452
2452
|
Available2: '-available',
|
|
2453
2453
|
Wip: '+wip',
|
|
@@ -2461,6 +2461,6 @@ export const GetPickfacesSortByEnum = {
|
|
|
2461
2461
|
Picked: '+picked',
|
|
2462
2462
|
Picked2: '-picked'
|
|
2463
2463
|
} as const;
|
|
2464
|
-
export type
|
|
2464
|
+
export type ListPickfacesSortByEnum = typeof ListPickfacesSortByEnum[keyof typeof ListPickfacesSortByEnum];
|
|
2465
2465
|
|
|
2466
2466
|
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Pickfaces API
|
|
5
5
|
* Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.19.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Pickfaces API
|
|
5
5
|
* Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.19.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Pickfaces API
|
|
5
5
|
* Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.19.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -89,7 +89,13 @@ export class Configuration {
|
|
|
89
89
|
this.accessToken = param.accessToken;
|
|
90
90
|
this.basePath = param.basePath;
|
|
91
91
|
this.serverIndex = param.serverIndex;
|
|
92
|
-
this.baseOptions =
|
|
92
|
+
this.baseOptions = {
|
|
93
|
+
headers: {
|
|
94
|
+
...param.baseOptions?.headers,
|
|
95
|
+
'User-Agent': "OpenAPI-Generator/0.19.1/typescript-axios"
|
|
96
|
+
},
|
|
97
|
+
...param.baseOptions
|
|
98
|
+
};
|
|
93
99
|
this.formDataCtor = param.formDataCtor;
|
|
94
100
|
}
|
|
95
101
|
|