yellowgrid-api-ts 3.2.193-dev.0 → 3.2.194-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -0
- package/README.md +7 -0
- package/api.ts +522 -6
- package/dist/api.d.ts +382 -6
- package/dist/api.js +363 -4
- package/docs/AccountsApi.md +55 -0
- package/docs/CrmActivityDTO.md +2 -2
- package/docs/MiscApi.md +63 -0
- package/docs/PasswordSenderDTO.md +37 -0
- package/docs/PasswordSenderEntity.md +33 -0
- package/docs/ReportsApi.md +52 -0
- package/docs/StockReportItemModel.md +31 -0
- package/docs/StockReportModel.md +29 -0
- package/docs/TcxInstallationModel.md +2 -0
- package/package.json +1 -1
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# ReportsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getGetStockReport**](#getgetstockreport) | **GET** /reports/stock | |
|
|
8
|
+
|
|
9
|
+
# **getGetStockReport**
|
|
10
|
+
> StockReportModel getGetStockReport()
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import {
|
|
17
|
+
ReportsApi,
|
|
18
|
+
Configuration
|
|
19
|
+
} from 'yellowgrid-api-ts';
|
|
20
|
+
|
|
21
|
+
const configuration = new Configuration();
|
|
22
|
+
const apiInstance = new ReportsApi(configuration);
|
|
23
|
+
|
|
24
|
+
const { status, data } = await apiInstance.getGetStockReport();
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Parameters
|
|
28
|
+
This endpoint does not have any parameters.
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### Return type
|
|
32
|
+
|
|
33
|
+
**StockReportModel**
|
|
34
|
+
|
|
35
|
+
### Authorization
|
|
36
|
+
|
|
37
|
+
No authorization required
|
|
38
|
+
|
|
39
|
+
### HTTP request headers
|
|
40
|
+
|
|
41
|
+
- **Content-Type**: Not defined
|
|
42
|
+
- **Accept**: application/json
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### HTTP response details
|
|
46
|
+
| Status code | Description | Response headers |
|
|
47
|
+
|-------------|-------------|------------------|
|
|
48
|
+
|**200** | Stock Report | - |
|
|
49
|
+
|**400** | Bad Request | - |
|
|
50
|
+
|
|
51
|
+
[[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)
|
|
52
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# StockReportItemModel
|
|
2
|
+
|
|
3
|
+
Stock Report Item
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**title** | **string** | Title | [optional] [default to undefined]
|
|
10
|
+
**sku** | **string** | SKU | [optional] [default to undefined]
|
|
11
|
+
**quantity** | **number** | In Stock | [optional] [default to undefined]
|
|
12
|
+
**currency** | **string** | Currency | [optional] [default to undefined]
|
|
13
|
+
**basePrice** | **number** | Cost Price | [optional] [default to undefined]
|
|
14
|
+
**totalValue** | **number** | Line Total | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { StockReportItemModel } from 'yellowgrid-api-ts';
|
|
20
|
+
|
|
21
|
+
const instance: StockReportItemModel = {
|
|
22
|
+
title,
|
|
23
|
+
sku,
|
|
24
|
+
quantity,
|
|
25
|
+
currency,
|
|
26
|
+
basePrice,
|
|
27
|
+
totalValue,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# StockReportModel
|
|
2
|
+
|
|
3
|
+
Stock Report
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**products** | [**Array<StockReportItemModel>**](StockReportItemModel.md) | Items | [optional] [default to undefined]
|
|
10
|
+
**unitsInStock** | **number** | Units In Stock | [optional] [default to undefined]
|
|
11
|
+
**usdStock** | **number** | Value Of USD Stock | [optional] [default to undefined]
|
|
12
|
+
**gbpStock** | **number** | Value Of GBP Stock | [optional] [default to undefined]
|
|
13
|
+
**totalStockGbp** | **number** | Total value of stock in GBP | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { StockReportModel } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: StockReportModel = {
|
|
21
|
+
products,
|
|
22
|
+
unitsInStock,
|
|
23
|
+
usdStock,
|
|
24
|
+
gbpStock,
|
|
25
|
+
totalStockGbp,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**wizardId** | **string** | Wizard ID | [optional] [default to undefined]
|
|
10
|
+
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
|
10
11
|
**instanceId** | **string** | Instance ID | [optional] [default to undefined]
|
|
11
12
|
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
12
13
|
**endUser** | **string** | End User | [optional] [default to undefined]
|
|
@@ -45,6 +46,7 @@ import { TcxInstallationModel } from 'yellowgrid-api-ts';
|
|
|
45
46
|
|
|
46
47
|
const instance: TcxInstallationModel = {
|
|
47
48
|
wizardId,
|
|
49
|
+
customerId,
|
|
48
50
|
instanceId,
|
|
49
51
|
licenceKey,
|
|
50
52
|
endUser,
|