@connectedxm/admin 6.25.0 → 6.26.0

package/dist/index.js

@@ -17927,6 +17927,33 @@ var useGetCustomReport = (reportId, options = {}) => {
   );
 };
 
+// src/queries/reports/useGetCustomReportSchedule.ts
+var CUSTOM_REPORT_SCHEDULE_QUERY_KEY = (reportId) => [
+  ...CUSTOM_REPORT_QUERY_KEY(reportId),
+  "schedule"
+];
+var SET_CUSTOM_REPORT_SCHEDULE_QUERY_DATA = (client, keyParams, response) => {
+  client.setQueryData(CUSTOM_REPORT_SCHEDULE_QUERY_KEY(...keyParams), response);
+};
+var GetCustomReportSchedule = async ({
+  reportId,
+  adminApiParams
+}) => {
+  const adminApi = await GetAdminAPI(adminApiParams);
+  const { data } = await adminApi.get(`/reports/custom/${reportId}/schedule`);
+  return data;
+};
+var useGetCustomReportSchedule = (reportId, options = {}) => {
+  return useConnectedSingleQuery(
+    CUSTOM_REPORT_SCHEDULE_QUERY_KEY(reportId),
+    (params) => GetCustomReportSchedule({ reportId, ...params }),
+    {
+      ...options,
+      enabled: !!reportId && (options?.enabled ?? true)
+    }
+  );
+};
+
 // src/queries/reports/useGetReport.ts
 var REPORT_QUERY_KEY = (standard, filters = {}) => ["REPORT", standard, ...Object.values(filters)];
 var SET_REPORT_QUERY_DATA = (client, keyParams, response) => {
@@ -36125,6 +36152,25 @@ var useDeleteCustomReport = (options = {}) => {
   return useConnectedMutation(DeleteCustomReport, options);
 };
 
+// src/mutations/reports/useDeleteCustomReportSchedule.ts
+var DeleteCustomReportSchedule = async ({
+  reportId,
+  adminApiParams,
+  queryClient
+}) => {
+  const connectedXM = await GetAdminAPI(adminApiParams);
+  const { data } = await connectedXM.delete(`/reports/custom/${reportId}/schedule`);
+  if (queryClient && data.status === "ok") {
+    queryClient.invalidateQueries({
+      queryKey: CUSTOM_REPORT_SCHEDULE_QUERY_KEY(reportId)
+    });
+  }
+  return data;
+};
+var useDeleteCustomReportSchedule = (options = {}) => {
+  return useConnectedMutation(DeleteCustomReportSchedule, options);
+};
+
 // src/mutations/reports/useExportCustomReport.ts
 var ExportCustomReport = async ({
   reportId,
@@ -36173,6 +36219,24 @@ var useUpdateCustomReport = (options = {}) => {
   return useConnectedMutation(UpdateCustomReport, options);
 };
 
+// src/mutations/reports/useUpsertCustomReportSchedule.ts
+var UpsertCustomReportSchedule = async ({
+  reportId,
+  schedule,
+  adminApiParams,
+  queryClient
+}) => {
+  const connectedXM = await GetAdminAPI(adminApiParams);
+  const { data } = await connectedXM.post(`/reports/custom/${reportId}/schedule`, schedule);
+  if (queryClient && data.status === "ok") {
+    SET_CUSTOM_REPORT_SCHEDULE_QUERY_DATA(queryClient, [reportId], data);
+  }
+  return data;
+};
+var useUpsertCustomReportSchedule = (options = {}) => {
+  return useConnectedMutation(UpsertCustomReportSchedule, options);
+};
+
 // src/mutations/reports/users/useAddCustomReportUser.ts
 var AddCustomReportUser = async ({
   reportId,
@@ -39731,6 +39795,7 @@ export {
   CUSTOM_MODULE_TRANSLATION_QUERY_KEY,
   CUSTOM_REPORTS_QUERY_KEY,
   CUSTOM_REPORT_QUERY_KEY,
+  CUSTOM_REPORT_SCHEDULE_QUERY_KEY,
   CUSTOM_REPORT_USERS_QUERY_KEY,
   CacheIndividualQueries,
   CalculateDuration,
@@ -39897,6 +39962,7 @@ export {
   DeleteCustomModule,
   DeleteCustomModuleTranslation,
   DeleteCustomReport,
+  DeleteCustomReportSchedule,
   DeleteDashboard,
   DeleteDashboardWidget,
   DeleteEvent,
@@ -40395,6 +40461,7 @@ export {
   GetCustomModuleTranslations,
   GetCustomModules,
   GetCustomReport,
+  GetCustomReportSchedule,
   GetCustomReportUsers,
   GetCustomReports,
   GetDashboard,
@@ -41166,6 +41233,7 @@ export {
   SET_CUSTOM_MODULE_TRANSLATION_QUERY_DATA,
   SET_CUSTOM_REPORTS_QUERY_DATA,
   SET_CUSTOM_REPORT_QUERY_DATA,
+  SET_CUSTOM_REPORT_SCHEDULE_QUERY_DATA,
   SET_CUSTOM_REPORT_USERS_QUERY_DATA,
   SET_DASHBOARDS_QUERY_DATA,
   SET_DASHBOARD_ATTRIBUTES_QUERY_DATA,
@@ -41862,6 +41930,7 @@ export {
   UpdateVideo,
   UploadFile,
   UploadVideoCaptions,
+  UpsertCustomReportSchedule,
   UpsertLinkPreview,
   UserRole,
   VIDEOS_QUERY_KEY,
@@ -42106,6 +42175,7 @@ export {
   useDeleteCustomModule,
   useDeleteCustomModuleTranslation,
   useDeleteCustomReport,
+  useDeleteCustomReportSchedule,
   useDeleteDashboard,
   useDeleteDashboardWidget,
   useDeleteEvent,
@@ -42348,6 +42418,7 @@ export {
   useGetCustomModuleTranslations,
   useGetCustomModules,
   useGetCustomReport,
+  useGetCustomReportSchedule,
   useGetCustomReportUsers,
   useGetCustomReports,
   useGetDashboard,
@@ -43072,6 +43143,7 @@ export {
   useUpdateVideo,
   useUploadFile,
   useUploadVideoCaptions,
+  useUpsertCustomReportSchedule,
   useUpsertLinkPreview,
   useVerifyOrganizationWebhook,
   useVoidInvoice

package/openapi.json

@@ -76245,6 +76245,181 @@
         ]
       }
     },
+    "/reports/custom/{reportId}/schedule": {
+      "get": {
+        "operationId": "GetCustomReportSchedule",
+        "summary": "Get Custom Report Schedule",
+        "description": "Get Custom Report Schedule endpoint",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "reportId",
+            "schema": {
+              "type": "string"
+            },
+            "description": "The report identifier",
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "status": {
+                      "type": "string",
+                      "enum": [
+                        "ok"
+                      ]
+                    },
+                    "message": {
+                      "type": "string",
+                      "example": "Success message."
+                    },
+                    "data": {
+                      "allOf": [
+                        {
+                          "$ref": "#/components/schemas/CustomReportSchedule"
+                        }
+                      ],
+                      "nullable": true
+                    }
+                  },
+                  "required": [
+                    "status",
+                    "message",
+                    "data"
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Reports"
+        ]
+      },
+      "post": {
+        "operationId": "UpsertCustomReportSchedule",
+        "summary": "Upsert Custom Report Schedule",
+        "description": "Upsert Custom Report Schedule endpoint",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "reportId",
+            "schema": {
+              "type": "string"
+            },
+            "description": "The report identifier",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CustomReportScheduleInputs"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "status": {
+                      "type": "string",
+                      "enum": [
+                        "ok"
+                      ]
+                    },
+                    "message": {
+                      "type": "string",
+                      "example": "Success message."
+                    },
+                    "data": {
+                      "$ref": "#/components/schemas/CustomReportSchedule"
+                    }
+                  },
+                  "required": [
+                    "status",
+                    "message",
+                    "data"
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Reports"
+        ]
+      },
+      "delete": {
+        "operationId": "DeleteCustomReportSchedule",
+        "summary": "Delete Custom Report Schedule",
+        "description": "Delete Custom Report Schedule endpoint",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "reportId",
+            "schema": {
+              "type": "string"
+            },
+            "description": "The report identifier",
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "status": {
+                      "type": "string",
+                      "enum": [
+                        "ok"
+                      ]
+                    },
+                    "message": {
+                      "type": "string",
+                      "example": "Success message."
+                    },
+                    "data": {
+                      "allOf": [
+                        {
+                          "$ref": "#/components/schemas/CustomReportSchedule"
+                        }
+                      ],
+                      "nullable": true
+                    }
+                  },
+                  "required": [
+                    "status",
+                    "message",
+                    "data"
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "tags": [
+          "Reports"
+        ]
+      }
+    },
     "/reports/custom/{reportId}/users": {
       "get": {
         "operationId": "GetCustomReportUsers",
@@ -100902,6 +101077,31 @@
           "updatedAt"
         ]
       },
+      "CustomReportSchedule": {
+        "type": "object",
+        "properties": {
+          "scheduleExpression": {
+            "type": "string",
+            "nullable": true
+          },
+          "scheduleTimezone": {
+            "type": "string",
+            "nullable": true
+          },
+          "scheduleEmails": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "nullable": true
+          }
+        },
+        "required": [
+          "scheduleExpression",
+          "scheduleTimezone",
+          "scheduleEmails"
+        ]
+      },
       "SearchField": {
         "type": "object",
         "properties": {
@@ -116991,6 +117191,26 @@
           }
         }
       },
+      "CustomReportScheduleInputs": {
+        "type": "object",
+        "properties": {
+          "scheduleExpression": {
+            "type": "string",
+            "nullable": true
+          },
+          "scheduleTimezone": {
+            "type": "string",
+            "nullable": true
+          },
+          "scheduleEmails": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "nullable": true
+          }
+        }
+      },
       "EventSectionCreateInputs": {
         "type": "object",
         "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin",
-  "version": "6.25.0",
+  "version": "6.26.0",
   "description": "Admin API javascript SDK",
   "author": "ConnectedXM Inc.",
   "type": "module",
@@ -24,7 +24,7 @@
     "upgrade": "ncu -i --format group"
   },
   "dependencies": {
-    "axios": "^1.13.6",
+    "axios": "^1.15.0",
     "immer": "^11.1.4"
   },
   "peerDependencies": {
@@ -32,16 +32,15 @@
     "react": "^18 || ^19"
   },
   "devDependencies": {
-    "tsx": "^4.21.0",
-    "@babel/parser": "^7.29.0",
-    "@swc/core": "^1.15.18",
-    "@tanstack/react-query": "^5.90.21",
+    "@babel/parser": "^7.29.2",
+    "@swc/core": "^1.15.24",
+    "@tanstack/react-query": "^5.97.0",
     "@types/glob": "^9.0.0",
     "@types/node": "^22.15.3",
     "@types/react": "^19.2.14",
-    "@typescript-eslint/eslint-plugin": "^8.57.0",
-    "@typescript-eslint/parser": "^8.57.0",
-    "comment-parser": "^1.4.5",
+    "@typescript-eslint/eslint-plugin": "^8.58.1",
+    "@typescript-eslint/parser": "^8.58.1",
+    "comment-parser": "^1.4.6",
     "eslint": "^9.39.2",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^5.2.0",
@@ -49,10 +48,11 @@
     "openapi-schema-validator": "^12.1.3",
     "recast": "^0.23.11",
     "tsup": "^8.5.1",
+    "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "vitest": "^4.1.0"
+    "vitest": "^4.1.4"
   },
   "optionalDependencies": {
-    "@rollup/rollup-linux-x64-gnu": "4.59.0"
+    "@rollup/rollup-linux-x64-gnu": "4.60.1"
   }
 }