@vizzly/api-client 0.0.39 → 0.0.41

package/dist/models/VizzlyApi.d.ts

@@ -1,6 +1,6 @@
 import { Api } from './Api';
 import { Authentication } from './Authentication';
-import { CreateDashboardParams, CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermissionFromAPI, QueryEngineUserFromAPI, Request, RequestParams, TeamMemberFromAPI, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
+import { CreateDashboardParams, CreateGlobalLibraryParams, GlobalLibrary, GlobalLibraryPermissionFromAPI, PersistedReport, QueryEngineUserFromAPI, Request, RequestParams, TeamMemberFromAPI, UpdateDashboardParams, UpdateDashboardResponseBody, UpdateGlobalLibraryParams } from '../types';
 import { nVizzlyApi } from '../types';
 import { ProjectFromAPI } from '../types/project';
 export declare class VizzlyApi extends Api {
@@ -93,7 +93,13 @@ export declare class VizzlyApi extends Api {
     buildSaveConnectionRequest(params: RequestParams<nVizzlyApi.SaveConnectionParams>): Request<{}>;
     saveEncryptedProjectEncryptionSecret(params: RequestParams<nVizzlyApi.SaveEncryptedProjectEncryptionSecretParams>): Promise<boolean>;
     buildSaveEncryptedProjectEncryptionSecretRequest(params: RequestParams<nVizzlyApi.SaveEncryptedProjectEncryptionSecretParams>): Request<{}>;
-    saveScheduledReport(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Promise<import("../types").Response<unknown>>;
+    getScheduledReports(params: RequestParams<nVizzlyApi.GetScheduledReportParams>): Promise<import("../types").Response<{
+        reports: Array<PersistedReport>;
+    }>>;
+    buildGetScheduledReports(params: RequestParams<nVizzlyApi.GetScheduledReportParams>): Request<{}>;
+    saveScheduledReport(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Promise<import("../types").Response<{
+        report: PersistedReport;
+    }>>;
     buildSaveScheduledReportRequest(params: RequestParams<nVizzlyApi.SaveScheduledReportParams>): Request<{}>;
     updateDashboard(params: RequestParams<UpdateDashboardParams>): Promise<import("../types").Response<UpdateDashboardResponseBody>>;
     buildUpdateDashboardRequest(params: RequestParams<UpdateDashboardParams>): Request<{}>;

package/dist/models/VizzlyApi.js

@@ -422,6 +422,21 @@ class VizzlyApi extends Api_1.Api {
             acceptedAuthParams: ['projectApiKey', 'projectAccessToken'],
         };
     }
+    getScheduledReports(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildGetScheduledReports(params));
+        });
+    }
+    buildGetScheduledReports(params) {
+        return {
+            path: '/api/scheduled-report/collect',
+            method: 'post',
+            body: {
+                dashboardAccessToken: params.dashboardAccessToken,
+            },
+            abortSignal: params.abortSignal,
+        };
+    }
     saveScheduledReport(params) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.execute(this.buildSaveScheduledReportRequest(params));
@@ -433,7 +448,7 @@ class VizzlyApi extends Api_1.Api {
             method: 'post',
             body: {
                 cronSchedule: params.cronSchedule,
-                dashboardAccessToken: this.auth.getDashboardAccessToken(),
+                dashboardAccessToken: params.dashboardAccessToken,
                 scheduledReportId: params.scheduledReportId,
             },
             abortSignal: params.abortSignal,

package/dist/models/VizzlyAppApi.d.ts

@@ -41,6 +41,19 @@ export declare class VizzlyAppApi extends Api {
     buildStartSignInRequest(params: nVizzlyAppApi.StartSignInParams): Request<{}>;
     completeSignIn(params: nVizzlyAppApi.CompleteSignInParams): Promise<import("../types").Response<unknown>>;
     buildCompleteSignInRequest(params: nVizzlyAppApi.CompleteSignInParams): Request<{}>;
+    searchUserDashboards(params: nVizzlyAppApi.SearchUserDashboardsParams): Promise<import("../types").Response<{
+        search_results: Array<{
+            id: string;
+            parent_dashboard_id: string | null;
+            parent_dashboard_name: string | null;
+            scope: 'read' | 'read_write';
+            user_reference: string;
+            permission_created_at: string;
+            dashboard_created_at: string;
+            dashboard_updated_at: string;
+        }>;
+    }>>;
+    buildSearchUserDashboardsRequest(params: nVizzlyAppApi.SearchUserDashboardsParams): Request<{}>;
     signUp(params: nVizzlyAppApi.SignUpParams): Promise<import("../types").Response<unknown>>;
     buildSignUpRequest(params: nVizzlyAppApi.SignUpParams): Request<{}>;
     switchOrganisation(params: nVizzlyAppApi.SwitchOrganisationParams): Promise<import("../types").Response<unknown>>;

package/dist/models/VizzlyAppApi.js

@@ -266,6 +266,17 @@ class VizzlyAppApi extends Api_1.Api {
             },
         };
     }
+    searchUserDashboards(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.execute(this.buildSearchUserDashboardsRequest(params));
+        });
+    }
+    buildSearchUserDashboardsRequest(params) {
+        return {
+            path: `/api/v2/project/${params.projectId}/search-user-dashboards?user_reference=${params.userReference}`,
+            method: 'get',
+        };
+    }
     signUp(params) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.execute(this.buildSignUpRequest(params));

package/dist/types.d.ts

@@ -11,6 +11,14 @@ export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export type UpdateDashboardResponseBody = {
     dashboard: DashboardFromAPI;
 };
+export type PersistedReport = {
+    id: string;
+    dashboard_id: string;
+    organisation_id: string;
+    schedule: string;
+    type: 'scheduled';
+    user_reference: string;
+};
 export type Response<T> = {
     status: number;
     headers: Headers;
@@ -126,6 +134,9 @@ export declare namespace nVizzlyQueryEngine {
     };
 }
 export declare namespace nVizzlyApi {
+    type GetScheduledReportParams = {
+        dashboardAccessToken: string;
+    };
     type CreateParentDashboardParams = {
         definition: any;
         projectId: string;
@@ -155,7 +166,8 @@ export declare namespace nVizzlyApi {
         name?: string;
     };
     type SaveScheduledReportParams = {
-        cronSchedule: string;
+        dashboardAccessToken: string;
+        cronSchedule: string | null;
         scheduledReportId: string;
     };
     type SaveEncryptedProjectEncryptionSecretParams = {
@@ -204,6 +216,10 @@ export declare namespace nVizzlyApi {
     };
 }
 export declare namespace nVizzlyAppApi {
+    type SearchUserDashboardsParams = {
+        projectId: string;
+        userReference: string;
+    };
     type CreateInstantDashboardParams = {
         definition: Object;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vizzly/api-client",
-  "version": "0.0.39",
+  "version": "0.0.41",
   "private": false,
   "license": "NONE",
   "source": "src/index.ts",
@@ -25,7 +25,8 @@
     "uuid": "^9.0.1"
   },
   "scripts": {
-    "test": "jest",
+    "test": ". ./secrets.env && jest",
+    "test:ci": "jest",
     "build": "rm -rf ./dist && tsc",
     "dev": "tsc -w",
     "format": "prettier --write ./src/** ./__tests__/**",