yellowgrid-api-ts 3.2.206-dev.0 → 3.2.207-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 +4 -0
- package/README.md +4 -0
- package/api.ts +55 -3
- package/dist/api.d.ts +54 -3
- package/dist/api.js +2 -1
- package/dist/models/GraphTypeEnum.d.ts +5 -0
- package/dist/models/GraphTypeEnum.js +5 -0
- package/docs/PostGenerateReport200Response.md +36 -0
- package/docs/ReportsApi.md +2 -2
- package/docs/TableDTO.md +23 -0
- package/docs/TableDataDTO.md +21 -0
- package/docs/TableRowDTO.md +21 -0
- package/models/GraphTypeEnum.ts +5 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -159,6 +159,7 @@ docs/PortalAccountModel.md
|
|
|
159
159
|
docs/PortalLoginModel.md
|
|
160
160
|
docs/PostAddOrderNoteRequest.md
|
|
161
161
|
docs/PostAddWebhook200Response.md
|
|
162
|
+
docs/PostGenerateReport200Response.md
|
|
162
163
|
docs/PostGetClientCredentialsRequest.md
|
|
163
164
|
docs/PostGetProductForCustomerRequest.md
|
|
164
165
|
docs/PostSendWelcomeEmailRequest.md
|
|
@@ -263,7 +264,10 @@ docs/SupplierProductResultsModel.md
|
|
|
263
264
|
docs/SuppliersApi.md
|
|
264
265
|
docs/SupportTicketModel.md
|
|
265
266
|
docs/SystemApi.md
|
|
267
|
+
docs/TableDTO.md
|
|
268
|
+
docs/TableDataDTO.md
|
|
266
269
|
docs/TableHistoryEntity.md
|
|
270
|
+
docs/TableRowDTO.md
|
|
267
271
|
docs/TcxBackupEntity.md
|
|
268
272
|
docs/TcxBackupModel.md
|
|
269
273
|
docs/TcxBillingEntity.md
|
package/README.md
CHANGED
|
@@ -472,6 +472,7 @@ Class | Method | HTTP request | Description
|
|
|
472
472
|
- [PortalLoginModel](docs/PortalLoginModel.md)
|
|
473
473
|
- [PostAddOrderNoteRequest](docs/PostAddOrderNoteRequest.md)
|
|
474
474
|
- [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
|
|
475
|
+
- [PostGenerateReport200Response](docs/PostGenerateReport200Response.md)
|
|
475
476
|
- [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
|
|
476
477
|
- [PostGetProductForCustomerRequest](docs/PostGetProductForCustomerRequest.md)
|
|
477
478
|
- [PostSendWelcomeEmailRequest](docs/PostSendWelcomeEmailRequest.md)
|
|
@@ -564,7 +565,10 @@ Class | Method | HTTP request | Description
|
|
|
564
565
|
- [SupplierProductModel](docs/SupplierProductModel.md)
|
|
565
566
|
- [SupplierProductResultsModel](docs/SupplierProductResultsModel.md)
|
|
566
567
|
- [SupportTicketModel](docs/SupportTicketModel.md)
|
|
568
|
+
- [TableDTO](docs/TableDTO.md)
|
|
569
|
+
- [TableDataDTO](docs/TableDataDTO.md)
|
|
567
570
|
- [TableHistoryEntity](docs/TableHistoryEntity.md)
|
|
571
|
+
- [TableRowDTO](docs/TableRowDTO.md)
|
|
568
572
|
- [TcxBackupEntity](docs/TcxBackupEntity.md)
|
|
569
573
|
- [TcxBackupModel](docs/TcxBackupModel.md)
|
|
570
574
|
- [TcxBillingEntity](docs/TcxBillingEntity.md)
|
package/api.ts
CHANGED
|
@@ -7247,6 +7247,12 @@ export interface PostAddWebhook200Response {
|
|
|
7247
7247
|
*/
|
|
7248
7248
|
'url'?: string;
|
|
7249
7249
|
}
|
|
7250
|
+
/**
|
|
7251
|
+
* @type PostGenerateReport200Response
|
|
7252
|
+
* @export
|
|
7253
|
+
*/
|
|
7254
|
+
export type PostGenerateReport200Response = GraphDTO | TableDTO;
|
|
7255
|
+
|
|
7250
7256
|
/**
|
|
7251
7257
|
*
|
|
7252
7258
|
* @export
|
|
@@ -8217,7 +8223,8 @@ export const ReportRequestDTOReportEnum = {
|
|
|
8217
8223
|
|
|
8218
8224
|
export type ReportRequestDTOReportEnum = typeof ReportRequestDTOReportEnum[keyof typeof ReportRequestDTOReportEnum];
|
|
8219
8225
|
export const ReportRequestDTOGraphTypeEnum = {
|
|
8220
|
-
StackedArea: 'stacked-area'
|
|
8226
|
+
StackedArea: 'stacked-area',
|
|
8227
|
+
Table: 'table'
|
|
8221
8228
|
} as const;
|
|
8222
8229
|
|
|
8223
8230
|
export type ReportRequestDTOGraphTypeEnum = typeof ReportRequestDTOGraphTypeEnum[keyof typeof ReportRequestDTOGraphTypeEnum];
|
|
@@ -11254,6 +11261,38 @@ export interface SupportTicketModel {
|
|
|
11254
11261
|
*/
|
|
11255
11262
|
'conversations'?: Array<ConversationModel>;
|
|
11256
11263
|
}
|
|
11264
|
+
/**
|
|
11265
|
+
* Table
|
|
11266
|
+
* @export
|
|
11267
|
+
* @interface TableDTO
|
|
11268
|
+
*/
|
|
11269
|
+
export interface TableDTO {
|
|
11270
|
+
/**
|
|
11271
|
+
* Headers
|
|
11272
|
+
* @type {Array<TableRowDTO>}
|
|
11273
|
+
* @memberof TableDTO
|
|
11274
|
+
*/
|
|
11275
|
+
'headers'?: Array<TableRowDTO>;
|
|
11276
|
+
/**
|
|
11277
|
+
* Rows
|
|
11278
|
+
* @type {Array<TableRowDTO>}
|
|
11279
|
+
* @memberof TableDTO
|
|
11280
|
+
*/
|
|
11281
|
+
'rows'?: Array<TableRowDTO>;
|
|
11282
|
+
}
|
|
11283
|
+
/**
|
|
11284
|
+
* Table Data
|
|
11285
|
+
* @export
|
|
11286
|
+
* @interface TableDataDTO
|
|
11287
|
+
*/
|
|
11288
|
+
export interface TableDataDTO {
|
|
11289
|
+
/**
|
|
11290
|
+
* Value
|
|
11291
|
+
* @type {string}
|
|
11292
|
+
* @memberof TableDataDTO
|
|
11293
|
+
*/
|
|
11294
|
+
'value'?: string;
|
|
11295
|
+
}
|
|
11257
11296
|
/**
|
|
11258
11297
|
* TableAttribsEntity
|
|
11259
11298
|
* @export
|
|
@@ -11309,6 +11348,19 @@ export interface TableHistoryEntity {
|
|
|
11309
11348
|
*/
|
|
11310
11349
|
'page'?: number;
|
|
11311
11350
|
}
|
|
11351
|
+
/**
|
|
11352
|
+
* Table Row
|
|
11353
|
+
* @export
|
|
11354
|
+
* @interface TableRowDTO
|
|
11355
|
+
*/
|
|
11356
|
+
export interface TableRowDTO {
|
|
11357
|
+
/**
|
|
11358
|
+
* Table Data
|
|
11359
|
+
* @type {Array<TableDataDTO>}
|
|
11360
|
+
* @memberof TableRowDTO
|
|
11361
|
+
*/
|
|
11362
|
+
'data'?: Array<TableDataDTO>;
|
|
11363
|
+
}
|
|
11312
11364
|
/**
|
|
11313
11365
|
* 3CX Wizard Restore From Backup
|
|
11314
11366
|
* @export
|
|
@@ -30096,7 +30148,7 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
30096
30148
|
* @param {*} [options] Override http request option.
|
|
30097
30149
|
* @throws {RequiredError}
|
|
30098
30150
|
*/
|
|
30099
|
-
async postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
30151
|
+
async postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostGenerateReport200Response>> {
|
|
30100
30152
|
const localVarAxiosArgs = await localVarAxiosParamCreator.postGenerateReport(reportRequestDTO, options);
|
|
30101
30153
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
30102
30154
|
const localVarOperationServerBasePath = operationServerMap['ReportsApi.postGenerateReport']?.[localVarOperationServerIndex]?.url;
|
|
@@ -30127,7 +30179,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
30127
30179
|
* @param {*} [options] Override http request option.
|
|
30128
30180
|
* @throws {RequiredError}
|
|
30129
30181
|
*/
|
|
30130
|
-
postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
30182
|
+
postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<PostGenerateReport200Response> {
|
|
30131
30183
|
return localVarFp.postGenerateReport(reportRequestDTO, options).then((request) => request(axios, basePath));
|
|
30132
30184
|
},
|
|
30133
30185
|
};
|
package/dist/api.d.ts
CHANGED
|
@@ -7184,6 +7184,11 @@ export interface PostAddWebhook200Response {
|
|
|
7184
7184
|
*/
|
|
7185
7185
|
'url'?: string;
|
|
7186
7186
|
}
|
|
7187
|
+
/**
|
|
7188
|
+
* @type PostGenerateReport200Response
|
|
7189
|
+
* @export
|
|
7190
|
+
*/
|
|
7191
|
+
export type PostGenerateReport200Response = GraphDTO | TableDTO;
|
|
7187
7192
|
/**
|
|
7188
7193
|
*
|
|
7189
7194
|
* @export
|
|
@@ -8150,6 +8155,7 @@ export declare const ReportRequestDTOReportEnum: {
|
|
|
8150
8155
|
export type ReportRequestDTOReportEnum = typeof ReportRequestDTOReportEnum[keyof typeof ReportRequestDTOReportEnum];
|
|
8151
8156
|
export declare const ReportRequestDTOGraphTypeEnum: {
|
|
8152
8157
|
readonly StackedArea: "stacked-area";
|
|
8158
|
+
readonly Table: "table";
|
|
8153
8159
|
};
|
|
8154
8160
|
export type ReportRequestDTOGraphTypeEnum = typeof ReportRequestDTOGraphTypeEnum[keyof typeof ReportRequestDTOGraphTypeEnum];
|
|
8155
8161
|
/**
|
|
@@ -11135,6 +11141,38 @@ export interface SupportTicketModel {
|
|
|
11135
11141
|
*/
|
|
11136
11142
|
'conversations'?: Array<ConversationModel>;
|
|
11137
11143
|
}
|
|
11144
|
+
/**
|
|
11145
|
+
* Table
|
|
11146
|
+
* @export
|
|
11147
|
+
* @interface TableDTO
|
|
11148
|
+
*/
|
|
11149
|
+
export interface TableDTO {
|
|
11150
|
+
/**
|
|
11151
|
+
* Headers
|
|
11152
|
+
* @type {Array<TableRowDTO>}
|
|
11153
|
+
* @memberof TableDTO
|
|
11154
|
+
*/
|
|
11155
|
+
'headers'?: Array<TableRowDTO>;
|
|
11156
|
+
/**
|
|
11157
|
+
* Rows
|
|
11158
|
+
* @type {Array<TableRowDTO>}
|
|
11159
|
+
* @memberof TableDTO
|
|
11160
|
+
*/
|
|
11161
|
+
'rows'?: Array<TableRowDTO>;
|
|
11162
|
+
}
|
|
11163
|
+
/**
|
|
11164
|
+
* Table Data
|
|
11165
|
+
* @export
|
|
11166
|
+
* @interface TableDataDTO
|
|
11167
|
+
*/
|
|
11168
|
+
export interface TableDataDTO {
|
|
11169
|
+
/**
|
|
11170
|
+
* Value
|
|
11171
|
+
* @type {string}
|
|
11172
|
+
* @memberof TableDataDTO
|
|
11173
|
+
*/
|
|
11174
|
+
'value'?: string;
|
|
11175
|
+
}
|
|
11138
11176
|
/**
|
|
11139
11177
|
* TableAttribsEntity
|
|
11140
11178
|
* @export
|
|
@@ -11190,6 +11228,19 @@ export interface TableHistoryEntity {
|
|
|
11190
11228
|
*/
|
|
11191
11229
|
'page'?: number;
|
|
11192
11230
|
}
|
|
11231
|
+
/**
|
|
11232
|
+
* Table Row
|
|
11233
|
+
* @export
|
|
11234
|
+
* @interface TableRowDTO
|
|
11235
|
+
*/
|
|
11236
|
+
export interface TableRowDTO {
|
|
11237
|
+
/**
|
|
11238
|
+
* Table Data
|
|
11239
|
+
* @type {Array<TableDataDTO>}
|
|
11240
|
+
* @memberof TableRowDTO
|
|
11241
|
+
*/
|
|
11242
|
+
'data'?: Array<TableDataDTO>;
|
|
11243
|
+
}
|
|
11193
11244
|
/**
|
|
11194
11245
|
* 3CX Wizard Restore From Backup
|
|
11195
11246
|
* @export
|
|
@@ -21556,7 +21607,7 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
21556
21607
|
* @param {*} [options] Override http request option.
|
|
21557
21608
|
* @throws {RequiredError}
|
|
21558
21609
|
*/
|
|
21559
|
-
postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
21610
|
+
postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostGenerateReport200Response>>;
|
|
21560
21611
|
};
|
|
21561
21612
|
/**
|
|
21562
21613
|
* ReportsApi - factory interface
|
|
@@ -21576,7 +21627,7 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
|
|
|
21576
21627
|
* @param {*} [options] Override http request option.
|
|
21577
21628
|
* @throws {RequiredError}
|
|
21578
21629
|
*/
|
|
21579
|
-
postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
21630
|
+
postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<PostGenerateReport200Response>;
|
|
21580
21631
|
};
|
|
21581
21632
|
/**
|
|
21582
21633
|
* ReportsApi - object-oriented interface
|
|
@@ -21600,7 +21651,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
21600
21651
|
* @throws {RequiredError}
|
|
21601
21652
|
* @memberof ReportsApi
|
|
21602
21653
|
*/
|
|
21603
|
-
postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
21654
|
+
postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PostGenerateReport200Response, any, {}>>;
|
|
21604
21655
|
}
|
|
21605
21656
|
/**
|
|
21606
21657
|
* SIPTrunksApi - axios parameter creator
|
package/dist/api.js
CHANGED
|
@@ -4,5 +4,10 @@ export declare const GraphTypeEnum: {
|
|
|
4
4
|
readonly value: "stacked-area";
|
|
5
5
|
readonly publicValue: "Stacked Area";
|
|
6
6
|
};
|
|
7
|
+
readonly TABLE: {
|
|
8
|
+
readonly name: "TABLE";
|
|
9
|
+
readonly value: "table";
|
|
10
|
+
readonly publicValue: "Table";
|
|
11
|
+
};
|
|
7
12
|
};
|
|
8
13
|
export type GraphTypeEnum = typeof GraphTypeEnum;
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# PostGenerateReport200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**title** | **string** | Title | [optional] [default to undefined]
|
|
9
|
+
**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [optional] [default to undefined]
|
|
10
|
+
**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [optional] [default to undefined]
|
|
11
|
+
**legend** | **Array<string>** | Legend | [optional] [default to undefined]
|
|
12
|
+
**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [optional] [default to undefined]
|
|
13
|
+
**currency** | **string** | Currency | [optional] [default to undefined]
|
|
14
|
+
**locale** | **string** | Locale | [optional] [default to undefined]
|
|
15
|
+
**headers** | [**Array<TableRowDTO>**](TableRowDTO.md) | Headers | [optional] [default to undefined]
|
|
16
|
+
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { PostGenerateReport200Response } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: PostGenerateReport200Response = {
|
|
24
|
+
title,
|
|
25
|
+
xAxis,
|
|
26
|
+
yAxis,
|
|
27
|
+
legend,
|
|
28
|
+
series,
|
|
29
|
+
currency,
|
|
30
|
+
locale,
|
|
31
|
+
headers,
|
|
32
|
+
rows,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[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
CHANGED
|
@@ -52,7 +52,7 @@ No authorization required
|
|
|
52
52
|
[[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)
|
|
53
53
|
|
|
54
54
|
# **postGenerateReport**
|
|
55
|
-
>
|
|
55
|
+
> PostGenerateReport200Response postGenerateReport()
|
|
56
56
|
|
|
57
57
|
Generate Reports
|
|
58
58
|
|
|
@@ -84,7 +84,7 @@ const { status, data } = await apiInstance.postGenerateReport(
|
|
|
84
84
|
|
|
85
85
|
### Return type
|
|
86
86
|
|
|
87
|
-
**
|
|
87
|
+
**PostGenerateReport200Response**
|
|
88
88
|
|
|
89
89
|
### Authorization
|
|
90
90
|
|
package/docs/TableDTO.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TableDTO
|
|
2
|
+
|
|
3
|
+
Table
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**headers** | [**Array<TableRowDTO>**](TableRowDTO.md) | Headers | [optional] [default to undefined]
|
|
10
|
+
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { TableDTO } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: TableDTO = {
|
|
18
|
+
headers,
|
|
19
|
+
rows,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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,21 @@
|
|
|
1
|
+
# TableDataDTO
|
|
2
|
+
|
|
3
|
+
Table Data
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**value** | **string** | Value | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { TableDataDTO } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: TableDataDTO = {
|
|
17
|
+
value,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[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,21 @@
|
|
|
1
|
+
# TableRowDTO
|
|
2
|
+
|
|
3
|
+
Table Row
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**data** | [**Array<TableDataDTO>**](TableDataDTO.md) | Table Data | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { TableRowDTO } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: TableRowDTO = {
|
|
17
|
+
data,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[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
CHANGED