yellowgrid-api-ts 3.2.75-dev.0 → 3.2.77-dev.0

package/README.md

@@ -168,6 +168,7 @@ Class | Method | HTTP request | Description
 *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
+*OrdersApi* | [**postSendShipmentEmail**](docs/OrdersApi.md#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)
 *OrdersApi* | [**postSendSupplierEmail**](docs/OrdersApi.md#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email
 *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

package/api.ts

@@ -20434,6 +20434,55 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Send Shipment Email (Admin)
+         * @summary Send Shipment Email (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {string} email Email Address
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postSendShipmentEmail: async (id: number, batchId: number, shipmentId: number, email: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('postSendShipmentEmail', 'id', id)
+            // verify required parameter 'batchId' is not null or undefined
+            assertParamExists('postSendShipmentEmail', 'batchId', batchId)
+            // verify required parameter 'shipmentId' is not null or undefined
+            assertParamExists('postSendShipmentEmail', 'shipmentId', shipmentId)
+            // verify required parameter 'email' is not null or undefined
+            assertParamExists('postSendShipmentEmail', 'email', email)
+            const localVarPath = `/admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)))
+                .replace(`{${"batch_id"}}`, encodeURIComponent(String(batchId)))
+                .replace(`{${"shipment_id"}}`, encodeURIComponent(String(shipmentId)));
+            // 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;
+
+            if (email !== undefined) {
+                localVarQueryParameter['email'] = email;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -20933,6 +20982,22 @@ export const OrdersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OrdersApi.postSendOrderEmail']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Send Shipment Email (Admin)
+         * @summary Send Shipment Email (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {string} email Email Address
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postSendShipmentEmail(id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postSendShipmentEmail(id, batchId, shipmentId, email, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.postSendShipmentEmail']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Send Supplier Email
          * @summary Send Supplier Email
@@ -21211,6 +21276,19 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
         postSendOrderEmail(id: number, email: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
             return localVarFp.postSendOrderEmail(id, email, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Send Shipment Email (Admin)
+         * @summary Send Shipment Email (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {string} email Email Address
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postSendShipmentEmail(id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.postSendShipmentEmail(id, batchId, shipmentId, email, options).then((request) => request(axios, basePath));
+        },
         /**
          * Send Supplier Email
          * @summary Send Supplier Email
@@ -21503,6 +21581,21 @@ export class OrdersApi extends BaseAPI {
         return OrdersApiFp(this.configuration).postSendOrderEmail(id, email, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Send Shipment Email (Admin)
+     * @summary Send Shipment Email (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {string} email Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    public postSendShipmentEmail(id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).postSendShipmentEmail(id, batchId, shipmentId, email, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Send Supplier Email
      * @summary Send Supplier Email

package/dist/api.d.ts

@@ -15624,6 +15624,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     postSendOrderEmail: (id: number, email: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Send Shipment Email (Admin)
+     * @summary Send Shipment Email (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {string} email Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postSendShipmentEmail: (id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Send Supplier Email
      * @summary Send Supplier Email
@@ -15836,6 +15847,17 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postSendOrderEmail(id: number, email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Send Shipment Email (Admin)
+     * @summary Send Shipment Email (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {string} email Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postSendShipmentEmail(id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Send Supplier Email
      * @summary Send Supplier Email
@@ -16048,6 +16070,17 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     postSendOrderEmail(id: number, email: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Send Shipment Email (Admin)
+     * @summary Send Shipment Email (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {string} email Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postSendShipmentEmail(id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Send Supplier Email
      * @summary Send Supplier Email
@@ -16278,6 +16311,18 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     postSendOrderEmail(id: number, email: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Send Shipment Email (Admin)
+     * @summary Send Shipment Email (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {string} email Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    postSendShipmentEmail(id: number, batchId: number, shipmentId: number, email: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Send Supplier Email
      * @summary Send Supplier Email

package/dist/api.js

@@ -10519,6 +10519,57 @@ var OrdersApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Send Shipment Email (Admin)
+         * @summary Send Shipment Email (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {string} email Email Address
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postSendShipmentEmail: function (id_1, batchId_1, shipmentId_1, email_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, email_1], args_1, true), void 0, function (id, batchId, shipmentId, email, 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)('postSendShipmentEmail', 'id', id);
+                    // verify required parameter 'batchId' is not null or undefined
+                    (0, common_1.assertParamExists)('postSendShipmentEmail', 'batchId', batchId);
+                    // verify required parameter 'shipmentId' is not null or undefined
+                    (0, common_1.assertParamExists)('postSendShipmentEmail', 'shipmentId', shipmentId);
+                    // verify required parameter 'email' is not null or undefined
+                    (0, common_1.assertParamExists)('postSendShipmentEmail', 'email', email);
+                    localVarPath = "/admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email"
+                        .replace("{".concat("id", "}"), encodeURIComponent(String(id)))
+                        .replace("{".concat("batch_id", "}"), encodeURIComponent(String(batchId)))
+                        .replace("{".concat("shipment_id", "}"), encodeURIComponent(String(shipmentId)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    if (email !== undefined) {
+                        localVarQueryParameter['email'] = email;
+                    }
+                    (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,
+                        }];
+                });
+            });
+        },
         /**
          * Send Supplier Email
          * @summary Send Supplier Email
@@ -11179,6 +11230,32 @@ var OrdersApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Send Shipment Email (Admin)
+         * @summary Send Shipment Email (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {string} email Email Address
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postSendShipmentEmail: function (id, batchId, shipmentId, email, 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.postSendShipmentEmail(id, batchId, shipmentId, email, 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.postSendShipmentEmail']) === 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); }];
+                    }
+                });
+            });
+        },
         /**
          * Send Supplier Email
          * @summary Send Supplier Email
@@ -11517,6 +11594,19 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
         postSendOrderEmail: function (id, email, options) {
             return localVarFp.postSendOrderEmail(id, email, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Send Shipment Email (Admin)
+         * @summary Send Shipment Email (Admin)
+         * @param {number} id Order ID
+         * @param {number} batchId Batch ID
+         * @param {number} shipmentId Shipment ID
+         * @param {string} email Email Address
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postSendShipmentEmail: function (id, batchId, shipmentId, email, options) {
+            return localVarFp.postSendShipmentEmail(id, batchId, shipmentId, email, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Send Supplier Email
          * @summary Send Supplier Email
@@ -11813,6 +11903,21 @@ var OrdersApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.OrdersApiFp)(this.configuration).postSendOrderEmail(id, email, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Send Shipment Email (Admin)
+     * @summary Send Shipment Email (Admin)
+     * @param {number} id Order ID
+     * @param {number} batchId Batch ID
+     * @param {number} shipmentId Shipment ID
+     * @param {string} email Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    OrdersApi.prototype.postSendShipmentEmail = function (id, batchId, shipmentId, email, options) {
+        var _this = this;
+        return (0, exports.OrdersApiFp)(this.configuration).postSendShipmentEmail(id, batchId, shipmentId, email, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Send Supplier Email
      * @summary Send Supplier Email

package/docs/OrdersApi.md

@@ -20,6 +20,7 @@ All URIs are relative to *https://api.yellowgrid.local*
 |[**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|
+|[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
 |[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
 |[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
 |[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
@@ -933,6 +934,69 @@ const { status, data } = await apiInstance.postSendOrderEmail(
 | **email** | [**string**] | Email Address | defaults to undefined|
 
 
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**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)
+
+# **postSendShipmentEmail**
+> postSendShipmentEmail()
+
+Send Shipment Email (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 email: string; //Email Address (default to undefined)
+
+const { status, data } = await apiInstance.postSendShipmentEmail(
+    id,
+    batchId,
+    shipmentId,
+    email
+);
+```
+
+### 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|
+| **email** | [**string**] | Email Address | defaults to undefined|
+
+
 ### Return type
 
 void (empty response body)

package/package.json

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