@vizzly/api-client 0.0.50 → 0.0.51
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.
|
@@ -28,27 +28,29 @@ class DashboardRepository {
|
|
|
28
28
|
componentLibrary: [],
|
|
29
29
|
customFields: {},
|
|
30
30
|
globalFilters: [],
|
|
31
|
-
display: [
|
|
31
|
+
display: [
|
|
32
|
+
{
|
|
32
33
|
components: [
|
|
33
34
|
{ colSpan: 6, isEmpty: true },
|
|
34
|
-
{ colSpan: 6, isEmpty: true }
|
|
35
|
+
{ colSpan: 6, isEmpty: true },
|
|
35
36
|
],
|
|
36
|
-
height: 350
|
|
37
|
+
height: 350,
|
|
37
38
|
},
|
|
38
39
|
{
|
|
39
40
|
components: [
|
|
40
41
|
{ colSpan: 6, isEmpty: true },
|
|
41
|
-
{ colSpan: 6, isEmpty: true }
|
|
42
|
+
{ colSpan: 6, isEmpty: true },
|
|
42
43
|
],
|
|
43
|
-
height: 350
|
|
44
|
+
height: 350,
|
|
44
45
|
},
|
|
45
46
|
{
|
|
46
47
|
components: [
|
|
47
48
|
{ colSpan: 6, isEmpty: true },
|
|
48
|
-
{ colSpan: 6, isEmpty: true }
|
|
49
|
+
{ colSpan: 6, isEmpty: true },
|
|
49
50
|
],
|
|
50
|
-
height: 350
|
|
51
|
-
}
|
|
51
|
+
height: 350,
|
|
52
|
+
},
|
|
53
|
+
],
|
|
52
54
|
};
|
|
53
55
|
}
|
|
54
56
|
createDashboard(createParams) {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Api } from './Api';
|
|
2
2
|
import { Authentication } from './Authentication';
|
|
3
|
-
import { CreateDashboardParams, CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermissionFromAPI, PersistedReport, QueryEngineUserFromAPI, Request, RequestParams, Response, TeamMemberFromAPI, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
|
|
3
|
+
import { CreateDashboardParams, CreateGlobalLibraryParams, FieldUsage, GlobalLibrary, GlobalLibraryPermissionFromAPI, PersistedReport, QueryEngineUserFromAPI, Request, RequestParams, Response, TeamMemberFromAPI, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
|
|
4
4
|
import { nVizzlyApi } from '../types';
|
|
5
5
|
import { ProjectFromAPI } from '../types/project';
|
|
6
6
|
export declare class VizzlyApi extends Api {
|
|
@@ -118,4 +118,13 @@ export declare class VizzlyApi extends Api {
|
|
|
118
118
|
buildUpdateProjectApiKeyRequest(params: RequestParams<nVizzlyApi.UpdateProjectApiKeyParams>): Request<{}>;
|
|
119
119
|
updateQueryEngineUser(params: RequestParams<nVizzlyApi.UpdateQueryEngineUserParams>): Promise<boolean>;
|
|
120
120
|
buildUpdateQueryEngineUserRequest(params: RequestParams<nVizzlyApi.UpdateQueryEngineUserParams>): Request<{}>;
|
|
121
|
+
getDashboardFieldUsageMetadata(params: {
|
|
122
|
+
dashboardId: string;
|
|
123
|
+
}): Promise<Response<{
|
|
124
|
+
dashboard_field_usage_metadata: FieldUsage | null;
|
|
125
|
+
library_field_usage_metadata: FieldUsage | null;
|
|
126
|
+
}>>;
|
|
127
|
+
buildGetDashboardFieldUsageMetadata(params: RequestParams<{
|
|
128
|
+
dashboardId: string;
|
|
129
|
+
}>): Request<{}>;
|
|
121
130
|
}
|
package/dist/models/VizzlyApi.js
CHANGED
|
@@ -76,6 +76,7 @@ class VizzlyApi extends Api_1.Api {
|
|
|
76
76
|
meta: params.metadata || params.meta || {},
|
|
77
77
|
parentDashboardId: params.parentDashboardId,
|
|
78
78
|
permissions: params.permissions,
|
|
79
|
+
usage_metadata: params.usage_metadata,
|
|
79
80
|
},
|
|
80
81
|
abortSignal: params.abortSignal,
|
|
81
82
|
};
|
|
@@ -471,6 +472,7 @@ class VizzlyApi extends Api_1.Api {
|
|
|
471
472
|
meta: params.metadata || params.meta || {},
|
|
472
473
|
deleted: params.deleted,
|
|
473
474
|
name: params.name,
|
|
475
|
+
usage_metadata: params.usage_metadata,
|
|
474
476
|
},
|
|
475
477
|
abortSignal: params.abortSignal,
|
|
476
478
|
};
|
|
@@ -505,6 +507,7 @@ class VizzlyApi extends Api_1.Api {
|
|
|
505
507
|
globalLibrarySessionToken: params.globalLibrarySessionToken,
|
|
506
508
|
deleted: params.deleted,
|
|
507
509
|
library: params.library,
|
|
510
|
+
usage_metadata: params.usage_metadata,
|
|
508
511
|
},
|
|
509
512
|
abortSignal: params.abortSignal,
|
|
510
513
|
};
|
|
@@ -544,5 +547,17 @@ class VizzlyApi extends Api_1.Api {
|
|
|
544
547
|
acceptedAuthParams: ['projectApiKey', 'projectAccessToken'],
|
|
545
548
|
};
|
|
546
549
|
}
|
|
550
|
+
getDashboardFieldUsageMetadata(params) {
|
|
551
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
552
|
+
return yield this.execute(this.buildGetDashboardFieldUsageMetadata(params));
|
|
553
|
+
});
|
|
554
|
+
}
|
|
555
|
+
buildGetDashboardFieldUsageMetadata(params) {
|
|
556
|
+
return {
|
|
557
|
+
path: `/api/v2/field-usage/dashboard/${params.dashboardId}`,
|
|
558
|
+
method: 'get',
|
|
559
|
+
abortSignal: params.abortSignal,
|
|
560
|
+
};
|
|
561
|
+
}
|
|
547
562
|
}
|
|
548
563
|
exports.VizzlyApi = VizzlyApi;
|
|
@@ -31,6 +31,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
31
31
|
meta: params.metadata || params.meta || {},
|
|
32
32
|
parentDashboardId: params.parentDashboardId,
|
|
33
33
|
permissions: params.permissions,
|
|
34
|
+
usage_metadata: params.usage_metadata,
|
|
34
35
|
},
|
|
35
36
|
};
|
|
36
37
|
}
|
|
@@ -378,6 +379,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
378
379
|
globalLibrarySessionToken: params.globalLibrarySessionToken,
|
|
379
380
|
deleted: params.deleted,
|
|
380
381
|
library: params.library,
|
|
382
|
+
usage_metadata: params.usage_metadata,
|
|
381
383
|
},
|
|
382
384
|
};
|
|
383
385
|
}
|
|
@@ -397,6 +399,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
|
|
|
397
399
|
meta: params.metadata || params.meta || {},
|
|
398
400
|
deleted: params.deleted,
|
|
399
401
|
name: params.name,
|
|
402
|
+
usage_metadata: params.usage_metadata,
|
|
400
403
|
},
|
|
401
404
|
};
|
|
402
405
|
}
|
package/dist/types.d.ts
CHANGED
|
@@ -40,6 +40,7 @@ export type UpdateGlobalLibraryParams = {
|
|
|
40
40
|
globalLibrarySessionToken: string;
|
|
41
41
|
deleted?: boolean;
|
|
42
42
|
library: GlobalLibrary['library'] | string;
|
|
43
|
+
usage_metadata?: FieldUsage;
|
|
43
44
|
};
|
|
44
45
|
export type CreateGlobalLibraryParams = {
|
|
45
46
|
parentGlobalLibraryId: string;
|
|
@@ -48,6 +49,16 @@ export type CreateGlobalLibraryParams = {
|
|
|
48
49
|
user_reference?: string;
|
|
49
50
|
scope: 'read' | 'read_write';
|
|
50
51
|
}>;
|
|
52
|
+
usage_metadata?: FieldUsage;
|
|
53
|
+
};
|
|
54
|
+
export type FieldUsage = {
|
|
55
|
+
lowest_date_granularity_function: string | null;
|
|
56
|
+
fields: Array<{
|
|
57
|
+
data_set_id: string;
|
|
58
|
+
field_id: string;
|
|
59
|
+
function: string;
|
|
60
|
+
name: string;
|
|
61
|
+
}>;
|
|
51
62
|
};
|
|
52
63
|
export type CreateDashboardParams = {
|
|
53
64
|
definition?: DashboardDefinition | string;
|
|
@@ -56,6 +67,7 @@ export type CreateDashboardParams = {
|
|
|
56
67
|
metadata?: any;
|
|
57
68
|
parentDashboardId: string;
|
|
58
69
|
permissions: Array<any>;
|
|
70
|
+
usage_metadata?: FieldUsage;
|
|
59
71
|
};
|
|
60
72
|
export type CreateDashboardParamsUnencrypted = Omit<CreateDashboardParams, 'definition'> & {
|
|
61
73
|
definition: DashboardDefinition;
|
|
@@ -68,6 +80,7 @@ export type UpdateDashboardParams = {
|
|
|
68
80
|
metadata?: any;
|
|
69
81
|
deleted?: boolean;
|
|
70
82
|
name?: string;
|
|
83
|
+
usage_metadata?: FieldUsage;
|
|
71
84
|
};
|
|
72
85
|
export type APIs = {
|
|
73
86
|
vizzlyApi: VizzlyApi;
|