@vizzly/api-client 0.0.44 → 0.0.45

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.
Files changed (3) hide show
  1. package/README.md +24 -0
  2. package/dist/models/VizzlyApi.d.ts +23 -18
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1 +1,25 @@
1
1
  # Vizzly API client
2
+
3
+ ## Create a parent dashboard
4
+
5
+ ```ts
6
+ import { VizzlyApi, Authentication } from '@vizzly/api-client';
7
+
8
+ export const createParentDashboard = async () => {
9
+ const auth = new Authentication({projectApiKey: process.env['VIZZLY_PROJECT_API_KEY']});
10
+ const vizzlyApi = new VizzlyApi(auth);
11
+
12
+ const response = await vizzlyApi.createParentDashboard({
13
+ name: 'My new parent dashboard'
14
+ });
15
+
16
+ if(response.status === 200) {
17
+ const { dashboard } = response.body;
18
+ // dashboard.id
19
+ // dashboard.name
20
+ } else {
21
+ throw "Failed to create a parent dashboard.";
22
+ }
23
+ };
24
+
25
+ ```
package/dist/models/VizzlyApi.d.ts CHANGED
@@ -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, TeamMemberFromAPI, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
3
+ import { CreateDashboardParams, CreateGlobalLibraryParams, 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 {
@@ -11,7 +11,7 @@ export declare class VizzlyApi extends Api {
11
11
  }>;
12
12
  fetchGlobalLibraries(params: RequestParams<{
13
13
  globalLibraryAccessTokens: string[];
14
- }>): Promise<import("../types").Response<{
14
+ }>): Promise<Response<{
15
15
  found: GlobalLibrary[];
16
16
  not_found: string[];
17
17
  }>>;
@@ -20,7 +20,7 @@ export declare class VizzlyApi extends Api {
20
20
  }>): Request<{
21
21
  globalLibraryAccessTokens: string[];
22
22
  }>;
23
- fetchGlobalLibraryAccessTokens(params?: RequestParams): Promise<import("../types").Response<{
23
+ fetchGlobalLibraryAccessTokens(params?: RequestParams): Promise<Response<{
24
24
  global_libraries: GlobalLibrary[];
25
25
  permissions: Array<GlobalLibraryPermissionFromAPI>;
26
26
  }>>;
@@ -34,9 +34,14 @@ export declare class VizzlyApi extends Api {
34
34
  buildFetchDashboardsRequest(params: RequestParams<{
35
35
  dashboardSessionAccessTokens: string[];
36
36
  }>): Request<{}>;
37
- createParentDashboard(params: RequestParams<nVizzlyApi.CreateParentDashboardParams>): Promise<import("../types").Response<unknown>>;
37
+ createParentDashboard(params: RequestParams<nVizzlyApi.CreateParentDashboardParams>): Promise<Response<{
38
+ dashboard: {
39
+ id: string;
40
+ name: string | null;
41
+ };
42
+ }>>;
38
43
  buildCreateParentDashboardRequest(params: RequestParams<nVizzlyApi.CreateParentDashboardParams>): Request<{}>;
39
- createParentGlobalLibrary(params: RequestParams<nVizzlyApi.CreateParentGlobalLibraryParams>): Promise<import("../types").Response<unknown>>;
44
+ createParentGlobalLibrary(params: RequestParams<nVizzlyApi.CreateParentGlobalLibraryParams>): Promise<Response<unknown>>;
40
45
  buildCreateParentGlobalLibraryRequest(params: RequestParams<nVizzlyApi.CreateParentGlobalLibraryParams>): Request<{}>;
41
46
  createGlobalLibrary(params: RequestParams<CreateGlobalLibraryParams>): Promise<{
42
47
  global_library: GlobalLibrary;
@@ -47,7 +52,7 @@ export declare class VizzlyApi extends Api {
47
52
  projects: Array<ProjectFromAPI>;
48
53
  }>;
49
54
  buildGetProjectsRequest(params?: RequestParams): Request<{}>;
50
- createProjectApiKey(params: RequestParams<nVizzlyApi.CreateProjectApiKeyParams>): Promise<import("../types").Response<{
55
+ createProjectApiKey(params: RequestParams<nVizzlyApi.CreateProjectApiKeyParams>): Promise<Response<{
51
56
  api_key: string;
52
57
  }>>;
53
58
  buildCreateProjectApiKeyRequest(params: RequestParams<nVizzlyApi.CreateProjectApiKeyParams>): Request<{}>;
@@ -56,23 +61,23 @@ export declare class VizzlyApi extends Api {
56
61
  buildCreateSelfHostedDynamicQueryEngineProjectRequest(params?: RequestParams): Request<{}>;
57
62
  buildCreateSelfHostedInBrowserProjectRequest(params?: RequestParams): Request<{}>;
58
63
  buildCreateSelfHostedProjectRequest(params?: RequestParams): Request<{}>;
59
- createManagedQueryEngineProject(params?: RequestParams): Promise<import("../types").Response<unknown>>;
64
+ createManagedQueryEngineProject(params?: RequestParams): Promise<Response<unknown>>;
60
65
  buildCreateManagedQueryEngineProjectRequest(params?: RequestParams): Request<{}>;
61
- createVizzlyConfigVersion(params: RequestParams<nVizzlyApi.CreateVizzlyConfigVersionParams>): Promise<import("../types").Response<unknown>>;
66
+ createVizzlyConfigVersion(params: RequestParams<nVizzlyApi.CreateVizzlyConfigVersionParams>): Promise<Response<unknown>>;
62
67
  buildCreateVizzlyConfigVersionRequest(params: RequestParams<nVizzlyApi.CreateVizzlyConfigVersionParams>): Request<{}>;
63
- duplicateParentDashboard(params: RequestParams<nVizzlyApi.DuplicateParentDashboardParams>): Promise<import("../types").Response<unknown>>;
68
+ duplicateParentDashboard(params: RequestParams<nVizzlyApi.DuplicateParentDashboardParams>): Promise<Response<unknown>>;
64
69
  buildDuplicateParentDashboardRequest(params: RequestParams<nVizzlyApi.DuplicateParentDashboardParams>): Request<{}>;
65
70
  getConnection(params: RequestParams<nVizzlyApi.GetConnectionParams>): Promise<{
66
71
  encryptedCredentials: string | null;
67
72
  }>;
68
73
  buildGetConnectionRequest(params: RequestParams<nVizzlyApi.GetConnectionParams>): Request<{}>;
69
- getManagedQueryEngineKeyPair(params: RequestParams<nVizzlyApi.GetManagedQueryEngineKeyPairParams>): Promise<import("../types").Response<unknown>>;
74
+ getManagedQueryEngineKeyPair(params: RequestParams<nVizzlyApi.GetManagedQueryEngineKeyPairParams>): Promise<Response<unknown>>;
70
75
  buildGetManagedQueryEngineKeyPairRequest(params: RequestParams<nVizzlyApi.GetManagedQueryEngineKeyPairParams>): Request<{}>;
71
76
  getProject(params: RequestParams<nVizzlyApi.GetProjectParams>): Promise<{
72
77
  project: ProjectFromAPI;
73
78
  }>;
74
79
  buildGetProjectRequest(params: RequestParams<nVizzlyApi.GetProjectParams>): Request<{}>;
75
- getProjectAccessToken(params: RequestParams<nVizzlyApi.GetProjectAccessTokenParams>): Promise<import("../types").Response<{
80
+ getProjectAccessToken(params: RequestParams<nVizzlyApi.GetProjectAccessTokenParams>): Promise<Response<{
76
81
  token: {
77
82
  max_age: number;
78
83
  token: string;
@@ -89,27 +94,27 @@ export declare class VizzlyApi extends Api {
89
94
  encryptedConfig: string | null;
90
95
  }>;
91
96
  buildGetVizzlyConfigRequest(params: RequestParams<nVizzlyApi.GetVizzlyConfigParams>): Request<{}>;
92
- saveConnection(params: RequestParams<nVizzlyApi.SaveConnectionParams>): Promise<import("../types").Response<unknown>>;
97
+ saveConnection(params: RequestParams<nVizzlyApi.SaveConnectionParams>): Promise<Response<unknown>>;
93
98
  buildSaveConnectionRequest(params: RequestParams<nVizzlyApi.SaveConnectionParams>): Request<{}>;
94
99
  saveEncryptedProjectEncryptionSecret(params: RequestParams<nVizzlyApi.SaveEncryptedProjectEncryptionSecretParams>): Promise<boolean>;
95
100
  buildSaveEncryptedProjectEncryptionSecretRequest(params: RequestParams<nVizzlyApi.SaveEncryptedProjectEncryptionSecretParams>): Request<{}>;
96
- getScheduledReports(params: RequestParams<nVizzlyApi.GetScheduledReportParams>): Promise<import("../types").Response<{
101
+ getScheduledReports(params: RequestParams<nVizzlyApi.GetScheduledReportParams>): Promise<Response<{
97
102
  reports: Array<PersistedReport>;
98
103
  }>>;
99
104
  buildGetScheduledReports(params: RequestParams<nVizzlyApi.GetScheduledReportParams>): Request<{}>;
100
- saveScheduledReport(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Promise<import("../types").Response<{
105
+ saveScheduledReport(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Promise<Response<{
101
106
  report: PersistedReport;
102
107
  }>>;
103
108
  buildSaveScheduledReportRequest(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Request<{}>;
104
- updateDashboard(params: RequestParams<UpdateDashboardParams>): Promise<import("../types").Response<UpdateDashboardResponseBody>>;
109
+ updateDashboard(params: RequestParams<UpdateDashboardParams>): Promise<Response<UpdateDashboardResponseBody>>;
105
110
  buildUpdateDashboardRequest(params: RequestParams<UpdateDashboardParams>): Request<{}>;
106
- updateParentGlobalLibrary(params: RequestParams<nVizzlyApi.UpdateParentGlobalLibraryParams>): Promise<import("../types").Response<unknown>>;
111
+ updateParentGlobalLibrary(params: RequestParams<nVizzlyApi.UpdateParentGlobalLibraryParams>): Promise<Response<unknown>>;
107
112
  buildUpdateParentGlobalLibraryRequest(params: RequestParams<nVizzlyApi.UpdateParentGlobalLibraryParams>): Request<{}>;
108
- updateGlobalLibrary(params: UpdateGlobalLibraryParams): Promise<import("../types").Response<{
113
+ updateGlobalLibrary(params: UpdateGlobalLibraryParams): Promise<Response<{
109
114
  global_library: GlobalLibrary;
110
115
  }>>;
111
116
  buildUpdateGlobalLibraryRequest(params: RequestParams<UpdateGlobalLibraryParams>): Request<{}>;
112
- updateProjectApiKey(params: RequestParams<nVizzlyApi.UpdateProjectApiKeyParams>): Promise<import("../types").Response<unknown>>;
117
+ updateProjectApiKey(params: RequestParams<nVizzlyApi.UpdateProjectApiKeyParams>): Promise<Response<unknown>>;
113
118
  buildUpdateProjectApiKeyRequest(params: RequestParams<nVizzlyApi.UpdateProjectApiKeyParams>): Request<{}>;
114
119
  updateQueryEngineUser(params: RequestParams<nVizzlyApi.UpdateQueryEngineUserParams>): Promise<boolean>;
115
120
  buildUpdateQueryEngineUserRequest(params: RequestParams<nVizzlyApi.UpdateQueryEngineUserParams>): Request<{}>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vizzly/api-client",
3
- "version": "0.0.44",
3
+ "version": "0.0.45",
4
4
  "private": false,
5
5
  "license": "NONE",
6
6
  "source": "src/index.ts",