@teemill/pickfaces 0.30.0 → 0.31.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.30.0
7
+ * The version of the OpenAPI document: 0.31.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -43,10 +43,49 @@ export const VariantAttributeThumbnailTypeEnum = {
43
43
  };
44
44
  /**
45
45
  * PickfacesApi - axios parameter creator
46
- * @export
47
46
  */
48
47
  export const PickfacesApiAxiosParamCreator = function (configuration) {
49
48
  return {
49
+ /**
50
+ * Mark stock as checked in a pickface
51
+ * @summary Mark stock as checked
52
+ * @param {string} project The project ID
53
+ * @param {string} pickfaceId Unique identifier of a pickface
54
+ * @param {*} [options] Override http request option.
55
+ * @throws {RequiredError}
56
+ */
57
+ checkedStock: (project_1, pickfaceId_1, ...args_1) => __awaiter(this, [project_1, pickfaceId_1, ...args_1], void 0, function* (project, pickfaceId, options = {}) {
58
+ // verify required parameter 'project' is not null or undefined
59
+ assertParamExists('checkedStock', 'project', project);
60
+ // verify required parameter 'pickfaceId' is not null or undefined
61
+ assertParamExists('checkedStock', 'pickfaceId', pickfaceId);
62
+ const localVarPath = `/v1/pickfaces/{pickfaceId}/stock/checked`
63
+ .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
64
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
65
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
66
+ let baseOptions;
67
+ if (configuration) {
68
+ baseOptions = configuration.baseOptions;
69
+ }
70
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
71
+ const localVarHeaderParameter = {};
72
+ const localVarQueryParameter = {};
73
+ // authentication session-oauth required
74
+ // oauth required
75
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
76
+ // authentication api-key required
77
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
78
+ if (project !== undefined) {
79
+ localVarQueryParameter['project'] = project;
80
+ }
81
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
82
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
83
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
84
+ return {
85
+ url: toPathString(localVarUrlObj),
86
+ options: localVarRequestOptions,
87
+ };
88
+ }),
50
89
  /**
51
90
  * Create a Pickface
52
91
  * @summary Create Pickface
@@ -777,11 +816,27 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
777
816
  };
778
817
  /**
779
818
  * PickfacesApi - functional programming interface
780
- * @export
781
819
  */
782
820
  export const PickfacesApiFp = function (configuration) {
783
821
  const localVarAxiosParamCreator = PickfacesApiAxiosParamCreator(configuration);
784
822
  return {
823
+ /**
824
+ * Mark stock as checked in a pickface
825
+ * @summary Mark stock as checked
826
+ * @param {string} project The project ID
827
+ * @param {string} pickfaceId Unique identifier of a pickface
828
+ * @param {*} [options] Override http request option.
829
+ * @throws {RequiredError}
830
+ */
831
+ checkedStock(project, pickfaceId, options) {
832
+ return __awaiter(this, void 0, void 0, function* () {
833
+ var _a, _b, _c;
834
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.checkedStock(project, pickfaceId, options);
835
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
836
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.checkedStock']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
837
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
838
+ });
839
+ },
785
840
  /**
786
841
  * Create a Pickface
787
842
  * @summary Create Pickface
@@ -1075,11 +1130,20 @@ export const PickfacesApiFp = function (configuration) {
1075
1130
  };
1076
1131
  /**
1077
1132
  * PickfacesApi - factory interface
1078
- * @export
1079
1133
  */
1080
1134
  export const PickfacesApiFactory = function (configuration, basePath, axios) {
1081
1135
  const localVarFp = PickfacesApiFp(configuration);
1082
1136
  return {
1137
+ /**
1138
+ * Mark stock as checked in a pickface
1139
+ * @summary Mark stock as checked
1140
+ * @param {PickfacesApiCheckedStockRequest} requestParameters Request parameters.
1141
+ * @param {*} [options] Override http request option.
1142
+ * @throws {RequiredError}
1143
+ */
1144
+ checkedStock(requestParameters, options) {
1145
+ return localVarFp.checkedStock(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(axios, basePath));
1146
+ },
1083
1147
  /**
1084
1148
  * Create a Pickface
1085
1149
  * @summary Create Pickface
@@ -1244,18 +1308,24 @@ export const PickfacesApiFactory = function (configuration, basePath, axios) {
1244
1308
  };
1245
1309
  /**
1246
1310
  * PickfacesApi - object-oriented interface
1247
- * @export
1248
- * @class PickfacesApi
1249
- * @extends {BaseAPI}
1250
1311
  */
1251
1312
  export class PickfacesApi extends BaseAPI {
1313
+ /**
1314
+ * Mark stock as checked in a pickface
1315
+ * @summary Mark stock as checked
1316
+ * @param {PickfacesApiCheckedStockRequest} requestParameters Request parameters.
1317
+ * @param {*} [options] Override http request option.
1318
+ * @throws {RequiredError}
1319
+ */
1320
+ checkedStock(requestParameters, options) {
1321
+ return PickfacesApiFp(this.configuration).checkedStock(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
1322
+ }
1252
1323
  /**
1253
1324
  * Create a Pickface
1254
1325
  * @summary Create Pickface
1255
1326
  * @param {PickfacesApiCreatePickfaceRequest} requestParameters Request parameters.
1256
1327
  * @param {*} [options] Override http request option.
1257
1328
  * @throws {RequiredError}
1258
- * @memberof PickfacesApi
1259
1329
  */
1260
1330
  createPickface(requestParameters, options) {
1261
1331
  return PickfacesApiFp(this.configuration).createPickface(requestParameters.project, requestParameters.createPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
@@ -1266,7 +1336,6 @@ export class PickfacesApi extends BaseAPI {
1266
1336
  * @param {PickfacesApiDeletePickfaceRequest} requestParameters Request parameters.
1267
1337
  * @param {*} [options] Override http request option.
1268
1338
  * @throws {RequiredError}
1269
- * @memberof PickfacesApi
1270
1339
  */
1271
1340
  deletePickface(requestParameters, options) {
1272
1341
  return PickfacesApiFp(this.configuration).deletePickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
@@ -1277,7 +1346,6 @@ export class PickfacesApi extends BaseAPI {
1277
1346
  * @param {PickfacesApiExportPickfacesRequest} requestParameters Request parameters.
1278
1347
  * @param {*} [options] Override http request option.
1279
1348
  * @throws {RequiredError}
1280
- * @memberof PickfacesApi
1281
1349
  */
1282
1350
  exportPickfaces(requestParameters, options) {
1283
1351
  return PickfacesApiFp(this.configuration).exportPickfaces(requestParameters.project, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
@@ -1288,7 +1356,6 @@ export class PickfacesApi extends BaseAPI {
1288
1356
  * @param {PickfacesApiGetPickfaceRequest} requestParameters Request parameters.
1289
1357
  * @param {*} [options] Override http request option.
1290
1358
  * @throws {RequiredError}
1291
- * @memberof PickfacesApi
1292
1359
  */
1293
1360
  getPickface(requestParameters, options) {
1294
1361
  return PickfacesApiFp(this.configuration).getPickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
@@ -1299,7 +1366,6 @@ export class PickfacesApi extends BaseAPI {
1299
1366
  * @param {PickfacesApiIssueEmptyPickfaceRequest} requestParameters Request parameters.
1300
1367
  * @param {*} [options] Override http request option.
1301
1368
  * @throws {RequiredError}
1302
- * @memberof PickfacesApi
1303
1369
  */
1304
1370
  issueEmptyPickface(requestParameters, options) {
1305
1371
  return PickfacesApiFp(this.configuration).issueEmptyPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueEmptyPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
@@ -1310,7 +1376,6 @@ export class PickfacesApi extends BaseAPI {
1310
1376
  * @param {PickfacesApiIssueWrongContentsPickfaceRequest} requestParameters Request parameters.
1311
1377
  * @param {*} [options] Override http request option.
1312
1378
  * @throws {RequiredError}
1313
- * @memberof PickfacesApi
1314
1379
  */
1315
1380
  issueWrongContentsPickface(requestParameters, options) {
1316
1381
  return PickfacesApiFp(this.configuration).issueWrongContentsPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueWrongContentsPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
@@ -1321,7 +1386,6 @@ export class PickfacesApi extends BaseAPI {
1321
1386
  * @param {PickfacesApiListPickfaceContainerTypesRequest} requestParameters Request parameters.
1322
1387
  * @param {*} [options] Override http request option.
1323
1388
  * @throws {RequiredError}
1324
- * @memberof PickfacesApi
1325
1389
  */
1326
1390
  listPickfaceContainerTypes(requestParameters, options) {
1327
1391
  return PickfacesApiFp(this.configuration).listPickfaceContainerTypes(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
@@ -1332,7 +1396,6 @@ export class PickfacesApi extends BaseAPI {
1332
1396
  * @param {PickfacesApiListPickfaceLogsRequest} requestParameters Request parameters.
1333
1397
  * @param {*} [options] Override http request option.
1334
1398
  * @throws {RequiredError}
1335
- * @memberof PickfacesApi
1336
1399
  */
1337
1400
  listPickfaceLogs(requestParameters, options) {
1338
1401
  return PickfacesApiFp(this.configuration).listPickfaceLogs(requestParameters.project, requestParameters.pickfaceId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
@@ -1343,7 +1406,6 @@ export class PickfacesApi extends BaseAPI {
1343
1406
  * @param {PickfacesApiListPickfacesRequest} requestParameters Request parameters.
1344
1407
  * @param {*} [options] Override http request option.
1345
1408
  * @throws {RequiredError}
1346
- * @memberof PickfacesApi
1347
1409
  */
1348
1410
  listPickfaces(requestParameters, options) {
1349
1411
  return PickfacesApiFp(this.configuration).listPickfaces(requestParameters.project, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, requestParameters.sortBy, requestParameters.updatedStart, requestParameters.updatedEnd, options).then((request) => request(this.axios, this.basePath));
@@ -1354,7 +1416,6 @@ export class PickfacesApi extends BaseAPI {
1354
1416
  * @param {PickfacesApiMoveStockRequest} requestParameters Request parameters.
1355
1417
  * @param {*} [options] Override http request option.
1356
1418
  * @throws {RequiredError}
1357
- * @memberof PickfacesApi
1358
1419
  */
1359
1420
  moveStock(requestParameters, options) {
1360
1421
  return PickfacesApiFp(this.configuration).moveStock(requestParameters.project, requestParameters.pickfaceId, requestParameters.moveStockRequest, options).then((request) => request(this.axios, this.basePath));
@@ -1365,7 +1426,6 @@ export class PickfacesApi extends BaseAPI {
1365
1426
  * @param {PickfacesApiPrintPickfaceLabelRequest} requestParameters Request parameters.
1366
1427
  * @param {*} [options] Override http request option.
1367
1428
  * @throws {RequiredError}
1368
- * @memberof PickfacesApi
1369
1429
  */
1370
1430
  printPickfaceLabel(requestParameters, options) {
1371
1431
  return PickfacesApiFp(this.configuration).printPickfaceLabel(requestParameters.project, requestParameters.pickfaceId, requestParameters.deviceRef, options).then((request) => request(this.axios, this.basePath));
@@ -1376,7 +1436,6 @@ export class PickfacesApi extends BaseAPI {
1376
1436
  * @param {PickfacesApiPrintPickfaceLabelsRequest} requestParameters Request parameters.
1377
1437
  * @param {*} [options] Override http request option.
1378
1438
  * @throws {RequiredError}
1379
- * @memberof PickfacesApi
1380
1439
  */
1381
1440
  printPickfaceLabels(requestParameters, options) {
1382
1441
  return PickfacesApiFp(this.configuration).printPickfaceLabels(requestParameters.project, requestParameters.deviceRef, requestParameters.search, requestParameters.ids, options).then((request) => request(this.axios, this.basePath));
@@ -1387,7 +1446,6 @@ export class PickfacesApi extends BaseAPI {
1387
1446
  * @param {PickfacesApiResolvePickfaceIssueRequest} requestParameters Request parameters.
1388
1447
  * @param {*} [options] Override http request option.
1389
1448
  * @throws {RequiredError}
1390
- * @memberof PickfacesApi
1391
1449
  */
1392
1450
  resolvePickfaceIssue(requestParameters, options) {
1393
1451
  return PickfacesApiFp(this.configuration).resolvePickfaceIssue(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
@@ -1398,7 +1456,6 @@ export class PickfacesApi extends BaseAPI {
1398
1456
  * @param {PickfacesApiSuggestPickfacesRequest} requestParameters Request parameters.
1399
1457
  * @param {*} [options] Override http request option.
1400
1458
  * @throws {RequiredError}
1401
- * @memberof PickfacesApi
1402
1459
  */
1403
1460
  suggestPickfaces(requestParameters, options) {
1404
1461
  return PickfacesApiFp(this.configuration).suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.sellThroughRate, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
@@ -1409,7 +1466,6 @@ export class PickfacesApi extends BaseAPI {
1409
1466
  * @param {PickfacesApiUpdatePickfaceRequest} requestParameters Request parameters.
1410
1467
  * @param {*} [options] Override http request option.
1411
1468
  * @throws {RequiredError}
1412
- * @memberof PickfacesApi
1413
1469
  */
1414
1470
  updatePickface(requestParameters, options) {
1415
1471
  return PickfacesApiFp(this.configuration).updatePickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.updatePickfaceRequest, options).then((request) => request(this.axios, this.basePath));
@@ -1420,15 +1476,11 @@ export class PickfacesApi extends BaseAPI {
1420
1476
  * @param {PickfacesApiUpdatePickfacesRequest} requestParameters Request parameters.
1421
1477
  * @param {*} [options] Override http request option.
1422
1478
  * @throws {RequiredError}
1423
- * @memberof PickfacesApi
1424
1479
  */
1425
1480
  updatePickfaces(requestParameters, options) {
1426
1481
  return PickfacesApiFp(this.configuration).updatePickfaces(requestParameters.project, requestParameters.updatePickfacesRequest, options).then((request) => request(this.axios, this.basePath));
1427
1482
  }
1428
1483
  }
1429
- /**
1430
- * @export
1431
- */
1432
1484
  export const ListPickfacesSortByEnum = {
1433
1485
  Available: '+available',
1434
1486
  Available2: '-available',
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.30.0
5
+ * The version of the OpenAPI document: 0.31.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,42 +12,22 @@
12
12
  import type { Configuration } from './configuration';
13
13
  import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const COLLECTION_FORMATS: {
20
16
  csv: string;
21
17
  ssv: string;
22
18
  tsv: string;
23
19
  pipes: string;
24
20
  };
25
- /**
26
- *
27
- * @export
28
- * @interface RequestArgs
29
- */
30
21
  export interface RequestArgs {
31
22
  url: string;
32
23
  options: RawAxiosRequestConfig;
33
24
  }
34
- /**
35
- *
36
- * @export
37
- * @class BaseAPI
38
- */
39
25
  export declare class BaseAPI {
40
26
  protected basePath: string;
41
27
  protected axios: AxiosInstance;
42
28
  protected configuration: Configuration | undefined;
43
29
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
44
30
  }
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
31
  export declare class RequiredError extends Error {
52
32
  field: string;
53
33
  constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
58
38
  description: string;
59
39
  }[];
60
40
  }
61
- /**
62
- *
63
- * @export
64
- */
65
41
  export declare const operationServerMap: ServerMap;
66
42
  export {};
package/dist/esm/base.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.30.0
7
+ * The version of the OpenAPI document: 0.31.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,21 +13,12 @@
13
13
  */
14
14
  import globalAxios from 'axios';
15
15
  export const BASE_PATH = "https://api.localhost:8080".replace(/\/+$/, "");
16
- /**
17
- *
18
- * @export
19
- */
20
16
  export const COLLECTION_FORMATS = {
21
17
  csv: ",",
22
18
  ssv: " ",
23
19
  tsv: "\t",
24
20
  pipes: "|",
25
21
  };
26
- /**
27
- *
28
- * @export
29
- * @class BaseAPI
30
- */
31
22
  export class BaseAPI {
32
23
  constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
33
24
  var _a;
@@ -40,12 +31,6 @@ export class BaseAPI {
40
31
  }
41
32
  }
42
33
  ;
43
- /**
44
- *
45
- * @export
46
- * @class RequiredError
47
- * @extends {Error}
48
- */
49
34
  export class RequiredError extends Error {
50
35
  constructor(field, msg) {
51
36
  super(msg);
@@ -53,8 +38,4 @@ export class RequiredError extends Error {
53
38
  this.name = "RequiredError";
54
39
  }
55
40
  }
56
- /**
57
- *
58
- * @export
59
- */
60
41
  export const operationServerMap = {};
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.30.0
5
+ * The version of the OpenAPI document: 0.31.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.30.0
7
+ * The version of the OpenAPI document: 0.31.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.30.0
5
+ * The version of the OpenAPI document: 0.31.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,49 +23,32 @@ export declare class Configuration {
23
23
  /**
24
24
  * parameter for apiKey security
25
25
  * @param name security name
26
- * @memberof Configuration
27
26
  */
28
27
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
28
  /**
30
29
  * parameter for basic security
31
- *
32
- * @type {string}
33
- * @memberof Configuration
34
30
  */
35
31
  username?: string;
36
32
  /**
37
33
  * parameter for basic security
38
- *
39
- * @type {string}
40
- * @memberof Configuration
41
34
  */
42
35
  password?: string;
43
36
  /**
44
37
  * parameter for oauth2 security
45
38
  * @param name security name
46
39
  * @param scopes oauth2 scope
47
- * @memberof Configuration
48
40
  */
49
41
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
50
42
  /**
51
43
  * override base path
52
- *
53
- * @type {string}
54
- * @memberof Configuration
55
44
  */
56
45
  basePath?: string;
57
46
  /**
58
47
  * override server index
59
- *
60
- * @type {number}
61
- * @memberof Configuration
62
48
  */
63
49
  serverIndex?: number;
64
50
  /**
65
51
  * base options for axios calls
66
- *
67
- * @type {any}
68
- * @memberof Configuration
69
52
  */
70
53
  baseOptions?: any;
71
54
  /**
@@ -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.30.0
7
+ * The version of the OpenAPI document: 0.31.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.30.0
5
+ * The version of the OpenAPI document: 0.31.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.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.30.0
7
+ * The version of the OpenAPI document: 0.31.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.30.0
5
+ * The version of the OpenAPI document: 0.31.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Pickfaces API
6
6
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
7
7
  *
8
- * The version of the OpenAPI document: 0.30.0
8
+ * The version of the OpenAPI document: 0.31.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
11
11
  **bulk** | **boolean** | Whether the pickface is used for bulk storage | [optional] [default to false]
12
12
  **mixedContents** | **boolean** | Whether the pickface can contain mixed contents. | [optional] [default to false]
13
13
  **zoneId** | **string** | Typically this field is left empty. Use \&#39;Zones API\&#39; &gt; \&#39;List warehouse zones\&#39; to get a list of available options. | [optional] [default to undefined]
14
- **distanceFromLabelPrinter** | **number** | The distance from the nearest label printer to the pickface in meters. This is used for put away recommendations. | [optional] [default to undefined]
14
+ **distanceFromLabelPrinter** | **number** | The distance from the nearest label printer to the pickface in centimeters. This is used for put away recommendations. | [optional] [default to undefined]
15
15
 
16
16
  ## Example
17
17
 
package/docs/Pickface.md CHANGED
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
19
19
  **lastRestocked** | [**PickfaceLog**](PickfaceLog.md) | The last time the pickface was restocked | [default to undefined]
20
20
  **issue** | [**PickfaceIssue**](PickfaceIssue.md) | | [default to undefined]
21
21
  **contents** | [**Array&lt;PickfaceContentsInner&gt;**](PickfaceContentsInner.md) | | [default to undefined]
22
- **distanceFromLabelPrinter** | **number** | The distance from the nearest label printer to the pickface in meters. | [default to undefined]
22
+ **distanceFromLabelPrinter** | **number** | The distance from the nearest label printer to the pickface in centimeters. | [default to undefined]
23
23
 
24
24
  ## Example
25
25
 
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.localhost:8080*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**checkedStock**](#checkedstock) | **POST** /v1/pickfaces/{pickfaceId}/stock/checked | Mark stock as checked|
7
8
  |[**createPickface**](#createpickface) | **POST** /v1/pickfaces | Create Pickface|
8
9
  |[**deletePickface**](#deletepickface) | **DELETE** /v1/pickfaces/{pickfaceId} | Delete Pickface|
9
10
  |[**exportPickfaces**](#exportpickfaces) | **GET** /v1/pickfaces/export | Export pickfaces|
@@ -21,6 +22,65 @@ All URIs are relative to *https://api.localhost:8080*
21
22
  |[**updatePickface**](#updatepickface) | **PATCH** /v1/pickfaces/{pickfaceId} | Update Pickface|
22
23
  |[**updatePickfaces**](#updatepickfaces) | **PATCH** /v1/pickfaces | Update pickfaces|
23
24
 
25
+ # **checkedStock**
26
+ > checkedStock()
27
+
28
+ Mark stock as checked in a pickface
29
+
30
+ ### Example
31
+
32
+ ```typescript
33
+ import {
34
+ PickfacesApi,
35
+ Configuration
36
+ } from '@teemill/pickfaces';
37
+
38
+ const configuration = new Configuration();
39
+ const apiInstance = new PickfacesApi(configuration);
40
+
41
+ let project: string; //The project ID (default to undefined)
42
+ let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
43
+
44
+ const { status, data } = await apiInstance.checkedStock(
45
+ project,
46
+ pickfaceId
47
+ );
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ |Name | Type | Description | Notes|
53
+ |------------- | ------------- | ------------- | -------------|
54
+ | **project** | [**string**] | The project ID | defaults to undefined|
55
+ | **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
56
+
57
+
58
+ ### Return type
59
+
60
+ void (empty response body)
61
+
62
+ ### Authorization
63
+
64
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
65
+
66
+ ### HTTP request headers
67
+
68
+ - **Content-Type**: Not defined
69
+ - **Accept**: application/json
70
+
71
+
72
+ ### HTTP response details
73
+ | Status code | Description | Response headers |
74
+ |-------------|-------------|------------------|
75
+ |**204** | This will add a log entry to the pickface that the stock has been checked by the requester | - |
76
+ |**400** | Failed validation | - |
77
+ |**401** | Not authorised to access this resource | - |
78
+ |**403** | Refuse to authorize | - |
79
+ |**404** | Resource not found | - |
80
+ |**500** | Unknown server error | - |
81
+
82
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
83
+
24
84
  # **createPickface**
25
85
  > Pickface createPickface(createPickfaceRequest)
26
86
 
@@ -504,7 +564,7 @@ const { status, data } = await apiInstance.listPickfaceLogs(
504
564
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
505
565
 
506
566
  # **listPickfaces**
507
- > InlineObject listPickfaces()
567
+ > ListPickfaces200Response listPickfaces()
508
568
 
509
569
  Lists pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
510
570
 
@@ -553,7 +613,7 @@ const { status, data } = await apiInstance.listPickfaces(
553
613
 
554
614
  ### Return type
555
615
 
556
- **InlineObject**
616
+ **ListPickfaces200Response**
557
617
 
558
618
  ### Authorization
559
619
 
@@ -824,7 +884,7 @@ const { status, data } = await apiInstance.resolvePickfaceIssue(
824
884
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
825
885
 
826
886
  # **suggestPickfaces**
827
- > InlineObject suggestPickfaces()
887
+ > ListPickfaces200Response suggestPickfaces()
828
888
 
829
889
  Suggest pickfaces for putting away stock
830
890
 
@@ -870,7 +930,7 @@ const { status, data } = await apiInstance.suggestPickfaces(
870
930
 
871
931
  ### Return type
872
932
 
873
- **InlineObject**
933
+ **ListPickfaces200Response**
874
934
 
875
935
  ### Authorization
876
936
 
@@ -957,7 +1017,7 @@ const { status, data } = await apiInstance.updatePickface(
957
1017
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
958
1018
 
959
1019
  # **updatePickfaces**
960
- > InlineObject updatePickfaces(updatePickfacesRequest)
1020
+ > ListPickfaces200Response updatePickfaces(updatePickfacesRequest)
961
1021
 
962
1022
  Update pickfaces in bulk
963
1023
 
@@ -992,7 +1052,7 @@ const { status, data } = await apiInstance.updatePickfaces(
992
1052
 
993
1053
  ### Return type
994
1054
 
995
- **InlineObject**
1055
+ **ListPickfaces200Response**
996
1056
 
997
1057
  ### Authorization
998
1058
 
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
12
12
  **mixedContents** | **boolean** | Whether the pickface can contain mixed contents. | [optional] [default to undefined]
13
13
  **bulk** | **boolean** | Whether the pickface is used for bulk storage | [optional] [default to undefined]
14
14
  **name** | **string** | A user defined name for the pickface, if this is not provided the location will be used as the name. | [optional] [default to undefined]
15
- **distanceFromLabelPrinter** | **number** | The distance from the nearest label printer to the pickface in meters. This is used for put away recommendations. | [optional] [default to undefined]
15
+ **distanceFromLabelPrinter** | **number** | The distance from the nearest label printer to the pickface in centimeters. This is used for put away recommendations. | [optional] [default to undefined]
16
16
  **contents** | [**Array&lt;UpdatePickfaceRequestContentsInner&gt;**](UpdatePickfaceRequestContentsInner.md) | | [optional] [default to undefined]
17
17
  **purchaseOrderId** | **string** | Unique object identifier | [optional] [default to undefined]
18
18
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **enabled** | **boolean** | Whether the pickface is enabled | [optional] [default to undefined]
11
11
  **mixedContents** | **boolean** | Whether the pickface can contain mixed contents. | [optional] [default to undefined]
12
12
  **bulk** | **boolean** | Whether the pickface is used for bulk storage | [optional] [default to undefined]
13
- **distanceFromLabelPrinter** | **number** | The distance from the nearest label printer to the pickface in meters. This is used for put away recommendations. | [optional] [default to undefined]
13
+ **distanceFromLabelPrinter** | **number** | The distance from the nearest label printer to the pickface in centimeters. This is used for put away recommendations. | [optional] [default to undefined]
14
14
 
15
15
  ## Example
16
16