@teemill/pickfaces 0.12.2 → 0.14.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.
Files changed (182) hide show
  1. package/.openapi-generator/FILES +6 -24
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +3 -3
  4. package/api.ts +2297 -0
  5. package/base.ts +86 -0
  6. package/common.ts +150 -0
  7. package/configuration.ts +110 -0
  8. package/dist/api.d.ts +1480 -0
  9. package/dist/api.js +1243 -0
  10. package/dist/base.d.ts +66 -0
  11. package/dist/base.js +65 -0
  12. package/dist/common.d.ts +65 -0
  13. package/dist/common.js +161 -0
  14. package/dist/configuration.d.ts +91 -0
  15. package/dist/configuration.js +43 -0
  16. package/dist/esm/api.d.ts +1480 -0
  17. package/dist/esm/api.js +1236 -0
  18. package/dist/esm/base.d.ts +66 -0
  19. package/dist/esm/base.js +60 -0
  20. package/dist/esm/common.d.ts +65 -0
  21. package/dist/esm/common.js +149 -0
  22. package/dist/esm/configuration.d.ts +91 -0
  23. package/dist/esm/configuration.js +39 -0
  24. package/dist/esm/index.d.ts +13 -3
  25. package/dist/esm/index.js +13 -3
  26. package/dist/index.d.ts +13 -3
  27. package/dist/index.js +15 -5
  28. package/git_push.sh +57 -0
  29. package/index.ts +18 -0
  30. package/package.json +15 -3
  31. package/tsconfig.json +4 -6
  32. package/dist/apis/PickfacesApi.d.ts +0 -189
  33. package/dist/apis/PickfacesApi.js +0 -569
  34. package/dist/apis/index.d.ts +0 -1
  35. package/dist/apis/index.js +0 -19
  36. package/dist/esm/apis/PickfacesApi.d.ts +0 -189
  37. package/dist/esm/apis/PickfacesApi.js +0 -565
  38. package/dist/esm/apis/index.d.ts +0 -1
  39. package/dist/esm/apis/index.js +0 -3
  40. package/dist/esm/models/ApiError.d.ts +0 -37
  41. package/dist/esm/models/ApiError.js +0 -42
  42. package/dist/esm/models/ContainerModel.d.ts +0 -61
  43. package/dist/esm/models/ContainerModel.js +0 -54
  44. package/dist/esm/models/ContainerModels.d.ts +0 -32
  45. package/dist/esm/models/ContainerModels.js +0 -39
  46. package/dist/esm/models/CreatePickfaceRequest.d.ts +0 -37
  47. package/dist/esm/models/CreatePickfaceRequest.js +0 -40
  48. package/dist/esm/models/CreatePickfaceRequestDimensions.d.ts +0 -43
  49. package/dist/esm/models/CreatePickfaceRequestDimensions.js +0 -42
  50. package/dist/esm/models/GetPickfaces200Response.d.ts +0 -38
  51. package/dist/esm/models/GetPickfaces200Response.js +0 -41
  52. package/dist/esm/models/ListPickfaceLogs200Response.d.ts +0 -38
  53. package/dist/esm/models/ListPickfaceLogs200Response.js +0 -41
  54. package/dist/esm/models/ModelError.d.ts +0 -37
  55. package/dist/esm/models/ModelError.js +0 -46
  56. package/dist/esm/models/MoveStockRequest.d.ts +0 -43
  57. package/dist/esm/models/MoveStockRequest.js +0 -48
  58. package/dist/esm/models/Pickface.d.ts +0 -83
  59. package/dist/esm/models/Pickface.js +0 -58
  60. package/dist/esm/models/PickfaceContainerModel.d.ts +0 -37
  61. package/dist/esm/models/PickfaceContainerModel.js +0 -40
  62. package/dist/esm/models/PickfaceContentsInner.d.ts +0 -58
  63. package/dist/esm/models/PickfaceContentsInner.js +0 -49
  64. package/dist/esm/models/PickfaceContentsInnerApplicationsInner.d.ts +0 -37
  65. package/dist/esm/models/PickfaceContentsInnerApplicationsInner.js +0 -40
  66. package/dist/esm/models/PickfaceContentsInnerMetadata.d.ts +0 -43
  67. package/dist/esm/models/PickfaceContentsInnerMetadata.js +0 -42
  68. package/dist/esm/models/PickfaceContentsInnerQuantity.d.ts +0 -43
  69. package/dist/esm/models/PickfaceContentsInnerQuantity.js +0 -42
  70. package/dist/esm/models/PickfaceLastPicked.d.ts +0 -55
  71. package/dist/esm/models/PickfaceLastPicked.js +0 -46
  72. package/dist/esm/models/PickfaceLastRestocked.d.ts +0 -55
  73. package/dist/esm/models/PickfaceLastRestocked.js +0 -46
  74. package/dist/esm/models/PickfaceLog.d.ts +0 -55
  75. package/dist/esm/models/PickfaceLog.js +0 -46
  76. package/dist/esm/models/PickfaceLogUser.d.ts +0 -37
  77. package/dist/esm/models/PickfaceLogUser.js +0 -45
  78. package/dist/esm/models/PickfaceModel.d.ts +0 -37
  79. package/dist/esm/models/PickfaceModel.js +0 -40
  80. package/dist/esm/models/PickfaceModels.d.ts +0 -32
  81. package/dist/esm/models/PickfaceModels.js +0 -39
  82. package/dist/esm/models/UpdatePickfaceRequest.d.ts +0 -44
  83. package/dist/esm/models/UpdatePickfaceRequest.js +0 -43
  84. package/dist/esm/models/UpdatePickfaceRequestContents.d.ts +0 -37
  85. package/dist/esm/models/UpdatePickfaceRequestContents.js +0 -40
  86. package/dist/esm/models/UpdatePickfaceRequestContentsInner.d.ts +0 -38
  87. package/dist/esm/models/UpdatePickfaceRequestContentsInner.js +0 -45
  88. package/dist/esm/models/UpdatePickfaceRequestContentsInnerQuantity.d.ts +0 -45
  89. package/dist/esm/models/UpdatePickfaceRequestContentsInnerQuantity.js +0 -51
  90. package/dist/esm/models/UpdatePickfaceRequestContentsInnerQuantityOneOf.d.ts +0 -45
  91. package/dist/esm/models/UpdatePickfaceRequestContentsInnerQuantityOneOf.js +0 -51
  92. package/dist/esm/models/index.d.ts +0 -19
  93. package/dist/esm/models/index.js +0 -21
  94. package/dist/esm/runtime.d.ts +0 -187
  95. package/dist/esm/runtime.js +0 -333
  96. package/dist/models/ApiError.d.ts +0 -37
  97. package/dist/models/ApiError.js +0 -49
  98. package/dist/models/ContainerModel.d.ts +0 -61
  99. package/dist/models/ContainerModel.js +0 -61
  100. package/dist/models/ContainerModels.d.ts +0 -32
  101. package/dist/models/ContainerModels.js +0 -46
  102. package/dist/models/CreatePickfaceRequest.d.ts +0 -37
  103. package/dist/models/CreatePickfaceRequest.js +0 -47
  104. package/dist/models/CreatePickfaceRequestDimensions.d.ts +0 -43
  105. package/dist/models/CreatePickfaceRequestDimensions.js +0 -49
  106. package/dist/models/GetPickfaces200Response.d.ts +0 -38
  107. package/dist/models/GetPickfaces200Response.js +0 -48
  108. package/dist/models/ListPickfaceLogs200Response.d.ts +0 -38
  109. package/dist/models/ListPickfaceLogs200Response.js +0 -48
  110. package/dist/models/ModelError.d.ts +0 -37
  111. package/dist/models/ModelError.js +0 -53
  112. package/dist/models/MoveStockRequest.d.ts +0 -43
  113. package/dist/models/MoveStockRequest.js +0 -55
  114. package/dist/models/Pickface.d.ts +0 -83
  115. package/dist/models/Pickface.js +0 -65
  116. package/dist/models/PickfaceContainerModel.d.ts +0 -37
  117. package/dist/models/PickfaceContainerModel.js +0 -47
  118. package/dist/models/PickfaceContentsInner.d.ts +0 -58
  119. package/dist/models/PickfaceContentsInner.js +0 -56
  120. package/dist/models/PickfaceContentsInnerApplicationsInner.d.ts +0 -37
  121. package/dist/models/PickfaceContentsInnerApplicationsInner.js +0 -47
  122. package/dist/models/PickfaceContentsInnerMetadata.d.ts +0 -43
  123. package/dist/models/PickfaceContentsInnerMetadata.js +0 -49
  124. package/dist/models/PickfaceContentsInnerQuantity.d.ts +0 -43
  125. package/dist/models/PickfaceContentsInnerQuantity.js +0 -49
  126. package/dist/models/PickfaceLastPicked.d.ts +0 -55
  127. package/dist/models/PickfaceLastPicked.js +0 -53
  128. package/dist/models/PickfaceLastRestocked.d.ts +0 -55
  129. package/dist/models/PickfaceLastRestocked.js +0 -53
  130. package/dist/models/PickfaceLog.d.ts +0 -55
  131. package/dist/models/PickfaceLog.js +0 -53
  132. package/dist/models/PickfaceLogUser.d.ts +0 -37
  133. package/dist/models/PickfaceLogUser.js +0 -52
  134. package/dist/models/PickfaceModel.d.ts +0 -37
  135. package/dist/models/PickfaceModel.js +0 -47
  136. package/dist/models/PickfaceModels.d.ts +0 -32
  137. package/dist/models/PickfaceModels.js +0 -46
  138. package/dist/models/UpdatePickfaceRequest.d.ts +0 -44
  139. package/dist/models/UpdatePickfaceRequest.js +0 -50
  140. package/dist/models/UpdatePickfaceRequestContents.d.ts +0 -37
  141. package/dist/models/UpdatePickfaceRequestContents.js +0 -47
  142. package/dist/models/UpdatePickfaceRequestContentsInner.d.ts +0 -38
  143. package/dist/models/UpdatePickfaceRequestContentsInner.js +0 -52
  144. package/dist/models/UpdatePickfaceRequestContentsInnerQuantity.d.ts +0 -45
  145. package/dist/models/UpdatePickfaceRequestContentsInnerQuantity.js +0 -58
  146. package/dist/models/UpdatePickfaceRequestContentsInnerQuantityOneOf.d.ts +0 -45
  147. package/dist/models/UpdatePickfaceRequestContentsInnerQuantityOneOf.js +0 -58
  148. package/dist/models/index.d.ts +0 -19
  149. package/dist/models/index.js +0 -37
  150. package/dist/runtime.d.ts +0 -187
  151. package/dist/runtime.js +0 -349
  152. package/src/apis/PickfacesApi.ts +0 -821
  153. package/src/apis/index.ts +0 -3
  154. package/src/index.ts +0 -5
  155. package/src/models/ApiError.ts +0 -69
  156. package/src/models/ContainerModel.ts +0 -103
  157. package/src/models/ContainerModels.ts +0 -67
  158. package/src/models/CreatePickfaceRequest.ts +0 -68
  159. package/src/models/CreatePickfaceRequestDimensions.ts +0 -76
  160. package/src/models/GetPickfaces200Response.ts +0 -75
  161. package/src/models/ListPickfaceLogs200Response.ts +0 -75
  162. package/src/models/ModelError.ts +0 -74
  163. package/src/models/MoveStockRequest.ts +0 -79
  164. package/src/models/Pickface.ts +0 -149
  165. package/src/models/PickfaceContainerModel.ts +0 -68
  166. package/src/models/PickfaceContentsInner.ts +0 -111
  167. package/src/models/PickfaceContentsInnerApplicationsInner.ts +0 -68
  168. package/src/models/PickfaceContentsInnerMetadata.ts +0 -76
  169. package/src/models/PickfaceContentsInnerQuantity.ts +0 -76
  170. package/src/models/PickfaceLastPicked.ts +0 -92
  171. package/src/models/PickfaceLastRestocked.ts +0 -92
  172. package/src/models/PickfaceLog.ts +0 -92
  173. package/src/models/PickfaceLogUser.ts +0 -73
  174. package/src/models/PickfaceModel.ts +0 -68
  175. package/src/models/PickfaceModels.ts +0 -67
  176. package/src/models/UpdatePickfaceRequest.ts +0 -83
  177. package/src/models/UpdatePickfaceRequestContents.ts +0 -68
  178. package/src/models/UpdatePickfaceRequestContentsInner.ts +0 -77
  179. package/src/models/UpdatePickfaceRequestContentsInnerQuantity.ts +0 -81
  180. package/src/models/UpdatePickfaceRequestContentsInnerQuantityOneOf.ts +0 -81
  181. package/src/models/index.ts +0 -21
  182. package/src/runtime.ts +0 -441
@@ -1,821 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Pickfaces API
5
- * Manage Teemill Pickfaces. Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
6
- *
7
- * The version of the OpenAPI document: 0.12.2
8
- * Contact: hello@teemill.com
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
-
16
- import * as runtime from '../runtime';
17
- import type {
18
- ApiError,
19
- ContainerModels,
20
- CreatePickfaceRequest,
21
- GetPickfaces200Response,
22
- ListPickfaceLogs200Response,
23
- MoveStockRequest,
24
- Pickface,
25
- UpdatePickfaceRequest,
26
- } from '../models/index';
27
- import {
28
- ApiErrorFromJSON,
29
- ApiErrorToJSON,
30
- ContainerModelsFromJSON,
31
- ContainerModelsToJSON,
32
- CreatePickfaceRequestFromJSON,
33
- CreatePickfaceRequestToJSON,
34
- GetPickfaces200ResponseFromJSON,
35
- GetPickfaces200ResponseToJSON,
36
- ListPickfaceLogs200ResponseFromJSON,
37
- ListPickfaceLogs200ResponseToJSON,
38
- MoveStockRequestFromJSON,
39
- MoveStockRequestToJSON,
40
- PickfaceFromJSON,
41
- PickfaceToJSON,
42
- UpdatePickfaceRequestFromJSON,
43
- UpdatePickfaceRequestToJSON,
44
- } from '../models/index';
45
-
46
- export interface CreatePickfaceOperationRequest {
47
- project: string;
48
- createPickfaceRequest: CreatePickfaceRequest;
49
- }
50
-
51
- export interface DeletePickfaceRequest {
52
- project: string;
53
- pickfaceId: string;
54
- }
55
-
56
- export interface ExportPickfacesRequest {
57
- project: string;
58
- }
59
-
60
- export interface GetPickfaceRequest {
61
- project: string;
62
- pickfaceId: string;
63
- }
64
-
65
- export interface GetPickfaceContainerModelsRequest {
66
- project: string;
67
- }
68
-
69
- export interface GetPickfacesRequest {
70
- project: string;
71
- search?: string;
72
- pageToken?: number;
73
- pageSize?: number;
74
- filters?: Array<GetPickfacesFiltersEnum>;
75
- }
76
-
77
- export interface ListPickfaceLogsRequest {
78
- project: string;
79
- pickfaceId: string;
80
- pageToken?: number;
81
- pageSize?: number;
82
- }
83
-
84
- export interface MoveStockOperationRequest {
85
- project: string;
86
- pickfaceId: string;
87
- moveStockRequest: MoveStockRequest;
88
- }
89
-
90
- export interface PrintPickfaceLabelRequest {
91
- project: string;
92
- pickfaceId: string;
93
- deviceRef: string;
94
- }
95
-
96
- export interface SuggestPickfacesRequest {
97
- project: string;
98
- variantRef: string;
99
- quantity: number;
100
- pageToken?: number;
101
- pageSize?: number;
102
- }
103
-
104
- export interface UpdatePickfaceOperationRequest {
105
- project: string;
106
- pickfaceId: string;
107
- updatePickfaceRequest: UpdatePickfaceRequest;
108
- }
109
-
110
- /**
111
- *
112
- */
113
- export class PickfacesApi extends runtime.BaseAPI {
114
-
115
- /**
116
- * Create a Pickface
117
- * Create Pickface
118
- */
119
- async createPickfaceRaw(requestParameters: CreatePickfaceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Pickface>> {
120
- if (requestParameters.project === null || requestParameters.project === undefined) {
121
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling createPickface.');
122
- }
123
-
124
- if (requestParameters.createPickfaceRequest === null || requestParameters.createPickfaceRequest === undefined) {
125
- throw new runtime.RequiredError('createPickfaceRequest','Required parameter requestParameters.createPickfaceRequest was null or undefined when calling createPickface.');
126
- }
127
-
128
- const queryParameters: any = {};
129
-
130
- if (requestParameters.project !== undefined) {
131
- queryParameters['project'] = requestParameters.project;
132
- }
133
-
134
- const headerParameters: runtime.HTTPHeaders = {};
135
-
136
- headerParameters['Content-Type'] = 'application/json';
137
-
138
- if (this.configuration && this.configuration.accessToken) {
139
- // oauth required
140
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
141
- }
142
-
143
- if (this.configuration && this.configuration.apiKey) {
144
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
145
- }
146
-
147
- const response = await this.request({
148
- path: `/v1/pickfaces`,
149
- method: 'POST',
150
- headers: headerParameters,
151
- query: queryParameters,
152
- body: CreatePickfaceRequestToJSON(requestParameters.createPickfaceRequest),
153
- }, initOverrides);
154
-
155
- return new runtime.JSONApiResponse(response, (jsonValue) => PickfaceFromJSON(jsonValue));
156
- }
157
-
158
- /**
159
- * Create a Pickface
160
- * Create Pickface
161
- */
162
- async createPickface(
163
- project: string, createPickfaceRequest: CreatePickfaceRequest,
164
- initOverrides?: RequestInit | runtime.InitOverrideFunction
165
- ): Promise<Pickface> {
166
- const response = await this.createPickfaceRaw(
167
- {
168
- project: project,createPickfaceRequest: createPickfaceRequest,
169
- },
170
- initOverrides
171
- );
172
-
173
- return await response.value();
174
- }
175
-
176
- /**
177
- * Delete a Pickface
178
- * Delete Pickface
179
- */
180
- async deletePickfaceRaw(requestParameters: DeletePickfaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
181
- if (requestParameters.project === null || requestParameters.project === undefined) {
182
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling deletePickface.');
183
- }
184
-
185
- if (requestParameters.pickfaceId === null || requestParameters.pickfaceId === undefined) {
186
- throw new runtime.RequiredError('pickfaceId','Required parameter requestParameters.pickfaceId was null or undefined when calling deletePickface.');
187
- }
188
-
189
- const queryParameters: any = {};
190
-
191
- if (requestParameters.project !== undefined) {
192
- queryParameters['project'] = requestParameters.project;
193
- }
194
-
195
- const headerParameters: runtime.HTTPHeaders = {};
196
-
197
- if (this.configuration && this.configuration.accessToken) {
198
- // oauth required
199
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
200
- }
201
-
202
- if (this.configuration && this.configuration.apiKey) {
203
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
204
- }
205
-
206
- const response = await this.request({
207
- path: `/v1/pickfaces/{pickfaceId}`.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(requestParameters.pickfaceId))),
208
- method: 'DELETE',
209
- headers: headerParameters,
210
- query: queryParameters,
211
- }, initOverrides);
212
-
213
- return new runtime.VoidApiResponse(response);
214
- }
215
-
216
- /**
217
- * Delete a Pickface
218
- * Delete Pickface
219
- */
220
- async deletePickface(
221
- project: string, pickfaceId: string,
222
- initOverrides?: RequestInit | runtime.InitOverrideFunction
223
- ): Promise<void> {
224
- await this.deletePickfaceRaw(
225
- {
226
- project: project,pickfaceId: pickfaceId,
227
- },
228
- initOverrides
229
- );
230
- }
231
-
232
- /**
233
- * Export pickfaces as a CSV file
234
- * Export pickfaces
235
- */
236
- async exportPickfacesRaw(requestParameters: ExportPickfacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
237
- if (requestParameters.project === null || requestParameters.project === undefined) {
238
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling exportPickfaces.');
239
- }
240
-
241
- const queryParameters: any = {};
242
-
243
- if (requestParameters.project !== undefined) {
244
- queryParameters['project'] = requestParameters.project;
245
- }
246
-
247
- const headerParameters: runtime.HTTPHeaders = {};
248
-
249
- if (this.configuration && this.configuration.accessToken) {
250
- // oauth required
251
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
252
- }
253
-
254
- if (this.configuration && this.configuration.apiKey) {
255
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
256
- }
257
-
258
- const response = await this.request({
259
- path: `/v1/pickfaces/export`,
260
- method: 'GET',
261
- headers: headerParameters,
262
- query: queryParameters,
263
- }, initOverrides);
264
-
265
- return new runtime.BlobApiResponse(response);
266
- }
267
-
268
- /**
269
- * Export pickfaces as a CSV file
270
- * Export pickfaces
271
- */
272
- async exportPickfaces(
273
- project: string,
274
- initOverrides?: RequestInit | runtime.InitOverrideFunction
275
- ): Promise<Blob> {
276
- const response = await this.exportPickfacesRaw(
277
- {
278
- project: project,
279
- },
280
- initOverrides
281
- );
282
-
283
- return await response.value();
284
- }
285
-
286
- /**
287
- * Get a pickface
288
- * Get pickface
289
- */
290
- async getPickfaceRaw(requestParameters: GetPickfaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Pickface>> {
291
- if (requestParameters.project === null || requestParameters.project === undefined) {
292
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getPickface.');
293
- }
294
-
295
- if (requestParameters.pickfaceId === null || requestParameters.pickfaceId === undefined) {
296
- throw new runtime.RequiredError('pickfaceId','Required parameter requestParameters.pickfaceId was null or undefined when calling getPickface.');
297
- }
298
-
299
- const queryParameters: any = {};
300
-
301
- if (requestParameters.project !== undefined) {
302
- queryParameters['project'] = requestParameters.project;
303
- }
304
-
305
- const headerParameters: runtime.HTTPHeaders = {};
306
-
307
- if (this.configuration && this.configuration.accessToken) {
308
- // oauth required
309
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
310
- }
311
-
312
- if (this.configuration && this.configuration.apiKey) {
313
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
314
- }
315
-
316
- const response = await this.request({
317
- path: `/v1/pickfaces/{pickfaceId}`.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(requestParameters.pickfaceId))),
318
- method: 'GET',
319
- headers: headerParameters,
320
- query: queryParameters,
321
- }, initOverrides);
322
-
323
- return new runtime.JSONApiResponse(response, (jsonValue) => PickfaceFromJSON(jsonValue));
324
- }
325
-
326
- /**
327
- * Get a pickface
328
- * Get pickface
329
- */
330
- async getPickface(
331
- project: string, pickfaceId: string,
332
- initOverrides?: RequestInit | runtime.InitOverrideFunction
333
- ): Promise<Pickface> {
334
- const response = await this.getPickfaceRaw(
335
- {
336
- project: project,pickfaceId: pickfaceId,
337
- },
338
- initOverrides
339
- );
340
-
341
- return await response.value();
342
- }
343
-
344
- /**
345
- * Lists pickface container models
346
- * Get pickface container models
347
- */
348
- async getPickfaceContainerModelsRaw(requestParameters: GetPickfaceContainerModelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContainerModels>> {
349
- if (requestParameters.project === null || requestParameters.project === undefined) {
350
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getPickfaceContainerModels.');
351
- }
352
-
353
- const queryParameters: any = {};
354
-
355
- if (requestParameters.project !== undefined) {
356
- queryParameters['project'] = requestParameters.project;
357
- }
358
-
359
- const headerParameters: runtime.HTTPHeaders = {};
360
-
361
- if (this.configuration && this.configuration.accessToken) {
362
- // oauth required
363
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
364
- }
365
-
366
- if (this.configuration && this.configuration.apiKey) {
367
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
368
- }
369
-
370
- const response = await this.request({
371
- path: `/v1/pickfaces/container-models`,
372
- method: 'GET',
373
- headers: headerParameters,
374
- query: queryParameters,
375
- }, initOverrides);
376
-
377
- return new runtime.JSONApiResponse(response, (jsonValue) => ContainerModelsFromJSON(jsonValue));
378
- }
379
-
380
- /**
381
- * Lists pickface container models
382
- * Get pickface container models
383
- */
384
- async getPickfaceContainerModels(
385
- project: string,
386
- initOverrides?: RequestInit | runtime.InitOverrideFunction
387
- ): Promise<ContainerModels> {
388
- const response = await this.getPickfaceContainerModelsRaw(
389
- {
390
- project: project,
391
- },
392
- initOverrides
393
- );
394
-
395
- return await response.value();
396
- }
397
-
398
- /**
399
- * Lists all pickfaces available paginated into chunks
400
- * List pickfaces
401
- */
402
- async getPickfacesRaw(requestParameters: GetPickfacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPickfaces200Response>> {
403
- if (requestParameters.project === null || requestParameters.project === undefined) {
404
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getPickfaces.');
405
- }
406
-
407
- const queryParameters: any = {};
408
-
409
- if (requestParameters.project !== undefined) {
410
- queryParameters['project'] = requestParameters.project;
411
- }
412
-
413
- if (requestParameters.search !== undefined) {
414
- queryParameters['search'] = requestParameters.search;
415
- }
416
-
417
- if (requestParameters.pageToken !== undefined) {
418
- queryParameters['pageToken'] = requestParameters.pageToken;
419
- }
420
-
421
- if (requestParameters.pageSize !== undefined) {
422
- queryParameters['pageSize'] = requestParameters.pageSize;
423
- }
424
-
425
- if (requestParameters.filters) {
426
- queryParameters['filters'] = requestParameters.filters;
427
- }
428
-
429
- const headerParameters: runtime.HTTPHeaders = {};
430
-
431
- if (this.configuration && this.configuration.accessToken) {
432
- // oauth required
433
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
434
- }
435
-
436
- if (this.configuration && this.configuration.apiKey) {
437
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
438
- }
439
-
440
- const response = await this.request({
441
- path: `/v1/pickfaces`,
442
- method: 'GET',
443
- headers: headerParameters,
444
- query: queryParameters,
445
- }, initOverrides);
446
-
447
- return new runtime.JSONApiResponse(response, (jsonValue) => GetPickfaces200ResponseFromJSON(jsonValue));
448
- }
449
-
450
- /**
451
- * Lists all pickfaces available paginated into chunks
452
- * List pickfaces
453
- */
454
- async getPickfaces(
455
- project: string,
456
- optionalParameters: runtime.OptionalOnly<GetPickfacesRequest> = {},
457
- initOverrides?: RequestInit | runtime.InitOverrideFunction
458
- ): Promise<GetPickfaces200Response> {
459
- const response = await this.getPickfacesRaw(
460
- {
461
- project: project,
462
- ...optionalParameters,
463
- },
464
- initOverrides
465
- );
466
-
467
- return await response.value();
468
- }
469
-
470
- /**
471
- * Get a list of pickface logs
472
- * Get pickface logs
473
- */
474
- async listPickfaceLogsRaw(requestParameters: ListPickfaceLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPickfaceLogs200Response>> {
475
- if (requestParameters.project === null || requestParameters.project === undefined) {
476
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling listPickfaceLogs.');
477
- }
478
-
479
- if (requestParameters.pickfaceId === null || requestParameters.pickfaceId === undefined) {
480
- throw new runtime.RequiredError('pickfaceId','Required parameter requestParameters.pickfaceId was null or undefined when calling listPickfaceLogs.');
481
- }
482
-
483
- const queryParameters: any = {};
484
-
485
- if (requestParameters.project !== undefined) {
486
- queryParameters['project'] = requestParameters.project;
487
- }
488
-
489
- if (requestParameters.pageToken !== undefined) {
490
- queryParameters['pageToken'] = requestParameters.pageToken;
491
- }
492
-
493
- if (requestParameters.pageSize !== undefined) {
494
- queryParameters['pageSize'] = requestParameters.pageSize;
495
- }
496
-
497
- const headerParameters: runtime.HTTPHeaders = {};
498
-
499
- if (this.configuration && this.configuration.accessToken) {
500
- // oauth required
501
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
502
- }
503
-
504
- if (this.configuration && this.configuration.apiKey) {
505
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
506
- }
507
-
508
- const response = await this.request({
509
- path: `/v1/pickfaces/{pickfaceId}/logs`.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(requestParameters.pickfaceId))),
510
- method: 'GET',
511
- headers: headerParameters,
512
- query: queryParameters,
513
- }, initOverrides);
514
-
515
- return new runtime.JSONApiResponse(response, (jsonValue) => ListPickfaceLogs200ResponseFromJSON(jsonValue));
516
- }
517
-
518
- /**
519
- * Get a list of pickface logs
520
- * Get pickface logs
521
- */
522
- async listPickfaceLogs(
523
- project: string, pickfaceId: string,
524
- optionalParameters: runtime.OptionalOnly<ListPickfaceLogsRequest> = {},
525
- initOverrides?: RequestInit | runtime.InitOverrideFunction
526
- ): Promise<ListPickfaceLogs200Response> {
527
- const response = await this.listPickfaceLogsRaw(
528
- {
529
- project: project,pickfaceId: pickfaceId,
530
- ...optionalParameters,
531
- },
532
- initOverrides
533
- );
534
-
535
- return await response.value();
536
- }
537
-
538
- /**
539
- * Move stock from one pickface to another in a single transaction
540
- * Move stock
541
- */
542
- async moveStockRaw(requestParameters: MoveStockOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Pickface>> {
543
- if (requestParameters.project === null || requestParameters.project === undefined) {
544
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling moveStock.');
545
- }
546
-
547
- if (requestParameters.pickfaceId === null || requestParameters.pickfaceId === undefined) {
548
- throw new runtime.RequiredError('pickfaceId','Required parameter requestParameters.pickfaceId was null or undefined when calling moveStock.');
549
- }
550
-
551
- if (requestParameters.moveStockRequest === null || requestParameters.moveStockRequest === undefined) {
552
- throw new runtime.RequiredError('moveStockRequest','Required parameter requestParameters.moveStockRequest was null or undefined when calling moveStock.');
553
- }
554
-
555
- const queryParameters: any = {};
556
-
557
- if (requestParameters.project !== undefined) {
558
- queryParameters['project'] = requestParameters.project;
559
- }
560
-
561
- const headerParameters: runtime.HTTPHeaders = {};
562
-
563
- headerParameters['Content-Type'] = 'application/json';
564
-
565
- if (this.configuration && this.configuration.accessToken) {
566
- // oauth required
567
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
568
- }
569
-
570
- if (this.configuration && this.configuration.apiKey) {
571
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
572
- }
573
-
574
- const response = await this.request({
575
- path: `/v1/pickfaces/{pickfaceId}/stock/move`.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(requestParameters.pickfaceId))),
576
- method: 'POST',
577
- headers: headerParameters,
578
- query: queryParameters,
579
- body: MoveStockRequestToJSON(requestParameters.moveStockRequest),
580
- }, initOverrides);
581
-
582
- return new runtime.JSONApiResponse(response, (jsonValue) => PickfaceFromJSON(jsonValue));
583
- }
584
-
585
- /**
586
- * Move stock from one pickface to another in a single transaction
587
- * Move stock
588
- */
589
- async moveStock(
590
- project: string, pickfaceId: string, moveStockRequest: MoveStockRequest,
591
- initOverrides?: RequestInit | runtime.InitOverrideFunction
592
- ): Promise<Pickface> {
593
- const response = await this.moveStockRaw(
594
- {
595
- project: project,pickfaceId: pickfaceId,moveStockRequest: moveStockRequest,
596
- },
597
- initOverrides
598
- );
599
-
600
- return await response.value();
601
- }
602
-
603
- /**
604
- * Print a pickface label
605
- * Print pickface label
606
- */
607
- async printPickfaceLabelRaw(requestParameters: PrintPickfaceLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
608
- if (requestParameters.project === null || requestParameters.project === undefined) {
609
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling printPickfaceLabel.');
610
- }
611
-
612
- if (requestParameters.pickfaceId === null || requestParameters.pickfaceId === undefined) {
613
- throw new runtime.RequiredError('pickfaceId','Required parameter requestParameters.pickfaceId was null or undefined when calling printPickfaceLabel.');
614
- }
615
-
616
- if (requestParameters.deviceRef === null || requestParameters.deviceRef === undefined) {
617
- throw new runtime.RequiredError('deviceRef','Required parameter requestParameters.deviceRef was null or undefined when calling printPickfaceLabel.');
618
- }
619
-
620
- const queryParameters: any = {};
621
-
622
- if (requestParameters.project !== undefined) {
623
- queryParameters['project'] = requestParameters.project;
624
- }
625
-
626
- if (requestParameters.deviceRef !== undefined) {
627
- queryParameters['deviceRef'] = requestParameters.deviceRef;
628
- }
629
-
630
- const headerParameters: runtime.HTTPHeaders = {};
631
-
632
- if (this.configuration && this.configuration.accessToken) {
633
- // oauth required
634
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
635
- }
636
-
637
- if (this.configuration && this.configuration.apiKey) {
638
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
639
- }
640
-
641
- const response = await this.request({
642
- path: `/v1/pickfaces/{pickfaceId}/print`.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(requestParameters.pickfaceId))),
643
- method: 'GET',
644
- headers: headerParameters,
645
- query: queryParameters,
646
- }, initOverrides);
647
-
648
- return new runtime.VoidApiResponse(response);
649
- }
650
-
651
- /**
652
- * Print a pickface label
653
- * Print pickface label
654
- */
655
- async printPickfaceLabel(
656
- project: string, pickfaceId: string, deviceRef: string,
657
- initOverrides?: RequestInit | runtime.InitOverrideFunction
658
- ): Promise<void> {
659
- await this.printPickfaceLabelRaw(
660
- {
661
- project: project,pickfaceId: pickfaceId,deviceRef: deviceRef,
662
- },
663
- initOverrides
664
- );
665
- }
666
-
667
- /**
668
- * Suggest pickfaces for putting away stock
669
- * Suggest pickfaces
670
- */
671
- async suggestPickfacesRaw(requestParameters: SuggestPickfacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPickfaces200Response>> {
672
- if (requestParameters.project === null || requestParameters.project === undefined) {
673
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling suggestPickfaces.');
674
- }
675
-
676
- if (requestParameters.variantRef === null || requestParameters.variantRef === undefined) {
677
- throw new runtime.RequiredError('variantRef','Required parameter requestParameters.variantRef was null or undefined when calling suggestPickfaces.');
678
- }
679
-
680
- if (requestParameters.quantity === null || requestParameters.quantity === undefined) {
681
- throw new runtime.RequiredError('quantity','Required parameter requestParameters.quantity was null or undefined when calling suggestPickfaces.');
682
- }
683
-
684
- const queryParameters: any = {};
685
-
686
- if (requestParameters.project !== undefined) {
687
- queryParameters['project'] = requestParameters.project;
688
- }
689
-
690
- if (requestParameters.variantRef !== undefined) {
691
- queryParameters['variantRef'] = requestParameters.variantRef;
692
- }
693
-
694
- if (requestParameters.quantity !== undefined) {
695
- queryParameters['quantity'] = requestParameters.quantity;
696
- }
697
-
698
- if (requestParameters.pageToken !== undefined) {
699
- queryParameters['pageToken'] = requestParameters.pageToken;
700
- }
701
-
702
- if (requestParameters.pageSize !== undefined) {
703
- queryParameters['pageSize'] = requestParameters.pageSize;
704
- }
705
-
706
- const headerParameters: runtime.HTTPHeaders = {};
707
-
708
- if (this.configuration && this.configuration.accessToken) {
709
- // oauth required
710
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
711
- }
712
-
713
- if (this.configuration && this.configuration.apiKey) {
714
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
715
- }
716
-
717
- const response = await this.request({
718
- path: `/v1/pickfaces/suggest`,
719
- method: 'GET',
720
- headers: headerParameters,
721
- query: queryParameters,
722
- }, initOverrides);
723
-
724
- return new runtime.JSONApiResponse(response, (jsonValue) => GetPickfaces200ResponseFromJSON(jsonValue));
725
- }
726
-
727
- /**
728
- * Suggest pickfaces for putting away stock
729
- * Suggest pickfaces
730
- */
731
- async suggestPickfaces(
732
- project: string, variantRef: string, quantity: number,
733
- optionalParameters: runtime.OptionalOnly<SuggestPickfacesRequest> = {},
734
- initOverrides?: RequestInit | runtime.InitOverrideFunction
735
- ): Promise<GetPickfaces200Response> {
736
- const response = await this.suggestPickfacesRaw(
737
- {
738
- project: project,variantRef: variantRef,quantity: quantity,
739
- ...optionalParameters,
740
- },
741
- initOverrides
742
- );
743
-
744
- return await response.value();
745
- }
746
-
747
- /**
748
- * Update a Pickface
749
- * Update Pickface
750
- */
751
- async updatePickfaceRaw(requestParameters: UpdatePickfaceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Pickface>> {
752
- if (requestParameters.project === null || requestParameters.project === undefined) {
753
- throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling updatePickface.');
754
- }
755
-
756
- if (requestParameters.pickfaceId === null || requestParameters.pickfaceId === undefined) {
757
- throw new runtime.RequiredError('pickfaceId','Required parameter requestParameters.pickfaceId was null or undefined when calling updatePickface.');
758
- }
759
-
760
- if (requestParameters.updatePickfaceRequest === null || requestParameters.updatePickfaceRequest === undefined) {
761
- throw new runtime.RequiredError('updatePickfaceRequest','Required parameter requestParameters.updatePickfaceRequest was null or undefined when calling updatePickface.');
762
- }
763
-
764
- const queryParameters: any = {};
765
-
766
- if (requestParameters.project !== undefined) {
767
- queryParameters['project'] = requestParameters.project;
768
- }
769
-
770
- const headerParameters: runtime.HTTPHeaders = {};
771
-
772
- headerParameters['Content-Type'] = 'application/json';
773
-
774
- if (this.configuration && this.configuration.accessToken) {
775
- // oauth required
776
- headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
777
- }
778
-
779
- if (this.configuration && this.configuration.apiKey) {
780
- headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
781
- }
782
-
783
- const response = await this.request({
784
- path: `/v1/pickfaces/{pickfaceId}`.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(requestParameters.pickfaceId))),
785
- method: 'PATCH',
786
- headers: headerParameters,
787
- query: queryParameters,
788
- body: UpdatePickfaceRequestToJSON(requestParameters.updatePickfaceRequest),
789
- }, initOverrides);
790
-
791
- return new runtime.JSONApiResponse(response, (jsonValue) => PickfaceFromJSON(jsonValue));
792
- }
793
-
794
- /**
795
- * Update a Pickface
796
- * Update Pickface
797
- */
798
- async updatePickface(
799
- project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest,
800
- initOverrides?: RequestInit | runtime.InitOverrideFunction
801
- ): Promise<Pickface> {
802
- const response = await this.updatePickfaceRaw(
803
- {
804
- project: project,pickfaceId: pickfaceId,updatePickfaceRequest: updatePickfaceRequest,
805
- },
806
- initOverrides
807
- );
808
-
809
- return await response.value();
810
- }
811
-
812
- }
813
-
814
- /**
815
- * @export
816
- */
817
- export const GetPickfacesFiltersEnum = {
818
- Empty: 'empty',
819
- Flagged: 'flagged'
820
- } as const;
821
- export type GetPickfacesFiltersEnum = typeof GetPickfacesFiltersEnum[keyof typeof GetPickfacesFiltersEnum];