@rlvt/statistics-openapi-client 1.0.2 → 1.0.4
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/build/api.d.ts +75 -2
- package/build/api.js +31 -3
- package/build/definitions.d.ts +41 -0
- package/package.json +1 -1
package/build/api.d.ts
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
import { AxiosInstance, AxiosRequestConfig } from "axios";
|
|
2
|
-
import type { Measure, Dimension, Query, QueryResult } from "./definitions";
|
|
2
|
+
import type { Measure, Dimension, StatisticsQuery, Query, QueryResult, Pick_Pick_StatisticsQuery_query_or_name_or_schedule__and__companyId_string_id_string_createdAt_Date_updatedAt_Date___query_or_name_or_schedule_ } from "./definitions";
|
|
3
3
|
export * from "./definitions";
|
|
4
4
|
export default class {
|
|
5
5
|
axios: AxiosInstance;
|
|
6
6
|
constructor(configOrInstance: AxiosRequestConfig | AxiosInstance);
|
|
7
7
|
private meta;
|
|
8
|
+
private listSavedQueries;
|
|
8
9
|
private query;
|
|
10
|
+
private saveQuery;
|
|
11
|
+
private runSavedQuery;
|
|
12
|
+
private deleteSavedQuery;
|
|
9
13
|
get Default(): {
|
|
10
14
|
meta: (params: Record<string, never>, options?: AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<{
|
|
11
15
|
status: "success";
|
|
@@ -23,7 +27,65 @@ export default class {
|
|
|
23
27
|
};
|
|
24
28
|
};
|
|
25
29
|
}, any>>;
|
|
26
|
-
|
|
30
|
+
listSavedQueries: (params: {
|
|
31
|
+
name?: string | undefined;
|
|
32
|
+
page?: number | undefined;
|
|
33
|
+
perPage?: number | undefined;
|
|
34
|
+
}, options?: AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<{
|
|
35
|
+
paginationCount: number;
|
|
36
|
+
paginationPage: number;
|
|
37
|
+
paginationLimit: number;
|
|
38
|
+
status: "success";
|
|
39
|
+
program: string;
|
|
40
|
+
version: string;
|
|
41
|
+
datetime: string;
|
|
42
|
+
code?: number | undefined;
|
|
43
|
+
message: string;
|
|
44
|
+
data: StatisticsQuery[];
|
|
45
|
+
}, any>>;
|
|
46
|
+
query: (params: {
|
|
47
|
+
format?: "csv" | "raw" | "table" | undefined;
|
|
48
|
+
}, data: Query, options?: AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<{
|
|
49
|
+
status: "success";
|
|
50
|
+
program: string;
|
|
51
|
+
version: string;
|
|
52
|
+
datetime: string;
|
|
53
|
+
code?: number | undefined;
|
|
54
|
+
message: string;
|
|
55
|
+
data: string | QueryResult | {
|
|
56
|
+
[key: string]: {
|
|
57
|
+
value: string | number | boolean;
|
|
58
|
+
metadata: {
|
|
59
|
+
link?: string | undefined;
|
|
60
|
+
formattedValue?: string | undefined;
|
|
61
|
+
} | {
|
|
62
|
+
calculation?: ({
|
|
63
|
+
type: "number";
|
|
64
|
+
value: number;
|
|
65
|
+
unit?: "currency" | "percent" | undefined;
|
|
66
|
+
} | {
|
|
67
|
+
type: "scope";
|
|
68
|
+
value: "(" | ")";
|
|
69
|
+
} | {
|
|
70
|
+
type: "operator";
|
|
71
|
+
value: "/" | "×" | "-" | "+";
|
|
72
|
+
})[] | undefined;
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
}[];
|
|
76
|
+
}, any>>;
|
|
77
|
+
saveQuery: (params: Record<string, never>, data: Pick_Pick_StatisticsQuery_query_or_name_or_schedule__and__companyId_string_id_string_createdAt_Date_updatedAt_Date___query_or_name_or_schedule_, options?: AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<{
|
|
78
|
+
status: "success";
|
|
79
|
+
program: string;
|
|
80
|
+
version: string;
|
|
81
|
+
datetime: string;
|
|
82
|
+
code?: number | undefined;
|
|
83
|
+
message: string;
|
|
84
|
+
data: StatisticsQuery;
|
|
85
|
+
}, any>>;
|
|
86
|
+
runSavedQuery: (params: {
|
|
87
|
+
id: string;
|
|
88
|
+
}, options?: AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<{
|
|
27
89
|
status: "success";
|
|
28
90
|
program: string;
|
|
29
91
|
version: string;
|
|
@@ -32,5 +94,16 @@ export default class {
|
|
|
32
94
|
message: string;
|
|
33
95
|
data: QueryResult;
|
|
34
96
|
}, any>>;
|
|
97
|
+
deleteSavedQuery: (params: {
|
|
98
|
+
id: string;
|
|
99
|
+
}, options?: AxiosRequestConfig<any> | undefined) => Promise<import("axios").AxiosResponse<{
|
|
100
|
+
status: "success";
|
|
101
|
+
program: string;
|
|
102
|
+
version: string;
|
|
103
|
+
datetime: string;
|
|
104
|
+
code?: number | undefined;
|
|
105
|
+
message: string;
|
|
106
|
+
data: {};
|
|
107
|
+
}, any>>;
|
|
35
108
|
};
|
|
36
109
|
}
|
package/build/api.js
CHANGED
|
@@ -30,15 +30,43 @@ class default_1 {
|
|
|
30
30
|
meta(params, options) {
|
|
31
31
|
return this.axios.get("/meta", options);
|
|
32
32
|
}
|
|
33
|
+
listSavedQueries(params, options) {
|
|
34
|
+
return this.axios.get("/query", Object.assign({}, {
|
|
35
|
+
params: pick(params, "name", "page", "perPage"),
|
|
36
|
+
}, options));
|
|
37
|
+
}
|
|
33
38
|
query(params, data, options) {
|
|
34
|
-
return this.axios.post("/query", data,
|
|
39
|
+
return this.axios.post("/query", data, Object.assign({}, {
|
|
40
|
+
params: pick(params, "format"),
|
|
41
|
+
}, options));
|
|
42
|
+
}
|
|
43
|
+
saveQuery(params, data, options) {
|
|
44
|
+
return this.axios.post("/query/save", data, options);
|
|
45
|
+
}
|
|
46
|
+
runSavedQuery(params, options) {
|
|
47
|
+
return this.axios.post("/query/{id}".replace(/{id}/, String(params["id"])), {}, options);
|
|
48
|
+
}
|
|
49
|
+
deleteSavedQuery(params, options) {
|
|
50
|
+
return this.axios.delete("/query/{id}".replace(/{id}/, String(params["id"])), options);
|
|
35
51
|
}
|
|
36
52
|
get Default() {
|
|
37
53
|
return {
|
|
38
54
|
meta: this.meta.bind(this),
|
|
39
|
-
|
|
55
|
+
listSavedQueries: this.listSavedQueries.bind(this),
|
|
56
|
+
query: this.query.bind(this),
|
|
57
|
+
saveQuery: this.saveQuery.bind(this),
|
|
58
|
+
runSavedQuery: this.runSavedQuery.bind(this),
|
|
59
|
+
deleteSavedQuery: this.deleteSavedQuery.bind(this)
|
|
40
60
|
};
|
|
41
61
|
}
|
|
42
62
|
}
|
|
43
63
|
exports.default = default_1;
|
|
44
|
-
|
|
64
|
+
function pick(obj, ...keys) {
|
|
65
|
+
const ret = {};
|
|
66
|
+
keys.forEach(key => {
|
|
67
|
+
if (obj && Object.keys(obj).includes(key))
|
|
68
|
+
ret[key] = obj[key];
|
|
69
|
+
});
|
|
70
|
+
return ret;
|
|
71
|
+
}
|
|
72
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vYXBpLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxvQkFBb0I7QUFDcEIsb0JBQW9COzs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBRXBCLGtEQUFpRTtBQUdqRSxnREFBOEI7QUFFOUI7SUFHSSxZQUFZLGdCQUFvRDtRQUM1RCxJQUFJLENBQUMsS0FBSyxHQUFHLGNBQWMsSUFBSSxnQkFBZ0I7WUFDM0MsQ0FBQyxDQUFDLGdCQUFnQjtZQUNsQixDQUFDLENBQUMsZUFBSyxDQUFDLE1BQU0sQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFBO0lBQ3hDLENBQUM7SUFFTyxJQUFJLENBQUMsTUFBNkIsRUFBRSxPQUE0QjtRQUNwRSxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsR0FBRyxDQWdCakIsT0FBTyxFQUFFLE9BQU8sQ0FDbkIsQ0FBQztJQUNOLENBQUM7SUFFTyxnQkFBZ0IsQ0FBQyxNQUl4QixFQUFFLE9BQTRCO1FBQzNCLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBWWpCLFFBQVEsRUFDUixNQUFNLENBQUMsTUFBTSxDQUNULEVBQUUsRUFDRjtZQUNJLE1BQU0sRUFBRSxJQUFJLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsU0FBUyxDQUFDO1NBQ2xELEVBQ0QsT0FBTyxDQUNWLENBQ0osQ0FBQztJQUNOLENBQUM7SUFFTyxLQUFLLENBQUMsTUFFYixFQUFFLElBQVcsRUFBRSxPQUE0QjtRQUN4QyxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQTZCbEIsUUFBUSxFQUFFLElBQUksRUFDZCxNQUFNLENBQUMsTUFBTSxDQUNULEVBQUUsRUFDRjtZQUNJLE1BQU0sRUFBRSxJQUFJLENBQUMsTUFBTSxFQUFFLFFBQVEsQ0FBQztTQUNqQyxFQUNELE9BQU8sQ0FDVixDQUNKLENBQUM7SUFDTixDQUFDO0lBRU8sU0FBUyxDQUFDLE1BQTZCLEVBQUUsSUFBcUosRUFBRSxPQUE0QjtRQUNoTyxPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQVNsQixhQUFhLEVBQUUsSUFBSSxFQUFFLE9BQU8sQ0FDL0IsQ0FBQztJQUNOLENBQUM7SUFFTyxhQUFhLENBQUMsTUFFckIsRUFBRSxPQUE0QjtRQUMzQixPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQVNsQixhQUFhLENBQUMsT0FBTyxDQUFDLE1BQU0sRUFBRSxNQUFNLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsRUFBRSxFQUFFLEVBQUUsT0FBTyxDQUNuRSxDQUFDO0lBQ04sQ0FBQztJQUVPLGdCQUFnQixDQUFDLE1BRXhCLEVBQUUsT0FBNEI7UUFDM0IsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FTcEIsYUFBYSxDQUFDLE9BQU8sQ0FBQyxNQUFNLEVBQUUsTUFBTSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLEVBQUUsT0FBTyxDQUMvRCxDQUFDO0lBQ04sQ0FBQztJQUVELElBQUksT0FBTztRQUNQLE9BQU87WUFDSCxJQUFJLEVBQUUsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDO1lBQzFCLGdCQUFnQixFQUFFLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDO1lBQ2xELEtBQUssRUFBRSxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUM7WUFDNUIsU0FBUyxFQUFFLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQztZQUNwQyxhQUFhLEVBQUUsSUFBSSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDO1lBQzVDLGdCQUFnQixFQUFFLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDO1NBQ3JELENBQUM7SUFDTixDQUFDO0NBQ0o7QUE3SkQsNEJBNkpDO0FBRUQsU0FBUyxJQUFJLENBQXVCLEdBQU0sRUFBRSxHQUFHLElBQVM7SUFDcEQsTUFBTSxHQUFHLEdBQWUsRUFBZ0IsQ0FBQztJQUN6QyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUFFO1FBQ2YsSUFBSSxHQUFHLElBQUksTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQyxRQUFRLENBQUMsR0FBYSxDQUFDO1lBQy9DLEdBQUcsQ0FBQyxHQUFHLENBQUMsR0FBRyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDNUIsQ0FBQyxDQUFDLENBQUM7SUFDSCxPQUFPLEdBQUcsQ0FBQztBQUNmLENBQUMifQ==
|
package/build/definitions.d.ts
CHANGED
|
@@ -76,3 +76,44 @@ export declare type Query = {
|
|
|
76
76
|
limit?: number;
|
|
77
77
|
order?: TQueryOrderObject | (string | ("asc" | "desc"))[][];
|
|
78
78
|
};
|
|
79
|
+
export declare type StatisticsQuerySchedule = {
|
|
80
|
+
cron: string;
|
|
81
|
+
};
|
|
82
|
+
export declare type Pick_StatisticsQuery_query_or_name_or_schedule_ = {
|
|
83
|
+
query: Query;
|
|
84
|
+
name: string;
|
|
85
|
+
schedule?: StatisticsQuerySchedule;
|
|
86
|
+
};
|
|
87
|
+
export declare type StatisticsQuery = Pick_StatisticsQuery_query_or_name_or_schedule_ & {
|
|
88
|
+
companyId: string;
|
|
89
|
+
id: string;
|
|
90
|
+
createdAt: Date;
|
|
91
|
+
updatedAt: Date;
|
|
92
|
+
};
|
|
93
|
+
export declare type Pick_Pick_StatisticsQuery_query_or_name_or_schedule__and__companyId_string_id_string_createdAt_Date_updatedAt_Date___query_or_name_or_schedule_ = {
|
|
94
|
+
query: Query;
|
|
95
|
+
name: string;
|
|
96
|
+
schedule?: StatisticsQuerySchedule;
|
|
97
|
+
};
|
|
98
|
+
export declare type QueryFormatterTableResult = {
|
|
99
|
+
[key: string]: {
|
|
100
|
+
value: string | number | (false) | (true);
|
|
101
|
+
metadata: {
|
|
102
|
+
link?: string;
|
|
103
|
+
formattedValue?: string;
|
|
104
|
+
} | {
|
|
105
|
+
calculation?: ({
|
|
106
|
+
type: "number";
|
|
107
|
+
value: number;
|
|
108
|
+
unit?: "currency" | "percent";
|
|
109
|
+
} | {
|
|
110
|
+
type: "scope";
|
|
111
|
+
value: "(" | ")";
|
|
112
|
+
} | {
|
|
113
|
+
type: "operator";
|
|
114
|
+
value: "/" | "\u00D7" | "-" | "+";
|
|
115
|
+
})[];
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
}[];
|
|
119
|
+
export declare type QueryFormatterCSVResult = string;
|
package/package.json
CHANGED