@teemill/pickfaces 0.36.0 → 0.36.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,6 +5,35 @@ api.ts
5
5
  base.ts
6
6
  common.ts
7
7
  configuration.ts
8
+ docs/ApiError.md
9
+ docs/ContainerType.md
10
+ docs/ContainerTypes.md
11
+ docs/CreatePickfaceRequest.md
12
+ docs/ExportPickfaces202Response.md
13
+ docs/IssueEmptyPickfaceRequest.md
14
+ docs/IssueWrongContentsPickfaceRequest.md
15
+ docs/ListPickfaceLogs200Response.md
16
+ docs/ListPickfaces200Response.md
17
+ docs/MoveStockRequest.md
18
+ docs/Pickface.md
19
+ docs/PickfaceContainerType.md
20
+ docs/PickfaceContentsInner.md
21
+ docs/PickfaceContentsInnerMetadata.md
22
+ docs/PickfaceContentsInnerQuantity.md
23
+ docs/PickfaceIssue.md
24
+ docs/PickfaceLog.md
25
+ docs/PickfaceZone.md
26
+ docs/PickfacesApi.md
27
+ docs/UpdatePickfaceRequest.md
28
+ docs/UpdatePickfaceRequestContentsInner.md
29
+ docs/UpdatePickfaceRequestContentsInnerQuantity.md
30
+ docs/UpdatePickfaceRequestContentsInnerQuantityAvailable.md
31
+ docs/UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf.md
32
+ docs/UpdatePickfaceRequestContentsInnerQuantityZWip.md
33
+ docs/UpdatePickfacesRequest.md
34
+ docs/UpdatePickfacesRequestPickfacesInner.md
35
+ docs/VariantAttribute.md
36
+ docs/VariantAttributeThumbnail.md
8
37
  git_push.sh
9
38
  index.ts
10
39
  package.json
@@ -1 +1 @@
1
- 7.8.0
1
+ 7.21.0
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/pickfaces@0.36.0
1
+ ## @teemill/pickfaces@0.36.2
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.36.0 --save
39
+ npm install @teemill/pickfaces@0.36.2 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Pickfaces API
4
+ * Pickfaces
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.36.0
7
+ * The version of the OpenAPI document: 0.36.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,8 +23,17 @@ import type { RequestArgs } from './base';
23
23
  // @ts-ignore
24
24
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
25
 
26
+ /**
27
+ * Represents an error returned by the API.
28
+ */
26
29
  export interface ApiError {
30
+ /**
31
+ * A machine-readable error code identifying the type of error.
32
+ */
27
33
  'code'?: string;
34
+ /**
35
+ * A human-readable message providing more details about the error.
36
+ */
28
37
  'message': string;
29
38
  }
30
39
  /**
@@ -140,13 +149,16 @@ export interface MoveStockRequest {
140
149
  */
141
150
  'toPickfaceRef': string;
142
151
  }
152
+ /**
153
+ * A warehouse pickface (storage location) containing stock items, with information about its contents, fullness, and container type.
154
+ */
143
155
  export interface Pickface {
144
156
  /**
145
- * Unique object identifier
157
+ * The unique identifier of the pickface.
146
158
  */
147
159
  'id': string;
148
160
  /**
149
- * A reference to the resource location
161
+ * A URI reference to this pickface resource.
150
162
  */
151
163
  'ref': string;
152
164
  /**
@@ -269,13 +281,16 @@ export interface PickfaceIssue {
269
281
  */
270
282
  'ref'?: string;
271
283
  }
284
+ /**
285
+ * A log entry recording an action performed on a pickface (e.g. pick, restock, adjustment).
286
+ */
272
287
  export interface PickfaceLog {
273
288
  /**
274
- * Unique object identifier
289
+ * The unique identifier of this log entry.
275
290
  */
276
291
  'id': string;
277
292
  /**
278
- * A reference to the resource location
293
+ * A reference to the user who performed the action.
279
294
  */
280
295
  'userRef': string;
281
296
  /**
@@ -336,7 +351,7 @@ export interface UpdatePickfaceRequest {
336
351
  'distanceFromLabelPrinter'?: number | null;
337
352
  'contents'?: Array<UpdatePickfaceRequestContentsInner> | null;
338
353
  /**
339
- * Unique object identifier
354
+ * The purchase order id related to the stock that is being added or subtracted from the pickface
340
355
  */
341
356
  'purchaseOrderId'?: string;
342
357
  }
@@ -365,7 +380,7 @@ export interface UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf {
365
380
  export const UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = {
366
381
  Add: 'add',
367
382
  Subtract: 'subtract',
368
- Set: 'set'
383
+ Set: 'set',
369
384
  } as const;
370
385
 
371
386
  export type UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum];
@@ -381,7 +396,7 @@ export interface UpdatePickfaceRequestContentsInnerQuantityZWip {
381
396
  export const UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum = {
382
397
  Add: 'add',
383
398
  Subtract: 'subtract',
384
- Set: 'set'
399
+ Set: 'set',
385
400
  } as const;
386
401
 
387
402
  export type UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum];
@@ -437,7 +452,7 @@ export interface VariantAttributeThumbnail {
437
452
  export const VariantAttributeThumbnailTypeEnum = {
438
453
  Text: 'text',
439
454
  Color: 'color',
440
- Image: 'image'
455
+ Image: 'image',
441
456
  } as const;
442
457
 
443
458
  export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
@@ -2354,7 +2369,7 @@ export class PickfacesApi extends BaseAPI {
2354
2369
 
2355
2370
  export const ExportPickfacesCostModeEnum = {
2356
2371
  Split: 'split',
2357
- Average: 'average'
2372
+ Average: 'average',
2358
2373
  } as const;
2359
2374
  export type ExportPickfacesCostModeEnum = typeof ExportPickfacesCostModeEnum[keyof typeof ExportPickfacesCostModeEnum];
2360
2375
  export const ListPickfacesSortByEnum = {
@@ -2369,7 +2384,9 @@ export const ListPickfacesSortByEnum = {
2369
2384
  Restocked: '+restocked',
2370
2385
  Restocked2: '-restocked',
2371
2386
  Picked: '+picked',
2372
- Picked2: '-picked'
2387
+ Picked2: '-picked',
2388
+ Code: '+code',
2389
+ Code2: '-code',
2373
2390
  } as const;
2374
2391
  export type ListPickfacesSortByEnum = typeof ListPickfacesSortByEnum[keyof typeof ListPickfacesSortByEnum];
2375
2392
 
package/base.ts CHANGED
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Pickfaces API
4
+ * Pickfaces
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.36.0
7
+ * The version of the OpenAPI document: 0.36.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Pickfaces API
4
+ * Pickfaces
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.36.0
7
+ * The version of the OpenAPI document: 0.36.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -1,9 +1,9 @@
1
1
  /* tslint:disable */
2
2
  /**
3
- * Pickfaces API
3
+ * Pickfaces
4
4
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
5
5
  *
6
- * The version of the OpenAPI document: 0.36.0
6
+ * The version of the OpenAPI document: 0.36.2
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/api.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Pickfaces API
2
+ * Pickfaces
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.36.0
5
+ * The version of the OpenAPI document: 0.36.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,8 +13,17 @@ import type { Configuration } from './configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import type { RequestArgs } from './base';
15
15
  import { BaseAPI } from './base';
16
+ /**
17
+ * Represents an error returned by the API.
18
+ */
16
19
  export interface ApiError {
20
+ /**
21
+ * A machine-readable error code identifying the type of error.
22
+ */
17
23
  'code'?: string;
24
+ /**
25
+ * A human-readable message providing more details about the error.
26
+ */
18
27
  'message': string;
19
28
  }
20
29
  /**
@@ -130,13 +139,16 @@ export interface MoveStockRequest {
130
139
  */
131
140
  'toPickfaceRef': string;
132
141
  }
142
+ /**
143
+ * A warehouse pickface (storage location) containing stock items, with information about its contents, fullness, and container type.
144
+ */
133
145
  export interface Pickface {
134
146
  /**
135
- * Unique object identifier
147
+ * The unique identifier of the pickface.
136
148
  */
137
149
  'id': string;
138
150
  /**
139
- * A reference to the resource location
151
+ * A URI reference to this pickface resource.
140
152
  */
141
153
  'ref': string;
142
154
  /**
@@ -259,13 +271,16 @@ export interface PickfaceIssue {
259
271
  */
260
272
  'ref'?: string;
261
273
  }
274
+ /**
275
+ * A log entry recording an action performed on a pickface (e.g. pick, restock, adjustment).
276
+ */
262
277
  export interface PickfaceLog {
263
278
  /**
264
- * Unique object identifier
279
+ * The unique identifier of this log entry.
265
280
  */
266
281
  'id': string;
267
282
  /**
268
- * A reference to the resource location
283
+ * A reference to the user who performed the action.
269
284
  */
270
285
  'userRef': string;
271
286
  /**
@@ -326,7 +341,7 @@ export interface UpdatePickfaceRequest {
326
341
  'distanceFromLabelPrinter'?: number | null;
327
342
  'contents'?: Array<UpdatePickfaceRequestContentsInner> | null;
328
343
  /**
329
- * Unique object identifier
344
+ * The purchase order id related to the stock that is being added or subtracted from the pickface
330
345
  */
331
346
  'purchaseOrderId'?: string;
332
347
  }
@@ -1364,5 +1379,7 @@ export declare const ListPickfacesSortByEnum: {
1364
1379
  readonly Restocked2: "-restocked";
1365
1380
  readonly Picked: "+picked";
1366
1381
  readonly Picked2: "-picked";
1382
+ readonly Code: "+code";
1383
+ readonly Code2: "-code";
1367
1384
  };
1368
1385
  export type ListPickfacesSortByEnum = typeof ListPickfacesSortByEnum[keyof typeof ListPickfacesSortByEnum];
package/dist/api.js CHANGED
@@ -2,10 +2,10 @@
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
4
  /**
5
- * Pickfaces API
5
+ * Pickfaces
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.36.0
8
+ * The version of the OpenAPI document: 0.36.2
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,17 +32,17 @@ const base_1 = require("./base");
32
32
  exports.UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = {
33
33
  Add: 'add',
34
34
  Subtract: 'subtract',
35
- Set: 'set'
35
+ Set: 'set',
36
36
  };
37
37
  exports.UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum = {
38
38
  Add: 'add',
39
39
  Subtract: 'subtract',
40
- Set: 'set'
40
+ Set: 'set',
41
41
  };
42
42
  exports.VariantAttributeThumbnailTypeEnum = {
43
43
  Text: 'text',
44
44
  Color: 'color',
45
- Image: 'image'
45
+ Image: 'image',
46
46
  };
47
47
  /**
48
48
  * PickfacesApi - axios parameter creator
@@ -1510,7 +1510,7 @@ class PickfacesApi extends base_1.BaseAPI {
1510
1510
  exports.PickfacesApi = PickfacesApi;
1511
1511
  exports.ExportPickfacesCostModeEnum = {
1512
1512
  Split: 'split',
1513
- Average: 'average'
1513
+ Average: 'average',
1514
1514
  };
1515
1515
  exports.ListPickfacesSortByEnum = {
1516
1516
  Available: '+available',
@@ -1524,5 +1524,7 @@ exports.ListPickfacesSortByEnum = {
1524
1524
  Restocked: '+restocked',
1525
1525
  Restocked2: '-restocked',
1526
1526
  Picked: '+picked',
1527
- Picked2: '-picked'
1527
+ Picked2: '-picked',
1528
+ Code: '+code',
1529
+ Code2: '-code',
1528
1530
  };
package/dist/base.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Pickfaces API
2
+ * Pickfaces
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.36.0
5
+ * The version of the OpenAPI document: 0.36.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -2,10 +2,10 @@
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
4
  /**
5
- * Pickfaces API
5
+ * Pickfaces
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.36.0
8
+ * The version of the OpenAPI document: 0.36.2
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Pickfaces API
2
+ * Pickfaces
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.36.0
5
+ * The version of the OpenAPI document: 0.36.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -2,10 +2,10 @@
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
4
  /**
5
- * Pickfaces API
5
+ * Pickfaces
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.36.0
8
+ * The version of the OpenAPI document: 0.36.2
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Pickfaces API
2
+ * Pickfaces
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.36.0
5
+ * The version of the OpenAPI document: 0.36.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,10 +1,10 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
3
  /**
4
- * Pickfaces API
4
+ * Pickfaces
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.36.0
7
+ * The version of the OpenAPI document: 0.36.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/api.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Pickfaces API
2
+ * Pickfaces
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.36.0
5
+ * The version of the OpenAPI document: 0.36.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,8 +13,17 @@ import type { Configuration } from './configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import type { RequestArgs } from './base';
15
15
  import { BaseAPI } from './base';
16
+ /**
17
+ * Represents an error returned by the API.
18
+ */
16
19
  export interface ApiError {
20
+ /**
21
+ * A machine-readable error code identifying the type of error.
22
+ */
17
23
  'code'?: string;
24
+ /**
25
+ * A human-readable message providing more details about the error.
26
+ */
18
27
  'message': string;
19
28
  }
20
29
  /**
@@ -130,13 +139,16 @@ export interface MoveStockRequest {
130
139
  */
131
140
  'toPickfaceRef': string;
132
141
  }
142
+ /**
143
+ * A warehouse pickface (storage location) containing stock items, with information about its contents, fullness, and container type.
144
+ */
133
145
  export interface Pickface {
134
146
  /**
135
- * Unique object identifier
147
+ * The unique identifier of the pickface.
136
148
  */
137
149
  'id': string;
138
150
  /**
139
- * A reference to the resource location
151
+ * A URI reference to this pickface resource.
140
152
  */
141
153
  'ref': string;
142
154
  /**
@@ -259,13 +271,16 @@ export interface PickfaceIssue {
259
271
  */
260
272
  'ref'?: string;
261
273
  }
274
+ /**
275
+ * A log entry recording an action performed on a pickface (e.g. pick, restock, adjustment).
276
+ */
262
277
  export interface PickfaceLog {
263
278
  /**
264
- * Unique object identifier
279
+ * The unique identifier of this log entry.
265
280
  */
266
281
  'id': string;
267
282
  /**
268
- * A reference to the resource location
283
+ * A reference to the user who performed the action.
269
284
  */
270
285
  'userRef': string;
271
286
  /**
@@ -326,7 +341,7 @@ export interface UpdatePickfaceRequest {
326
341
  'distanceFromLabelPrinter'?: number | null;
327
342
  'contents'?: Array<UpdatePickfaceRequestContentsInner> | null;
328
343
  /**
329
- * Unique object identifier
344
+ * The purchase order id related to the stock that is being added or subtracted from the pickface
330
345
  */
331
346
  'purchaseOrderId'?: string;
332
347
  }
@@ -1364,5 +1379,7 @@ export declare const ListPickfacesSortByEnum: {
1364
1379
  readonly Restocked2: "-restocked";
1365
1380
  readonly Picked: "+picked";
1366
1381
  readonly Picked2: "-picked";
1382
+ readonly Code: "+code";
1383
+ readonly Code2: "-code";
1367
1384
  };
1368
1385
  export type ListPickfacesSortByEnum = typeof ListPickfacesSortByEnum[keyof typeof ListPickfacesSortByEnum];
package/dist/esm/api.js CHANGED
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Pickfaces API
4
+ * Pickfaces
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.36.0
7
+ * The version of the OpenAPI document: 0.36.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,17 +29,17 @@ import { BASE_PATH, BaseAPI, operationServerMap } from './base';
29
29
  export const UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = {
30
30
  Add: 'add',
31
31
  Subtract: 'subtract',
32
- Set: 'set'
32
+ Set: 'set',
33
33
  };
34
34
  export const UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum = {
35
35
  Add: 'add',
36
36
  Subtract: 'subtract',
37
- Set: 'set'
37
+ Set: 'set',
38
38
  };
39
39
  export const VariantAttributeThumbnailTypeEnum = {
40
40
  Text: 'text',
41
41
  Color: 'color',
42
- Image: 'image'
42
+ Image: 'image',
43
43
  };
44
44
  /**
45
45
  * PickfacesApi - axios parameter creator
@@ -1503,7 +1503,7 @@ export class PickfacesApi extends BaseAPI {
1503
1503
  }
1504
1504
  export const ExportPickfacesCostModeEnum = {
1505
1505
  Split: 'split',
1506
- Average: 'average'
1506
+ Average: 'average',
1507
1507
  };
1508
1508
  export const ListPickfacesSortByEnum = {
1509
1509
  Available: '+available',
@@ -1517,5 +1517,7 @@ export const ListPickfacesSortByEnum = {
1517
1517
  Restocked: '+restocked',
1518
1518
  Restocked2: '-restocked',
1519
1519
  Picked: '+picked',
1520
- Picked2: '-picked'
1520
+ Picked2: '-picked',
1521
+ Code: '+code',
1522
+ Code2: '-code',
1521
1523
  };
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Pickfaces API
2
+ * Pickfaces
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.36.0
5
+ * The version of the OpenAPI document: 0.36.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Pickfaces API
4
+ * Pickfaces
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.36.0
7
+ * The version of the OpenAPI document: 0.36.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Pickfaces API
2
+ * Pickfaces
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.36.0
5
+ * The version of the OpenAPI document: 0.36.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Pickfaces API
4
+ * Pickfaces
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.36.0
7
+ * The version of the OpenAPI document: 0.36.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Pickfaces API
2
+ * Pickfaces
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.36.0
5
+ * The version of the OpenAPI document: 0.36.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,9 +1,9 @@
1
1
  /* tslint:disable */
2
2
  /**
3
- * Pickfaces API
3
+ * Pickfaces
4
4
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
5
5
  *
6
- * The version of the OpenAPI document: 0.36.0
6
+ * The version of the OpenAPI document: 0.36.2
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Pickfaces API
2
+ * Pickfaces
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.36.0
5
+ * The version of the OpenAPI document: 0.36.2
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
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Pickfaces API
4
+ * Pickfaces
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.36.0
7
+ * The version of the OpenAPI document: 0.36.2
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
@@ -1,8 +1,8 @@
1
1
  /**
2
- * Pickfaces API
2
+ * Pickfaces
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.36.0
5
+ * The version of the OpenAPI document: 0.36.2
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -2,10 +2,10 @@
2
2
  /* tslint:disable */
3
3
  /* eslint-disable */
4
4
  /**
5
- * Pickfaces API
5
+ * Pickfaces
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.36.0
8
+ * The version of the OpenAPI document: 0.36.2
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/docs/ApiError.md CHANGED
@@ -1,12 +1,13 @@
1
1
  # ApiError
2
2
 
3
+ Represents an error returned by the API.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **code** | **string** | | [optional] [default to undefined]
9
- **message** | **string** | | [default to undefined]
9
+ **code** | **string** | A machine-readable error code identifying the type of error. | [optional] [default to undefined]
10
+ **message** | **string** | A human-readable message providing more details about the error. | [default to undefined]
10
11
 
11
12
  ## Example
12
13
 
package/docs/Pickface.md CHANGED
@@ -1,12 +1,13 @@
1
1
  # Pickface
2
2
 
3
+ A warehouse pickface (storage location) containing stock items, with information about its contents, fullness, and container type.
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | Unique object identifier | [default to undefined]
9
- **ref** | **string** | A reference to the resource location | [default to undefined]
9
+ **id** | **string** | The unique identifier of the pickface. | [default to undefined]
10
+ **ref** | **string** | A URI reference to this pickface resource. | [default to undefined]
10
11
  **barcode** | **string** | The barcode of the pickface | [default to undefined]
11
12
  **zone** | [**PickfaceZone**](PickfaceZone.md) | | [default to undefined]
12
13
  **code** | **string** | The human readable location of the pickface, if a name is provided this will be the name. | [default to undefined]
@@ -1,12 +1,13 @@
1
1
  # PickfaceLog
2
2
 
3
+ A log entry recording an action performed on a pickface (e.g. pick, restock, adjustment).
3
4
 
4
5
  ## Properties
5
6
 
6
7
  Name | Type | Description | Notes
7
8
  ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | Unique object identifier | [default to undefined]
9
- **userRef** | **string** | A reference to the resource location | [default to undefined]
9
+ **id** | **string** | The unique identifier of this log entry. | [default to undefined]
10
+ **userRef** | **string** | A reference to the user who performed the action. | [default to undefined]
10
11
  **action** | **string** | The action that was taken | [default to undefined]
11
12
  **reason** | **string** | The reason for the action | [default to undefined]
12
13
  **createdAt** | **string** | ISO 8601 Created at timestamp | [default to undefined]
@@ -253,8 +253,8 @@ const { status, data } = await apiInstance.exportPickfaces(
253
253
  ### HTTP response details
254
254
  | Status code | Description | Response headers |
255
255
  |-------------|-------------|------------------|
256
- |**200** | Returns the CSV export | - |
257
- |**202** | Export started. When complete, the export will be available for download from a notification within PodOS Dashboard. | - |
256
+ |**200** | The dataset is small enough to return immediately. Returns the CSV export directly. | - |
257
+ |**202** | The dataset is too large to return immediately. The export has been queued and a notification will be sent when it is ready for download. | - |
258
258
  |**400** | Failed validation | - |
259
259
  |**401** | Not authorised to access this resource | - |
260
260
  |**403** | Refuse to authorize | - |
@@ -587,7 +587,7 @@ let project: string; //The project ID (default to undefined)
587
587
  let search: string; //Search term to filter based on pickface code (optional) (default to undefined)
588
588
  let pageToken: number; //Page reference token (optional) (default to 1)
589
589
  let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
590
- let sortBy: Array<'+available' | '-available' | '+wip' | '-wip' | '+total' | '-total' | '+fullness' | '-fullness' | '+restocked' | '-restocked' | '+picked' | '-picked'>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
590
+ let sortBy: Array<'+available' | '-available' | '+wip' | '-wip' | '+total' | '-total' | '+fullness' | '-fullness' | '+restocked' | '-restocked' | '+picked' | '-picked' | '+code' | '-code'>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
591
591
  let updatedStart: string; //Start of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string (optional) (default to undefined)
592
592
  let updatedEnd: string; //End of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string (optional) (default to undefined)
593
593
 
@@ -610,7 +610,7 @@ const { status, data } = await apiInstance.listPickfaces(
610
610
  | **search** | [**string**] | Search term to filter based on pickface code | (optional) defaults to undefined|
611
611
  | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
612
612
  | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
613
- | **sortBy** | **Array<&#39;+available&#39; &#124; &#39;-available&#39; &#124; &#39;+wip&#39; &#124; &#39;-wip&#39; &#124; &#39;+total&#39; &#124; &#39;-total&#39; &#124; &#39;+fullness&#39; &#124; &#39;-fullness&#39; &#124; &#39;+restocked&#39; &#124; &#39;-restocked&#39; &#124; &#39;+picked&#39; &#124; &#39;-picked&#39;>** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
613
+ | **sortBy** | **Array<&#39;+available&#39; &#124; &#39;-available&#39; &#124; &#39;+wip&#39; &#124; &#39;-wip&#39; &#124; &#39;+total&#39; &#124; &#39;-total&#39; &#124; &#39;+fullness&#39; &#124; &#39;-fullness&#39; &#124; &#39;+restocked&#39; &#124; &#39;-restocked&#39; &#124; &#39;+picked&#39; &#124; &#39;-picked&#39; &#124; &#39;+code&#39; &#124; &#39;-code&#39;>** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
614
614
  | **updatedStart** | [**string**] | Start of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string | (optional) defaults to undefined|
615
615
  | **updatedEnd** | [**string**] | End of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string | (optional) defaults to undefined|
616
616
 
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
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
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
- **purchaseOrderId** | **string** | Unique object identifier | [optional] [default to undefined]
17
+ **purchaseOrderId** | **string** | The purchase order id related to the stock that is being added or subtracted from the pickface | [optional] [default to undefined]
18
18
 
19
19
  ## Example
20
20
 
package/index.ts CHANGED
@@ -1,10 +1,10 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  /**
4
- * Pickfaces API
4
+ * Pickfaces
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.36.0
7
+ * The version of the OpenAPI document: 0.36.2
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/pickfaces",
3
- "version": "0.36.0",
3
+ "version": "0.36.2",
4
4
  "description": "OpenAPI client for @teemill/pickfaces",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -24,7 +24,7 @@
24
24
  "prepare": "npm run build"
25
25
  },
26
26
  "dependencies": {
27
- "axios": "1.13.5"
27
+ "axios": "1.15.0"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@types/node": "12.11.5 - 12.20.42",