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

package/README.md

@@ -162,6 +162,7 @@ Class | Method | HTTP request | Description
 *OrdersApi* | [**getGetOrderPdf**](docs/OrdersApi.md#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF
 *OrdersApi* | [**getGetOrderSummary**](docs/OrdersApi.md#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)
 *OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders (Beta)
+*OrdersApi* | [**getUpdatePaymentStatus**](docs/OrdersApi.md#getupdatepaymentstatus) | **GET** /admin/orders/{id}/paid | Change Payment Status (Admin)
 *OrdersApi* | [**postAddOrderNote**](docs/OrdersApi.md#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note
 *OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
 *OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment

package/api.ts

@@ -20362,6 +20362,47 @@ 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,
+            };
+        },
+        /**
+         * 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}
+         */
+        getUpdatePaymentStatus: async (id: number, id2: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getUpdatePaymentStatus', 'id', id)
+            // verify required parameter 'id2' is not null or undefined
+            assertParamExists('getUpdatePaymentStatus', '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: 'GET', ...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};
@@ -21146,6 +21187,20 @@ export const OrdersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetOrders']?.[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 getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getUpdatePaymentStatus(id, id2, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.getUpdatePaymentStatus']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Add Order Note
          * @summary Add Order Note
@@ -21485,6 +21540,17 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
         getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummariesModel> {
             return localVarFp.getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, 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}
+         */
+        getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO> {
+            return localVarFp.getUpdatePaymentStatus(id, id2, options).then((request) => request(axios, basePath));
+        },
         /**
          * Add Order Note
          * @summary Add Order Note
@@ -21799,6 +21865,19 @@ export class OrdersApi extends BaseAPI {
         return OrdersApiFp(this.configuration).getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, 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 getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).getUpdatePaymentStatus(id, id2, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Add Order Note
      * @summary Add Order Note

package/dist/api.d.ts

@@ -15741,6 +15741,15 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getGetOrders: (pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, 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}
+     */
+    getUpdatePaymentStatus: (id: number, id2: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -15981,6 +15990,15 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummariesModel>>;
+    /**
+     * 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}
+     */
+    getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -16221,6 +16239,15 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummariesModel>;
+    /**
+     * 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}
+     */
+    getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -16473,6 +16500,16 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummariesModel, 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
+     */
+    getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
     /**
      * Add Order Note
      * @summary Add Order Note

package/dist/api.js

@@ -10278,6 +10278,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}
+         */
+        getUpdatePaymentStatus: 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)('getUpdatePaymentStatus', 'id', id);
+                    // verify required parameter 'id2' is not null or undefined
+                    (0, common_1.assertParamExists)('getUpdatePaymentStatus', '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: 'GET' }, 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,
+                        }];
+                });
+            });
+        },
         /**
          * Add Order Note
          * @summary Add Order Note
@@ -11179,6 +11222,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}
+         */
+        getUpdatePaymentStatus: 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.getUpdatePaymentStatus(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.getUpdatePaymentStatus']) === 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); }];
+                    }
+                });
+            });
+        },
         /**
          * Add Order Note
          * @summary Add Order Note
@@ -11668,6 +11735,17 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
         getGetOrders: function (pageSize, page, search, fulfillable, status, filter, customerId, options) {
             return localVarFp.getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, 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}
+         */
+        getUpdatePaymentStatus: function (id, id2, options) {
+            return localVarFp.getUpdatePaymentStatus(id, id2, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Add Order Note
          * @summary Add Order Note
@@ -11986,6 +12064,19 @@ var OrdersApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.OrdersApiFp)(this.configuration).getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, 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.getUpdatePaymentStatus = function (id, id2, options) {
+        var _this = this;
+        return (0, exports.OrdersApiFp)(this.configuration).getUpdatePaymentStatus(id, id2, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Add Order Note
      * @summary Add Order Note

package/docs/OrdersApi.md

@@ -14,6 +14,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
 |[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
 |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
+|[**getUpdatePaymentStatus**](#getupdatepaymentstatus) | **GET** /admin/orders/{id}/paid | Change Payment Status (Admin)|
 |[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
 |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
 |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
@@ -600,6 +601,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)
 
+# **getUpdatePaymentStatus**
+> OrderDetailsDTO getUpdatePaymentStatus()
+
+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.getUpdatePaymentStatus(
+    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)
+
 # **postAddOrderNote**
 > AuditLogEntity postAddOrderNote()
 

package/package.json

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