yellowgrid-api-ts 3.2.83-dev.0 → 3.2.85-dev.0

package/README.md

@@ -160,6 +160,7 @@ Class | Method | HTTP request | Description
 *OrdersApi* | [**getGetEditableOrder**](docs/OrdersApi.md#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)
 *OrdersApi* | [**getGetItemSerialInfo**](docs/OrdersApi.md#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)
 *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* | [**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)

package/api.ts

@@ -20101,6 +20101,40 @@ 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,
+            };
+        },
+        /**
+         * Get Order Summary (Admin)
+         * @summary Get Order Summary (Admin)
+         * @param {number} id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetOrderSummary: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getGetOrderSummary', 'id', id)
+            const localVarPath = `/admin/orders/{id}/summary`
+                .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;
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -20918,6 +20952,19 @@ export const OrdersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetOrderPdf']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get Order Summary (Admin)
+         * @summary Get Order Summary (Admin)
+         * @param {number} id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummaryDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetOrderSummary(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetOrderSummary']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get Orders (Beta)
          * @summary Get Orders (Beta)
@@ -21250,6 +21297,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
         getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): AxiosPromise<File> {
             return localVarFp.getGetOrderPdf(id, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Order Summary (Admin)
+         * @summary Get Order Summary (Admin)
+         * @param {number} id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummaryDTO> {
+            return localVarFp.getGetOrderSummary(id, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get Orders (Beta)
          * @summary Get Orders (Beta)
@@ -21550,6 +21607,18 @@ export class OrdersApi extends BaseAPI {
         return OrdersApiFp(this.configuration).getGetOrderPdf(id, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Order Summary (Admin)
+     * @summary Get Order Summary (Admin)
+     * @param {number} id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    public getGetOrderSummary(id: number, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).getGetOrderSummary(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get Orders (Beta)
      * @summary Get Orders (Beta)

package/dist/api.d.ts

@@ -15562,6 +15562,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getGetOrderPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Order Summary (Admin)
+     * @summary Get Order Summary (Admin)
+     * @param {number} id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetOrderSummary: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Orders (Beta)
      * @summary Get Orders (Beta)
@@ -15794,6 +15802,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Get Order Summary (Admin)
+     * @summary Get Order Summary (Admin)
+     * @param {number} id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummaryDTO>>;
     /**
      * Get Orders (Beta)
      * @summary Get Orders (Beta)
@@ -16026,6 +16042,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Get Order Summary (Admin)
+     * @summary Get Order Summary (Admin)
+     * @param {number} id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummaryDTO>;
     /**
      * Get Orders (Beta)
      * @summary Get Orders (Beta)
@@ -16268,6 +16292,15 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
+    /**
+     * Get Order Summary (Admin)
+     * @summary Get Order Summary (Admin)
+     * @param {number} id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO, any, {}>>;
     /**
      * Get Orders (Beta)
      * @summary Get Orders (Beta)

package/dist/api.js

@@ -10161,6 +10161,43 @@ var OrdersApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Order Summary (Admin)
+         * @summary Get Order Summary (Admin)
+         * @param {number} id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetOrderSummary: function (id_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, 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)('getGetOrderSummary', 'id', id);
+                    localVarPath = "/admin/orders/{id}/summary"
+                        .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 = {};
+                    (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,
+                        }];
+                });
+            });
+        },
         /**
          * Get Orders (Beta)
          * @summary Get Orders (Beta)
@@ -11071,6 +11108,29 @@ var OrdersApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Order Summary (Admin)
+         * @summary Get Order Summary (Admin)
+         * @param {number} id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetOrderSummary: function (id, 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.getGetOrderSummary(id, 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.getGetOrderSummary']) === 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); }];
+                    }
+                });
+            });
+        },
         /**
          * Get Orders (Beta)
          * @summary Get Orders (Beta)
@@ -11563,6 +11623,16 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
         getGetOrderPdf: function (id, options) {
             return localVarFp.getGetOrderPdf(id, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Get Order Summary (Admin)
+         * @summary Get Order Summary (Admin)
+         * @param {number} id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetOrderSummary: function (id, options) {
+            return localVarFp.getGetOrderSummary(id, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Get Orders (Beta)
          * @summary Get Orders (Beta)
@@ -11867,6 +11937,18 @@ var OrdersApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.OrdersApiFp)(this.configuration).getGetOrderPdf(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Get Order Summary (Admin)
+     * @summary Get Order Summary (Admin)
+     * @param {number} id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    OrdersApi.prototype.getGetOrderSummary = function (id, options) {
+        var _this = this;
+        return (0, exports.OrdersApiFp)(this.configuration).getGetOrderSummary(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Get Orders (Beta)
      * @summary Get Orders (Beta)

package/docs/OrdersApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *https://api.yellowgrid.local*
 |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
 |[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
 |[**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)|
 |[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
 |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
@@ -473,6 +474,60 @@ 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)
 
+# **getGetOrderSummary**
+> OrderSummaryDTO getGetOrderSummary()
+
+Get Order Summary (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)
+
+const { status, data } = await apiInstance.getGetOrderSummary(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**OrderSummaryDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Summary |  -  |
+|**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)
+
 # **getGetOrders**
 > OrderSummariesModel getGetOrders()
 

package/package.json

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