@vizzly/api-client 0.0.43 → 0.0.45

package/README.md

@@ -1 +1,25 @@
 # Vizzly API client
+
+## Create a parent dashboard
+
+```ts
+import { VizzlyApi, Authentication } from '@vizzly/api-client';
+
+export const createParentDashboard = async () => {
+  const auth = new Authentication({projectApiKey: process.env['VIZZLY_PROJECT_API_KEY']});
+  const vizzlyApi = new VizzlyApi(auth);
+
+  const response = await vizzlyApi.createParentDashboard({
+    name: 'My new parent dashboard'
+  });
+
+  if(response.status === 200) {
+    const { dashboard } = response.body;
+    // dashboard.id
+    // dashboard.name
+  } else {
+    throw "Failed to create a parent dashboard.";
+  }
+};
+
+```

package/dist/models/DashboardRepository.d.ts

@@ -4,6 +4,12 @@ export declare class DashboardRepository {
     private vizzly;
     private repo;
     constructor(vizzly: Vizzly);
+    static EmptyDashboardDefinition(): {
+        componentLibrary: never[];
+        customFields: {};
+        display: never[];
+        globalFilters: never[];
+    };
     createDashboard(createParams: CreateDashboardParams): Promise<{
         dashboard: Dashboard;
         permissions: DashboardPermission[];

package/dist/models/DashboardRepository.js

@@ -23,6 +23,14 @@ class DashboardRepository {
         this.vizzly = vizzly;
         this.repo = new Repository_1.Repository('id');
     }
+    static EmptyDashboardDefinition() {
+        return {
+            componentLibrary: [],
+            customFields: {},
+            display: [],
+            globalFilters: [],
+        };
+    }
     createDashboard(createParams) {
         return __awaiter(this, void 0, void 0, function* () {
             let builtDashboard;

package/dist/models/VizzlyApi.d.ts

@@ -1,6 +1,6 @@
 import { Api } from './Api';
 import { Authentication } from './Authentication';
-import { CreateDashboardParams, CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermissionFromAPI, PersistedReport, QueryEngineUserFromAPI, Request, RequestParams, TeamMemberFromAPI, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
+import { CreateDashboardParams, CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermissionFromAPI, PersistedReport, QueryEngineUserFromAPI, Request, RequestParams, Response, TeamMemberFromAPI, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
 import { nVizzlyApi } from '../types';
 import { ProjectFromAPI } from '../types/project';
 export declare class VizzlyApi extends Api {
@@ -11,7 +11,7 @@ export declare class VizzlyApi extends Api {
     }>;
     fetchGlobalLibraries(params: RequestParams<{
         globalLibraryAccessTokens: string[];
-    }>): Promise<import("../types").Response<{
+    }>): Promise<Response<{
         found: GlobalLibrary[];
         not_found: string[];
     }>>;
@@ -20,7 +20,7 @@ export declare class VizzlyApi extends Api {
     }>): Request<{
         globalLibraryAccessTokens: string[];
     }>;
-    fetchGlobalLibraryAccessTokens(params?: RequestParams): Promise<import("../types").Response<{
+    fetchGlobalLibraryAccessTokens(params?: RequestParams): Promise<Response<{
         global_libraries: GlobalLibrary[];
         permissions: Array<GlobalLibraryPermissionFromAPI>;
     }>>;
@@ -34,9 +34,14 @@ export declare class VizzlyApi extends Api {
     buildFetchDashboardsRequest(params: RequestParams<{
         dashboardSessionAccessTokens: string[];
     }>): Request<{}>;
-    createParentDashboard(params: RequestParams<nVizzlyApi.CreateParentDashboardParams>): Promise<import("../types").Response<unknown>>;
+    createParentDashboard(params: RequestParams<nVizzlyApi.CreateParentDashboardParams>): Promise<Response<{
+        dashboard: {
+            id: string;
+            name: string | null;
+        };
+    }>>;
     buildCreateParentDashboardRequest(params: RequestParams<nVizzlyApi.CreateParentDashboardParams>): Request<{}>;
-    createParentGlobalLibrary(params: RequestParams<nVizzlyApi.CreateParentGlobalLibraryParams>): Promise<import("../types").Response<unknown>>;
+    createParentGlobalLibrary(params: RequestParams<nVizzlyApi.CreateParentGlobalLibraryParams>): Promise<Response<unknown>>;
     buildCreateParentGlobalLibraryRequest(params: RequestParams<nVizzlyApi.CreateParentGlobalLibraryParams>): Request<{}>;
     createGlobalLibrary(params: RequestParams<CreateGlobalLibraryParams>): Promise<{
         global_library: GlobalLibrary;
@@ -47,7 +52,7 @@ export declare class VizzlyApi extends Api {
         projects: Array<ProjectFromAPI>;
     }>;
     buildGetProjectsRequest(params?: RequestParams): Request<{}>;
-    createProjectApiKey(params: RequestParams<nVizzlyApi.CreateProjectApiKeyParams>): Promise<import("../types").Response<{
+    createProjectApiKey(params: RequestParams<nVizzlyApi.CreateProjectApiKeyParams>): Promise<Response<{
         api_key: string;
     }>>;
     buildCreateProjectApiKeyRequest(params: RequestParams<nVizzlyApi.CreateProjectApiKeyParams>): Request<{}>;
@@ -56,23 +61,23 @@ export declare class VizzlyApi extends Api {
     buildCreateSelfHostedDynamicQueryEngineProjectRequest(params?: RequestParams): Request<{}>;
     buildCreateSelfHostedInBrowserProjectRequest(params?: RequestParams): Request<{}>;
     buildCreateSelfHostedProjectRequest(params?: RequestParams): Request<{}>;
-    createManagedQueryEngineProject(params?: RequestParams): Promise<import("../types").Response<unknown>>;
+    createManagedQueryEngineProject(params?: RequestParams): Promise<Response<unknown>>;
     buildCreateManagedQueryEngineProjectRequest(params?: RequestParams): Request<{}>;
-    createVizzlyConfigVersion(params: RequestParams<nVizzlyApi.CreateVizzlyConfigVersionParams>): Promise<import("../types").Response<unknown>>;
+    createVizzlyConfigVersion(params: RequestParams<nVizzlyApi.CreateVizzlyConfigVersionParams>): Promise<Response<unknown>>;
     buildCreateVizzlyConfigVersionRequest(params: RequestParams<nVizzlyApi.CreateVizzlyConfigVersionParams>): Request<{}>;
-    duplicateParentDashboard(params: RequestParams<nVizzlyApi.DuplicateParentDashboardParams>): Promise<import("../types").Response<unknown>>;
+    duplicateParentDashboard(params: RequestParams<nVizzlyApi.DuplicateParentDashboardParams>): Promise<Response<unknown>>;
     buildDuplicateParentDashboardRequest(params: RequestParams<nVizzlyApi.DuplicateParentDashboardParams>): Request<{}>;
     getConnection(params: RequestParams<nVizzlyApi.GetConnectionParams>): Promise<{
         encryptedCredentials: string | null;
     }>;
     buildGetConnectionRequest(params: RequestParams<nVizzlyApi.GetConnectionParams>): Request<{}>;
-    getManagedQueryEngineKeyPair(params: RequestParams<nVizzlyApi.GetManagedQueryEngineKeyPairParams>): Promise<import("../types").Response<unknown>>;
+    getManagedQueryEngineKeyPair(params: RequestParams<nVizzlyApi.GetManagedQueryEngineKeyPairParams>): Promise<Response<unknown>>;
     buildGetManagedQueryEngineKeyPairRequest(params: RequestParams<nVizzlyApi.GetManagedQueryEngineKeyPairParams>): Request<{}>;
     getProject(params: RequestParams<nVizzlyApi.GetProjectParams>): Promise<{
         project: ProjectFromAPI;
     }>;
     buildGetProjectRequest(params: RequestParams<nVizzlyApi.GetProjectParams>): Request<{}>;
-    getProjectAccessToken(params: RequestParams<nVizzlyApi.GetProjectAccessTokenParams>): Promise<import("../types").Response<{
+    getProjectAccessToken(params: RequestParams<nVizzlyApi.GetProjectAccessTokenParams>): Promise<Response<{
         token: {
             max_age: number;
             token: string;
@@ -89,27 +94,27 @@ export declare class VizzlyApi extends Api {
         encryptedConfig: string | null;
     }>;
     buildGetVizzlyConfigRequest(params: RequestParams<nVizzlyApi.GetVizzlyConfigParams>): Request<{}>;
-    saveConnection(params: RequestParams<nVizzlyApi.SaveConnectionParams>): Promise<import("../types").Response<unknown>>;
+    saveConnection(params: RequestParams<nVizzlyApi.SaveConnectionParams>): Promise<Response<unknown>>;
     buildSaveConnectionRequest(params: RequestParams<nVizzlyApi.SaveConnectionParams>): Request<{}>;
     saveEncryptedProjectEncryptionSecret(params: RequestParams<nVizzlyApi.SaveEncryptedProjectEncryptionSecretParams>): Promise<boolean>;
     buildSaveEncryptedProjectEncryptionSecretRequest(params: RequestParams<nVizzlyApi.SaveEncryptedProjectEncryptionSecretParams>): Request<{}>;
-    getScheduledReports(params: RequestParams<nVizzlyApi.GetScheduledReportParams>): Promise<import("../types").Response<{
+    getScheduledReports(params: RequestParams<nVizzlyApi.GetScheduledReportParams>): Promise<Response<{
         reports: Array<PersistedReport>;
     }>>;
     buildGetScheduledReports(params: RequestParams<nVizzlyApi.GetScheduledReportParams>): Request<{}>;
-    saveScheduledReport(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Promise<import("../types").Response<{
+    saveScheduledReport(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Promise<Response<{
         report: PersistedReport;
     }>>;
     buildSaveScheduledReportRequest(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Request<{}>;
-    updateDashboard(params: RequestParams<UpdateDashboardParams>): Promise<import("../types").Response<UpdateDashboardResponseBody>>;
+    updateDashboard(params: RequestParams<UpdateDashboardParams>): Promise<Response<UpdateDashboardResponseBody>>;
     buildUpdateDashboardRequest(params: RequestParams<UpdateDashboardParams>): Request<{}>;
-    updateParentGlobalLibrary(params: RequestParams<nVizzlyApi.UpdateParentGlobalLibraryParams>): Promise<import("../types").Response<unknown>>;
+    updateParentGlobalLibrary(params: RequestParams<nVizzlyApi.UpdateParentGlobalLibraryParams>): Promise<Response<unknown>>;
     buildUpdateParentGlobalLibraryRequest(params: RequestParams<nVizzlyApi.UpdateParentGlobalLibraryParams>): Request<{}>;
-    updateGlobalLibrary(params: UpdateGlobalLibraryParams): Promise<import("../types").Response<{
+    updateGlobalLibrary(params: UpdateGlobalLibraryParams): Promise<Response<{
         global_library: GlobalLibrary;
     }>>;
     buildUpdateGlobalLibraryRequest(params: RequestParams<UpdateGlobalLibraryParams>): Request<{}>;
-    updateProjectApiKey(params: RequestParams<nVizzlyApi.UpdateProjectApiKeyParams>): Promise<import("../types").Response<unknown>>;
+    updateProjectApiKey(params: RequestParams<nVizzlyApi.UpdateProjectApiKeyParams>): Promise<Response<unknown>>;
     buildUpdateProjectApiKeyRequest(params: RequestParams<nVizzlyApi.UpdateProjectApiKeyParams>): Request<{}>;
     updateQueryEngineUser(params: RequestParams<nVizzlyApi.UpdateQueryEngineUserParams>): Promise<boolean>;
     buildUpdateQueryEngineUserRequest(params: RequestParams<nVizzlyApi.UpdateQueryEngineUserParams>): Request<{}>;

package/dist/models/VizzlyApi.js

@@ -19,6 +19,7 @@ const FailedToFetchProject_1 = require("../errors/FailedToFetchProject");
 const FailedToUpdateQueryEngineUser_1 = require("../errors/FailedToUpdateQueryEngineUser");
 const FailedToSaveProjectEncryptedEncryptionSecret_1 = require("../errors/FailedToSaveProjectEncryptedEncryptionSecret");
 const ProjectEncryptedSecretAlreadySaved_1 = require("../errors/ProjectEncryptedSecretAlreadySaved");
+const DashboardRepository_1 = require("./DashboardRepository");
 class VizzlyApi extends Api_1.Api {
     constructor(auth, host = 'https://api.vizzly.co') {
         super(auth, host);
@@ -71,7 +72,7 @@ class VizzlyApi extends Api_1.Api {
             method: 'post',
             body: {
                 dashboardAccessToken: this.auth.getDashboardAccessToken(),
-                definition: params.definition,
+                definition: params.definition || DashboardRepository_1.DashboardRepository.EmptyDashboardDefinition(),
                 meta: params.metadata || params.meta || {},
                 parentDashboardId: params.parentDashboardId,
                 permissions: params.permissions,
@@ -100,7 +101,8 @@ class VizzlyApi extends Api_1.Api {
             method: 'post',
             body: {
                 projectId: params.projectId,
-                definition: params.definition,
+                definition: params.definition || DashboardRepository_1.DashboardRepository.EmptyDashboardDefinition(),
+                name: params.name,
             },
             abortSignal: params.abortSignal,
         };
@@ -468,6 +470,7 @@ class VizzlyApi extends Api_1.Api {
                 definition: params.definition,
                 meta: params.metadata || params.meta || {},
                 deleted: params.deleted,
+                name: params.name,
             },
             abortSignal: params.abortSignal,
         };

package/dist/models/VizzlyQueryEngineApi.js

@@ -15,6 +15,7 @@ const SQLPreviewError_1 = require("../errors/SQLPreviewError");
 const FailedToResolveDataSets_1 = require("../errors/FailedToResolveDataSets");
 const FailedToSetupProject_1 = require("../errors/FailedToSetupProject");
 const errors_1 = require("../errors");
+const DashboardRepository_1 = require("./DashboardRepository");
 class VizzlyQueryEngineApi extends Api_1.Api {
     constructor(auth, host, extraHeaders) {
         super(auth, host, extraHeaders);
@@ -26,7 +27,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
             abortSignal: params.abortSignal,
             body: {
                 dashboardAccessToken: this.auth.getDashboardAccessToken(),
-                definition: params.definition,
+                definition: params.definition || DashboardRepository_1.DashboardRepository.EmptyDashboardDefinition(),
                 meta: params.metadata || params.meta || {},
                 parentDashboardId: params.parentDashboardId,
                 permissions: params.permissions,
@@ -375,6 +376,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
                 definition: params.definition,
                 meta: params.metadata || params.meta || {},
                 deleted: params.deleted,
+                name: params.name,
             },
         };
     }

package/dist/types.d.ts

@@ -48,7 +48,7 @@ export type CreateGlobalLibraryParams = {
     }>;
 };
 export type CreateDashboardParams = {
-    definition: DashboardDefinition | string;
+    definition?: DashboardDefinition | string;
     /** @deprecated - use `metadata` instead */
     meta?: any;
     metadata?: any;
@@ -65,6 +65,7 @@ export type UpdateDashboardParams = {
     meta?: any;
     metadata?: any;
     deleted?: boolean;
+    name?: string;
 };
 export type APIs = {
     vizzlyApi: VizzlyApi;
@@ -138,8 +139,10 @@ export declare namespace nVizzlyApi {
         dashboardAccessToken: string;
     };
     type CreateParentDashboardParams = {
-        definition: any;
-        projectId: string;
+        definition?: any;
+        name?: string;
+        /** Optional, only when using project API key for auth. */
+        projectId?: string;
     };
     type CreateParentGlobalLibraryParams = {
         library: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vizzly/api-client",
-  "version": "0.0.43",
+  "version": "0.0.45",
   "private": false,
   "license": "NONE",
   "source": "src/index.ts",