@teemill/pickfaces 0.33.1 → 0.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/pickfaces@0.33.1
1
+ ## @teemill/pickfaces@0.35.0
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.33.1 --save
39
+ npm install @teemill/pickfaces@0.35.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -94,6 +94,7 @@ Class | Method | HTTP request | Description
94
94
  - [UpdatePickfaceRequestContentsInner](docs/UpdatePickfaceRequestContentsInner.md)
95
95
  - [UpdatePickfaceRequestContentsInnerQuantity](docs/UpdatePickfaceRequestContentsInnerQuantity.md)
96
96
  - [UpdatePickfaceRequestContentsInnerQuantityAvailable](docs/UpdatePickfaceRequestContentsInnerQuantityAvailable.md)
97
+ - [UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf](docs/UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf.md)
97
98
  - [UpdatePickfaceRequestContentsInnerQuantityZWip](docs/UpdatePickfaceRequestContentsInnerQuantityZWip.md)
98
99
  - [UpdatePickfacesRequest](docs/UpdatePickfacesRequest.md)
99
100
  - [UpdatePickfacesRequestPickfacesInner](docs/UpdatePickfacesRequestPickfacesInner.md)
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.33.1
7
+ * The version of the OpenAPI document: 0.35.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -221,6 +221,10 @@ export interface PickfaceContentsInnerMetadata {
221
221
  * The SKU of the product
222
222
  */
223
223
  'sku': string | null;
224
+ /**
225
+ * The SKU of the variant
226
+ */
227
+ 'variantSku'?: string | null;
224
228
  /**
225
229
  * The image of the front of the product
226
230
  */
@@ -338,36 +342,39 @@ export interface UpdatePickfaceRequest {
338
342
  }
339
343
  export interface UpdatePickfaceRequestContentsInner {
340
344
  /**
341
- * The variant to add or subtract from the pickface
345
+ * The variant to update on the pickface
342
346
  */
343
347
  'variantRef': string;
344
348
  'quantity': UpdatePickfaceRequestContentsInnerQuantity;
345
349
  }
346
350
  export interface UpdatePickfaceRequestContentsInnerQuantity {
347
- 'available'?: UpdatePickfaceRequestContentsInnerQuantityAvailable | null;
348
- 'ZWip'?: UpdatePickfaceRequestContentsInnerQuantityZWip | null;
351
+ 'available'?: UpdatePickfaceRequestContentsInnerQuantityAvailable;
352
+ 'ZWip'?: UpdatePickfaceRequestContentsInnerQuantityZWip;
349
353
  }
350
354
  /**
351
- * The amount to add or subtract from the available stock on the pickface
355
+ * @type UpdatePickfaceRequestContentsInnerQuantityAvailable
356
+ * The available stock quantity. Can be an integer to set absolute value, or an object with operation (add/subtract/set) and value. Use the integer value if you want to set the value of multiple variants at once.
352
357
  */
353
- export interface UpdatePickfaceRequestContentsInnerQuantityAvailable {
354
- 'operation'?: UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum;
358
+ export type UpdatePickfaceRequestContentsInnerQuantityAvailable = UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf | number;
359
+
360
+ export interface UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf {
361
+ 'operation': UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum;
355
362
  'value': number;
356
363
  }
357
364
 
358
- export const UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = {
365
+ export const UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = {
359
366
  Add: 'add',
360
367
  Subtract: 'subtract',
361
368
  Set: 'set'
362
369
  } as const;
363
370
 
364
- export type UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum];
371
+ export type UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum];
365
372
 
366
373
  /**
367
- * The amount to add or subtract from the Z WIP stock on the pickface.
374
+ * The Z WIP stock quantity.
368
375
  */
369
376
  export interface UpdatePickfaceRequestContentsInnerQuantityZWip {
370
- 'operation'?: UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum;
377
+ 'operation': UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum;
371
378
  'value': number;
372
379
  }
373
380
 
@@ -1273,17 +1280,15 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1273
1280
  * @summary Update Pickface
1274
1281
  * @param {string} project The project ID
1275
1282
  * @param {string} pickfaceId Unique identifier of a pickface
1276
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
1283
+ * @param {UpdatePickfaceRequest} [updatePickfaceRequest]
1277
1284
  * @param {*} [options] Override http request option.
1278
1285
  * @throws {RequiredError}
1279
1286
  */
1280
- updatePickface: async (project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1287
+ updatePickface: async (project: string, pickfaceId: string, updatePickfaceRequest?: UpdatePickfaceRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1281
1288
  // verify required parameter 'project' is not null or undefined
1282
1289
  assertParamExists('updatePickface', 'project', project)
1283
1290
  // verify required parameter 'pickfaceId' is not null or undefined
1284
1291
  assertParamExists('updatePickface', 'pickfaceId', pickfaceId)
1285
- // verify required parameter 'updatePickfaceRequest' is not null or undefined
1286
- assertParamExists('updatePickface', 'updatePickfaceRequest', updatePickfaceRequest)
1287
1292
  const localVarPath = `/v1/pickfaces/{pickfaceId}`
1288
1293
  .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
1289
1294
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -1613,11 +1618,11 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1613
1618
  * @summary Update Pickface
1614
1619
  * @param {string} project The project ID
1615
1620
  * @param {string} pickfaceId Unique identifier of a pickface
1616
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
1621
+ * @param {UpdatePickfaceRequest} [updatePickfaceRequest]
1617
1622
  * @param {*} [options] Override http request option.
1618
1623
  * @throws {RequiredError}
1619
1624
  */
1620
- async updatePickface(project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
1625
+ async updatePickface(project: string, pickfaceId: string, updatePickfaceRequest?: UpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>> {
1621
1626
  const localVarAxiosArgs = await localVarAxiosParamCreator.updatePickface(project, pickfaceId, updatePickfaceRequest, options);
1622
1627
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1623
1628
  const localVarOperationServerBasePath = operationServerMap['PickfacesApi.updatePickface']?.[localVarOperationServerIndex]?.url;
@@ -2143,10 +2148,7 @@ export interface PickfacesApiUpdatePickfaceRequest {
2143
2148
  */
2144
2149
  readonly pickfaceId: string
2145
2150
 
2146
- /**
2147
- * Update pickface schema
2148
- */
2149
- readonly updatePickfaceRequest: UpdatePickfaceRequest
2151
+ readonly updatePickfaceRequest?: UpdatePickfaceRequest
2150
2152
  }
2151
2153
 
2152
2154
  /**
package/base.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.33.1
7
+ * The version of the OpenAPI document: 0.35.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.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.33.1
7
+ * The version of the OpenAPI document: 0.35.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * Pickfaces API
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.33.1
6
+ * The version of the OpenAPI document: 0.35.0
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
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.35.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -211,6 +211,10 @@ export interface PickfaceContentsInnerMetadata {
211
211
  * The SKU of the product
212
212
  */
213
213
  'sku': string | null;
214
+ /**
215
+ * The SKU of the variant
216
+ */
217
+ 'variantSku'?: string | null;
214
218
  /**
215
219
  * The image of the front of the product
216
220
  */
@@ -328,33 +332,35 @@ export interface UpdatePickfaceRequest {
328
332
  }
329
333
  export interface UpdatePickfaceRequestContentsInner {
330
334
  /**
331
- * The variant to add or subtract from the pickface
335
+ * The variant to update on the pickface
332
336
  */
333
337
  'variantRef': string;
334
338
  'quantity': UpdatePickfaceRequestContentsInnerQuantity;
335
339
  }
336
340
  export interface UpdatePickfaceRequestContentsInnerQuantity {
337
- 'available'?: UpdatePickfaceRequestContentsInnerQuantityAvailable | null;
338
- 'ZWip'?: UpdatePickfaceRequestContentsInnerQuantityZWip | null;
341
+ 'available'?: UpdatePickfaceRequestContentsInnerQuantityAvailable;
342
+ 'ZWip'?: UpdatePickfaceRequestContentsInnerQuantityZWip;
339
343
  }
340
344
  /**
341
- * The amount to add or subtract from the available stock on the pickface
345
+ * @type UpdatePickfaceRequestContentsInnerQuantityAvailable
346
+ * The available stock quantity. Can be an integer to set absolute value, or an object with operation (add/subtract/set) and value. Use the integer value if you want to set the value of multiple variants at once.
342
347
  */
343
- export interface UpdatePickfaceRequestContentsInnerQuantityAvailable {
344
- 'operation'?: UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum;
348
+ export type UpdatePickfaceRequestContentsInnerQuantityAvailable = UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf | number;
349
+ export interface UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf {
350
+ 'operation': UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum;
345
351
  'value': number;
346
352
  }
347
- export declare const UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum: {
353
+ export declare const UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum: {
348
354
  readonly Add: "add";
349
355
  readonly Subtract: "subtract";
350
356
  readonly Set: "set";
351
357
  };
352
- export type UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum];
358
+ export type UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum];
353
359
  /**
354
- * The amount to add or subtract from the Z WIP stock on the pickface.
360
+ * The Z WIP stock quantity.
355
361
  */
356
362
  export interface UpdatePickfaceRequestContentsInnerQuantityZWip {
357
- 'operation'?: UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum;
363
+ 'operation': UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum;
358
364
  'value': number;
359
365
  }
360
366
  export declare const UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum: {
@@ -577,11 +583,11 @@ export declare const PickfacesApiAxiosParamCreator: (configuration?: Configurati
577
583
  * @summary Update Pickface
578
584
  * @param {string} project The project ID
579
585
  * @param {string} pickfaceId Unique identifier of a pickface
580
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
586
+ * @param {UpdatePickfaceRequest} [updatePickfaceRequest]
581
587
  * @param {*} [options] Override http request option.
582
588
  * @throws {RequiredError}
583
589
  */
584
- updatePickface: (project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
590
+ updatePickface: (project: string, pickfaceId: string, updatePickfaceRequest?: UpdatePickfaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
585
591
  /**
586
592
  * Update pickfaces in bulk
587
593
  * @summary Update pickfaces
@@ -753,11 +759,11 @@ export declare const PickfacesApiFp: (configuration?: Configuration) => {
753
759
  * @summary Update Pickface
754
760
  * @param {string} project The project ID
755
761
  * @param {string} pickfaceId Unique identifier of a pickface
756
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
762
+ * @param {UpdatePickfaceRequest} [updatePickfaceRequest]
757
763
  * @param {*} [options] Override http request option.
758
764
  * @throws {RequiredError}
759
765
  */
760
- updatePickface(project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
766
+ updatePickface(project: string, pickfaceId: string, updatePickfaceRequest?: UpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
761
767
  /**
762
768
  * Update pickfaces in bulk
763
769
  * @summary Update pickfaces
@@ -1184,10 +1190,7 @@ export interface PickfacesApiUpdatePickfaceRequest {
1184
1190
  * Unique identifier of a pickface
1185
1191
  */
1186
1192
  readonly pickfaceId: string;
1187
- /**
1188
- * Update pickface schema
1189
- */
1190
- readonly updatePickfaceRequest: UpdatePickfaceRequest;
1193
+ readonly updatePickfaceRequest?: UpdatePickfaceRequest;
1191
1194
  }
1192
1195
  /**
1193
1196
  * Request parameters for updatePickfaces operation in PickfacesApi.
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Pickfaces API
6
6
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
7
7
  *
8
- * The version of the OpenAPI document: 0.33.1
8
+ * The version of the OpenAPI document: 0.35.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,14 +22,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.ListPickfacesSortByEnum = exports.PickfacesApi = exports.PickfacesApiFactory = exports.PickfacesApiFp = exports.PickfacesApiAxiosParamCreator = exports.VariantAttributeThumbnailTypeEnum = exports.UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum = exports.UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = void 0;
25
+ exports.ListPickfacesSortByEnum = exports.PickfacesApi = exports.PickfacesApiFactory = exports.PickfacesApiFp = exports.PickfacesApiAxiosParamCreator = exports.VariantAttributeThumbnailTypeEnum = exports.UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum = exports.UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = void 0;
26
26
  const axios_1 = require("axios");
27
27
  // Some imports not used depending on template conditions
28
28
  // @ts-ignore
29
29
  const common_1 = require("./common");
30
30
  // @ts-ignore
31
31
  const base_1 = require("./base");
32
- exports.UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = {
32
+ exports.UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = {
33
33
  Add: 'add',
34
34
  Subtract: 'subtract',
35
35
  Set: 'set'
@@ -738,7 +738,7 @@ const PickfacesApiAxiosParamCreator = function (configuration) {
738
738
  * @summary Update Pickface
739
739
  * @param {string} project The project ID
740
740
  * @param {string} pickfaceId Unique identifier of a pickface
741
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
741
+ * @param {UpdatePickfaceRequest} [updatePickfaceRequest]
742
742
  * @param {*} [options] Override http request option.
743
743
  * @throws {RequiredError}
744
744
  */
@@ -747,8 +747,6 @@ const PickfacesApiAxiosParamCreator = function (configuration) {
747
747
  (0, common_1.assertParamExists)('updatePickface', 'project', project);
748
748
  // verify required parameter 'pickfaceId' is not null or undefined
749
749
  (0, common_1.assertParamExists)('updatePickface', 'pickfaceId', pickfaceId);
750
- // verify required parameter 'updatePickfaceRequest' is not null or undefined
751
- (0, common_1.assertParamExists)('updatePickface', 'updatePickfaceRequest', updatePickfaceRequest);
752
750
  const localVarPath = `/v1/pickfaces/{pickfaceId}`
753
751
  .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
754
752
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -1105,7 +1103,7 @@ const PickfacesApiFp = function (configuration) {
1105
1103
  * @summary Update Pickface
1106
1104
  * @param {string} project The project ID
1107
1105
  * @param {string} pickfaceId Unique identifier of a pickface
1108
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
1106
+ * @param {UpdatePickfaceRequest} [updatePickfaceRequest]
1109
1107
  * @param {*} [options] Override http request option.
1110
1108
  * @throws {RequiredError}
1111
1109
  */
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.35.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Pickfaces API
6
6
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
7
7
  *
8
- * The version of the OpenAPI document: 0.33.1
8
+ * The version of the OpenAPI document: 0.35.0
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
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.35.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Pickfaces API
6
6
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
7
7
  *
8
- * The version of the OpenAPI document: 0.33.1
8
+ * The version of the OpenAPI document: 0.35.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.35.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Pickfaces API
5
5
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
6
6
  *
7
- * The version of the OpenAPI document: 0.33.1
7
+ * The version of the OpenAPI document: 0.35.0
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
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.35.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -211,6 +211,10 @@ export interface PickfaceContentsInnerMetadata {
211
211
  * The SKU of the product
212
212
  */
213
213
  'sku': string | null;
214
+ /**
215
+ * The SKU of the variant
216
+ */
217
+ 'variantSku'?: string | null;
214
218
  /**
215
219
  * The image of the front of the product
216
220
  */
@@ -328,33 +332,35 @@ export interface UpdatePickfaceRequest {
328
332
  }
329
333
  export interface UpdatePickfaceRequestContentsInner {
330
334
  /**
331
- * The variant to add or subtract from the pickface
335
+ * The variant to update on the pickface
332
336
  */
333
337
  'variantRef': string;
334
338
  'quantity': UpdatePickfaceRequestContentsInnerQuantity;
335
339
  }
336
340
  export interface UpdatePickfaceRequestContentsInnerQuantity {
337
- 'available'?: UpdatePickfaceRequestContentsInnerQuantityAvailable | null;
338
- 'ZWip'?: UpdatePickfaceRequestContentsInnerQuantityZWip | null;
341
+ 'available'?: UpdatePickfaceRequestContentsInnerQuantityAvailable;
342
+ 'ZWip'?: UpdatePickfaceRequestContentsInnerQuantityZWip;
339
343
  }
340
344
  /**
341
- * The amount to add or subtract from the available stock on the pickface
345
+ * @type UpdatePickfaceRequestContentsInnerQuantityAvailable
346
+ * The available stock quantity. Can be an integer to set absolute value, or an object with operation (add/subtract/set) and value. Use the integer value if you want to set the value of multiple variants at once.
342
347
  */
343
- export interface UpdatePickfaceRequestContentsInnerQuantityAvailable {
344
- 'operation'?: UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum;
348
+ export type UpdatePickfaceRequestContentsInnerQuantityAvailable = UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf | number;
349
+ export interface UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf {
350
+ 'operation': UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum;
345
351
  'value': number;
346
352
  }
347
- export declare const UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum: {
353
+ export declare const UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum: {
348
354
  readonly Add: "add";
349
355
  readonly Subtract: "subtract";
350
356
  readonly Set: "set";
351
357
  };
352
- export type UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum];
358
+ export type UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum];
353
359
  /**
354
- * The amount to add or subtract from the Z WIP stock on the pickface.
360
+ * The Z WIP stock quantity.
355
361
  */
356
362
  export interface UpdatePickfaceRequestContentsInnerQuantityZWip {
357
- 'operation'?: UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum;
363
+ 'operation': UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum;
358
364
  'value': number;
359
365
  }
360
366
  export declare const UpdatePickfaceRequestContentsInnerQuantityZWipOperationEnum: {
@@ -577,11 +583,11 @@ export declare const PickfacesApiAxiosParamCreator: (configuration?: Configurati
577
583
  * @summary Update Pickface
578
584
  * @param {string} project The project ID
579
585
  * @param {string} pickfaceId Unique identifier of a pickface
580
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
586
+ * @param {UpdatePickfaceRequest} [updatePickfaceRequest]
581
587
  * @param {*} [options] Override http request option.
582
588
  * @throws {RequiredError}
583
589
  */
584
- updatePickface: (project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
590
+ updatePickface: (project: string, pickfaceId: string, updatePickfaceRequest?: UpdatePickfaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
585
591
  /**
586
592
  * Update pickfaces in bulk
587
593
  * @summary Update pickfaces
@@ -753,11 +759,11 @@ export declare const PickfacesApiFp: (configuration?: Configuration) => {
753
759
  * @summary Update Pickface
754
760
  * @param {string} project The project ID
755
761
  * @param {string} pickfaceId Unique identifier of a pickface
756
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
762
+ * @param {UpdatePickfaceRequest} [updatePickfaceRequest]
757
763
  * @param {*} [options] Override http request option.
758
764
  * @throws {RequiredError}
759
765
  */
760
- updatePickface(project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
766
+ updatePickface(project: string, pickfaceId: string, updatePickfaceRequest?: UpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
761
767
  /**
762
768
  * Update pickfaces in bulk
763
769
  * @summary Update pickfaces
@@ -1184,10 +1190,7 @@ export interface PickfacesApiUpdatePickfaceRequest {
1184
1190
  * Unique identifier of a pickface
1185
1191
  */
1186
1192
  readonly pickfaceId: string;
1187
- /**
1188
- * Update pickface schema
1189
- */
1190
- readonly updatePickfaceRequest: UpdatePickfaceRequest;
1193
+ readonly updatePickfaceRequest?: UpdatePickfaceRequest;
1191
1194
  }
1192
1195
  /**
1193
1196
  * Request parameters for updatePickfaces operation in PickfacesApi.
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Pickfaces API
5
5
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
6
6
  *
7
- * The version of the OpenAPI document: 0.33.1
7
+ * The version of the OpenAPI document: 0.35.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,7 +26,7 @@ import globalAxios from 'axios';
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
27
27
  // @ts-ignore
28
28
  import { BASE_PATH, BaseAPI, operationServerMap } from './base';
29
- export const UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = {
29
+ export const UpdatePickfaceRequestContentsInnerQuantityAvailableOneOfOperationEnum = {
30
30
  Add: 'add',
31
31
  Subtract: 'subtract',
32
32
  Set: 'set'
@@ -735,7 +735,7 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
735
735
  * @summary Update Pickface
736
736
  * @param {string} project The project ID
737
737
  * @param {string} pickfaceId Unique identifier of a pickface
738
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
738
+ * @param {UpdatePickfaceRequest} [updatePickfaceRequest]
739
739
  * @param {*} [options] Override http request option.
740
740
  * @throws {RequiredError}
741
741
  */
@@ -744,8 +744,6 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
744
744
  assertParamExists('updatePickface', 'project', project);
745
745
  // verify required parameter 'pickfaceId' is not null or undefined
746
746
  assertParamExists('updatePickface', 'pickfaceId', pickfaceId);
747
- // verify required parameter 'updatePickfaceRequest' is not null or undefined
748
- assertParamExists('updatePickface', 'updatePickfaceRequest', updatePickfaceRequest);
749
747
  const localVarPath = `/v1/pickfaces/{pickfaceId}`
750
748
  .replace(`{${"pickfaceId"}}`, encodeURIComponent(String(pickfaceId)));
751
749
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -1101,7 +1099,7 @@ export const PickfacesApiFp = function (configuration) {
1101
1099
  * @summary Update Pickface
1102
1100
  * @param {string} project The project ID
1103
1101
  * @param {string} pickfaceId Unique identifier of a pickface
1104
- * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
1102
+ * @param {UpdatePickfaceRequest} [updatePickfaceRequest]
1105
1103
  * @param {*} [options] Override http request option.
1106
1104
  * @throws {RequiredError}
1107
1105
  */
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.35.0
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
@@ -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.33.1
7
+ * The version of the OpenAPI document: 0.35.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.35.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Pickfaces API
5
5
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
6
6
  *
7
- * The version of the OpenAPI document: 0.33.1
7
+ * The version of the OpenAPI document: 0.35.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.35.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Pickfaces API
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.33.1
6
+ * The version of the OpenAPI document: 0.35.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.35.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Pickfaces API
5
5
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
6
6
  *
7
- * The version of the OpenAPI document: 0.33.1
7
+ * The version of the OpenAPI document: 0.35.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Pickfaces API
3
3
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
4
4
  *
5
- * The version of the OpenAPI document: 0.33.1
5
+ * The version of the OpenAPI document: 0.35.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Pickfaces API
6
6
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
7
7
  *
8
- * The version of the OpenAPI document: 0.33.1
8
+ * The version of the OpenAPI document: 0.35.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **title** | **string** | The title of the product | [default to undefined]
10
10
  **sku** | **string** | The SKU of the product | [default to undefined]
11
+ **variantSku** | **string** | The SKU of the variant | [optional] [default to undefined]
11
12
  **frontImage** | **string** | The image of the front of the product | [optional] [default to undefined]
12
13
  **backImage** | **string** | The image of the back of the product | [optional] [default to undefined]
13
14
  **attributes** | [**Array&lt;VariantAttribute&gt;**](VariantAttribute.md) | Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of &#x60;text&#x60;, &#x60;color&#x60;, or &#x60;image&#x60;. | [optional] [default to undefined]
@@ -20,6 +21,7 @@ import { PickfaceContentsInnerMetadata } from '@teemill/pickfaces';
20
21
  const instance: PickfaceContentsInnerMetadata = {
21
22
  title,
22
23
  sku,
24
+ variantSku,
23
25
  frontImage,
24
26
  backImage,
25
27
  attributes,
@@ -958,7 +958,7 @@ const { status, data } = await apiInstance.suggestPickfaces(
958
958
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
959
959
 
960
960
  # **updatePickface**
961
- > Pickface updatePickface(updatePickfaceRequest)
961
+ > Pickface updatePickface()
962
962
 
963
963
  Update a Pickface
964
964
 
@@ -976,7 +976,7 @@ const apiInstance = new PickfacesApi(configuration);
976
976
 
977
977
  let project: string; //The project ID (default to undefined)
978
978
  let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
979
- let updatePickfaceRequest: UpdatePickfaceRequest; //Update pickface schema
979
+ let updatePickfaceRequest: UpdatePickfaceRequest; // (optional)
980
980
 
981
981
  const { status, data } = await apiInstance.updatePickface(
982
982
  project,
@@ -989,7 +989,7 @@ const { status, data } = await apiInstance.updatePickface(
989
989
 
990
990
  |Name | Type | Description | Notes|
991
991
  |------------- | ------------- | ------------- | -------------|
992
- | **updatePickfaceRequest** | **UpdatePickfaceRequest**| Update pickface schema | |
992
+ | **updatePickfaceRequest** | **UpdatePickfaceRequest**| | |
993
993
  | **project** | [**string**] | The project ID | defaults to undefined|
994
994
  | **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
995
995
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **variantRef** | **string** | The variant to add or subtract from the pickface | [default to undefined]
8
+ **variantRef** | **string** | The variant to update on the pickface | [default to undefined]
9
9
  **quantity** | [**UpdatePickfaceRequestContentsInnerQuantity**](UpdatePickfaceRequestContentsInnerQuantity.md) | | [default to undefined]
10
10
 
11
11
  ## Example
@@ -1,12 +1,12 @@
1
1
  # UpdatePickfaceRequestContentsInnerQuantityAvailable
2
2
 
3
- The amount to add or subtract from the available stock on the pickface
3
+ The available stock quantity. Can be an integer to set absolute value, or an object with operation (add/subtract/set) and value. Use the integer value if you want to set the value of multiple variants at once.
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **operation** | **string** | | [optional] [default to undefined]
9
+ **operation** | **string** | | [default to undefined]
10
10
  **value** | **number** | | [default to undefined]
11
11
 
12
12
  ## Example
@@ -0,0 +1,22 @@
1
+ # UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **operation** | **string** | | [default to undefined]
9
+ **value** | **number** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf } from '@teemill/pickfaces';
15
+
16
+ const instance: UpdatePickfaceRequestContentsInnerQuantityAvailableOneOf = {
17
+ operation,
18
+ value,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,12 +1,12 @@
1
1
  # UpdatePickfaceRequestContentsInnerQuantityZWip
2
2
 
3
- The amount to add or subtract from the Z WIP stock on the pickface.
3
+ The Z WIP stock quantity.
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **operation** | **string** | | [optional] [default to undefined]
9
+ **operation** | **string** | | [default to undefined]
10
10
  **value** | **number** | | [default to undefined]
11
11
 
12
12
  ## Example
package/index.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.33.1
7
+ * The version of the OpenAPI document: 0.35.0
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.33.1",
3
+ "version": "0.35.0",
4
4
  "description": "OpenAPI client for @teemill/pickfaces",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {