@vizzly/api-client 0.0.53 → 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;
     }>>;
@@ -65,7 +69,24 @@ export declare class VizzlyApi extends Api {
     buildCreateManagedQueryEngineProjectRequest(params?: RequestParams): Request<{}>;
     createVizzlyConfigVersion(params: RequestParams<nVizzlyApi.CreateVizzlyConfigVersionParams>): Promise<Response<unknown>>;
     buildCreateVizzlyConfigVersionRequest(params: RequestParams<nVizzlyApi.CreateVizzlyConfigVersionParams>): Request<{}>;
+    duplicateDashboards(params: RequestParams<nVizzlyApi.DuplicateDashboardParams>): Promise<Response<{
+        copies: {
+            [copiedDashboardId: string]: {
+                id: string;
+                name: string;
+            };
+        };
+    }>>;
+    buildDuplicateDashboardsRequest(params: RequestParams<nVizzlyApi.DuplicateDashboardParams>): Request<{
+        dashboardIds: string[];
+    }>;
+    /**
+     * @deprecated
+     */
     duplicateParentDashboard(params: RequestParams<nVizzlyApi.DuplicateParentDashboardParams>): Promise<Response<unknown>>;
+    /**
+     * @deprecated
+     */
     buildDuplicateParentDashboardRequest(params: RequestParams<nVizzlyApi.DuplicateParentDashboardParams>): Request<{}>;
     getConnection(params: RequestParams<nVizzlyApi.GetConnectionParams>): Promise<{
         encryptedCredentials: string | null;

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,
         };
@@ -249,11 +250,33 @@ class VizzlyApi extends Api_1.Api {
             abortSignal: params.abortSignal,
         };
     }
+    duplicateDashboards(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildDuplicateDashboardsRequest(params));
+        });
+    }
+    buildDuplicateDashboardsRequest(params) {
+        return {
+            path: `/api/v2/duplicate-dashboards`,
+            method: 'post',
+            body: {
+                dashboardIds: params.dashboardIds,
+            },
+            abortSignal: params.abortSignal,
+            acceptedAuthParams: ['projectApiKey'],
+        };
+    }
+    /**
+     * @deprecated
+     */
     duplicateParentDashboard(params) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.execute(this.buildDuplicateParentDashboardRequest(params));
         });
     }
+    /**
+     * @deprecated
+     */
     buildDuplicateParentDashboardRequest(params) {
         return {
             path: `/api/v2/duplicate-parent-dashboard`,
@@ -307,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

@@ -52,7 +52,6 @@ export type CreateGlobalLibraryParams = {
     usage_metadata?: FieldUsage;
 };
 export type FieldUsage = {
-    lowest_date_granularity_function: string | null;
     fields: Array<{
         data_set_id: string;
         field_id: string;
@@ -221,6 +220,7 @@ export declare namespace nVizzlyApi {
     };
     type GetProjectParams = {
         projectId: string;
+        withParentDashboards?: boolean;
     };
     type GetManagedQueryEngineKeyPairParams = {
         managedProjectId: string;
@@ -232,6 +232,9 @@ export declare namespace nVizzlyApi {
     type DuplicateParentDashboardParams = {
         dashboardId: string;
     };
+    type DuplicateDashboardParams = {
+        dashboardIds: string[];
+    };
     type CreateVizzlyConfigVersionParams = {
         projectId: string;
         encryptedConfig: string;

package/package.json

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