UNPKG

2.32 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(options: object | Callback<ReportInstanceAttrs>, callback?: Callback<ReportInstanceAttrs>): Promise<ReportInstanceAttrs>;
48
49 instance(id: string): ReportInstance;
50
51 instances(callback?: Callback<ReportInstance[]>): Promise<ReportInstance[]>;
52}
53
54export interface ReportInstanceAttrs {}
55
56export interface ReportMetadata {}
57
58export interface ReportResult {}
59
60export interface ReportInfo {}
61
62export interface DashboardInfo {}
63
64export class Analytics {
65 report(id: string): Promise<Report>;
66
67 reports(callback?: Callback<ReportInfo[]>): Promise<ReportInfo[]>;
68
69 dashboard(id: string): Promise<Dashboard>;
70
71 dashboards(callback?: Callback<DashboardInfo[]>): Promise<DashboardInfo[]>;
72}