yellowgrid-api-ts 3.2.79-dev.0 → 3.2.80-dev.0

package/README.md

@@ -165,6 +165,7 @@ Class | Method | HTTP request | Description
 *OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment
 *OrdersApi* | [**postCreateShipment**](docs/OrdersApi.md#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)
 *OrdersApi* | [**postGetOrders**](docs/OrdersApi.md#postgetorders) | **POST** /orders | Create An Order (Beta)
+*OrdersApi* | [**postGetShipmentItemSerialInfo**](docs/OrdersApi.md#postgetshipmentitemserialinfo) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info | Get Shipment Item Serial Info (Admin)
 *OrdersApi* | [**postIssueCredit**](docs/OrdersApi.md#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)
 *OrdersApi* | [**postPrintShippingLabel**](docs/OrdersApi.md#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label
 *OrdersApi* | [**postSendOrderEmail**](docs/OrdersApi.md#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email

package/api.ts

@@ -20337,6 +20337,52 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get Shipment Item Serial Info (Admin)
+         * @summary Get Shipment Item Serial Info (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {number} itemId Shipment Item ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetShipmentItemSerialInfo: async (id: number, batchId: number, shipmentId: number, itemId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('postGetShipmentItemSerialInfo', 'id', id)
+            // verify required parameter 'batchId' is not null or undefined
+            assertParamExists('postGetShipmentItemSerialInfo', 'batchId', batchId)
+            // verify required parameter 'shipmentId' is not null or undefined
+            assertParamExists('postGetShipmentItemSerialInfo', 'shipmentId', shipmentId)
+            // verify required parameter 'itemId' is not null or undefined
+            assertParamExists('postGetShipmentItemSerialInfo', 'itemId', itemId)
+            const localVarPath = `/admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)))
+                .replace(`{${"batch_id"}}`, encodeURIComponent(String(batchId)))
+                .replace(`{${"shipment_id"}}`, encodeURIComponent(String(shipmentId)))
+                .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: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Issue Credit (Admin)
          * @summary Issue Credit (Admin)
@@ -20957,6 +21003,22 @@ export const OrdersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OrdersApi.postGetOrders']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get Shipment Item Serial Info (Admin)
+         * @summary Get Shipment Item Serial Info (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {number} itemId Shipment Item ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.postGetShipmentItemSerialInfo']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Issue Credit (Admin)
          * @summary Issue Credit (Admin)
@@ -21260,6 +21322,19 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
         postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>> {
             return localVarFp.postGetOrders(readonly, customerOrderRequestDTO, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Shipment Item Serial Info (Admin)
+         * @summary Get Shipment Item Serial Info (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {number} itemId Shipment Item ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel> {
+            return localVarFp.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Issue Credit (Admin)
          * @summary Issue Credit (Admin)
@@ -21559,6 +21634,21 @@ export class OrdersApi extends BaseAPI {
         return OrdersApiFp(this.configuration).postGetOrders(readonly, customerOrderRequestDTO, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Shipment Item Serial Info (Admin)
+     * @summary Get Shipment Item Serial Info (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {number} itemId Shipment Item ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    public postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Issue Credit (Admin)
      * @summary Issue Credit (Admin)

package/dist/api.d.ts

@@ -15614,6 +15614,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     postGetOrders: (readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Shipment Item Serial Info (Admin)
+     * @summary Get Shipment Item Serial Info (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {number} itemId Shipment Item ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetShipmentItemSerialInfo: (id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Issue Credit (Admin)
      * @summary Issue Credit (Admin)
@@ -15837,6 +15848,17 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
+    /**
+     * Get Shipment Item Serial Info (Admin)
+     * @summary Get Shipment Item Serial Info (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {number} itemId Shipment Item ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSerialInfoModel>>;
     /**
      * Issue Credit (Admin)
      * @summary Issue Credit (Admin)
@@ -16060,6 +16082,17 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
+    /**
+     * Get Shipment Item Serial Info (Admin)
+     * @summary Get Shipment Item Serial Info (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {number} itemId Shipment Item ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSerialInfoModel>;
     /**
      * Issue Credit (Admin)
      * @summary Issue Credit (Admin)
@@ -16298,6 +16331,18 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     postGetOrders(readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
+    /**
+     * Get Shipment Item Serial Info (Admin)
+     * @summary Get Shipment Item Serial Info (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {number} itemId Shipment Item ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    postGetShipmentItemSerialInfo(id: number, batchId: number, shipmentId: number, itemId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSerialInfoModel, any, {}>>;
     /**
      * Issue Credit (Admin)
      * @summary Issue Credit (Admin)

package/dist/api.js

@@ -10389,6 +10389,55 @@ var OrdersApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Shipment Item Serial Info (Admin)
+         * @summary Get Shipment Item Serial Info (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {number} itemId Shipment Item ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetShipmentItemSerialInfo: function (id_1, batchId_1, shipmentId_1, itemId_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, shipmentId_1, itemId_1], args_1, true), void 0, function (id, batchId, shipmentId, itemId, 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)('postGetShipmentItemSerialInfo', 'id', id);
+                    // verify required parameter 'batchId' is not null or undefined
+                    (0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'batchId', batchId);
+                    // verify required parameter 'shipmentId' is not null or undefined
+                    (0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'shipmentId', shipmentId);
+                    // verify required parameter 'itemId' is not null or undefined
+                    (0, common_1.assertParamExists)('postGetShipmentItemSerialInfo', 'itemId', itemId);
+                    localVarPath = "/admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info"
+                        .replace("{".concat("id", "}"), encodeURIComponent(String(id)))
+                        .replace("{".concat("batch_id", "}"), encodeURIComponent(String(batchId)))
+                        .replace("{".concat("shipment_id", "}"), encodeURIComponent(String(shipmentId)))
+                        .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: 'POST' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Issue Credit (Admin)
          * @summary Issue Credit (Admin)
@@ -11157,6 +11206,32 @@ var OrdersApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Shipment Item Serial Info (Admin)
+         * @summary Get Shipment Item Serial Info (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {number} itemId Shipment Item ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetShipmentItemSerialInfo: function (id, batchId, shipmentId, itemId, 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.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, 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.postGetShipmentItemSerialInfo']) === 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); }];
+                    }
+                });
+            });
+        },
         /**
          * Issue Credit (Admin)
          * @summary Issue Credit (Admin)
@@ -11560,6 +11635,19 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
         postGetOrders: function (readonly, customerOrderRequestDTO, options) {
             return localVarFp.postGetOrders(readonly, customerOrderRequestDTO, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Get Shipment Item Serial Info (Admin)
+         * @summary Get Shipment Item Serial Info (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {number} itemId Shipment Item ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetShipmentItemSerialInfo: function (id, batchId, shipmentId, itemId, options) {
+            return localVarFp.postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Issue Credit (Admin)
          * @summary Issue Credit (Admin)
@@ -11863,6 +11951,21 @@ var OrdersApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.OrdersApiFp)(this.configuration).postGetOrders(readonly, customerOrderRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Get Shipment Item Serial Info (Admin)
+     * @summary Get Shipment Item Serial Info (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {number} itemId Shipment Item ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    OrdersApi.prototype.postGetShipmentItemSerialInfo = function (id, batchId, shipmentId, itemId, options) {
+        var _this = this;
+        return (0, exports.OrdersApiFp)(this.configuration).postGetShipmentItemSerialInfo(id, batchId, shipmentId, itemId, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Issue Credit (Admin)
      * @summary Issue Credit (Admin)

package/docs/OrdersApi.md

@@ -17,6 +17,7 @@ All URIs are relative to *https://api.yellowgrid.local*
 |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
 |[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
 |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
+|[**postGetShipmentItemSerialInfo**](#postgetshipmentitemserialinfo) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/items/{item_id}/info | Get Shipment Item Serial Info (Admin)|
 |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
 |[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
 |[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
@@ -783,6 +784,69 @@ 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)
 
+# **postGetShipmentItemSerialInfo**
+> ProductSerialInfoModel postGetShipmentItemSerialInfo()
+
+Get Shipment Item Serial Info (Admin)
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} 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 shipmentId: number; //Shipment ID (default to undefined)
+let itemId: number; //Shipment Item ID (default to undefined)
+
+const { status, data } = await apiInstance.postGetShipmentItemSerialInfo(
+    id,
+    batchId,
+    shipmentId,
+    itemId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
+| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
+| **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
+
+
+### Return type
+
+**ProductSerialInfoModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Serial Info |  -  |
+|**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)
+
 # **postIssueCredit**
 > CreditNoteModel postIssueCredit()
 

package/package.json

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