ofsc-utility 1.0.28 → 1.0.30

package/dist/metadata/enumerations.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Fetch enumeration metadata for a specific property label.
+ *
+ * This helper will page through the OFSC metadata API until all enumeration
+ * values are retrieved for the requested property label.
+ *
+ * @param clientId - OFSC client ID
+ * @param clientSecret - OFSC client secret
+ * @param instanceUrl - OFSC instance host portion
+ * @param label - property label used to fetch enumeration values
+ * @param allUsedPropes - collection of properties used in other metadata sheets
+ * @param token - optional existing OAuth token
+ * @returns array of enumeration rows for the property
+ */
+export declare function getPropertiesDropDownMetaData(clientId: string, clientSecret: string, instanceUrl: string, label: string, allUsedPropes: any[], token?: string): Promise<any[]>;
+/**
+ * Transform raw enumeration items into the final sheet row format.
+ *
+ * The output is a simple array of enumeration rows, and each row includes the
+ * property label, enumeration label, active flag, and translated name.
+ *
+ * @param data - raw enumeration items returned by the API
+ * @param allUsedPropes - collection of properties used elsewhere, used for comments
+ * @param label - parent property label for this enumeration list
+ * @returns transformed enumeration rows
+ */
+export declare function transformData(data: any[], allUsedPropes: any[], label: string): Promise<any[]>;

package/dist/metadata/enumerations.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPropertiesDropDownMetaData = getPropertiesDropDownMetaData;
+exports.transformData = transformData;
+const utilities_1 = require("../utilities");
+/**
+ * Fetch enumeration metadata for a specific property label.
+ *
+ * This helper will page through the OFSC metadata API until all enumeration
+ * values are retrieved for the requested property label.
+ *
+ * @param clientId - OFSC client ID
+ * @param clientSecret - OFSC client secret
+ * @param instanceUrl - OFSC instance host portion
+ * @param label - property label used to fetch enumeration values
+ * @param allUsedPropes - collection of properties used in other metadata sheets
+ * @param token - optional existing OAuth token
+ * @returns array of enumeration rows for the property
+ */
+async function getPropertiesDropDownMetaData(clientId, clientSecret, instanceUrl, label, allUsedPropes, token = "") {
+    let responsedata = [];
+    let offset = 0;
+    const limit = 100;
+    // Continue paging until the API indicates there are no more items.
+    while (true) {
+        const url = `https://${instanceUrl}.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/properties/${label}/enumerationList?offset=${offset}&limit=${limit}`;
+        const res = await (0, utilities_1.fetchWithRetry)(url, clientId, clientSecret, instanceUrl, token);
+        // Keep the latest token for subsequent requests.
+        token = res.token;
+        if (res.data.items) {
+            responsedata = [...responsedata, ...res.data.items];
+        }
+        // If the API indicates there are no more items, exit the loop.
+        if (!res.data.hasMore)
+            break;
+        // Update the offset for the next page of results.
+        offset = res.data.offset + limit;
+    }
+    // Transform the raw enumeration data into the final sheet format.
+    return transformData(responsedata, allUsedPropes, label);
+}
+/**
+ * Transform raw enumeration items into the final sheet row format.
+ *
+ * The output is a simple array of enumeration rows, and each row includes the
+ * property label, enumeration label, active flag, and translated name.
+ *
+ * @param data - raw enumeration items returned by the API
+ * @param allUsedPropes - collection of properties used elsewhere, used for comments
+ * @param label - parent property label for this enumeration list
+ * @returns transformed enumeration rows
+ */
+async function transformData(data, allUsedPropes, label) {
+    const overview = data.map(d => {
+        // Find all matching comments from the shared property usage data.
+        const comments = [
+            ...new Set(allUsedPropes
+                .filter((p) => p.label === d.label)
+                .map((p) => p.comment)
+                .filter(Boolean))
+        ].join(', ');
+        return {
+            propertyLabel: label,
+            Label: d.label,
+            active: d.active,
+            name: d.translations?.[0]?.name || '',
+            comments
+        };
+    });
+    return overview;
+}

package/dist/metadata/properties.d.ts

@@ -1,4 +1,4 @@
 type SheetData = Record<string, any[]>;
 export declare function getPropertiesMetaData(clientId: string, clientSecret: string, instanceUrl: string, allUsedPropes: any[], token?: string): Promise<SheetData>;
-export declare function transformData(data: any[], allUsedPropes: any[]): SheetData;
+export declare function transformData(data: any[], allUsedPropes: any[], clientId: string, clientSecret: string, instanceUrl: string, token: string): Promise<SheetData>;
 export {};

package/dist/metadata/properties.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPropertiesMetaData = getPropertiesMetaData;
 exports.transformData = transformData;
 const utilities_1 = require("../utilities");
+const enumerations_1 = require("./enumerations");
 async function getPropertiesMetaData(clientId, clientSecret, instanceUrl, allUsedPropes, token = "") {
     let responsedata = [];
     let offset = 0;
@@ -16,10 +17,10 @@ async function getPropertiesMetaData(clientId, clientSecret, instanceUrl, allUse
             break;
         offset = res.data.offset + limit;
     }
-    const sheet = transformData(responsedata, allUsedPropes);
+    const sheet = transformData(responsedata, allUsedPropes, clientId, clientSecret, instanceUrl, token);
     return sheet;
 }
-function transformData(data, allUsedPropes) {
+async function transformData(data, allUsedPropes, clientId, clientSecret, instanceUrl, token) {
     const sheets = {};
     // Sheet 1: Activity Type Groups Overview
     const overview = data.map(d => {
@@ -41,5 +42,14 @@ function transformData(data, allUsedPropes) {
         };
     });
     sheets['Properties Overview'] = overview;
+    const dropDownData = [];
+    const enumerationProps = overview.filter((prop) => prop["Data Type"] === 'enumeration');
+    console.log(`Found ${enumerationProps.length} enumeration properties to fetch dropdown data for.`);
+    for (const prop of enumerationProps) {
+        // Process each property
+        let enums = await (0, enumerations_1.getPropertiesDropDownMetaData)(clientId, clientSecret, instanceUrl, prop.Label, allUsedPropes, token);
+        dropDownData.push(...enums);
+    }
+    sheets['Properties Enumerations'] = dropDownData;
     return sheets;
 }

package/dist/metadata/scripts/create-configuration-example.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Example script to generate the OFSC metadata configuration file using the `src/metadata` helpers.
+ *
+ * Environment variables:
+ * - CLIENT_ID
+ * - CLIENT_SECRET
+ * - INSTANCE_URL (host portion, e.g. example-instance)
+ * - OUTPUT_FILE_NAME (optional)
+ *
+ * compile + run:
+ *   tsc && node dist/metadata/scripts/create-configuration-example.js
+ */
+export {};

package/dist/metadata/scripts/create-configuration-example.js

@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * Example script to generate the OFSC metadata configuration file using the `src/metadata` helpers.
+ *
+ * Environment variables:
+ * - CLIENT_ID
+ * - CLIENT_SECRET
+ * - INSTANCE_URL (host portion, e.g. example-instance)
+ * - OUTPUT_FILE_NAME (optional)
+ *
+ * compile + run:
+ *   tsc && node dist/metadata/scripts/create-configuration-example.js
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("..");
+const clientId = process.env.CLIENT_ID;
+const clientSecret = process.env.CLIENT_SECRET;
+const instanceUrl = process.env.INSTANCE_URL;
+const fileName = process.env.OUTPUT_FILE_NAME || "OFSC_CONFIGURATION_SHEET.xlsx";
+if (!clientId || !clientSecret || !instanceUrl) {
+    console.error("Missing required env vars: CLIENT_ID, CLIENT_SECRET, INSTANCE_URL");
+    process.exit(1);
+}
+(async () => {
+    try {
+        console.log("Generating OFSC metadata configuration file...");
+        await (0, __1.createConfigurationFile)(clientId, clientSecret, instanceUrl, fileName);
+        console.log(`Configuration workbook saved to ${fileName}`);
+    }
+    catch (err) {
+        console.error("Error generating metadata configuration file:", err);
+        process.exit(2);
+    }
+})();

package/dist/metadata/scripts/fetch-properties-example.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Example script to fetch properties metadata using `src/metadata/properties.ts`.
+ *
+ * Environment variables:
+ * - CLIENT_ID
+ * - CLIENT_SECRET
+ * - INSTANCE_URL (host portion, e.g. example-instance)
+ * - ALL_USED_PROPES_PATH (optional) - local JSON file path containing an array of property usage records
+ * - OUTPUT_FILE_NAME (optional) - save JSON output to this file
+ *
+ * compile + run:
+ *   source src/events/scripts/.env
+ *   tsc && node dist/metadata/scripts/fetch-properties-example.js
+ */
+export {};

package/dist/metadata/scripts/fetch-properties-example.js

@@ -0,0 +1,72 @@
+"use strict";
+/**
+ * Example script to fetch properties metadata using `src/metadata/properties.ts`.
+ *
+ * Environment variables:
+ * - CLIENT_ID
+ * - CLIENT_SECRET
+ * - INSTANCE_URL (host portion, e.g. example-instance)
+ * - ALL_USED_PROPES_PATH (optional) - local JSON file path containing an array of property usage records
+ * - OUTPUT_FILE_NAME (optional) - save JSON output to this file
+ *
+ * compile + run:
+ *   source src/events/scripts/.env
+ *   tsc && node dist/metadata/scripts/fetch-properties-example.js
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const __1 = require("..");
+const clientId = process.env.CLIENT_ID;
+const clientSecret = process.env.CLIENT_SECRET;
+const instanceUrl = process.env.INSTANCE_URL;
+const allUsedPropesPath = process.env.ALL_USED_PROPES_PATH;
+const outputFileName = process.env.OUTPUT_FILE_NAME;
+if (!clientId || !clientSecret || !instanceUrl) {
+    console.error("Missing required env vars: CLIENT_ID, CLIENT_SECRET, INSTANCE_URL");
+    process.exit(1);
+}
+function loadAllUsedPropes() {
+    if (!allUsedPropesPath) {
+        return [];
+    }
+    const resolvedPath = path_1.default.isAbsolute(allUsedPropesPath)
+        ? allUsedPropesPath
+        : path_1.default.resolve(process.cwd(), allUsedPropesPath);
+    if (!fs_1.default.existsSync(resolvedPath)) {
+        console.error(`ALL_USED_PROPES_PATH file not found: ${resolvedPath}`);
+        process.exit(1);
+    }
+    try {
+        const fileContents = fs_1.default.readFileSync(resolvedPath, "utf8");
+        const parsed = JSON.parse(fileContents);
+        if (!Array.isArray(parsed)) {
+            throw new Error("Expected JSON array");
+        }
+        return parsed;
+    }
+    catch (err) {
+        console.error("Failed to read ALL_USED_PROPES_PATH:", err);
+        process.exit(1);
+    }
+}
+(async () => {
+    try {
+        const allUsedPropes = loadAllUsedPropes();
+        console.log("Fetching properties metadata...");
+        const response = await (0, __1.getPropertiesMetaData)(clientId, clientSecret, instanceUrl, allUsedPropes);
+        console.log("Properties metadata response:");
+        console.log(JSON.stringify(response, null, 2));
+        if (outputFileName) {
+            fs_1.default.writeFileSync(outputFileName, JSON.stringify(response, null, 2), "utf8");
+            console.log(`Saved response to ${outputFileName}`);
+        }
+    }
+    catch (err) {
+        console.error("Error fetching properties metadata:", err);
+        process.exit(2);
+    }
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ofsc-utility",
-  "version": "1.0.28",
+  "version": "1.0.30",
   "description": "A wrapper for Oracle Field Service REST API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -1,15 +1,13 @@
-# Enhanced ofsc utility
+# OFSC Utility
 
-A lightweight utility library for interacting with **Oracle Field Service Cloud (OFSC)**.
+A small TypeScript wrapper for Oracle Field Service Cloud (OFSC) REST APIs.
 
-## Features
+This package exposes grouped API helpers for common OFSC operations, including:
 
-- 🚀 **40+ utility methods**
-- 📚 **Written in TypeScript** with full type definitions
-- 🧪 **Completely tested** with Jest
-- 📦 **Zero dependencies**
-- 🎯 **Modular architecture** for tree-shaking
-- 🔧 **Multiple import styles** for flexibility
+- authentication
+- export/download helpers
+- inventory and activity records
+- metadata file generation
 
 ## Installation
 
@@ -17,191 +15,285 @@ A lightweight utility library for interacting with **Oracle Field Service Cloud
 npm install ofsc-utility
 ```
 
-## Functions implemented
+## Getting Started
 
-### Download
+1. Install the package:
 
-Please see the code snippet below.
-
-#### csv
-
-    downloadWorkZoneCSV(process.env.clientID, process.env.clientSecret, process.env.instanceId)
-    downloadAllResourcesCSV(process.env.clientID, process.env.clientSecret, process.env.instanceId)
-    downloadAllUsersCSV(process.env.clientID, process.env.clientSecret, process.env.instanceId)
-    downloadAllInventoryTypesCSV(process.env.clientID, process.env.clientSecret, process.env.instanceId)
-    downloadAllEventsOfDayCSV(process.env.clientID, process.env.clientSecret, process.env.instanceId, process.env.subscriptionId,"2025-12-05")
-    // Download Collaboration groups  assigned to users
-    generateUsersCollaborationCSV(process.env.clientID, process.env.clientSecret, process.env.instanceId) 
-    // Download all resource's inventories
-    generateAllOnHandInventoryOfAllResourcesCSV(process.env.clientID, process.env.clientSecret, process.env.instanceId) 
+```bash
+npm install ofsc-utility
+```
 
-#### records
+2. Create a `.env` file or export environment variables in your shell:
 
-    getOAuthToken("clientId", "clientSecret", "instanceId")
-    getInventoryTypesDetail("clientId", "clientSecret", "instanceId"."inventory_label")
-    updateCreateInventoryType("clientId", "clientSecret", "instanceId"."inventory_label")
-    getAllActivities("clientId", "clientSecret", "instanceId"."resources","dateFrom","dateTo","q","fields")
-    getActivityCustomerInventories("clientId", "clientSecret", "instanceId"."activityId")
-    createActivityCustomerInventories( "clientId", "clientSecret", "instanceId"."activityId","payload")
-    downloadAllEventsOfDay(process.env.clientID, process.env.clientSecret, process.env.instanceId, process.env.subscriptionId,"2025-12-05")
-    getActivitybyId("clientId", "clientSecret", "instanceId"."activityId")
+```bash
+export CLIENT_ID=yourClientId
+export CLIENT_SECRET=yourClientSecret
+export INSTANCE_NAME=yourInstanceName
+export SUBSCRIPTION_ID=yourSubscriptionId
+```
 
-### Technical Design Doc - Configurations
+3. Create a file such as `example.js` and add the sample code below.
 
-    // It will create a techncial configuration file
-    createConfigurationFile(process.env.clientID, process.env.clientSecreat,process.env.instanceId,"OFSC_CONFIGURATION_SHEET.xlsx")
+4. Run the example:
 
-## Usage
+```bash
+node example.js
+```
 
-downloadWorkZoneCSV("bot", "XXXXXXXXX", "compXXX.test")
+## Quick Start
 
 ### CommonJS
 
 ```js
 const ofs = require("ofsc-utility");
 
-ofs.User.generateUsersCollaborationCSV(
-    process.env.clientID,
-    process.env.clientSecret,
-    process.env.instanceId,
-    process.env.subscriptionId
-);
+async function main() {
+  const token = await ofs.getOAuthToken(
+    "CLIENT_ID",
+    "CLIENT_SECRET",
+    "INSTANCE_NAME",
+  );
+  console.log("OAuth token:", token);
+}
+
+main().catch(console.error);
 ```
 
+### ES Modules
+
 ```js
-async function run() {
-  let data = await ofs.InventoryType.getInventoryTypesDetail("clientId", "clientSecret", "instanceId", "inventory_label");
-  console.error(data);
+import ofs from "ofsc-utility";
+
+async function main() {
+  const token = await ofs.getOAuthToken(
+    "CLIENT_ID",
+    "CLIENT_SECRET",
+    "INSTANCE_NAME",
+  );
+  console.log("OAuth token:", token);
 }
-run();
+
+main().catch(console.error);
 ```
 
-```js
-const ofs = require("ofsc-utility");
+## Complete Example
 
-ofs
-  .getOAuthToken("clientId", "clientSecret", "instanceId")
-  .then((token) => {
-    console.log(token);
-  })
-  .catch((err) => {
-    console.error("Error fetching token:", err);
-  });
-```
+This example shows a full CommonJS script that retrieves activity type metadata and prints the result.
 
 ```js
 const ofs = require("ofsc-utility");
 
-ofs.WorkZone.downloadWorkZoneCSV("clientId", "clientSecret", "instanceId")
-  .then(() => {
-    console.log("successful");
-  })
-  .catch((err) => {
-    console.error("Error:", err);
-  });
+async function main() {
+  const clientId = process.env.CLIENT_ID;
+  const clientSecret = process.env.CLIENT_SECRET;
+  const instanceUrl = process.env.INSTANCE_NAME;
+
+  if (!clientId || !clientSecret || !instanceUrl) {
+    throw new Error(
+      "Please set CLIENT_ID, CLIENT_SECRET and INSTANCE_NAME environment variables",
+    );
+  }
+
+  const activityTypes = await ofs.metadata.getActivityTypesMetaData(
+    clientId,
+    clientSecret,
+    instanceUrl,
+  );
+
+  console.log("Activity type metadata:");
+  console.log(JSON.stringify(activityTypes, null, 2));
+}
+
+main().catch((error) => {
+  console.error("Error running example:", error);
+  process.exit(1);
+});
 ```
 
-```js
-const ofs = require("ofsc-utility");
+## Usage
+
+### Authentication
 
-ofs
-  .downloadAllResourcesCSV("clientId", "clientSecret", "instanceId")
-  .then(() => {
-    console.log("successful");
-  })
-  .catch((err) => {
-    console.error("Error:", err);
-  });
+```js
+const token = await ofs.getOAuthToken(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
 ```
 
+### Download CSV files
+
 ```js
-const ofs = require("ofsc-utility");
+await ofs.downloadWorkZoneCSV(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+await ofs.downloadAllResourcesCSV(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
 
-ofs
-  .downloadAllUsersCSV("clientId", "clientSecret", "instanceId")
-  .then(() => {
-    console.log("successful");
-  })
-  .catch((err) => {
-    console.error("Error:", err);
-  });
+await ofs.downloadAllUsersCSV(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
 ```
 
+### Activity and inventory helpers
+
 ```js
-const ofs = require("ofsc-utility");
+const activities = await ofs.getAllActivities(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  "US",
+  "2025-11-01",
+  "2025-11-30",
+  "status=='pending'",
+  "activityId,activityType,date,status",
+);
 
-async function run() {
-  const payload = {
-    label: "inventory_label",
-    name: "Ordered Part",
-    unitOfMeasurement: "ea",
-    active: true,
-    nonSerialized: true,
-    modelProperty: "part_item_number_rev",
-    quantityPrecision: 0,
-    translations: [
-      {
-        language: "en",
-        name: "Ordered Part",
-        unitOfMeasurement: "ea",
-        languageISO: "en-US",
-      },
-    ],
-  };
-
-  try {
-    const result = await updateCreateInventoryType("CLIENT_ID", "CLIENT_SECRET", "INSTANCE_URL", "inventory_label", payload);
-
-    console.log("Updated:", result);
-  } catch (err) {
-    console.error(err);
-  }
-}
+const activityData = await ofs.getActivitybyId(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  "ACTIVITY_ID",
+);
 
-run();
+const inventoryDetail = await ofs.InventoryType.getInventoryTypesDetail(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  "inventory_label",
+);
 ```
 
+### Create a configuration workbook
+
 ```js
-const ofs = require("ofsc-utility");
-async function run() {
-  try {
-    const result = await ofs.getAllActivities(
-      (clientId = "CLIENT_ID"),
-      (clientSecret = "CLIENT_SECRET"),
-      (instanceUrl = "INSTANCE_URL"),
-      (resources = "US"),
-      (dateFrom = "2025-11-05"),
-      (dateTo = "2025-12-05"),
-      (q = "status=='pending' and ACTIVITY_NOTES!=''"),
-      (fields = "ACTIVITY_NOTES,status,activityId,activityType,date,resourceId")
-    );
+await ofs.createConfigurationFile(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  "OFSC_CONFIGURATION_SHEET.xlsx",
+);
+```
 
-    console.log("Updated:", result);
-  } catch (err) {
-    console.error(err);
-  }
-}
+### Metadata helpers
 
-run();
-```
+The `metadata` group exposes metadata-specific retrieval helpers.
 
 ```js
-ofs.getActivityCustomerInventories("CLIENT_ID", "CLIENT_SECRET", "INSTANCE_URL", "activityId").then((data) => {
-  console.log(data);
-});
+const meta = ofs.metadata;
+
+const activityTypes = await meta.getActivityTypesMetaData(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+const activityGroups = await meta.getActivityTypesGroupsMetaData(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+const workZones = await meta.getWorkZonesMetaData(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
 ```
 
+### Namespace-style imports
+
 ```js
 const ofs = require("ofsc-utility");
-ofs.Events.downloadAllEventsOfDayCSV(
-  process.env.clientID,
-  process.env.clientSecret,
-  process.env.instanceId,
-  process.env.subscriptionId,
-  "2025-12-05"
+
+await ofs.WorkZone.downloadWorkZoneCSV(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+);
+
+await ofs.User.generateUsersCollaborationCSV(
+  process.env.CLIENT_ID,
+  process.env.CLIENT_SECRET,
+  process.env.INSTANCE_NAME,
+  process.env.SUBSCRIPTION_ID,
 );
 ```
 
+## Available exports
+
+Top-level exports include:
+
+- `getOAuthToken`
+- `downloadWorkZoneCSV`
+- `downloadAllResourcesCSV`
+- `downloadAllUsersCSV`
+- `downloadAllInventoryTypesCSV`
+- `getInventoryTypesDetail`
+- `updateCreateInventoryType`
+- `getAllActivities`
+- `getActivitybyId`
+- `getActivityCustomerInventories`
+- `createActivityCustomerInventories`
+- `downloadAllEventsOfDay`
+- `downloadAllEventsOfDayCSV`
+- `createExcelFile`
+- `createConfigurationFile`
+
+Grouped exports include:
+
+- `ofs.Activity`
+- `ofs.ActivityInventories`
+- `ofs.Events`
+- `ofs.Inventory`
+- `ofs.InventoryType`
+- `ofs.OauthTokenService`
+- `ofs.Resource`
+- `ofs.User`
+- `ofs.Utilities`
+- `ofs.WorkZone`
+- `ofs.metadata`
+
+## Metadata namespace
+
+The `metadata` object exposes metadata helpers such as:
+
+- `getActivityTypesMetaData`
+- `getActivityTypesGroupsMetaData`
+- `getApplictaionsIntegrationsDetailMetaData`
+- `getCapacityMetaData`
+- `getFormsMetaData`
+- `getInventoryTypesMetaData`
+- `getPropertiesMetaData`
+- `getResourceTypesMetaData`
+- `getShiftMetaData`
+- `getTimeSlotsMetaData`
+- `getWorkSkillsMetaData`
+- `getWorkZoneKeyMetaData`
+- `getWorkZonesMetaData`
+- `createConfigurationFile`
+
+## Notes
+
+- `instanceUrl` is the OFSC instance name only, not the full URL. For example: `mycompany` for `mycompany.fs.ocs.oraclecloud.com`.
+- All API helper methods accept the same `clientId`, `clientSecret`, and `instanceUrl` parameters at minimum.
+- Most helper methods return a promise and should be used with `await` or `.then()`.
+
+## Testing
+
+```bash
+npm test
+```
+
 ## License
 
 MIT