@teemill/pickfaces 0.19.0 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/api.js 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.19.0
7
+ * The version of the OpenAPI document: 0.20.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -39,7 +39,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
39
39
  /**
40
40
  * Create a Pickface
41
41
  * @summary Create Pickface
42
- * @param {string} project What project it is
42
+ * @param {string} project The project ID
43
43
  * @param {CreatePickfaceRequest} createPickfaceRequest Create pickface schema
44
44
  * @param {*} [options] Override http request option.
45
45
  * @throws {RequiredError}
@@ -80,7 +80,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
80
80
  /**
81
81
  * Delete a Pickface
82
82
  * @summary Delete Pickface
83
- * @param {string} project What project it is
83
+ * @param {string} project The project ID
84
84
  * @param {string} pickfaceId Unique identifier of a pickface
85
85
  * @param {*} [options] Override http request option.
86
86
  * @throws {RequiredError}
@@ -120,7 +120,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
120
120
  /**
121
121
  * Export pickfaces as a CSV file
122
122
  * @summary Export pickfaces
123
- * @param {string} project What project it is
123
+ * @param {string} project The project ID
124
124
  * @param {string} [search] Search term to filter based on pickface code
125
125
  * @param {*} [options] Override http request option.
126
126
  * @throws {RequiredError}
@@ -160,7 +160,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
160
160
  /**
161
161
  * Get a specific pickface. Pickfaces contain useful information such as the items they contain and their level of fullness
162
162
  * @summary Get pickface
163
- * @param {string} project What project it is
163
+ * @param {string} project The project ID
164
164
  * @param {string} pickfaceId Unique identifier of a pickface
165
165
  * @param {*} [options] Override http request option.
166
166
  * @throws {RequiredError}
@@ -198,23 +198,30 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
198
198
  };
199
199
  }),
200
200
  /**
201
- * Lists pickface container models
202
- * @summary Get pickface container models
203
- * @param {string} project What project it is
201
+ * Issue an empty pickface
202
+ * @summary Issue empty pickface
203
+ * @param {string} project The project ID
204
+ * @param {string} pickfaceId Unique identifier of a pickface
205
+ * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
204
206
  * @param {*} [options] Override http request option.
205
207
  * @throws {RequiredError}
206
208
  */
207
- getPickfaceContainerModels: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
209
+ issueEmptyPickface: (project_1, pickfaceId_1, issueEmptyPickfaceRequest_1, ...args_1) => __awaiter(this, [project_1, pickfaceId_1, issueEmptyPickfaceRequest_1, ...args_1], void 0, function* (project, pickfaceId, issueEmptyPickfaceRequest, options = {}) {
208
210
  // verify required parameter 'project' is not null or undefined
209
- assertParamExists('getPickfaceContainerModels', 'project', project);
210
- const localVarPath = `/v1/pickfaces/container-models`;
211
+ assertParamExists('issueEmptyPickface', 'project', project);
212
+ // verify required parameter 'pickfaceId' is not null or undefined
213
+ assertParamExists('issueEmptyPickface', 'pickfaceId', pickfaceId);
214
+ // verify required parameter 'issueEmptyPickfaceRequest' is not null or undefined
215
+ assertParamExists('issueEmptyPickface', 'issueEmptyPickfaceRequest', issueEmptyPickfaceRequest);
216
+ const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/empty`
217
+ .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
211
218
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
212
219
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
213
220
  let baseOptions;
214
221
  if (configuration) {
215
222
  baseOptions = configuration.baseOptions;
216
223
  }
217
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
224
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
218
225
  const localVarHeaderParameter = {};
219
226
  const localVarQueryParameter = {};
220
227
  // authentication session-oauth required
@@ -225,36 +232,41 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
225
232
  if (project !== undefined) {
226
233
  localVarQueryParameter['project'] = project;
227
234
  }
235
+ localVarHeaderParameter['Content-Type'] = 'application/json';
228
236
  setSearchParams(localVarUrlObj, localVarQueryParameter);
229
237
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
230
238
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
239
+ localVarRequestOptions.data = serializeDataIfNeeded(issueEmptyPickfaceRequest, localVarRequestOptions, configuration);
231
240
  return {
232
241
  url: toPathString(localVarUrlObj),
233
242
  options: localVarRequestOptions,
234
243
  };
235
244
  }),
236
245
  /**
237
- * Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
238
- * @summary List pickfaces
239
- * @param {string} project What project it is
240
- * @param {string} [search] Search term to filter based on pickface code
241
- * @param {number} [pageToken] Page reference token
242
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
243
- * @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.
246
+ * Issue a pickface with wrong contents
247
+ * @summary Issue wrong contents pickface
248
+ * @param {string} project The project ID
249
+ * @param {string} pickfaceId Unique identifier of a pickface
250
+ * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
244
251
  * @param {*} [options] Override http request option.
245
252
  * @throws {RequiredError}
246
253
  */
247
- getPickfaces: (project_1, search_1, pageToken_1, pageSize_1, sortBy_1, ...args_1) => __awaiter(this, [project_1, search_1, pageToken_1, pageSize_1, sortBy_1, ...args_1], void 0, function* (project, search, pageToken, pageSize, sortBy, options = {}) {
254
+ issueWrongContentsPickface: (project_1, pickfaceId_1, issueWrongContentsPickfaceRequest_1, ...args_1) => __awaiter(this, [project_1, pickfaceId_1, issueWrongContentsPickfaceRequest_1, ...args_1], void 0, function* (project, pickfaceId, issueWrongContentsPickfaceRequest, options = {}) {
248
255
  // verify required parameter 'project' is not null or undefined
249
- assertParamExists('getPickfaces', 'project', project);
250
- const localVarPath = `/v1/pickfaces`;
256
+ assertParamExists('issueWrongContentsPickface', 'project', project);
257
+ // verify required parameter 'pickfaceId' is not null or undefined
258
+ assertParamExists('issueWrongContentsPickface', 'pickfaceId', pickfaceId);
259
+ // verify required parameter 'issueWrongContentsPickfaceRequest' is not null or undefined
260
+ assertParamExists('issueWrongContentsPickface', 'issueWrongContentsPickfaceRequest', issueWrongContentsPickfaceRequest);
261
+ const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/wrong-contents`
262
+ .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
251
263
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
252
264
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
253
265
  let baseOptions;
254
266
  if (configuration) {
255
267
  baseOptions = configuration.baseOptions;
256
268
  }
257
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
269
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
258
270
  const localVarHeaderParameter = {};
259
271
  const localVarQueryParameter = {};
260
272
  // authentication session-oauth required
@@ -265,51 +277,34 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
265
277
  if (project !== undefined) {
266
278
  localVarQueryParameter['project'] = project;
267
279
  }
268
- if (search !== undefined) {
269
- localVarQueryParameter['search'] = search;
270
- }
271
- if (pageToken !== undefined) {
272
- localVarQueryParameter['pageToken'] = pageToken;
273
- }
274
- if (pageSize !== undefined) {
275
- localVarQueryParameter['pageSize'] = pageSize;
276
- }
277
- if (sortBy) {
278
- localVarQueryParameter['sortBy'] = sortBy;
279
- }
280
+ localVarHeaderParameter['Content-Type'] = 'application/json';
280
281
  setSearchParams(localVarUrlObj, localVarQueryParameter);
281
282
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
282
283
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
284
+ localVarRequestOptions.data = serializeDataIfNeeded(issueWrongContentsPickfaceRequest, localVarRequestOptions, configuration);
283
285
  return {
284
286
  url: toPathString(localVarUrlObj),
285
287
  options: localVarRequestOptions,
286
288
  };
287
289
  }),
288
290
  /**
289
- * Issue an empty pickface
290
- * @summary Issue empty pickface
291
- * @param {string} project What project it is
292
- * @param {string} pickfaceId Unique identifier of a pickface
293
- * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
291
+ * Lists pickface container types
292
+ * @summary List pickface container types
293
+ * @param {string} project The project ID
294
294
  * @param {*} [options] Override http request option.
295
295
  * @throws {RequiredError}
296
296
  */
297
- issueEmptyPickface: (project_1, pickfaceId_1, issueEmptyPickfaceRequest_1, ...args_1) => __awaiter(this, [project_1, pickfaceId_1, issueEmptyPickfaceRequest_1, ...args_1], void 0, function* (project, pickfaceId, issueEmptyPickfaceRequest, options = {}) {
297
+ listPickfaceContainerTypes: (project_1, ...args_1) => __awaiter(this, [project_1, ...args_1], void 0, function* (project, options = {}) {
298
298
  // verify required parameter 'project' is not null or undefined
299
- assertParamExists('issueEmptyPickface', 'project', project);
300
- // verify required parameter 'pickfaceId' is not null or undefined
301
- assertParamExists('issueEmptyPickface', 'pickfaceId', pickfaceId);
302
- // verify required parameter 'issueEmptyPickfaceRequest' is not null or undefined
303
- assertParamExists('issueEmptyPickface', 'issueEmptyPickfaceRequest', issueEmptyPickfaceRequest);
304
- const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/empty`
305
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
299
+ assertParamExists('listPickfaceContainerTypes', 'project', project);
300
+ const localVarPath = `/v1/pickfaces/container-types`;
306
301
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
307
302
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
308
303
  let baseOptions;
309
304
  if (configuration) {
310
305
  baseOptions = configuration.baseOptions;
311
306
  }
312
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
307
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
313
308
  const localVarHeaderParameter = {};
314
309
  const localVarQueryParameter = {};
315
310
  // authentication session-oauth required
@@ -320,33 +315,30 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
320
315
  if (project !== undefined) {
321
316
  localVarQueryParameter['project'] = project;
322
317
  }
323
- localVarHeaderParameter['Content-Type'] = 'application/json';
324
318
  setSearchParams(localVarUrlObj, localVarQueryParameter);
325
319
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
326
320
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
327
- localVarRequestOptions.data = serializeDataIfNeeded(issueEmptyPickfaceRequest, localVarRequestOptions, configuration);
328
321
  return {
329
322
  url: toPathString(localVarUrlObj),
330
323
  options: localVarRequestOptions,
331
324
  };
332
325
  }),
333
326
  /**
334
- * Issue a pickface with wrong contents
335
- * @summary Issue wrong contents pickface
336
- * @param {string} project What project it is
327
+ * Get a list of pickface logs
328
+ * @summary Get pickface logs
329
+ * @param {string} project The project ID
337
330
  * @param {string} pickfaceId Unique identifier of a pickface
338
- * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
331
+ * @param {number} [pageToken] Page reference token
332
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
339
333
  * @param {*} [options] Override http request option.
340
334
  * @throws {RequiredError}
341
335
  */
342
- issueWrongContentsPickface: (project_1, pickfaceId_1, issueWrongContentsPickfaceRequest_1, ...args_1) => __awaiter(this, [project_1, pickfaceId_1, issueWrongContentsPickfaceRequest_1, ...args_1], void 0, function* (project, pickfaceId, issueWrongContentsPickfaceRequest, options = {}) {
336
+ listPickfaceLogs: (project_1, pickfaceId_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pickfaceId_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, pickfaceId, pageToken, pageSize, options = {}) {
343
337
  // verify required parameter 'project' is not null or undefined
344
- assertParamExists('issueWrongContentsPickface', 'project', project);
338
+ assertParamExists('listPickfaceLogs', 'project', project);
345
339
  // verify required parameter 'pickfaceId' is not null or undefined
346
- assertParamExists('issueWrongContentsPickface', 'pickfaceId', pickfaceId);
347
- // verify required parameter 'issueWrongContentsPickfaceRequest' is not null or undefined
348
- assertParamExists('issueWrongContentsPickface', 'issueWrongContentsPickfaceRequest', issueWrongContentsPickfaceRequest);
349
- const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/wrong-contents`
340
+ assertParamExists('listPickfaceLogs', 'pickfaceId', pickfaceId);
341
+ const localVarPath = `/v1/pickfaces/{pickfaceId}/logs`
350
342
  .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
351
343
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
352
344
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -354,7 +346,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
354
346
  if (configuration) {
355
347
  baseOptions = configuration.baseOptions;
356
348
  }
357
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
349
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
358
350
  const localVarHeaderParameter = {};
359
351
  const localVarQueryParameter = {};
360
352
  // authentication session-oauth required
@@ -365,33 +357,35 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
365
357
  if (project !== undefined) {
366
358
  localVarQueryParameter['project'] = project;
367
359
  }
368
- localVarHeaderParameter['Content-Type'] = 'application/json';
360
+ if (pageToken !== undefined) {
361
+ localVarQueryParameter['pageToken'] = pageToken;
362
+ }
363
+ if (pageSize !== undefined) {
364
+ localVarQueryParameter['pageSize'] = pageSize;
365
+ }
369
366
  setSearchParams(localVarUrlObj, localVarQueryParameter);
370
367
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
371
368
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
372
- localVarRequestOptions.data = serializeDataIfNeeded(issueWrongContentsPickfaceRequest, localVarRequestOptions, configuration);
373
369
  return {
374
370
  url: toPathString(localVarUrlObj),
375
371
  options: localVarRequestOptions,
376
372
  };
377
373
  }),
378
374
  /**
379
- * Get a list of pickface logs
380
- * @summary Get pickface logs
381
- * @param {string} project What project it is
382
- * @param {string} pickfaceId Unique identifier of a pickface
375
+ * Lists pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
376
+ * @summary List pickfaces
377
+ * @param {string} project The project ID
378
+ * @param {string} [search] Search term to filter based on pickface code
383
379
  * @param {number} [pageToken] Page reference token
384
380
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
381
+ * @param {Array<ListPickfacesSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
385
382
  * @param {*} [options] Override http request option.
386
383
  * @throws {RequiredError}
387
384
  */
388
- listPickfaceLogs: (project_1, pickfaceId_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, pickfaceId_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, pickfaceId, pageToken, pageSize, options = {}) {
385
+ listPickfaces: (project_1, search_1, pageToken_1, pageSize_1, sortBy_1, ...args_1) => __awaiter(this, [project_1, search_1, pageToken_1, pageSize_1, sortBy_1, ...args_1], void 0, function* (project, search, pageToken, pageSize, sortBy, options = {}) {
389
386
  // verify required parameter 'project' is not null or undefined
390
- assertParamExists('listPickfaceLogs', 'project', project);
391
- // verify required parameter 'pickfaceId' is not null or undefined
392
- assertParamExists('listPickfaceLogs', 'pickfaceId', pickfaceId);
393
- const localVarPath = `/v1/pickfaces/{pickfaceId}/logs`
394
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
387
+ assertParamExists('listPickfaces', 'project', project);
388
+ const localVarPath = `/v1/pickfaces`;
395
389
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
396
390
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
397
391
  let baseOptions;
@@ -409,12 +403,18 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
409
403
  if (project !== undefined) {
410
404
  localVarQueryParameter['project'] = project;
411
405
  }
406
+ if (search !== undefined) {
407
+ localVarQueryParameter['search'] = search;
408
+ }
412
409
  if (pageToken !== undefined) {
413
410
  localVarQueryParameter['pageToken'] = pageToken;
414
411
  }
415
412
  if (pageSize !== undefined) {
416
413
  localVarQueryParameter['pageSize'] = pageSize;
417
414
  }
415
+ if (sortBy) {
416
+ localVarQueryParameter['sortBy'] = sortBy;
417
+ }
418
418
  setSearchParams(localVarUrlObj, localVarQueryParameter);
419
419
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
420
420
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -426,7 +426,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
426
426
  /**
427
427
  * Move stock from one pickface to another in a single transaction
428
428
  * @summary Move stock
429
- * @param {string} project What project it is
429
+ * @param {string} project The project ID
430
430
  * @param {string} pickfaceId Unique identifier of a pickface
431
431
  * @param {MoveStockRequest} moveStockRequest Move stock from one pickface to another
432
432
  * @param {*} [options] Override http request option.
@@ -471,7 +471,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
471
471
  /**
472
472
  * Print a pickface label
473
473
  * @summary Print pickface label
474
- * @param {string} project What project it is
474
+ * @param {string} project The project ID
475
475
  * @param {string} pickfaceId Unique identifier of a pickface
476
476
  * @param {string} deviceRef Unique identifier of a warehouse device
477
477
  * @param {*} [options] Override http request option.
@@ -517,7 +517,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
517
517
  /**
518
518
  * Print pickface labels
519
519
  * @summary Print pickface Labels
520
- * @param {string} project What project it is
520
+ * @param {string} project The project ID
521
521
  * @param {string} deviceRef Unique identifier of a warehouse device
522
522
  * @param {string} [search] Search term to filter based on pickface code
523
523
  * @param {Array<string> | null} [ids] List of pickface ids
@@ -567,7 +567,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
567
567
  /**
568
568
  * Resolves an issue on a pickface
569
569
  * @summary Resolve pickface issue
570
- * @param {string} project What project it is
570
+ * @param {string} project The project ID
571
571
  * @param {string} pickfaceId Unique identifier of a pickface
572
572
  * @param {*} [options] Override http request option.
573
573
  * @throws {RequiredError}
@@ -607,7 +607,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
607
607
  /**
608
608
  * Suggest pickfaces for putting away stock
609
609
  * @summary Suggest pickfaces
610
- * @param {string} project What project it is
610
+ * @param {string} project The project ID
611
611
  * @param {string} variantRef Unique identifier of a warehouse variant
612
612
  * @param {number} quantity Number of variants
613
613
  * @param {number} [pageToken] Page reference token
@@ -663,7 +663,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
663
663
  /**
664
664
  * Update a Pickface
665
665
  * @summary Update Pickface
666
- * @param {string} project What project it is
666
+ * @param {string} project The project ID
667
667
  * @param {string} pickfaceId Unique identifier of a pickface
668
668
  * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
669
669
  * @param {*} [options] Override http request option.
@@ -717,7 +717,7 @@ export const PickfacesApiFp = function (configuration) {
717
717
  /**
718
718
  * Create a Pickface
719
719
  * @summary Create Pickface
720
- * @param {string} project What project it is
720
+ * @param {string} project The project ID
721
721
  * @param {CreatePickfaceRequest} createPickfaceRequest Create pickface schema
722
722
  * @param {*} [options] Override http request option.
723
723
  * @throws {RequiredError}
@@ -734,7 +734,7 @@ export const PickfacesApiFp = function (configuration) {
734
734
  /**
735
735
  * Delete a Pickface
736
736
  * @summary Delete Pickface
737
- * @param {string} project What project it is
737
+ * @param {string} project The project ID
738
738
  * @param {string} pickfaceId Unique identifier of a pickface
739
739
  * @param {*} [options] Override http request option.
740
740
  * @throws {RequiredError}
@@ -751,7 +751,7 @@ export const PickfacesApiFp = function (configuration) {
751
751
  /**
752
752
  * Export pickfaces as a CSV file
753
753
  * @summary Export pickfaces
754
- * @param {string} project What project it is
754
+ * @param {string} project The project ID
755
755
  * @param {string} [search] Search term to filter based on pickface code
756
756
  * @param {*} [options] Override http request option.
757
757
  * @throws {RequiredError}
@@ -768,7 +768,7 @@ export const PickfacesApiFp = function (configuration) {
768
768
  /**
769
769
  * Get a specific pickface. Pickfaces contain useful information such as the items they contain and their level of fullness
770
770
  * @summary Get pickface
771
- * @param {string} project What project it is
771
+ * @param {string} project The project ID
772
772
  * @param {string} pickfaceId Unique identifier of a pickface
773
773
  * @param {*} [options] Override http request option.
774
774
  * @throws {RequiredError}
@@ -783,100 +783,100 @@ export const PickfacesApiFp = function (configuration) {
783
783
  });
784
784
  },
785
785
  /**
786
- * Lists pickface container models
787
- * @summary Get pickface container models
788
- * @param {string} project What project it is
786
+ * Issue an empty pickface
787
+ * @summary Issue empty pickface
788
+ * @param {string} project The project ID
789
+ * @param {string} pickfaceId Unique identifier of a pickface
790
+ * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
789
791
  * @param {*} [options] Override http request option.
790
792
  * @throws {RequiredError}
791
793
  */
792
- getPickfaceContainerModels(project, options) {
794
+ issueEmptyPickface(project, pickfaceId, issueEmptyPickfaceRequest, options) {
793
795
  return __awaiter(this, void 0, void 0, function* () {
794
796
  var _a, _b, _c;
795
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getPickfaceContainerModels(project, options);
797
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.issueEmptyPickface(project, pickfaceId, issueEmptyPickfaceRequest, options);
796
798
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
797
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.getPickfaceContainerModels']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
799
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.issueEmptyPickface']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
798
800
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
799
801
  });
800
802
  },
801
803
  /**
802
- * Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
803
- * @summary List pickfaces
804
- * @param {string} project What project it is
805
- * @param {string} [search] Search term to filter based on pickface code
806
- * @param {number} [pageToken] Page reference token
807
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
808
- * @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.
804
+ * Issue a pickface with wrong contents
805
+ * @summary Issue wrong contents pickface
806
+ * @param {string} project The project ID
807
+ * @param {string} pickfaceId Unique identifier of a pickface
808
+ * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
809
809
  * @param {*} [options] Override http request option.
810
810
  * @throws {RequiredError}
811
811
  */
812
- getPickfaces(project, search, pageToken, pageSize, sortBy, options) {
812
+ issueWrongContentsPickface(project, pickfaceId, issueWrongContentsPickfaceRequest, options) {
813
813
  return __awaiter(this, void 0, void 0, function* () {
814
814
  var _a, _b, _c;
815
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getPickfaces(project, search, pageToken, pageSize, sortBy, options);
815
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.issueWrongContentsPickface(project, pickfaceId, issueWrongContentsPickfaceRequest, options);
816
816
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
817
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.getPickfaces']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
817
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.issueWrongContentsPickface']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
818
818
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
819
819
  });
820
820
  },
821
821
  /**
822
- * Issue an empty pickface
823
- * @summary Issue empty pickface
824
- * @param {string} project What project it is
825
- * @param {string} pickfaceId Unique identifier of a pickface
826
- * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
822
+ * Lists pickface container types
823
+ * @summary List pickface container types
824
+ * @param {string} project The project ID
827
825
  * @param {*} [options] Override http request option.
828
826
  * @throws {RequiredError}
829
827
  */
830
- issueEmptyPickface(project, pickfaceId, issueEmptyPickfaceRequest, options) {
828
+ listPickfaceContainerTypes(project, options) {
831
829
  return __awaiter(this, void 0, void 0, function* () {
832
830
  var _a, _b, _c;
833
- const localVarAxiosArgs = yield localVarAxiosParamCreator.issueEmptyPickface(project, pickfaceId, issueEmptyPickfaceRequest, options);
831
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listPickfaceContainerTypes(project, options);
834
832
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
835
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.issueEmptyPickface']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
833
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.listPickfaceContainerTypes']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
836
834
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
837
835
  });
838
836
  },
839
837
  /**
840
- * Issue a pickface with wrong contents
841
- * @summary Issue wrong contents pickface
842
- * @param {string} project What project it is
838
+ * Get a list of pickface logs
839
+ * @summary Get pickface logs
840
+ * @param {string} project The project ID
843
841
  * @param {string} pickfaceId Unique identifier of a pickface
844
- * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
842
+ * @param {number} [pageToken] Page reference token
843
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
845
844
  * @param {*} [options] Override http request option.
846
845
  * @throws {RequiredError}
847
846
  */
848
- issueWrongContentsPickface(project, pickfaceId, issueWrongContentsPickfaceRequest, options) {
847
+ listPickfaceLogs(project, pickfaceId, pageToken, pageSize, options) {
849
848
  return __awaiter(this, void 0, void 0, function* () {
850
849
  var _a, _b, _c;
851
- const localVarAxiosArgs = yield localVarAxiosParamCreator.issueWrongContentsPickface(project, pickfaceId, issueWrongContentsPickfaceRequest, options);
850
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listPickfaceLogs(project, pickfaceId, pageToken, pageSize, options);
852
851
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
853
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.issueWrongContentsPickface']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
852
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.listPickfaceLogs']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
854
853
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
855
854
  });
856
855
  },
857
856
  /**
858
- * Get a list of pickface logs
859
- * @summary Get pickface logs
860
- * @param {string} project What project it is
861
- * @param {string} pickfaceId Unique identifier of a pickface
857
+ * Lists pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
858
+ * @summary List pickfaces
859
+ * @param {string} project The project ID
860
+ * @param {string} [search] Search term to filter based on pickface code
862
861
  * @param {number} [pageToken] Page reference token
863
862
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
863
+ * @param {Array<ListPickfacesSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
864
864
  * @param {*} [options] Override http request option.
865
865
  * @throws {RequiredError}
866
866
  */
867
- listPickfaceLogs(project, pickfaceId, pageToken, pageSize, options) {
867
+ listPickfaces(project, search, pageToken, pageSize, sortBy, options) {
868
868
  return __awaiter(this, void 0, void 0, function* () {
869
869
  var _a, _b, _c;
870
- const localVarAxiosArgs = yield localVarAxiosParamCreator.listPickfaceLogs(project, pickfaceId, pageToken, pageSize, options);
870
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listPickfaces(project, search, pageToken, pageSize, sortBy, options);
871
871
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
872
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.listPickfaceLogs']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
872
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.listPickfaces']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
873
873
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
874
874
  });
875
875
  },
876
876
  /**
877
877
  * Move stock from one pickface to another in a single transaction
878
878
  * @summary Move stock
879
- * @param {string} project What project it is
879
+ * @param {string} project The project ID
880
880
  * @param {string} pickfaceId Unique identifier of a pickface
881
881
  * @param {MoveStockRequest} moveStockRequest Move stock from one pickface to another
882
882
  * @param {*} [options] Override http request option.
@@ -894,7 +894,7 @@ export const PickfacesApiFp = function (configuration) {
894
894
  /**
895
895
  * Print a pickface label
896
896
  * @summary Print pickface label
897
- * @param {string} project What project it is
897
+ * @param {string} project The project ID
898
898
  * @param {string} pickfaceId Unique identifier of a pickface
899
899
  * @param {string} deviceRef Unique identifier of a warehouse device
900
900
  * @param {*} [options] Override http request option.
@@ -912,7 +912,7 @@ export const PickfacesApiFp = function (configuration) {
912
912
  /**
913
913
  * Print pickface labels
914
914
  * @summary Print pickface Labels
915
- * @param {string} project What project it is
915
+ * @param {string} project The project ID
916
916
  * @param {string} deviceRef Unique identifier of a warehouse device
917
917
  * @param {string} [search] Search term to filter based on pickface code
918
918
  * @param {Array<string> | null} [ids] List of pickface ids
@@ -931,7 +931,7 @@ export const PickfacesApiFp = function (configuration) {
931
931
  /**
932
932
  * Resolves an issue on a pickface
933
933
  * @summary Resolve pickface issue
934
- * @param {string} project What project it is
934
+ * @param {string} project The project ID
935
935
  * @param {string} pickfaceId Unique identifier of a pickface
936
936
  * @param {*} [options] Override http request option.
937
937
  * @throws {RequiredError}
@@ -948,7 +948,7 @@ export const PickfacesApiFp = function (configuration) {
948
948
  /**
949
949
  * Suggest pickfaces for putting away stock
950
950
  * @summary Suggest pickfaces
951
- * @param {string} project What project it is
951
+ * @param {string} project The project ID
952
952
  * @param {string} variantRef Unique identifier of a warehouse variant
953
953
  * @param {number} quantity Number of variants
954
954
  * @param {number} [pageToken] Page reference token
@@ -968,7 +968,7 @@ export const PickfacesApiFp = function (configuration) {
968
968
  /**
969
969
  * Update a Pickface
970
970
  * @summary Update Pickface
971
- * @param {string} project What project it is
971
+ * @param {string} project The project ID
972
972
  * @param {string} pickfaceId Unique identifier of a pickface
973
973
  * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
974
974
  * @param {*} [options] Override http request option.
@@ -1032,26 +1032,6 @@ export const PickfacesApiFactory = function (configuration, basePath, axios) {
1032
1032
  getPickface(requestParameters, options) {
1033
1033
  return localVarFp.getPickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(axios, basePath));
1034
1034
  },
1035
- /**
1036
- * Lists pickface container models
1037
- * @summary Get pickface container models
1038
- * @param {PickfacesApiGetPickfaceContainerModelsRequest} requestParameters Request parameters.
1039
- * @param {*} [options] Override http request option.
1040
- * @throws {RequiredError}
1041
- */
1042
- getPickfaceContainerModels(requestParameters, options) {
1043
- return localVarFp.getPickfaceContainerModels(requestParameters.project, options).then((request) => request(axios, basePath));
1044
- },
1045
- /**
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
1048
- * @param {PickfacesApiGetPickfacesRequest} requestParameters Request parameters.
1049
- * @param {*} [options] Override http request option.
1050
- * @throws {RequiredError}
1051
- */
1052
- getPickfaces(requestParameters, options) {
1053
- return localVarFp.getPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(axios, basePath));
1054
- },
1055
1035
  /**
1056
1036
  * Issue an empty pickface
1057
1037
  * @summary Issue empty pickface
@@ -1072,6 +1052,16 @@ export const PickfacesApiFactory = function (configuration, basePath, axios) {
1072
1052
  issueWrongContentsPickface(requestParameters, options) {
1073
1053
  return localVarFp.issueWrongContentsPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueWrongContentsPickfaceRequest, options).then((request) => request(axios, basePath));
1074
1054
  },
1055
+ /**
1056
+ * Lists pickface container types
1057
+ * @summary List pickface container types
1058
+ * @param {PickfacesApiListPickfaceContainerTypesRequest} requestParameters Request parameters.
1059
+ * @param {*} [options] Override http request option.
1060
+ * @throws {RequiredError}
1061
+ */
1062
+ listPickfaceContainerTypes(requestParameters, options) {
1063
+ return localVarFp.listPickfaceContainerTypes(requestParameters.project, options).then((request) => request(axios, basePath));
1064
+ },
1075
1065
  /**
1076
1066
  * Get a list of pickface logs
1077
1067
  * @summary Get pickface logs
@@ -1082,6 +1072,16 @@ export const PickfacesApiFactory = function (configuration, basePath, axios) {
1082
1072
  listPickfaceLogs(requestParameters, options) {
1083
1073
  return localVarFp.listPickfaceLogs(requestParameters.project, requestParameters.pickfaceId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1084
1074
  },
1075
+ /**
1076
+ * Lists pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
1077
+ * @summary List pickfaces
1078
+ * @param {PickfacesApiListPickfacesRequest} requestParameters Request parameters.
1079
+ * @param {*} [options] Override http request option.
1080
+ * @throws {RequiredError}
1081
+ */
1082
+ listPickfaces(requestParameters, options) {
1083
+ return localVarFp.listPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(axios, basePath));
1084
+ },
1085
1085
  /**
1086
1086
  * Move stock from one pickface to another in a single transaction
1087
1087
  * @summary Move stock
@@ -1195,28 +1195,6 @@ export class PickfacesApi extends BaseAPI {
1195
1195
  getPickface(requestParameters, options) {
1196
1196
  return PickfacesApiFp(this.configuration).getPickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
1197
1197
  }
1198
- /**
1199
- * Lists pickface container models
1200
- * @summary Get pickface container models
1201
- * @param {PickfacesApiGetPickfaceContainerModelsRequest} requestParameters Request parameters.
1202
- * @param {*} [options] Override http request option.
1203
- * @throws {RequiredError}
1204
- * @memberof PickfacesApi
1205
- */
1206
- getPickfaceContainerModels(requestParameters, options) {
1207
- return PickfacesApiFp(this.configuration).getPickfaceContainerModels(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
1208
- }
1209
- /**
1210
- * Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
1211
- * @summary List pickfaces
1212
- * @param {PickfacesApiGetPickfacesRequest} requestParameters Request parameters.
1213
- * @param {*} [options] Override http request option.
1214
- * @throws {RequiredError}
1215
- * @memberof PickfacesApi
1216
- */
1217
- getPickfaces(requestParameters, options) {
1218
- return PickfacesApiFp(this.configuration).getPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
1219
- }
1220
1198
  /**
1221
1199
  * Issue an empty pickface
1222
1200
  * @summary Issue empty pickface
@@ -1239,6 +1217,17 @@ export class PickfacesApi extends BaseAPI {
1239
1217
  issueWrongContentsPickface(requestParameters, options) {
1240
1218
  return PickfacesApiFp(this.configuration).issueWrongContentsPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueWrongContentsPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
1241
1219
  }
1220
+ /**
1221
+ * Lists pickface container types
1222
+ * @summary List pickface container types
1223
+ * @param {PickfacesApiListPickfaceContainerTypesRequest} requestParameters Request parameters.
1224
+ * @param {*} [options] Override http request option.
1225
+ * @throws {RequiredError}
1226
+ * @memberof PickfacesApi
1227
+ */
1228
+ listPickfaceContainerTypes(requestParameters, options) {
1229
+ return PickfacesApiFp(this.configuration).listPickfaceContainerTypes(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
1230
+ }
1242
1231
  /**
1243
1232
  * Get a list of pickface logs
1244
1233
  * @summary Get pickface logs
@@ -1250,6 +1239,17 @@ export class PickfacesApi extends BaseAPI {
1250
1239
  listPickfaceLogs(requestParameters, options) {
1251
1240
  return PickfacesApiFp(this.configuration).listPickfaceLogs(requestParameters.project, requestParameters.pickfaceId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
1252
1241
  }
1242
+ /**
1243
+ * Lists pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
1244
+ * @summary List pickfaces
1245
+ * @param {PickfacesApiListPickfacesRequest} requestParameters Request parameters.
1246
+ * @param {*} [options] Override http request option.
1247
+ * @throws {RequiredError}
1248
+ * @memberof PickfacesApi
1249
+ */
1250
+ listPickfaces(requestParameters, options) {
1251
+ return PickfacesApiFp(this.configuration).listPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, options).then((request) => request(this.axios, this.basePath));
1252
+ }
1253
1253
  /**
1254
1254
  * Move stock from one pickface to another in a single transaction
1255
1255
  * @summary Move stock
@@ -1320,7 +1320,7 @@ export class PickfacesApi extends BaseAPI {
1320
1320
  /**
1321
1321
  * @export
1322
1322
  */
1323
- export const GetPickfacesSortByEnum = {
1323
+ export const ListPickfacesSortByEnum = {
1324
1324
  Available: '+available',
1325
1325
  Available2: '-available',
1326
1326
  Wip: '+wip',