Feat/api expansion

examples/async-export-report.ts

@@ -0,0 +1,37 @@
+import { config } from "dotenv";
+import { CxReportsClient } from "../src/v1/CxReportsClient.js";
+import { DocumentFileFormat } from "../src/v1/models/DocumentFileFormat.js";
+
+config();
+
+if (!process.env.BASE_URL || !process.env.AUTH_TOKEN)
+  throw new Error("Missing required environment variables");
+
+if (!process.env.DEFAULT_REPORT_ID)
+  throw new Error("Missing report ID environment variable");
+
+let client = new CxReportsClient({
+  baseUrl: process.env.BASE_URL,
+  authToken: process.env.AUTH_TOKEN,
+  defaultWorkspaceId: process.env.DEFAULT_WORKSPACE_ID,
+});
+
+try {
+  let reportId: number = parseInt(process.env.DEFAULT_REPORT_ID);
+  let exportResponse = await client.startAsyncExport({
+    reportId,
+    body: {
+      format: DocumentFileFormat.pdf,
+      includeAttachments: false,
+    },
+  });
+
+  console.log("Export started with ID:", exportResponse.temporaryFileId);
+
+  let status = await client.getExportStatus({
+    tempFileId: exportResponse.temporaryFileId,
+  });
+  console.log("Export status:", status);
+} catch (error) {
+  console.error(error);
+}

examples/build-preview-url.ts

@@ -4,7 +4,11 @@ import { CxReportsClient } from "../src/v1/CxReportsClient.js";
 
 config();
 
-if (!process.env.BASE_URL || !process.env.AUTH_TOKEN)
+if (
+  !process.env.BASE_URL ||
+  !process.env.AUTH_TOKEN ||
+  !process.env.DEFAULT_REPORT_ID
+)
   throw new Error("Missing required environment variables");
 
 let client = new CxReportsClient({
@@ -15,6 +19,7 @@ let client = new CxReportsClient({
 });
 
 try {
+  let reportId = parseInt(process.env.DEFAULT_REPORT_ID);
   let { nonce } = await client.createNonceAuthToken();
   console.log("NONCE", nonce);
 
@@ -24,7 +29,7 @@ try {
   console.table(tempDataId);
 
   let previewUrl = client.getReportPreviewURL({
-    reportId: 18620,
+    reportId: reportId,
     nonce,
     tempDataId,
     //params: { abc: "test" },

examples/check-job-run-status.ts

@@ -0,0 +1,33 @@
+import { config } from "dotenv";
+import { CxReportsClient } from "../src/v1/CxReportsClient.js";
+
+config();
+
+if (!process.env.BASE_URL || !process.env.AUTH_TOKEN)
+  throw new Error("Missing required environment variables");
+
+if (!process.env.DEFAULT_JOB_ID)
+  throw new Error("Missing job ID environment variable");
+
+if (!process.env.DEFAULT_JOB_RUN_ID)
+  throw new Error("Missing job run ID environment variable");
+
+let client = new CxReportsClient({
+  baseUrl: process.env.BASE_URL,
+  authToken: process.env.AUTH_TOKEN,
+  defaultWorkspaceId: process.env.DEFAULT_WORKSPACE_ID,
+});
+
+try {
+  let jobId: number = parseInt(process.env.DEFAULT_JOB_ID);
+  let jobRunId: number = parseInt(process.env.DEFAULT_JOB_RUN_ID);
+
+  let status = await client.getJobRunStatus({
+    jobId,
+    jobRunId,
+  });
+
+  console.log("Job run status:", status);
+} catch (error) {
+  console.error(error);
+}

examples/fetch-jobs.ts

@@ -0,0 +1,20 @@
+import { config } from "dotenv";
+import { CxReportsClient } from "../src/v1/CxReportsClient.js";
+
+config();
+
+if (!process.env.BASE_URL || !process.env.AUTH_TOKEN)
+  throw new Error("Missing required environment variables");
+
+let client = new CxReportsClient({
+  baseUrl: process.env.BASE_URL,
+  authToken: process.env.AUTH_TOKEN,
+  defaultWorkspaceId: process.env.DEFAULT_WORKSPACE_ID,
+});
+
+try {
+  let jobs = await client.getJobs({});
+  console.table(jobs);
+} catch (error) {
+  console.error(error);
+}

examples/fetch-report-pages.ts

@@ -0,0 +1,24 @@
+import { config } from "dotenv";
+import { CxReportsClient } from "../src/v1/CxReportsClient.js";
+
+config();
+
+if (!process.env.BASE_URL || !process.env.AUTH_TOKEN)
+  throw new Error("Missing required environment variables");
+
+if (!process.env.DEFAULT_REPORT_ID)
+  throw new Error("Missing report ID environment variable");
+
+let client = new CxReportsClient({
+  baseUrl: process.env.BASE_URL,
+  authToken: process.env.AUTH_TOKEN,
+  defaultWorkspaceId: process.env.DEFAULT_WORKSPACE_ID,
+});
+
+try {
+  let reportId: number = parseInt(process.env.DEFAULT_REPORT_ID);
+  let pages = await client.getReportPages({ reportId });
+  console.table(pages);
+} catch (error) {
+  console.error(error);
+}

examples/fetch-report-types.ts

@@ -0,0 +1,20 @@
+import { config } from "dotenv";
+import { CxReportsClient } from "../src/v1/CxReportsClient.js";
+
+config();
+
+if (!process.env.BASE_URL || !process.env.AUTH_TOKEN)
+  throw new Error("Missing required environment variables");
+
+let client = new CxReportsClient({
+  baseUrl: process.env.BASE_URL,
+  authToken: process.env.AUTH_TOKEN,
+  defaultWorkspaceId: process.env.DEFAULT_WORKSPACE_ID,
+});
+
+try {
+  let reportTypes = await client.getReportTypes({});
+  console.table(reportTypes);
+} catch (error) {
+  console.error(error);
+}

examples/nonce-token.ts

@@ -0,0 +1,21 @@
+import { config } from "dotenv";
+import { CxReportsClient } from "../src/v1/CxReportsClient.js";
+
+config();
+
+if (!process.env.BASE_URL || !process.env.AUTH_TOKEN)
+  throw new Error("Missing required environment variables");
+
+let client = new CxReportsClient({
+  baseUrl: process.env.BASE_URL,
+  authToken: process.env.AUTH_TOKEN,
+  defaultWorkspaceId: process.env.DEFAULT_WORKSPACE_ID,
+});
+
+try {
+  let nonceToken = await client.createNonceAuthToken();
+  console.log("Nonce token created successfully");
+  console.log("Token:", nonceToken.nonce);
+} catch (error) {
+  console.error(error);
+}

examples/start-job-run.ts

@@ -0,0 +1,29 @@
+import { config } from "dotenv";
+import { CxReportsClient } from "../src/v1/CxReportsClient.js";
+
+config();
+
+if (!process.env.BASE_URL || !process.env.AUTH_TOKEN)
+  throw new Error("Missing required environment variables");
+
+if (!process.env.DEFAULT_JOB_ID)
+  throw new Error("Missing job ID environment variable");
+
+let client = new CxReportsClient({
+  baseUrl: process.env.BASE_URL,
+  authToken: process.env.AUTH_TOKEN,
+  defaultWorkspaceId: process.env.DEFAULT_WORKSPACE_ID,
+});
+
+try {
+  let jobId: number = parseInt(process.env.DEFAULT_JOB_ID);
+  let jobRun = await client.startNewJobRun({
+    jobId,
+    body: {},
+  });
+
+  console.log("Job run started with ID:", jobRun.jobRunId);
+  console.log("Job run details:", jobRun);
+} catch (error) {
+  console.error(error);
+}

package.json

@@ -16,7 +16,14 @@
     "test": "jest",
     "example:fetch-reports": "tsx examples/fetch-reports.ts",
     "example:build-preview-url": "tsx examples/build-preview-url.ts",
-    "example:download-pdf": "tsx examples/download-pdf.ts"
+    "example:download-pdf": "tsx examples/download-pdf.ts",
+    "example:async-export-report": "tsx examples/async-export-report.ts",
+    "example:check-job-run-status": "tsx examples/check-job-run-status.ts",
+    "example:fetch-jobs": "tsx examples/fetch-jobs.ts",
+    "example:fetch-report-pages": "tsx examples/fetch-report-pages.ts",
+    "example:fetch-report-types": "tsx examples/fetch-report-types.ts",
+    "example:nonce-token": "tsx examples/nonce-token.ts",
+    "example:start-job-run": "tsx examples/start-job-run.ts"
   },
   "repository": {
     "type": "git",