@vizzly/api-client 0.0.55 → 0.0.56

package/dist/models/VizzlyApi.d.ts

@@ -48,10 +48,14 @@ export declare class VizzlyApi extends Api {
         permissions: Array<GlobalLibraryPermissionFromAPI>;
     }>;
     buildCreateGlobalLibraryRequest(params: RequestParams<CreateGlobalLibraryParams>): Request<{}>;
-    getProjects(params?: RequestParams): Promise<{
+    getProjects(params?: RequestParams<{
+        withParentDashboards?: boolean;
+    }>): Promise<{
         projects: Array<ProjectFromAPI>;
     }>;
-    buildGetProjectsRequest(params?: RequestParams): Request<{}>;
+    buildGetProjectsRequest(params?: RequestParams<{
+        withParentDashboards?: boolean;
+    }>): Request<{}>;
     createProjectApiKey(params: RequestParams<nVizzlyApi.CreateProjectApiKeyParams>): Promise<Response<{
         api_key: string;
     }>>;

package/dist/models/VizzlyApi.js

@@ -156,8 +156,9 @@ class VizzlyApi extends Api_1.Api {
         });
     }
     buildGetProjectsRequest(params) {
+        const queryString = (params === null || params === void 0 ? void 0 : params.withParentDashboards) ? '?with_parent_dashboards=true' : '';
         return {
-            path: `/api/v2/projects`,
+            path: `/api/v2/projects${queryString}`,
             method: 'get',
             abortSignal: params === null || params === void 0 ? void 0 : params.abortSignal,
         };
@@ -262,7 +263,7 @@ class VizzlyApi extends Api_1.Api {
                 dashboardIds: params.dashboardIds,
             },
             abortSignal: params.abortSignal,
-            acceptedAuthParams: ['projectApiKey']
+            acceptedAuthParams: ['projectApiKey'],
         };
     }
     /**
@@ -329,8 +330,9 @@ class VizzlyApi extends Api_1.Api {
         });
     }
     buildGetProjectRequest(params) {
+        const queryString = params.withParentDashboards ? '?with_parent_dashboards=true' : '';
         return {
-            path: `/api/v3/project/${params.projectId}`,
+            path: `/api/v3/project/${params.projectId}${queryString}`,
             method: 'get',
             abortSignal: params.abortSignal,
             acceptedAuthParams: ['projectApiKey', 'projectAccessToken', 'appSessionToken'],

package/dist/models/VizzlyQueryEngineApi.js

@@ -448,7 +448,7 @@ class VizzlyQueryEngineApi extends Api_1.Api {
             body: {
                 company: { id: params.companyId },
             },
-            acceptedAuthParams: ['queryEngineApiKey']
+            acceptedAuthParams: ['queryEngineApiKey'],
         };
     }
 }

package/dist/types/project.d.ts

@@ -8,7 +8,13 @@ export type ProjectFromAPI = {
     type: ProjectType;
     created_at: Date;
     share_links?: ShareLink[];
-    parent_dashboards: DashboardFromAPI[];
+    /**
+     * To include parent dashboards, use the withParentDashboards param.
+     * However only do this when strictly necessary as it inceases
+     * load on the Vizzly API for projects that create many parent dashboards, like
+     * the GTi next gen application.
+     * */
+    parent_dashboards: DashboardFromAPI[] | null;
     parent_global_libraries: GlobalLibrary[];
     key_pairs: RawKeyPair[];
     encrypted_encryption_secret: string | null;

package/dist/types.d.ts

@@ -220,6 +220,7 @@ export declare namespace nVizzlyApi {
     };
     type GetProjectParams = {
         projectId: string;
+        withParentDashboards?: boolean;
     };
     type GetManagedQueryEngineKeyPairParams = {
         managedProjectId: string;

package/package.json

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