yellowgrid-api-ts 3.2.96-dev.0 → 3.2.98-dev.0

package/README.md

@@ -177,6 +177,7 @@ Class | Method | HTTP request | Description
 *OrdersApi* | [**postSplitOrder**](docs/OrdersApi.md#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order
 *OrdersApi* | [**putAllocateItems**](docs/OrdersApi.md#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier
 *OrdersApi* | [**putUpdateAdminOrder**](docs/OrdersApi.md#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)
+*OrdersApi* | [**putUpdateBatchItem**](docs/OrdersApi.md#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)
 *OrdersApi* | [**putUpdateOrder**](docs/OrdersApi.md#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)
 *OrdersApi* | [**putUpdatePaymentStatus**](docs/OrdersApi.md#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)
 *OrdersApi* | [**putUpdateShipment**](docs/OrdersApi.md#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)

package/api.ts

@@ -21038,6 +21038,52 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Update Batch Item (Admin)
+         * @summary Update Batch Item (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} itemId Ordered Item ID
+         * @param {OrderedItemModel} [orderedItemModel] Batch Item
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putUpdateBatchItem: async (id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('putUpdateBatchItem', 'id', id)
+            // verify required parameter 'batchId' is not null or undefined
+            assertParamExists('putUpdateBatchItem', 'batchId', batchId)
+            // verify required parameter 'itemId' is not null or undefined
+            assertParamExists('putUpdateBatchItem', 'itemId', itemId)
+            const localVarPath = `/admin/orders/{id}/batches/{batch_id}/items/{item_id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)))
+                .replace(`{${"batch_id"}}`, encodeURIComponent(String(batchId)))
+                .replace(`{${"item_id"}}`, encodeURIComponent(String(itemId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(orderedItemModel, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update An Order (Beta)
          * @summary Update An Order (Beta)
@@ -21519,6 +21565,22 @@ export const OrdersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OrdersApi.putUpdateAdminOrder']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Update Batch Item (Admin)
+         * @summary Update Batch Item (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} itemId Ordered Item ID
+         * @param {OrderedItemModel} [orderedItemModel] Batch Item
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async putUpdateBatchItem(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderedItemModel>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.putUpdateBatchItem(id, batchId, itemId, orderedItemModel, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.putUpdateBatchItem']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Update An Order (Beta)
          * @summary Update An Order (Beta)
@@ -21843,6 +21905,19 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
         putUpdateAdminOrder(id: number, readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>> {
             return localVarFp.putUpdateAdminOrder(id, readonly, adminOrderRequestDTO, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Update Batch Item (Admin)
+         * @summary Update Batch Item (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} itemId Ordered Item ID
+         * @param {OrderedItemModel} [orderedItemModel] Batch Item
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putUpdateBatchItem(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): AxiosPromise<OrderedItemModel> {
+            return localVarFp.putUpdateBatchItem(id, batchId, itemId, orderedItemModel, options).then((request) => request(axios, basePath));
+        },
         /**
          * Update An Order (Beta)
          * @summary Update An Order (Beta)
@@ -22206,6 +22281,21 @@ export class OrdersApi extends BaseAPI {
         return OrdersApiFp(this.configuration).putUpdateAdminOrder(id, readonly, adminOrderRequestDTO, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Update Batch Item (Admin)
+     * @summary Update Batch Item (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} itemId Ordered Item ID
+     * @param {OrderedItemModel} [orderedItemModel] Batch Item
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    public putUpdateBatchItem(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).putUpdateBatchItem(id, batchId, itemId, orderedItemModel, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Update An Order (Beta)
      * @summary Update An Order (Beta)

package/dist/api.d.ts

@@ -15933,6 +15933,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     putUpdateAdminOrder: (id: number, readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update Batch Item (Admin)
+     * @summary Update Batch Item (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} itemId Ordered Item ID
+     * @param {OrderedItemModel} [orderedItemModel] Batch Item
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putUpdateBatchItem: (id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update An Order (Beta)
      * @summary Update An Order (Beta)
@@ -16190,6 +16201,17 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     putUpdateAdminOrder(id: number, readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
+    /**
+     * Update Batch Item (Admin)
+     * @summary Update Batch Item (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} itemId Ordered Item ID
+     * @param {OrderedItemModel} [orderedItemModel] Batch Item
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putUpdateBatchItem(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderedItemModel>>;
     /**
      * Update An Order (Beta)
      * @summary Update An Order (Beta)
@@ -16447,6 +16469,17 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     putUpdateAdminOrder(id: number, readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
+    /**
+     * Update Batch Item (Admin)
+     * @summary Update Batch Item (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} itemId Ordered Item ID
+     * @param {OrderedItemModel} [orderedItemModel] Batch Item
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putUpdateBatchItem(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): AxiosPromise<OrderedItemModel>;
     /**
      * Update An Order (Beta)
      * @summary Update An Order (Beta)
@@ -16730,6 +16763,18 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     putUpdateAdminOrder(id: number, readonly?: boolean, adminOrderRequestDTO?: AdminOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
+    /**
+     * Update Batch Item (Admin)
+     * @summary Update Batch Item (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} itemId Ordered Item ID
+     * @param {OrderedItemModel} [orderedItemModel] Batch Item
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    putUpdateBatchItem(id: number, batchId: number, itemId: number, orderedItemModel?: OrderedItemModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderedItemModel, any, {}>>;
     /**
      * Update An Order (Beta)
      * @summary Update An Order (Beta)

package/dist/api.js

@@ -10953,6 +10953,54 @@ var OrdersApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Update Batch Item (Admin)
+         * @summary Update Batch Item (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} itemId Ordered Item ID
+         * @param {OrderedItemModel} [orderedItemModel] Batch Item
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putUpdateBatchItem: function (id_1, batchId_1, itemId_1, orderedItemModel_1) {
+            var args_1 = [];
+            for (var _i = 4; _i < arguments.length; _i++) {
+                args_1[_i - 4] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([id_1, batchId_1, itemId_1, orderedItemModel_1], args_1, true), void 0, function (id, batchId, itemId, orderedItemModel, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'id' is not null or undefined
+                    (0, common_1.assertParamExists)('putUpdateBatchItem', 'id', id);
+                    // verify required parameter 'batchId' is not null or undefined
+                    (0, common_1.assertParamExists)('putUpdateBatchItem', 'batchId', batchId);
+                    // verify required parameter 'itemId' is not null or undefined
+                    (0, common_1.assertParamExists)('putUpdateBatchItem', 'itemId', itemId);
+                    localVarPath = "/admin/orders/{id}/batches/{batch_id}/items/{item_id}"
+                        .replace("{".concat("id", "}"), encodeURIComponent(String(id)))
+                        .replace("{".concat("batch_id", "}"), encodeURIComponent(String(batchId)))
+                        .replace("{".concat("item_id", "}"), encodeURIComponent(String(itemId)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    localVarHeaderParameter['Content-Type'] = 'application/json';
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(orderedItemModel, localVarRequestOptions, configuration);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Update An Order (Beta)
          * @summary Update An Order (Beta)
@@ -11679,6 +11727,32 @@ var OrdersApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Update Batch Item (Admin)
+         * @summary Update Batch Item (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} itemId Ordered Item ID
+         * @param {OrderedItemModel} [orderedItemModel] Batch Item
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putUpdateBatchItem: function (id, batchId, itemId, orderedItemModel, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.putUpdateBatchItem(id, batchId, itemId, orderedItemModel, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.putUpdateBatchItem']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Update An Order (Beta)
          * @summary Update An Order (Beta)
@@ -12033,6 +12107,19 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
         putUpdateAdminOrder: function (id, readonly, adminOrderRequestDTO, options) {
             return localVarFp.putUpdateAdminOrder(id, readonly, adminOrderRequestDTO, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Update Batch Item (Admin)
+         * @summary Update Batch Item (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} itemId Ordered Item ID
+         * @param {OrderedItemModel} [orderedItemModel] Batch Item
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putUpdateBatchItem: function (id, batchId, itemId, orderedItemModel, options) {
+            return localVarFp.putUpdateBatchItem(id, batchId, itemId, orderedItemModel, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Update An Order (Beta)
          * @summary Update An Order (Beta)
@@ -12400,6 +12487,21 @@ var OrdersApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.OrdersApiFp)(this.configuration).putUpdateAdminOrder(id, readonly, adminOrderRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Update Batch Item (Admin)
+     * @summary Update Batch Item (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} itemId Ordered Item ID
+     * @param {OrderedItemModel} [orderedItemModel] Batch Item
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    OrdersApi.prototype.putUpdateBatchItem = function (id, batchId, itemId, orderedItemModel, options) {
+        var _this = this;
+        return (0, exports.OrdersApiFp)(this.configuration).putUpdateBatchItem(id, batchId, itemId, orderedItemModel, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Update An Order (Beta)
      * @summary Update An Order (Beta)

package/docs/OrdersApi.md

@@ -28,6 +28,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
 |[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
 |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
+|[**putUpdateBatchItem**](#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)|
 |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
 |[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
 |[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
@@ -1427,6 +1428,70 @@ No authorization required
 
 [[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)
 
+# **putUpdateBatchItem**
+> OrderedItemModel putUpdateBatchItem()
+
+Update Batch Item (Admin)
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    OrderedItemModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+let batchId: number; //Batch ID (default to undefined)
+let itemId: number; //Ordered Item ID (default to undefined)
+let orderedItemModel: OrderedItemModel; //Batch Item (optional)
+
+const { status, data } = await apiInstance.putUpdateBatchItem(
+    id,
+    batchId,
+    itemId,
+    orderedItemModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderedItemModel** | **OrderedItemModel**| Batch Item | |
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
+| **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
+
+
+### Return type
+
+**OrderedItemModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ordered Item |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
 # **putUpdateOrder**
 > Array<OrderSummaryDTO> putUpdateOrder()
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.96-dev.0",
+  "version": "3.2.98-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {