yellowgrid-api-ts 3.2.239 → 3.2.241

package/docs/ReportRequestDTO.md

@@ -0,0 +1,37 @@
+# ReportRequestDTO
+
+Report Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**report** | **string** | Report | [optional] [default to undefined]
+**start** | **string** | Start | [optional] [default to undefined]
+**end** | **string** | End | [optional] [default to undefined]
+**month** | **number** | Month | [optional] [default to undefined]
+**year** | **number** | Year | [optional] [default to undefined]
+**sku** | **string** | SKU | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+**recipients** | **Array<string>** | Recipients | [optional] [default to undefined]
+**graphType** | **string** | Graph Type | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReportRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: ReportRequestDTO = {
+    report,
+    start,
+    end,
+    month,
+    year,
+    sku,
+    price,
+    recipients,
+    graphType,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReportsApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://bitbucket.org*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getGetStockReport**](#getgetstockreport) | **GET** /reports/stock | |
+|[**postGenerateReport**](#postgeneratereport) | **POST** /reports | Generate Reports|
 
 # **getGetStockReport**
 > StockReportModel getGetStockReport()
@@ -50,3 +51,57 @@ 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)
 
+# **postGenerateReport**
+> PostGenerateReport200Response postGenerateReport()
+
+Generate Reports
+
+### Example
+
+```typescript
+import {
+    ReportsApi,
+    Configuration,
+    ReportRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ReportsApi(configuration);
+
+let reportRequestDTO: ReportRequestDTO; //Report Request (optional)
+
+const { status, data } = await apiInstance.postGenerateReport(
+    reportRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reportRequestDTO** | **ReportRequestDTO**| Report Request | |
+
+
+### Return type
+
+**PostGenerateReport200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Report generated |  -  |
+|**204** | No Response |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+

package/docs/SeriesDTO.md

@@ -0,0 +1,27 @@
+# SeriesDTO
+
+Graph Series Data
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name | [optional] [default to undefined]
+**type** | **string** | Type | [optional] [default to undefined]
+**stack** | **string** | Stack | [optional] [default to undefined]
+**data** | **Array<string>** | Data | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesDTO } from 'yellowgrid-api-ts';
+
+const instance: SeriesDTO = {
+    name,
+    type,
+    stack,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TableDTO.md

@@ -0,0 +1,25 @@
+# TableDTO
+
+Table
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Title | [optional] [default to undefined]
+**headers** | [**TableRowDTO**](TableRowDTO.md) |  | [optional] [default to undefined]
+**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableDTO } from 'yellowgrid-api-ts';
+
+const instance: TableDTO = {
+    title,
+    headers,
+    rows,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TableDataDTO.md

@@ -0,0 +1,21 @@
+# TableDataDTO
+
+Table Data
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **string** | Value | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableDataDTO } from 'yellowgrid-api-ts';
+
+const instance: TableDataDTO = {
+    value,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TableRowDTO.md

@@ -0,0 +1,21 @@
+# TableRowDTO
+
+Table Row
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<TableDataDTO>**](TableDataDTO.md) | Table Data | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableRowDTO } from 'yellowgrid-api-ts';
+
+const instance: TableRowDTO = {
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/models/GraphTypeEnum.ts

@@ -0,0 +1,14 @@
+export const GraphTypeEnum = {
+    "STACKED": {
+        "name": "STACKED",
+        "value": "stacked-area",
+        "publicValue": "Stacked Area"
+    },
+    "TABLE": {
+        "name": "TABLE",
+        "value": "table",
+        "publicValue": "Table"
+    }
+} as const;
+
+ export type GraphTypeEnum = typeof GraphTypeEnum;

package/models/ReportEnum.ts

@@ -0,0 +1,54 @@
+export const ReportEnum = {
+    "STOCK": {
+        "name": "STOCK",
+        "value": 1,
+        "publicValue": "Stock"
+    },
+    "POS": {
+        "name": "POS",
+        "value": 2,
+        "publicValue": "POS"
+    },
+    "CUSTOMER_SPEND": {
+        "name": "CUSTOMER_SPEND",
+        "value": 3,
+        "publicValue": "Customer Spend"
+    },
+    "MONTHLY_SALES": {
+        "name": "MONTHLY_SALES",
+        "value": 4,
+        "publicValue": "Monthly Sales"
+    },
+    "CUSTOMER_ANNUAL_COMPARISON": {
+        "name": "CUSTOMER_ANNUAL_COMPARISON",
+        "value": 5,
+        "publicValue": "Customer Annual Comparison"
+    },
+    "LOW_STOCK": {
+        "name": "LOW_STOCK",
+        "value": 6,
+        "publicValue": "Low Stock"
+    },
+    "LEAGUE_TABLE": {
+        "name": "LEAGUE_TABLE",
+        "value": 7,
+        "publicValue": "League Table"
+    },
+    "REVENUE": {
+        "name": "REVENUE",
+        "value": 8,
+        "publicValue": "Revenue"
+    },
+    "EXPENDITURE": {
+        "name": "EXPENDITURE",
+        "value": 9,
+        "publicValue": "Expenditure"
+    },
+    "TECH_SUPPORT_CUSTOMERS": {
+        "name": "TECH_SUPPORT_CUSTOMERS",
+        "value": 10,
+        "publicValue": "Tech Support Customers"
+    }
+} as const;
+
+ export type ReportEnum = typeof ReportEnum;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.239",
+  "version": "3.2.241",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {