yellowgrid-api-ts 3.2.90-dev.0 → 3.2.92-dev.0

package/README.md

@@ -176,6 +176,7 @@ Class | Method | HTTP request | Description
 *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* | [**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)
 *PricingApi* | [**getGetPriceList**](docs/PricingApi.md#getgetpricelist) | **GET** /finance/pricing/lists | Get Price List
 *PricingApi* | [**postSendPriceList**](docs/PricingApi.md#postsendpricelist) | **POST** /finance/pricing/lists/send | Send Price List

package/api.ts

@@ -20951,6 +20951,47 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Change Payment Status (Admin)
+         * @summary Change Payment Status (Admin)
+         * @param {number} id Order ID
+         * @param {boolean} id2 Paid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putUpdatePaymentStatus: async (id: number, id2: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('putUpdatePaymentStatus', 'id', id)
+            // verify required parameter 'id2' is not null or undefined
+            assertParamExists('putUpdatePaymentStatus', 'id2', id2)
+            const localVarPath = `/admin/orders/{id}/paid`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // 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;
+
+            if (id2 !== undefined) {
+                localVarQueryParameter['id'] = id2;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update Shipment (Admin)
          * @summary Update Shipment (Admin)
@@ -21350,6 +21391,20 @@ export const OrdersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OrdersApi.putUpdateOrder']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Change Payment Status (Admin)
+         * @summary Change Payment Status (Admin)
+         * @param {number} id Order ID
+         * @param {boolean} id2 Paid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async putUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.putUpdatePaymentStatus(id, id2, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.putUpdatePaymentStatus']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Update Shipment (Admin)
          * @summary Update Shipment (Admin)
@@ -21647,6 +21702,17 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
         putUpdateOrder(id: number, readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>> {
             return localVarFp.putUpdateOrder(id, readonly, customerOrderRequestDTO, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Change Payment Status (Admin)
+         * @summary Change Payment Status (Admin)
+         * @param {number} id Order ID
+         * @param {boolean} id2 Paid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO> {
+            return localVarFp.putUpdatePaymentStatus(id, id2, options).then((request) => request(axios, basePath));
+        },
         /**
          * Update Shipment (Admin)
          * @summary Update Shipment (Admin)
@@ -21989,6 +22055,19 @@ export class OrdersApi extends BaseAPI {
         return OrdersApiFp(this.configuration).putUpdateOrder(id, readonly, customerOrderRequestDTO, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    public putUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).putUpdatePaymentStatus(id, id2, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Update Shipment (Admin)
      * @summary Update Shipment (Admin)

package/dist/api.d.ts

@@ -15875,6 +15875,15 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     putUpdateOrder: (id: number, readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putUpdatePaymentStatus: (id: number, id2: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update Shipment (Admin)
      * @summary Update Shipment (Admin)
@@ -16115,6 +16124,15 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     putUpdateOrder(id: number, readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OrderSummaryDTO>>>;
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
     /**
      * Update Shipment (Admin)
      * @summary Update Shipment (Admin)
@@ -16355,6 +16373,15 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     putUpdateOrder(id: number, readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<OrderSummaryDTO>>;
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
     /**
      * Update Shipment (Admin)
      * @summary Update Shipment (Admin)
@@ -16621,6 +16648,16 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     putUpdateOrder(id: number, readonly?: boolean, customerOrderRequestDTO?: CustomerOrderRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO[], any, {}>>;
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    putUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
     /**
      * Update Shipment (Admin)
      * @summary Update Shipment (Admin)

package/dist/api.js

@@ -10882,6 +10882,49 @@ var OrdersApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Change Payment Status (Admin)
+         * @summary Change Payment Status (Admin)
+         * @param {number} id Order ID
+         * @param {boolean} id2 Paid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putUpdatePaymentStatus: function (id_1, id2_1) {
+            var args_1 = [];
+            for (var _i = 2; _i < arguments.length; _i++) {
+                args_1[_i - 2] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([id_1, id2_1], args_1, true), void 0, function (id, id2, 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)('putUpdatePaymentStatus', 'id', id);
+                    // verify required parameter 'id2' is not null or undefined
+                    (0, common_1.assertParamExists)('putUpdatePaymentStatus', 'id2', id2);
+                    localVarPath = "/admin/orders/{id}/paid"
+                        .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    if (id2 !== undefined) {
+                        localVarQueryParameter['id'] = id2;
+                    }
+                    (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,
+                        }];
+                });
+            });
+        },
         /**
          * Update Shipment (Admin)
          * @summary Update Shipment (Admin)
@@ -11523,6 +11566,30 @@ var OrdersApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Change Payment Status (Admin)
+         * @summary Change Payment Status (Admin)
+         * @param {number} id Order ID
+         * @param {boolean} id2 Paid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putUpdatePaymentStatus: function (id, id2, 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.putUpdatePaymentStatus(id, id2, 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.putUpdatePaymentStatus']) === 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 Shipment (Admin)
          * @summary Update Shipment (Admin)
@@ -11830,6 +11897,17 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
         putUpdateOrder: function (id, readonly, customerOrderRequestDTO, options) {
             return localVarFp.putUpdateOrder(id, readonly, customerOrderRequestDTO, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Change Payment Status (Admin)
+         * @summary Change Payment Status (Admin)
+         * @param {number} id Order ID
+         * @param {boolean} id2 Paid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        putUpdatePaymentStatus: function (id, id2, options) {
+            return localVarFp.putUpdatePaymentStatus(id, id2, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Update Shipment (Admin)
          * @summary Update Shipment (Admin)
@@ -12176,6 +12254,19 @@ var OrdersApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.OrdersApiFp)(this.configuration).putUpdateOrder(id, readonly, customerOrderRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    OrdersApi.prototype.putUpdatePaymentStatus = function (id, id2, options) {
+        var _this = this;
+        return (0, exports.OrdersApiFp)(this.configuration).putUpdatePaymentStatus(id, id2, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Update Shipment (Admin)
      * @summary Update Shipment (Admin)

package/docs/OrdersApi.md

@@ -28,6 +28,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
 |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (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)|
 
 # **deleteDeleteBatch**
@@ -1432,6 +1433,63 @@ 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)
 
+# **putUpdatePaymentStatus**
+> OrderDetailsDTO putUpdatePaymentStatus()
+
+Change Payment Status (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 id2: boolean; //Paid (default to undefined)
+
+const { status, data } = await apiInstance.putUpdatePaymentStatus(
+    id,
+    id2
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **id2** | [**boolean**] | Paid | defaults to undefined|
+
+
+### Return type
+
+**OrderDetailsDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Details |  -  |
+|**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)
+
 # **putUpdateShipment**
 > ShipmentDTO putUpdateShipment()
 

package/package.json

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