@teemill/pickfaces 0.21.0 → 0.22.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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/pickfaces@0.21.0
1
+ ## @teemill/pickfaces@0.22.1
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.21.0 --save
39
+ npm install @teemill/pickfaces@0.22.1 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -396,6 +396,12 @@ export interface PickfaceContentsInnerMetadata {
396
396
  * @memberof PickfaceContentsInnerMetadata
397
397
  */
398
398
  'backImage'?: string | null;
399
+ /**
400
+ * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`.
401
+ * @type {Array<VariantAttribute>}
402
+ * @memberof PickfaceContentsInnerMetadata
403
+ */
404
+ 'attributes'?: Array<VariantAttribute>;
399
405
  }
400
406
  /**
401
407
  *
@@ -666,6 +672,59 @@ export const UpdatePickfaceRequestContentsInnerQuantityOperationEnum = {
666
672
 
667
673
  export type UpdatePickfaceRequestContentsInnerQuantityOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum];
668
674
 
675
+ /**
676
+ *
677
+ * @export
678
+ * @interface VariantAttribute
679
+ */
680
+ export interface VariantAttribute {
681
+ /**
682
+ * Attribute name
683
+ * @type {string}
684
+ * @memberof VariantAttribute
685
+ */
686
+ 'name': string;
687
+ /**
688
+ * Attribute value
689
+ * @type {string}
690
+ * @memberof VariantAttribute
691
+ */
692
+ 'value': string;
693
+ /**
694
+ *
695
+ * @type {VariantAttributeThumbnail}
696
+ * @memberof VariantAttribute
697
+ */
698
+ 'thumbnail'?: VariantAttributeThumbnail;
699
+ }
700
+ /**
701
+ * Attribute thumbnail
702
+ * @export
703
+ * @interface VariantAttributeThumbnail
704
+ */
705
+ export interface VariantAttributeThumbnail {
706
+ /**
707
+ *
708
+ * @type {string}
709
+ * @memberof VariantAttributeThumbnail
710
+ */
711
+ 'type': VariantAttributeThumbnailTypeEnum;
712
+ /**
713
+ *
714
+ * @type {string}
715
+ * @memberof VariantAttributeThumbnail
716
+ */
717
+ 'value': string;
718
+ }
719
+
720
+ export const VariantAttributeThumbnailTypeEnum = {
721
+ Text: 'text',
722
+ Color: 'color',
723
+ Image: 'image'
724
+ } as const;
725
+
726
+ export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
727
+
669
728
 
670
729
  /**
671
730
  * PickfacesApi - axios parameter creator
@@ -1366,12 +1425,13 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1366
1425
  * @param {string} project The project ID
1367
1426
  * @param {string} variantRef Unique identifier of a warehouse variant
1368
1427
  * @param {number} quantity Number of variants
1428
+ * @param {number} [sellThroughRate] The sell through rate of the variant to use when suggesting pickfaces
1369
1429
  * @param {number} [pageToken] Page reference token
1370
1430
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1371
1431
  * @param {*} [options] Override http request option.
1372
1432
  * @throws {RequiredError}
1373
1433
  */
1374
- suggestPickfaces: async (project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1434
+ suggestPickfaces: async (project: string, variantRef: string, quantity: number, sellThroughRate?: number, pageToken?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1375
1435
  // verify required parameter 'project' is not null or undefined
1376
1436
  assertParamExists('suggestPickfaces', 'project', project)
1377
1437
  // verify required parameter 'variantRef' is not null or undefined
@@ -1409,6 +1469,10 @@ export const PickfacesApiAxiosParamCreator = function (configuration?: Configura
1409
1469
  localVarQueryParameter['quantity'] = quantity;
1410
1470
  }
1411
1471
 
1472
+ if (sellThroughRate !== undefined) {
1473
+ localVarQueryParameter['sellThroughRate'] = sellThroughRate;
1474
+ }
1475
+
1412
1476
  if (pageToken !== undefined) {
1413
1477
  localVarQueryParameter['pageToken'] = pageToken;
1414
1478
  }
@@ -1690,13 +1754,14 @@ export const PickfacesApiFp = function(configuration?: Configuration) {
1690
1754
  * @param {string} project The project ID
1691
1755
  * @param {string} variantRef Unique identifier of a warehouse variant
1692
1756
  * @param {number} quantity Number of variants
1757
+ * @param {number} [sellThroughRate] The sell through rate of the variant to use when suggesting pickfaces
1693
1758
  * @param {number} [pageToken] Page reference token
1694
1759
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1695
1760
  * @param {*} [options] Override http request option.
1696
1761
  * @throws {RequiredError}
1697
1762
  */
1698
- async suggestPickfaces(project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>> {
1699
- const localVarAxiosArgs = await localVarAxiosParamCreator.suggestPickfaces(project, variantRef, quantity, pageToken, pageSize, options);
1763
+ async suggestPickfaces(project: string, variantRef: string, quantity: number, sellThroughRate?: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>> {
1764
+ const localVarAxiosArgs = await localVarAxiosParamCreator.suggestPickfaces(project, variantRef, quantity, sellThroughRate, pageToken, pageSize, options);
1700
1765
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1701
1766
  const localVarOperationServerBasePath = operationServerMap['PickfacesApi.suggestPickfaces']?.[localVarOperationServerIndex]?.url;
1702
1767
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1864,7 +1929,7 @@ export const PickfacesApiFactory = function (configuration?: Configuration, base
1864
1929
  * @throws {RequiredError}
1865
1930
  */
1866
1931
  suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaces200Response> {
1867
- return localVarFp.suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1932
+ return localVarFp.suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.sellThroughRate, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1868
1933
  },
1869
1934
  /**
1870
1935
  * Update a Pickface
@@ -2249,6 +2314,13 @@ export interface PickfacesApiSuggestPickfacesRequest {
2249
2314
  */
2250
2315
  readonly quantity: number
2251
2316
 
2317
+ /**
2318
+ * The sell through rate of the variant to use when suggesting pickfaces
2319
+ * @type {number}
2320
+ * @memberof PickfacesApiSuggestPickfaces
2321
+ */
2322
+ readonly sellThroughRate?: number
2323
+
2252
2324
  /**
2253
2325
  * Page reference token
2254
2326
  * @type {number}
@@ -2464,7 +2536,7 @@ export class PickfacesApi extends BaseAPI {
2464
2536
  * @memberof PickfacesApi
2465
2537
  */
2466
2538
  public suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig) {
2467
- return PickfacesApiFp(this.configuration).suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
2539
+ return PickfacesApiFp(this.configuration).suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.sellThroughRate, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
2468
2540
  }
2469
2541
 
2470
2542
  /**
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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -90,11 +90,10 @@ export class Configuration {
90
90
  this.basePath = param.basePath;
91
91
  this.serverIndex = param.serverIndex;
92
92
  this.baseOptions = {
93
+ ...param.baseOptions,
93
94
  headers: {
94
95
  ...param.baseOptions?.headers,
95
- 'User-Agent': "OpenAPI-Generator/0.21.0/typescript-axios"
96
96
  },
97
- ...param.baseOptions
98
97
  };
99
98
  this.formDataCtor = param.formDataCtor;
100
99
  }
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.21.0
5
+ * The version of the OpenAPI document: 0.22.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -386,6 +386,12 @@ export interface PickfaceContentsInnerMetadata {
386
386
  * @memberof PickfaceContentsInnerMetadata
387
387
  */
388
388
  'backImage'?: string | null;
389
+ /**
390
+ * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`.
391
+ * @type {Array<VariantAttribute>}
392
+ * @memberof PickfaceContentsInnerMetadata
393
+ */
394
+ 'attributes'?: Array<VariantAttribute>;
389
395
  }
390
396
  /**
391
397
  *
@@ -653,6 +659,56 @@ export declare const UpdatePickfaceRequestContentsInnerQuantityOperationEnum: {
653
659
  readonly Subtract: "subtract";
654
660
  };
655
661
  export type UpdatePickfaceRequestContentsInnerQuantityOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum];
662
+ /**
663
+ *
664
+ * @export
665
+ * @interface VariantAttribute
666
+ */
667
+ export interface VariantAttribute {
668
+ /**
669
+ * Attribute name
670
+ * @type {string}
671
+ * @memberof VariantAttribute
672
+ */
673
+ 'name': string;
674
+ /**
675
+ * Attribute value
676
+ * @type {string}
677
+ * @memberof VariantAttribute
678
+ */
679
+ 'value': string;
680
+ /**
681
+ *
682
+ * @type {VariantAttributeThumbnail}
683
+ * @memberof VariantAttribute
684
+ */
685
+ 'thumbnail'?: VariantAttributeThumbnail;
686
+ }
687
+ /**
688
+ * Attribute thumbnail
689
+ * @export
690
+ * @interface VariantAttributeThumbnail
691
+ */
692
+ export interface VariantAttributeThumbnail {
693
+ /**
694
+ *
695
+ * @type {string}
696
+ * @memberof VariantAttributeThumbnail
697
+ */
698
+ 'type': VariantAttributeThumbnailTypeEnum;
699
+ /**
700
+ *
701
+ * @type {string}
702
+ * @memberof VariantAttributeThumbnail
703
+ */
704
+ 'value': string;
705
+ }
706
+ export declare const VariantAttributeThumbnailTypeEnum: {
707
+ readonly Text: "text";
708
+ readonly Color: "color";
709
+ readonly Image: "image";
710
+ };
711
+ export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
656
712
  /**
657
713
  * PickfacesApi - axios parameter creator
658
714
  * @export
@@ -791,12 +847,13 @@ export declare const PickfacesApiAxiosParamCreator: (configuration?: Configurati
791
847
  * @param {string} project The project ID
792
848
  * @param {string} variantRef Unique identifier of a warehouse variant
793
849
  * @param {number} quantity Number of variants
850
+ * @param {number} [sellThroughRate] The sell through rate of the variant to use when suggesting pickfaces
794
851
  * @param {number} [pageToken] Page reference token
795
852
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
796
853
  * @param {*} [options] Override http request option.
797
854
  * @throws {RequiredError}
798
855
  */
799
- suggestPickfaces: (project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
856
+ suggestPickfaces: (project: string, variantRef: string, quantity: number, sellThroughRate?: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
800
857
  /**
801
858
  * Update a Pickface
802
859
  * @summary Update Pickface
@@ -946,12 +1003,13 @@ export declare const PickfacesApiFp: (configuration?: Configuration) => {
946
1003
  * @param {string} project The project ID
947
1004
  * @param {string} variantRef Unique identifier of a warehouse variant
948
1005
  * @param {number} quantity Number of variants
1006
+ * @param {number} [sellThroughRate] The sell through rate of the variant to use when suggesting pickfaces
949
1007
  * @param {number} [pageToken] Page reference token
950
1008
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
951
1009
  * @param {*} [options] Override http request option.
952
1010
  * @throws {RequiredError}
953
1011
  */
954
- suggestPickfaces(project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>>;
1012
+ suggestPickfaces(project: string, variantRef: string, quantity: number, sellThroughRate?: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>>;
955
1013
  /**
956
1014
  * Update a Pickface
957
1015
  * @summary Update Pickface
@@ -1420,6 +1478,12 @@ export interface PickfacesApiSuggestPickfacesRequest {
1420
1478
  * @memberof PickfacesApiSuggestPickfaces
1421
1479
  */
1422
1480
  readonly quantity: number;
1481
+ /**
1482
+ * The sell through rate of the variant to use when suggesting pickfaces
1483
+ * @type {number}
1484
+ * @memberof PickfacesApiSuggestPickfaces
1485
+ */
1486
+ readonly sellThroughRate?: number;
1423
1487
  /**
1424
1488
  * Page reference token
1425
1489
  * @type {number}
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.21.0
8
+ * The version of the OpenAPI document: 0.22.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,7 +22,7 @@ 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.UpdatePickfaceRequestContentsInnerQuantityOperationEnum = void 0;
25
+ exports.ListPickfacesSortByEnum = exports.PickfacesApi = exports.PickfacesApiFactory = exports.PickfacesApiFp = exports.PickfacesApiAxiosParamCreator = exports.VariantAttributeThumbnailTypeEnum = exports.UpdatePickfaceRequestContentsInnerQuantityOperationEnum = void 0;
26
26
  const axios_1 = require("axios");
27
27
  // Some imports not used depending on template conditions
28
28
  // @ts-ignore
@@ -33,6 +33,11 @@ exports.UpdatePickfaceRequestContentsInnerQuantityOperationEnum = {
33
33
  Add: 'add',
34
34
  Subtract: 'subtract'
35
35
  };
36
+ exports.VariantAttributeThumbnailTypeEnum = {
37
+ Text: 'text',
38
+ Color: 'color',
39
+ Image: 'image'
40
+ };
36
41
  /**
37
42
  * PickfacesApi - axios parameter creator
38
43
  * @export
@@ -613,12 +618,13 @@ const PickfacesApiAxiosParamCreator = function (configuration) {
613
618
  * @param {string} project The project ID
614
619
  * @param {string} variantRef Unique identifier of a warehouse variant
615
620
  * @param {number} quantity Number of variants
621
+ * @param {number} [sellThroughRate] The sell through rate of the variant to use when suggesting pickfaces
616
622
  * @param {number} [pageToken] Page reference token
617
623
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
618
624
  * @param {*} [options] Override http request option.
619
625
  * @throws {RequiredError}
620
626
  */
621
- suggestPickfaces: (project_1, variantRef_1, quantity_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, variantRef_1, quantity_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, variantRef, quantity, pageToken, pageSize, options = {}) {
627
+ suggestPickfaces: (project_1, variantRef_1, quantity_1, sellThroughRate_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, variantRef_1, quantity_1, sellThroughRate_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, variantRef, quantity, sellThroughRate, pageToken, pageSize, options = {}) {
622
628
  // verify required parameter 'project' is not null or undefined
623
629
  (0, common_1.assertParamExists)('suggestPickfaces', 'project', project);
624
630
  // verify required parameter 'variantRef' is not null or undefined
@@ -649,6 +655,9 @@ const PickfacesApiAxiosParamCreator = function (configuration) {
649
655
  if (quantity !== undefined) {
650
656
  localVarQueryParameter['quantity'] = quantity;
651
657
  }
658
+ if (sellThroughRate !== undefined) {
659
+ localVarQueryParameter['sellThroughRate'] = sellThroughRate;
660
+ }
652
661
  if (pageToken !== undefined) {
653
662
  localVarQueryParameter['pageToken'] = pageToken;
654
663
  }
@@ -955,15 +964,16 @@ const PickfacesApiFp = function (configuration) {
955
964
  * @param {string} project The project ID
956
965
  * @param {string} variantRef Unique identifier of a warehouse variant
957
966
  * @param {number} quantity Number of variants
967
+ * @param {number} [sellThroughRate] The sell through rate of the variant to use when suggesting pickfaces
958
968
  * @param {number} [pageToken] Page reference token
959
969
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
960
970
  * @param {*} [options] Override http request option.
961
971
  * @throws {RequiredError}
962
972
  */
963
- suggestPickfaces(project, variantRef, quantity, pageToken, pageSize, options) {
973
+ suggestPickfaces(project, variantRef, quantity, sellThroughRate, pageToken, pageSize, options) {
964
974
  return __awaiter(this, void 0, void 0, function* () {
965
975
  var _a, _b, _c;
966
- const localVarAxiosArgs = yield localVarAxiosParamCreator.suggestPickfaces(project, variantRef, quantity, pageToken, pageSize, options);
976
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.suggestPickfaces(project, variantRef, quantity, sellThroughRate, pageToken, pageSize, options);
967
977
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
968
978
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PickfacesApi.suggestPickfaces']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
969
979
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1135,7 +1145,7 @@ const PickfacesApiFactory = function (configuration, basePath, axios) {
1135
1145
  * @throws {RequiredError}
1136
1146
  */
1137
1147
  suggestPickfaces(requestParameters, options) {
1138
- return localVarFp.suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1148
+ return localVarFp.suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.sellThroughRate, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1139
1149
  },
1140
1150
  /**
1141
1151
  * Update a Pickface
@@ -1309,7 +1319,7 @@ class PickfacesApi extends base_1.BaseAPI {
1309
1319
  * @memberof PickfacesApi
1310
1320
  */
1311
1321
  suggestPickfaces(requestParameters, options) {
1312
- return (0, exports.PickfacesApiFp)(this.configuration).suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
1322
+ return (0, exports.PickfacesApiFp)(this.configuration).suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.sellThroughRate, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
1313
1323
  }
1314
1324
  /**
1315
1325
  * Update a Pickface
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.21.0
5
+ * The version of the OpenAPI document: 0.22.1
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.21.0
8
+ * The version of the OpenAPI document: 0.22.1
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.21.0
5
+ * The version of the OpenAPI document: 0.22.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
62
62
  *
63
63
  * @export
64
64
  */
65
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
65
+ export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
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.21.0
8
+ * The version of the OpenAPI document: 0.22.1
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.21.0
5
+ * The version of the OpenAPI document: 0.22.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.21.0
8
+ * The version of the OpenAPI document: 0.22.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,7 +23,7 @@ class Configuration {
23
23
  this.accessToken = param.accessToken;
24
24
  this.basePath = param.basePath;
25
25
  this.serverIndex = param.serverIndex;
26
- this.baseOptions = Object.assign({ headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "OpenAPI-Generator/0.21.0/typescript-axios" }) }, param.baseOptions);
26
+ this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
27
27
  this.formDataCtor = param.formDataCtor;
28
28
  }
29
29
  /**
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.21.0
5
+ * The version of the OpenAPI document: 0.22.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -386,6 +386,12 @@ export interface PickfaceContentsInnerMetadata {
386
386
  * @memberof PickfaceContentsInnerMetadata
387
387
  */
388
388
  'backImage'?: string | null;
389
+ /**
390
+ * Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`.
391
+ * @type {Array<VariantAttribute>}
392
+ * @memberof PickfaceContentsInnerMetadata
393
+ */
394
+ 'attributes'?: Array<VariantAttribute>;
389
395
  }
390
396
  /**
391
397
  *
@@ -653,6 +659,56 @@ export declare const UpdatePickfaceRequestContentsInnerQuantityOperationEnum: {
653
659
  readonly Subtract: "subtract";
654
660
  };
655
661
  export type UpdatePickfaceRequestContentsInnerQuantityOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum];
662
+ /**
663
+ *
664
+ * @export
665
+ * @interface VariantAttribute
666
+ */
667
+ export interface VariantAttribute {
668
+ /**
669
+ * Attribute name
670
+ * @type {string}
671
+ * @memberof VariantAttribute
672
+ */
673
+ 'name': string;
674
+ /**
675
+ * Attribute value
676
+ * @type {string}
677
+ * @memberof VariantAttribute
678
+ */
679
+ 'value': string;
680
+ /**
681
+ *
682
+ * @type {VariantAttributeThumbnail}
683
+ * @memberof VariantAttribute
684
+ */
685
+ 'thumbnail'?: VariantAttributeThumbnail;
686
+ }
687
+ /**
688
+ * Attribute thumbnail
689
+ * @export
690
+ * @interface VariantAttributeThumbnail
691
+ */
692
+ export interface VariantAttributeThumbnail {
693
+ /**
694
+ *
695
+ * @type {string}
696
+ * @memberof VariantAttributeThumbnail
697
+ */
698
+ 'type': VariantAttributeThumbnailTypeEnum;
699
+ /**
700
+ *
701
+ * @type {string}
702
+ * @memberof VariantAttributeThumbnail
703
+ */
704
+ 'value': string;
705
+ }
706
+ export declare const VariantAttributeThumbnailTypeEnum: {
707
+ readonly Text: "text";
708
+ readonly Color: "color";
709
+ readonly Image: "image";
710
+ };
711
+ export type VariantAttributeThumbnailTypeEnum = typeof VariantAttributeThumbnailTypeEnum[keyof typeof VariantAttributeThumbnailTypeEnum];
656
712
  /**
657
713
  * PickfacesApi - axios parameter creator
658
714
  * @export
@@ -791,12 +847,13 @@ export declare const PickfacesApiAxiosParamCreator: (configuration?: Configurati
791
847
  * @param {string} project The project ID
792
848
  * @param {string} variantRef Unique identifier of a warehouse variant
793
849
  * @param {number} quantity Number of variants
850
+ * @param {number} [sellThroughRate] The sell through rate of the variant to use when suggesting pickfaces
794
851
  * @param {number} [pageToken] Page reference token
795
852
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
796
853
  * @param {*} [options] Override http request option.
797
854
  * @throws {RequiredError}
798
855
  */
799
- suggestPickfaces: (project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
856
+ suggestPickfaces: (project: string, variantRef: string, quantity: number, sellThroughRate?: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
800
857
  /**
801
858
  * Update a Pickface
802
859
  * @summary Update Pickface
@@ -946,12 +1003,13 @@ export declare const PickfacesApiFp: (configuration?: Configuration) => {
946
1003
  * @param {string} project The project ID
947
1004
  * @param {string} variantRef Unique identifier of a warehouse variant
948
1005
  * @param {number} quantity Number of variants
1006
+ * @param {number} [sellThroughRate] The sell through rate of the variant to use when suggesting pickfaces
949
1007
  * @param {number} [pageToken] Page reference token
950
1008
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
951
1009
  * @param {*} [options] Override http request option.
952
1010
  * @throws {RequiredError}
953
1011
  */
954
- suggestPickfaces(project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>>;
1012
+ suggestPickfaces(project: string, variantRef: string, quantity: number, sellThroughRate?: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaces200Response>>;
955
1013
  /**
956
1014
  * Update a Pickface
957
1015
  * @summary Update Pickface
@@ -1420,6 +1478,12 @@ export interface PickfacesApiSuggestPickfacesRequest {
1420
1478
  * @memberof PickfacesApiSuggestPickfaces
1421
1479
  */
1422
1480
  readonly quantity: number;
1481
+ /**
1482
+ * The sell through rate of the variant to use when suggesting pickfaces
1483
+ * @type {number}
1484
+ * @memberof PickfacesApiSuggestPickfaces
1485
+ */
1486
+ readonly sellThroughRate?: number;
1423
1487
  /**
1424
1488
  * Page reference token
1425
1489
  * @type {number}
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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,6 +30,11 @@ export const UpdatePickfaceRequestContentsInnerQuantityOperationEnum = {
30
30
  Add: 'add',
31
31
  Subtract: 'subtract'
32
32
  };
33
+ export const VariantAttributeThumbnailTypeEnum = {
34
+ Text: 'text',
35
+ Color: 'color',
36
+ Image: 'image'
37
+ };
33
38
  /**
34
39
  * PickfacesApi - axios parameter creator
35
40
  * @export
@@ -610,12 +615,13 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
610
615
  * @param {string} project The project ID
611
616
  * @param {string} variantRef Unique identifier of a warehouse variant
612
617
  * @param {number} quantity Number of variants
618
+ * @param {number} [sellThroughRate] The sell through rate of the variant to use when suggesting pickfaces
613
619
  * @param {number} [pageToken] Page reference token
614
620
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
615
621
  * @param {*} [options] Override http request option.
616
622
  * @throws {RequiredError}
617
623
  */
618
- suggestPickfaces: (project_1, variantRef_1, quantity_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, variantRef_1, quantity_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, variantRef, quantity, pageToken, pageSize, options = {}) {
624
+ suggestPickfaces: (project_1, variantRef_1, quantity_1, sellThroughRate_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, variantRef_1, quantity_1, sellThroughRate_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, variantRef, quantity, sellThroughRate, pageToken, pageSize, options = {}) {
619
625
  // verify required parameter 'project' is not null or undefined
620
626
  assertParamExists('suggestPickfaces', 'project', project);
621
627
  // verify required parameter 'variantRef' is not null or undefined
@@ -646,6 +652,9 @@ export const PickfacesApiAxiosParamCreator = function (configuration) {
646
652
  if (quantity !== undefined) {
647
653
  localVarQueryParameter['quantity'] = quantity;
648
654
  }
655
+ if (sellThroughRate !== undefined) {
656
+ localVarQueryParameter['sellThroughRate'] = sellThroughRate;
657
+ }
649
658
  if (pageToken !== undefined) {
650
659
  localVarQueryParameter['pageToken'] = pageToken;
651
660
  }
@@ -951,15 +960,16 @@ export const PickfacesApiFp = function (configuration) {
951
960
  * @param {string} project The project ID
952
961
  * @param {string} variantRef Unique identifier of a warehouse variant
953
962
  * @param {number} quantity Number of variants
963
+ * @param {number} [sellThroughRate] The sell through rate of the variant to use when suggesting pickfaces
954
964
  * @param {number} [pageToken] Page reference token
955
965
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
956
966
  * @param {*} [options] Override http request option.
957
967
  * @throws {RequiredError}
958
968
  */
959
- suggestPickfaces(project, variantRef, quantity, pageToken, pageSize, options) {
969
+ suggestPickfaces(project, variantRef, quantity, sellThroughRate, pageToken, pageSize, options) {
960
970
  return __awaiter(this, void 0, void 0, function* () {
961
971
  var _a, _b, _c;
962
- const localVarAxiosArgs = yield localVarAxiosParamCreator.suggestPickfaces(project, variantRef, quantity, pageToken, pageSize, options);
972
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.suggestPickfaces(project, variantRef, quantity, sellThroughRate, pageToken, pageSize, options);
963
973
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
964
974
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PickfacesApi.suggestPickfaces']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
965
975
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1130,7 +1140,7 @@ export const PickfacesApiFactory = function (configuration, basePath, axios) {
1130
1140
  * @throws {RequiredError}
1131
1141
  */
1132
1142
  suggestPickfaces(requestParameters, options) {
1133
- return localVarFp.suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1143
+ return localVarFp.suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.sellThroughRate, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
1134
1144
  },
1135
1145
  /**
1136
1146
  * Update a Pickface
@@ -1303,7 +1313,7 @@ export class PickfacesApi extends BaseAPI {
1303
1313
  * @memberof PickfacesApi
1304
1314
  */
1305
1315
  suggestPickfaces(requestParameters, options) {
1306
- return PickfacesApiFp(this.configuration).suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
1316
+ return PickfacesApiFp(this.configuration).suggestPickfaces(requestParameters.project, requestParameters.variantRef, requestParameters.quantity, requestParameters.sellThroughRate, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
1307
1317
  }
1308
1318
  /**
1309
1319
  * Update a Pickface
@@ -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.21.0
5
+ * The version of the OpenAPI document: 0.22.1
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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
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.21.0
5
+ * The version of the OpenAPI document: 0.22.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
62
62
  *
63
63
  * @export
64
64
  */
65
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
65
+ export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
@@ -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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
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.21.0
5
+ * The version of the OpenAPI document: 0.22.1
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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -20,7 +20,7 @@ export class Configuration {
20
20
  this.accessToken = param.accessToken;
21
21
  this.basePath = param.basePath;
22
22
  this.serverIndex = param.serverIndex;
23
- this.baseOptions = Object.assign({ headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "OpenAPI-Generator/0.21.0/typescript-axios" }) }, param.baseOptions);
23
+ this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
24
24
  this.formDataCtor = param.formDataCtor;
25
25
  }
26
26
  /**
@@ -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.21.0
5
+ * The version of the OpenAPI document: 0.22.1
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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
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.21.0
5
+ * The version of the OpenAPI document: 0.22.1
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.21.0
8
+ * The version of the OpenAPI document: 0.22.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
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.21.0",
3
+ "version": "0.22.1",
4
4
  "description": "OpenAPI client for @teemill/pickfaces",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {