@teemill/pickfaces 0.19.1 → 0.20.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Pickfaces API
5
5
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
6
6
  *
7
- * The version of the OpenAPI document: 0.19.1
7
+ * The version of the OpenAPI document: 0.20.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -45,58 +45,58 @@ export interface ApiError {
45
45
  /**
46
46
  * The factory container the pickface is within
47
47
  * @export
48
- * @interface ContainerModel
48
+ * @interface ContainerType
49
49
  */
50
- export interface ContainerModel {
50
+ export interface ContainerType {
51
51
  /**
52
52
  * Unique object identifier
53
53
  * @type {string}
54
- * @memberof ContainerModel
54
+ * @memberof ContainerType
55
55
  */
56
56
  'id': string;
57
57
  /**
58
58
  * A reference to the resource location
59
59
  * @type {string}
60
- * @memberof ContainerModel
60
+ * @memberof ContainerType
61
61
  */
62
62
  'ref': string;
63
63
  /**
64
64
  *
65
65
  * @type {string}
66
- * @memberof ContainerModel
66
+ * @memberof ContainerType
67
67
  */
68
68
  'name': string;
69
69
  /**
70
- * The width of the model in millimetres
70
+ * The width of the container in millimetres
71
71
  * @type {number}
72
- * @memberof ContainerModel
72
+ * @memberof ContainerType
73
73
  */
74
74
  'width'?: number;
75
75
  /**
76
- * The depth of the model in millimetres
76
+ * The depth of the container in millimetres
77
77
  * @type {number}
78
- * @memberof ContainerModel
78
+ * @memberof ContainerType
79
79
  */
80
80
  'depth'?: number;
81
81
  /**
82
- * The height of the model in millimetres
82
+ * The height of the container in millimetres
83
83
  * @type {number}
84
- * @memberof ContainerModel
84
+ * @memberof ContainerType
85
85
  */
86
86
  'height'?: number;
87
87
  }
88
88
  /**
89
89
  *
90
90
  * @export
91
- * @interface ContainerModels
91
+ * @interface ContainerTypes
92
92
  */
93
- export interface ContainerModels {
93
+ export interface ContainerTypes {
94
94
  /**
95
95
  *
96
- * @type {Array<ContainerModel>}
97
- * @memberof ContainerModels
96
+ * @type {Array<ContainerType>}
97
+ * @memberof ContainerTypes
98
98
  */
99
- 'containerModels'?: Array<ContainerModel>;
99
+ 'containerTypes'?: Array<ContainerType>;
100
100
  }
101
101
  /**
102
102
  *
@@ -105,19 +105,19 @@ export interface ContainerModels {
105
105
  */
106
106
  export interface CreatePickfaceRequest {
107
107
  /**
108
- * The location of the pickface
108
+ * A human readable location for the pickface i.e. \"1 Wf 49\"
109
109
  * @type {string}
110
110
  * @memberof CreatePickfaceRequest
111
111
  */
112
- 'location'?: string;
112
+ 'location': string;
113
113
  /**
114
- * Unique object identifier
114
+ * Use \'Pickfaces API\' > \'List pickface container types\' to get a list of available options.
115
115
  * @type {string}
116
116
  * @memberof CreatePickfaceRequest
117
117
  */
118
- 'containerModelId'?: string;
118
+ 'containerTypeId': string;
119
119
  /**
120
- * Unique object identifier
120
+ * Typically this field is left empty. Use \'Zones API\' > \'List warehouse zones\' to get a list of available options.
121
121
  * @type {string}
122
122
  * @memberof CreatePickfaceRequest
123
123
  */
@@ -250,7 +250,7 @@ export interface Pickface {
250
250
  */
251
251
  'ref'?: string;
252
252
  /**
253
- *
253
+ * The human readable location of the pickface
254
254
  * @type {string}
255
255
  * @memberof Pickface
256
256
  */
@@ -263,10 +263,10 @@ export interface Pickface {
263
263
  'enabled'?: boolean;
264
264
  /**
265
265
  *
266
- * @type {PickfaceContainerModel}
266
+ * @type {PickfaceContainerType}
267
267
  * @memberof Pickface
268
268
  */
269
- 'containerModel'?: PickfaceContainerModel;
269
+ 'containerType'?: PickfaceContainerType;
270
270
  /**
271
271
  * The percentage of the pickface that has been taken up by its contents
272
272
  * @type {number}
@@ -301,19 +301,19 @@ export interface Pickface {
301
301
  /**
302
302
  *
303
303
  * @export
304
- * @interface PickfaceContainerModel
304
+ * @interface PickfaceContainerType
305
305
  */
306
- export interface PickfaceContainerModel {
306
+ export interface PickfaceContainerType {
307
307
  /**
308
308
  * Unique object identifier
309
309
  * @type {string}
310
- * @memberof PickfaceContainerModel
310
+ * @memberof PickfaceContainerType
311
311
  */
312
312
  'id'?: string;
313
313
  /**
314
314
  * A reference to the resource location
315
315
  * @type {string}
316
- * @memberof PickfaceContainerModel
316
+ * @memberof PickfaceContainerType
317
317
  */
318
318
  'ref'?: string;
319
319
  }
@@ -330,7 +330,7 @@ export interface PickfaceContentsInner {
330
330
  */
331
331
  'variantRef'?: string;
332
332
  /**
333
- *
333
+ * The ID of the project that the contents belongs to. For example, if you had a 3PL item this would be the project that created the product.
334
334
  * @type {string}
335
335
  * @memberof PickfaceContentsInner
336
336
  */
@@ -341,12 +341,6 @@ export interface PickfaceContentsInner {
341
341
  * @memberof PickfaceContentsInner
342
342
  */
343
343
  'quantity'?: PickfaceContentsInnerQuantity;
344
- /**
345
- *
346
- * @type {Array<PickfaceContentsInnerApplicationsInner>}
347
- * @memberof PickfaceContentsInner
348
- */
349
- 'applications'?: Array<PickfaceContentsInnerApplicationsInner>;
350
344
  /**
351
345
  *
352
346
  * @type {PickfaceContentsInnerMetadata}
@@ -354,25 +348,6 @@ export interface PickfaceContentsInner {
354
348
  */
355
349
  'metadata'?: PickfaceContentsInnerMetadata | null;
356
350
  }
357
- /**
358
- *
359
- * @export
360
- * @interface PickfaceContentsInnerApplicationsInner
361
- */
362
- export interface PickfaceContentsInnerApplicationsInner {
363
- /**
364
- *
365
- * @type {string}
366
- * @memberof PickfaceContentsInnerApplicationsInner
367
- */
368
- 'placement'?: string;
369
- /**
370
- * A unique identifier for the application
371
- * @type {string}
372
- * @memberof PickfaceContentsInnerApplicationsInner
373
- */
374
- 'signature'?: string;
375
- }
376
351
  /**
377
352
  * Any additional metadata
378
353
  * @export
@@ -570,7 +545,7 @@ export interface UpdatePickfaceRequest {
570
545
  * @type {string}
571
546
  * @memberof UpdatePickfaceRequest
572
547
  */
573
- 'containerModelId'?: string;
548
+ 'containerTypeId'?: string;
574
549
  /**
575
550
  * Unique object identifier
576
551
  * @type {string}
@@ -640,7 +615,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
640
615
  /**
641
616
  * Create a Pickface
642
617
  * @summary Create Pickface
643
- * @param {string} project What project it is
618
+ * @param {string} project The project ID
644
619
  * @param {CreatePickfaceRequest} createPickfaceRequest Create pickface schema
645
620
  * @param {*} [options] Override http request option.
646
621
  * @throws {RequiredError}
@@ -690,7 +665,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
690
665
  /**
691
666
  * Delete a Pickface
692
667
  * @summary Delete Pickface
693
- * @param {string} project What project it is
668
+ * @param {string} project The project ID
694
669
  * @param {string} pickfaceId Unique identifier of a pickface
695
670
  * @param {*} [options] Override http request option.
696
671
  * @throws {RequiredError}
@@ -738,7 +713,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
738
713
  /**
739
714
  * Export pickfaces as a CSV file
740
715
  * @summary Export pickfaces
741
- * @param {string} project What project it is
716
+ * @param {string} project The project ID
742
717
  * @param {string} [search] Search term to filter based on pickface code
743
718
  * @param {*} [options] Override http request option.
744
719
  * @throws {RequiredError}
@@ -787,7 +762,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
787
762
  /**
788
763
  * Get a specific pickface. Pickfaces contain useful information such as the items they contain and their level of fullness
789
764
  * @summary Get pickface
790
- * @param {string} project What project it is
765
+ * @param {string} project The project ID
791
766
  * @param {string} pickfaceId Unique identifier of a pickface
792
767
  * @param {*} [options] Override http request option.
793
768
  * @throws {RequiredError}
@@ -833,16 +808,23 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
833
808
  };
834
809
  },
835
810
  /**
836
- * Lists pickface container models
837
- * @summary Get pickface container models
838
- * @param {string} project What project it is
811
+ * Issue an empty pickface
812
+ * @summary Issue empty pickface
813
+ * @param {string} project The project ID
814
+ * @param {string} pickfaceId Unique identifier of a pickface
815
+ * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
839
816
  * @param {*} [options] Override http request option.
840
817
  * @throws {RequiredError}
841
818
  */
842
- getPickfaceContainerModels: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
819
+ issueEmptyPickface: async (project: string, pickfaceId: string, issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
843
820
  // verify required parameter 'project' is not null or undefined
844
- assertParamExists('getPickfaceContainerModels', 'project', project)
845
- const localVarPath = `/v1/pickfaces/container-models`;
821
+ assertParamExists('issueEmptyPickface', 'project', project)
822
+ // verify required parameter 'pickfaceId' is not null or undefined
823
+ assertParamExists('issueEmptyPickface', 'pickfaceId', pickfaceId)
824
+ // verify required parameter 'issueEmptyPickfaceRequest' is not null or undefined
825
+ assertParamExists('issueEmptyPickface', 'issueEmptyPickfaceRequest', issueEmptyPickfaceRequest)
826
+ const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/empty`
827
+ .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
846
828
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
847
829
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
848
830
  let baseOptions;
@@ -850,7 +832,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
850
832
  baseOptions = configuration.baseOptions;
851
833
  }
852
834
 
853
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
835
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
854
836
  const localVarHeaderParameter = {} as any;
855
837
  const localVarQueryParameter = {} as any;
856
838
 
@@ -867,9 +849,12 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
867
849
 
868
850
 
869
851
 
852
+ localVarHeaderParameter['Content-Type'] = 'application/json';
853
+
870
854
  setSearchParams(localVarUrlObj, localVarQueryParameter);
871
855
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
872
856
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
857
+ localVarRequestOptions.data = serializeDataIfNeeded(issueEmptyPickfaceRequest, localVarRequestOptions, configuration)
873
858
 
874
859
  return {
875
860
  url: toPathString(localVarUrlObj),
@@ -877,22 +862,22 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
877
862
  };
878
863
  },
879
864
  /**
880
- * Issue an empty pickface
881
- * @summary Issue empty pickface
882
- * @param {string} project What project it is
865
+ * Issue a pickface with wrong contents
866
+ * @summary Issue wrong contents pickface
867
+ * @param {string} project The project ID
883
868
  * @param {string} pickfaceId Unique identifier of a pickface
884
- * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
869
+ * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
885
870
  * @param {*} [options] Override http request option.
886
871
  * @throws {RequiredError}
887
872
  */
888
- issueEmptyPickface: async (project: string, pickfaceId: string, issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
873
+ issueWrongContentsPickface: async (project: string, pickfaceId: string, issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
889
874
  // verify required parameter 'project' is not null or undefined
890
- assertParamExists('issueEmptyPickface', 'project', project)
875
+ assertParamExists('issueWrongContentsPickface', 'project', project)
891
876
  // verify required parameter 'pickfaceId' is not null or undefined
892
- assertParamExists('issueEmptyPickface', 'pickfaceId', pickfaceId)
893
- // verify required parameter 'issueEmptyPickfaceRequest' is not null or undefined
894
- assertParamExists('issueEmptyPickface', 'issueEmptyPickfaceRequest', issueEmptyPickfaceRequest)
895
- const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/empty`
877
+ assertParamExists('issueWrongContentsPickface', 'pickfaceId', pickfaceId)
878
+ // verify required parameter 'issueWrongContentsPickfaceRequest' is not null or undefined
879
+ assertParamExists('issueWrongContentsPickface', 'issueWrongContentsPickfaceRequest', issueWrongContentsPickfaceRequest)
880
+ const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/wrong-contents`
896
881
  .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
897
882
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
898
883
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -923,7 +908,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
923
908
  setSearchParams(localVarUrlObj, localVarQueryParameter);
924
909
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
925
910
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
926
- localVarRequestOptions.data = serializeDataIfNeeded(issueEmptyPickfaceRequest, localVarRequestOptions, configuration)
911
+ localVarRequestOptions.data = serializeDataIfNeeded(issueWrongContentsPickfaceRequest, localVarRequestOptions, configuration)
927
912
 
928
913
  return {
929
914
  url: toPathString(localVarUrlObj),
@@ -931,23 +916,16 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
931
916
  };
932
917
  },
933
918
  /**
934
- * Issue a pickface with wrong contents
935
- * @summary Issue wrong contents pickface
936
- * @param {string} project What project it is
937
- * @param {string} pickfaceId Unique identifier of a pickface
938
- * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
919
+ * Lists pickface container types
920
+ * @summary List pickface container types
921
+ * @param {string} project The project ID
939
922
  * @param {*} [options] Override http request option.
940
923
  * @throws {RequiredError}
941
924
  */
942
- issueWrongContentsPickface: async (project: string, pickfaceId: string, issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
925
+ listPickfaceContainerTypes: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
943
926
  // verify required parameter 'project' is not null or undefined
944
- assertParamExists('issueWrongContentsPickface', 'project', project)
945
- // verify required parameter 'pickfaceId' is not null or undefined
946
- assertParamExists('issueWrongContentsPickface', 'pickfaceId', pickfaceId)
947
- // verify required parameter 'issueWrongContentsPickfaceRequest' is not null or undefined
948
- assertParamExists('issueWrongContentsPickface', 'issueWrongContentsPickfaceRequest', issueWrongContentsPickfaceRequest)
949
- const localVarPath = `/v1/pickfaces/{pickfaceId}/issue/wrong-contents`
950
- .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
927
+ assertParamExists('listPickfaceContainerTypes', 'project', project)
928
+ const localVarPath = `/v1/pickfaces/container-types`;
951
929
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
952
930
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
953
931
  let baseOptions;
@@ -955,7 +933,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
955
933
  baseOptions = configuration.baseOptions;
956
934
  }
957
935
 
958
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
936
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
959
937
  const localVarHeaderParameter = {} as any;
960
938
  const localVarQueryParameter = {} as any;
961
939
 
@@ -972,12 +950,9 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
972
950
 
973
951
 
974
952
 
975
- localVarHeaderParameter['Content-Type'] = 'application/json';
976
-
977
953
  setSearchParams(localVarUrlObj, localVarQueryParameter);
978
954
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
979
955
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
980
- localVarRequestOptions.data = serializeDataIfNeeded(issueWrongContentsPickfaceRequest, localVarRequestOptions, configuration)
981
956
 
982
957
  return {
983
958
  url: toPathString(localVarUrlObj),
@@ -987,7 +962,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
987
962
  /**
988
963
  * Get a list of pickface logs
989
964
  * @summary Get pickface logs
990
- * @param {string} project What project it is
965
+ * @param {string} project The project ID
991
966
  * @param {string} pickfaceId Unique identifier of a pickface
992
967
  * @param {number} [pageToken] Page reference token
993
968
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
@@ -1043,9 +1018,9 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1043
1018
  };
1044
1019
  },
1045
1020
  /**
1046
- * Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
1021
+ * Lists pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
1047
1022
  * @summary List pickfaces
1048
- * @param {string} project What project it is
1023
+ * @param {string} project The project ID
1049
1024
  * @param {string} [search] Search term to filter based on pickface code
1050
1025
  * @param {number} [pageToken] Page reference token
1051
1026
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
@@ -1109,7 +1084,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1109
1084
  /**
1110
1085
  * Move stock from one pickface to another in a single transaction
1111
1086
  * @summary Move stock
1112
- * @param {string} project What project it is
1087
+ * @param {string} project The project ID
1113
1088
  * @param {string} pickfaceId Unique identifier of a pickface
1114
1089
  * @param {MoveStockRequest} moveStockRequest Move stock from one pickface to another
1115
1090
  * @param {*} [options] Override http request option.
@@ -1163,7 +1138,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1163
1138
  /**
1164
1139
  * Print a pickface label
1165
1140
  * @summary Print pickface label
1166
- * @param {string} project What project it is
1141
+ * @param {string} project The project ID
1167
1142
  * @param {string} pickfaceId Unique identifier of a pickface
1168
1143
  * @param {string} deviceRef Unique identifier of a warehouse device
1169
1144
  * @param {*} [options] Override http request option.
@@ -1218,7 +1193,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1218
1193
  /**
1219
1194
  * Print pickface labels
1220
1195
  * @summary Print pickface Labels
1221
- * @param {string} project What project it is
1196
+ * @param {string} project The project ID
1222
1197
  * @param {string} deviceRef Unique identifier of a warehouse device
1223
1198
  * @param {string} [search] Search term to filter based on pickface code
1224
1199
  * @param {Array<string> | null} [ids] List of pickface ids
@@ -1279,7 +1254,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1279
1254
  /**
1280
1255
  * Resolves an issue on a pickface
1281
1256
  * @summary Resolve pickface issue
1282
- * @param {string} project What project it is
1257
+ * @param {string} project The project ID
1283
1258
  * @param {string} pickfaceId Unique identifier of a pickface
1284
1259
  * @param {*} [options] Override http request option.
1285
1260
  * @throws {RequiredError}
@@ -1327,7 +1302,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1327
1302
  /**
1328
1303
  * Suggest pickfaces for putting away stock
1329
1304
  * @summary Suggest pickfaces
1330
- * @param {string} project What project it is
1305
+ * @param {string} project The project ID
1331
1306
  * @param {string} variantRef Unique identifier of a warehouse variant
1332
1307
  * @param {number} quantity Number of variants
1333
1308
  * @param {number} [pageToken] Page reference token
@@ -1395,7 +1370,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1395
1370
  /**
1396
1371
  * Update a Pickface
1397
1372
  * @summary Update Pickface
1398
- * @param {string} project What project it is
1373
+ * @param {string} project The project ID
1399
1374
  * @param {string} pickfaceId Unique identifier of a pickface
1400
1375
  * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
1401
1376
  * @param {*} [options] Override http request option.
@@ -1459,7 +1434,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1459
1434
  /**
1460
1435
  * Create a Pickface
1461
1436
  * @summary Create Pickface
1462
- * @param {string} project What project it is
1437
+ * @param {string} project The project ID
1463
1438
  * @param {CreatePickfaceRequest} createPickfaceRequest Create pickface schema
1464
1439
  * @param {*} [options] Override http request option.
1465
1440
  * @throws {RequiredError}
@@ -1473,7 +1448,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1473
1448
  /**
1474
1449
  * Delete a Pickface
1475
1450
  * @summary Delete Pickface
1476
- * @param {string} project What project it is
1451
+ * @param {string} project The project ID
1477
1452
  * @param {string} pickfaceId Unique identifier of a pickface
1478
1453
  * @param {*} [options] Override http request option.
1479
1454
  * @throws {RequiredError}
@@ -1487,7 +1462,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1487
1462
  /**
1488
1463
  * Export pickfaces as a CSV file
1489
1464
  * @summary Export pickfaces
1490
- * @param {string} project What project it is
1465
+ * @param {string} project The project ID
1491
1466
  * @param {string} [search] Search term to filter based on pickface code
1492
1467
  * @param {*} [options] Override http request option.
1493
1468
  * @throws {RequiredError}
@@ -1501,7 +1476,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1501
1476
  /**
1502
1477
  * Get a specific pickface. Pickfaces contain useful information such as the items they contain and their level of fullness
1503
1478
  * @summary Get pickface
1504
- * @param {string} project What project it is
1479
+ * @param {string} project The project ID
1505
1480
  * @param {string} pickfaceId Unique identifier of a pickface
1506
1481
  * @param {*} [options] Override http request option.
1507
1482
  * @throws {RequiredError}
@@ -1512,23 +1487,10 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1512
1487
  const localVarOperationServerBasePath = operationServerMap['PickfacesApi.getPickface']?.[localVarOperationServerIndex]?.url;
1513
1488
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1514
1489
  },
1515
- /**
1516
- * Lists pickface container models
1517
- * @summary Get pickface container models
1518
- * @param {string} project What project it is
1519
- * @param {*} [options] Override http request option.
1520
- * @throws {RequiredError}
1521
- */
1522
- async getPickfaceContainerModels(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContainerModels>> {
1523
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPickfaceContainerModels(project, options);
1524
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1525
- const localVarOperationServerBasePath = operationServerMap['PickfacesApi.getPickfaceContainerModels']?.[localVarOperationServerIndex]?.url;
1526
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1527
- },
1528
1490
  /**
1529
1491
  * Issue an empty pickface
1530
1492
  * @summary Issue empty pickface
1531
- * @param {string} project What project it is
1493
+ * @param {string} project The project ID
1532
1494
  * @param {string} pickfaceId Unique identifier of a pickface
1533
1495
  * @param {IssueEmptyPickfaceRequest} issueEmptyPickfaceRequest pickface issue schema
1534
1496
  * @param {*} [options] Override http request option.
@@ -1543,7 +1505,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1543
1505
  /**
1544
1506
  * Issue a pickface with wrong contents
1545
1507
  * @summary Issue wrong contents pickface
1546
- * @param {string} project What project it is
1508
+ * @param {string} project The project ID
1547
1509
  * @param {string} pickfaceId Unique identifier of a pickface
1548
1510
  * @param {IssueWrongContentsPickfaceRequest} issueWrongContentsPickfaceRequest pickface issue schema
1549
1511
  * @param {*} [options] Override http request option.
@@ -1555,10 +1517,23 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1555
1517
  const localVarOperationServerBasePath = operationServerMap['PickfacesApi.issueWrongContentsPickface']?.[localVarOperationServerIndex]?.url;
1556
1518
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1557
1519
  },
1520
+ /**
1521
+ * Lists pickface container types
1522
+ * @summary List pickface container types
1523
+ * @param {string} project The project ID
1524
+ * @param {*} [options] Override http request option.
1525
+ * @throws {RequiredError}
1526
+ */
1527
+ async listPickfaceContainerTypes(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContainerTypes>> {
1528
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPickfaceContainerTypes(project, options);
1529
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1530
+ const localVarOperationServerBasePath = operationServerMap['PickfacesApi.listPickfaceContainerTypes']?.[localVarOperationServerIndex]?.url;
1531
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1532
+ },
1558
1533
  /**
1559
1534
  * Get a list of pickface logs
1560
1535
  * @summary Get pickface logs
1561
- * @param {string} project What project it is
1536
+ * @param {string} project The project ID
1562
1537
  * @param {string} pickfaceId Unique identifier of a pickface
1563
1538
  * @param {number} [pageToken] Page reference token
1564
1539
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
@@ -1572,9 +1547,9 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1572
1547
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1573
1548
  },
1574
1549
  /**
1575
- * Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
1550
+ * Lists pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
1576
1551
  * @summary List pickfaces
1577
- * @param {string} project What project it is
1552
+ * @param {string} project The project ID
1578
1553
  * @param {string} [search] Search term to filter based on pickface code
1579
1554
  * @param {number} [pageToken] Page reference token
1580
1555
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
@@ -1591,7 +1566,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1591
1566
  /**
1592
1567
  * Move stock from one pickface to another in a single transaction
1593
1568
  * @summary Move stock
1594
- * @param {string} project What project it is
1569
+ * @param {string} project The project ID
1595
1570
  * @param {string} pickfaceId Unique identifier of a pickface
1596
1571
  * @param {MoveStockRequest} moveStockRequest Move stock from one pickface to another
1597
1572
  * @param {*} [options] Override http request option.
@@ -1606,7 +1581,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1606
1581
  /**
1607
1582
  * Print a pickface label
1608
1583
  * @summary Print pickface label
1609
- * @param {string} project What project it is
1584
+ * @param {string} project The project ID
1610
1585
  * @param {string} pickfaceId Unique identifier of a pickface
1611
1586
  * @param {string} deviceRef Unique identifier of a warehouse device
1612
1587
  * @param {*} [options] Override http request option.
@@ -1621,7 +1596,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1621
1596
  /**
1622
1597
  * Print pickface labels
1623
1598
  * @summary Print pickface Labels
1624
- * @param {string} project What project it is
1599
+ * @param {string} project The project ID
1625
1600
  * @param {string} deviceRef Unique identifier of a warehouse device
1626
1601
  * @param {string} [search] Search term to filter based on pickface code
1627
1602
  * @param {Array<string> | null} [ids] List of pickface ids
@@ -1637,7 +1612,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1637
1612
  /**
1638
1613
  * Resolves an issue on a pickface
1639
1614
  * @summary Resolve pickface issue
1640
- * @param {string} project What project it is
1615
+ * @param {string} project The project ID
1641
1616
  * @param {string} pickfaceId Unique identifier of a pickface
1642
1617
  * @param {*} [options] Override http request option.
1643
1618
  * @throws {RequiredError}
@@ -1651,7 +1626,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1651
1626
  /**
1652
1627
  * Suggest pickfaces for putting away stock
1653
1628
  * @summary Suggest pickfaces
1654
- * @param {string} project What project it is
1629
+ * @param {string} project The project ID
1655
1630
  * @param {string} variantRef Unique identifier of a warehouse variant
1656
1631
  * @param {number} quantity Number of variants
1657
1632
  * @param {number} [pageToken] Page reference token
@@ -1668,7 +1643,7 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1668
1643
  /**
1669
1644
  * Update a Pickface
1670
1645
  * @summary Update Pickface
1671
- * @param {string} project What project it is
1646
+ * @param {string} project The project ID
1672
1647
  * @param {string} pickfaceId Unique identifier of a pickface
1673
1648
  * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
1674
1649
  * @param {*} [options] Override http request option.
@@ -1730,16 +1705,6 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
1730
1705
  getPickface(requestParameters: PickfacesApiGetPickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
1731
1706
  return localVarFp.getPickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(axios, basePath));
1732
1707
  },
1733
- /**
1734
- * Lists pickface container models
1735
- * @summary Get pickface container models
1736
- * @param {PickfacesApiGetPickfaceContainerModelsRequest} requestParameters Request parameters.
1737
- * @param {*} [options] Override http request option.
1738
- * @throws {RequiredError}
1739
- */
1740
- getPickfaceContainerModels(requestParameters: PickfacesApiGetPickfaceContainerModelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ContainerModels> {
1741
- return localVarFp.getPickfaceContainerModels(requestParameters.project, options).then((request) => request(axios, basePath));
1742
- },
1743
1708
  /**
1744
1709
  * Issue an empty pickface
1745
1710
  * @summary Issue empty pickface
@@ -1760,6 +1725,16 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
1760
1725
  issueWrongContentsPickface(requestParameters: PickfacesApiIssueWrongContentsPickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface> {
1761
1726
  return localVarFp.issueWrongContentsPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueWrongContentsPickfaceRequest, options).then((request) => request(axios, basePath));
1762
1727
  },
1728
+ /**
1729
+ * Lists pickface container types
1730
+ * @summary List pickface container types
1731
+ * @param {PickfacesApiListPickfaceContainerTypesRequest} requestParameters Request parameters.
1732
+ * @param {*} [options] Override http request option.
1733
+ * @throws {RequiredError}
1734
+ */
1735
+ listPickfaceContainerTypes(requestParameters: PickfacesApiListPickfaceContainerTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ContainerTypes> {
1736
+ return localVarFp.listPickfaceContainerTypes(requestParameters.project, options).then((request) => request(axios, basePath));
1737
+ },
1763
1738
  /**
1764
1739
  * Get a list of pickface logs
1765
1740
  * @summary Get pickface logs
@@ -1771,7 +1746,7 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
1771
1746
  return localVarFp.listPickfaceLogs(requestParameters.project, requestParameters.pickfaceId, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1772
1747
  },
1773
1748
  /**
1774
- * Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
1749
+ * Lists pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
1775
1750
  * @summary List pickfaces
1776
1751
  * @param {PickfacesApiListPickfacesRequest} requestParameters Request parameters.
1777
1752
  * @param {*} [options] Override http request option.
@@ -1850,7 +1825,7 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
1850
1825
  */
1851
1826
  export interface PickfacesApiCreatePickfaceRequest {
1852
1827
  /**
1853
- * What project it is
1828
+ * The project ID
1854
1829
  * @type {string}
1855
1830
  * @memberof PickfacesApiCreatePickface
1856
1831
  */
@@ -1871,7 +1846,7 @@ export interface PickfacesApiCreatePickfaceRequest {
1871
1846
  */
1872
1847
  export interface PickfacesApiDeletePickfaceRequest {
1873
1848
  /**
1874
- * What project it is
1849
+ * The project ID
1875
1850
  * @type {string}
1876
1851
  * @memberof PickfacesApiDeletePickface
1877
1852
  */
@@ -1892,7 +1867,7 @@ export interface PickfacesApiDeletePickfaceRequest {
1892
1867
  */
1893
1868
  export interface PickfacesApiExportPickfacesRequest {
1894
1869
  /**
1895
- * What project it is
1870
+ * The project ID
1896
1871
  * @type {string}
1897
1872
  * @memberof PickfacesApiExportPickfaces
1898
1873
  */
@@ -1913,7 +1888,7 @@ export interface PickfacesApiExportPickfacesRequest {
1913
1888
  */
1914
1889
  export interface PickfacesApiGetPickfaceRequest {
1915
1890
  /**
1916
- * What project it is
1891
+ * The project ID
1917
1892
  * @type {string}
1918
1893
  * @memberof PickfacesApiGetPickface
1919
1894
  */
@@ -1927,20 +1902,6 @@ export interface PickfacesApiGetPickfaceRequest {
1927
1902
  readonly pickfaceId: string
1928
1903
  }
1929
1904
 
1930
- /**
1931
- * Request parameters for getPickfaceContainerModels operation in PickfacesApi.
1932
- * @export
1933
- * @interface PickfacesApiGetPickfaceContainerModelsRequest
1934
- */
1935
- export interface PickfacesApiGetPickfaceContainerModelsRequest {
1936
- /**
1937
- * What project it is
1938
- * @type {string}
1939
- * @memberof PickfacesApiGetPickfaceContainerModels
1940
- */
1941
- readonly project: string
1942
- }
1943
-
1944
1905
  /**
1945
1906
  * Request parameters for issueEmptyPickface operation in PickfacesApi.
1946
1907
  * @export
@@ -1948,7 +1909,7 @@ export interface PickfacesApiGetPickfaceContainerModelsRequest {
1948
1909
  */
1949
1910
  export interface PickfacesApiIssueEmptyPickfaceRequest {
1950
1911
  /**
1951
- * What project it is
1912
+ * The project ID
1952
1913
  * @type {string}
1953
1914
  * @memberof PickfacesApiIssueEmptyPickface
1954
1915
  */
@@ -1976,7 +1937,7 @@ export interface PickfacesApiIssueEmptyPickfaceRequest {
1976
1937
  */
1977
1938
  export interface PickfacesApiIssueWrongContentsPickfaceRequest {
1978
1939
  /**
1979
- * What project it is
1940
+ * The project ID
1980
1941
  * @type {string}
1981
1942
  * @memberof PickfacesApiIssueWrongContentsPickface
1982
1943
  */
@@ -1997,6 +1958,20 @@ export interface PickfacesApiIssueWrongContentsPickfaceRequest {
1997
1958
  readonly issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest
1998
1959
  }
1999
1960
 
1961
+ /**
1962
+ * Request parameters for listPickfaceContainerTypes operation in PickfacesApi.
1963
+ * @export
1964
+ * @interface PickfacesApiListPickfaceContainerTypesRequest
1965
+ */
1966
+ export interface PickfacesApiListPickfaceContainerTypesRequest {
1967
+ /**
1968
+ * The project ID
1969
+ * @type {string}
1970
+ * @memberof PickfacesApiListPickfaceContainerTypes
1971
+ */
1972
+ readonly project: string
1973
+ }
1974
+
2000
1975
  /**
2001
1976
  * Request parameters for listPickfaceLogs operation in PickfacesApi.
2002
1977
  * @export
@@ -2004,7 +1979,7 @@ export interface PickfacesApiIssueWrongContentsPickfaceRequest {
2004
1979
  */
2005
1980
  export interface PickfacesApiListPickfaceLogsRequest {
2006
1981
  /**
2007
- * What project it is
1982
+ * The project ID
2008
1983
  * @type {string}
2009
1984
  * @memberof PickfacesApiListPickfaceLogs
2010
1985
  */
@@ -2039,7 +2014,7 @@ export interface PickfacesApiListPickfaceLogsRequest {
2039
2014
  */
2040
2015
  export interface PickfacesApiListPickfacesRequest {
2041
2016
  /**
2042
- * What project it is
2017
+ * The project ID
2043
2018
  * @type {string}
2044
2019
  * @memberof PickfacesApiListPickfaces
2045
2020
  */
@@ -2081,7 +2056,7 @@ export interface PickfacesApiListPickfacesRequest {
2081
2056
  */
2082
2057
  export interface PickfacesApiMoveStockRequest {
2083
2058
  /**
2084
- * What project it is
2059
+ * The project ID
2085
2060
  * @type {string}
2086
2061
  * @memberof PickfacesApiMoveStock
2087
2062
  */
@@ -2109,7 +2084,7 @@ export interface PickfacesApiMoveStockRequest {
2109
2084
  */
2110
2085
  export interface PickfacesApiPrintPickfaceLabelRequest {
2111
2086
  /**
2112
- * What project it is
2087
+ * The project ID
2113
2088
  * @type {string}
2114
2089
  * @memberof PickfacesApiPrintPickfaceLabel
2115
2090
  */
@@ -2137,7 +2112,7 @@ export interface PickfacesApiPrintPickfaceLabelRequest {
2137
2112
  */
2138
2113
  export interface PickfacesApiPrintPickfaceLabelsRequest {
2139
2114
  /**
2140
- * What project it is
2115
+ * The project ID
2141
2116
  * @type {string}
2142
2117
  * @memberof PickfacesApiPrintPickfaceLabels
2143
2118
  */
@@ -2172,7 +2147,7 @@ export interface PickfacesApiPrintPickfaceLabelsRequest {
2172
2147
  */
2173
2148
  export interface PickfacesApiResolvePickfaceIssueRequest {
2174
2149
  /**
2175
- * What project it is
2150
+ * The project ID
2176
2151
  * @type {string}
2177
2152
  * @memberof PickfacesApiResolvePickfaceIssue
2178
2153
  */
@@ -2193,7 +2168,7 @@ export interface PickfacesApiResolvePickfaceIssueRequest {
2193
2168
  */
2194
2169
  export interface PickfacesApiSuggestPickfacesRequest {
2195
2170
  /**
2196
- * What project it is
2171
+ * The project ID
2197
2172
  * @type {string}
2198
2173
  * @memberof PickfacesApiSuggestPickfaces
2199
2174
  */
@@ -2235,7 +2210,7 @@ export interface PickfacesApiSuggestPickfacesRequest {
2235
2210
  */
2236
2211
  export interface PickfacesApiUpdatePickfaceRequest {
2237
2212
  /**
2238
- * What project it is
2213
+ * The project ID
2239
2214
  * @type {string}
2240
2215
  * @memberof PickfacesApiUpdatePickface
2241
2216
  */
@@ -2311,18 +2286,6 @@ export class PickfacesApi extends BaseAPI {
2311
2286
  return PickfacesApiFp(this.configuration).getPickface(requestParameters.project, requestParameters.pickfaceId, options).then((request) => request(this.axios, this.basePath));
2312
2287
  }
2313
2288
 
2314
- /**
2315
- * Lists pickface container models
2316
- * @summary Get pickface container models
2317
- * @param {PickfacesApiGetPickfaceContainerModelsRequest} requestParameters Request parameters.
2318
- * @param {*} [options] Override http request option.
2319
- * @throws {RequiredError}
2320
- * @memberof PickfacesApi
2321
- */
2322
- public getPickfaceContainerModels(requestParameters: PickfacesApiGetPickfaceContainerModelsRequest, options?: RawAxiosRequestConfig) {
2323
- return PickfacesApiFp(this.configuration).getPickfaceContainerModels(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
2324
- }
2325
-
2326
2289
  /**
2327
2290
  * Issue an empty pickface
2328
2291
  * @summary Issue empty pickface
@@ -2347,6 +2310,18 @@ export class PickfacesApi extends BaseAPI {
2347
2310
  return PickfacesApiFp(this.configuration).issueWrongContentsPickface(requestParameters.project, requestParameters.pickfaceId, requestParameters.issueWrongContentsPickfaceRequest, options).then((request) => request(this.axios, this.basePath));
2348
2311
  }
2349
2312
 
2313
+ /**
2314
+ * Lists pickface container types
2315
+ * @summary List pickface container types
2316
+ * @param {PickfacesApiListPickfaceContainerTypesRequest} requestParameters Request parameters.
2317
+ * @param {*} [options] Override http request option.
2318
+ * @throws {RequiredError}
2319
+ * @memberof PickfacesApi
2320
+ */
2321
+ public listPickfaceContainerTypes(requestParameters: PickfacesApiListPickfaceContainerTypesRequest, options?: RawAxiosRequestConfig) {
2322
+ return PickfacesApiFp(this.configuration).listPickfaceContainerTypes(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
2323
+ }
2324
+
2350
2325
  /**
2351
2326
  * Get a list of pickface logs
2352
2327
  * @summary Get pickface logs
@@ -2360,7 +2335,7 @@ export class PickfacesApi extends BaseAPI {
2360
2335
  }
2361
2336
 
2362
2337
  /**
2363
- * Lists all available pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
2338
+ * Lists pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
2364
2339
  * @summary List pickfaces
2365
2340
  * @param {PickfacesApiListPickfacesRequest} requestParameters Request parameters.
2366
2341
  * @param {*} [options] Override http request option.