UNPKG

2.34 kBTypeScriptView Raw
1import { Callback } from "../connection";
2import { ExplainInfo } from "../query";
3
4export class Dashboard {
5 describe(callback?: Callback<object>): Promise<any>;
6
7 del(callback?: Callback<object>): Promise<any>;
8
9 destory(callback?: Callback<object>): Promise<any>;
10
11 delete(callback?: Callback<object>): Promise<any>;
12
13 components(componentIds: string[] | string | Callback<object>, callback?: Callback<object>): Promise<any>;
14
15 status(callback?: Callback<object>): Promise<any>;
16
17 refresh(callback?: Callback<object>): Promise<any>;
18
19 clone(name: string | object, folderid: string, callback?: Callback<object>): Promise<any>;
20}
21
22export class ReportInstance {
23 constructor(report: Report, id: string);
24
25 retrieve(callback: Callback<ReportResult>): Promise<ReportResult>;
26}
27
28export class Report {
29 describe(callback?: Callback<ReportMetadata>): Promise<ReportMetadata>;
30
31 del(callback?: Callback<ReportResult>): Promise<ReportResult>;
32
33 destory(callback?: Callback<ReportResult>): Promise<ReportResult>;
34
35 delete(callback?: Callback<ReportResult>): Promise<ReportResult>;
36
37 clone(name: string, callback?: Callback<ReportResult>): Promise<ReportResult>;
38
39 explain(callback?: Callback<ExplainInfo>): Promise<ExplainInfo>;
40
41 run(options: object | Callback<ReportResult>, callback?: Callback<ReportResult>): Promise<ReportResult>;
42
43 exec(options: object | Callback<ReportResult>, callback?: Callback<ReportResult>): Promise<ReportResult>;
44
45 execute(options: object | Callback<ReportResult>, callback?: Callback<ReportResult>): Promise<ReportResult>;
46
47 executeAsync(
48 options: object | Callback<ReportInstanceAttrs>,
49 callback?: Callback<ReportInstanceAttrs>,
50 ): Promise<ReportInstanceAttrs>;
51
52 instance(id: string): ReportInstance;
53
54 instances(callback?: Callback<ReportInstance[]>): Promise<ReportInstance[]>;
55}
56
57export interface ReportInstanceAttrs {}
58
59export interface ReportMetadata {}
60
61export interface ReportResult {}
62
63export interface ReportInfo {}
64
65export interface DashboardInfo {}
66
67export class Analytics {
68 report(id: string): Promise<Report>;
69
70 reports(callback?: Callback<ReportInfo[]>): Promise<ReportInfo[]>;
71
72 dashboard(id: string): Promise<Dashboard>;
73
74 dashboards(callback?: Callback<DashboardInfo[]>): Promise<DashboardInfo[]>;
75}