@rinse-dental/open-dental 2.4.15 → 2.4.17

package/dist/api/feeScheds.d.ts

@@ -0,0 +1,16 @@
+import HttpClient from "../utils/httpClient";
+import { FeeSched } from "../types/feeSchedsTypes";
+export default class FeeScheds {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch fee schedules with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.Offset] - Optional. Pagination offset for results.
+     * @returns {Promise<FeeSched[]>} - A list of fees.
+     */
+    getFeeScheds({ Offset }: {
+        Offset?: number;
+    }): Promise<FeeSched[]>;
+}
+//# sourceMappingURL=feeScheds.d.ts.map

package/dist/api/feeScheds.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feeScheds.d.ts","sourceRoot":"","sources":["../../src/api/feeScheds.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EAGT,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,YAAY,CAAC,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;CAShF"}

package/dist/api/feeScheds.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class FeeScheds {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch fee schedules with optional filtering and pagination.
+     * @param {Object} params - The parameters for filtering and pagination.
+     * @param {number} [params.Offset] - Optional. Pagination offset for results.
+     * @returns {Promise<FeeSched[]>} - A list of fees.
+     */
+    async getFeeScheds({ Offset }) {
+        const params = {};
+        if (Offset !== undefined) {
+            params.Offset = Offset;
+        }
+        return this.httpClient.get("/feescheds", params);
+    }
+}
+exports.default = FeeScheds;

package/dist/openDental.d.ts

@@ -27,6 +27,7 @@ import ClaimProcs from "./api/claimProcs";
 import Adjustments from "./api/adjustments";
 import ProcedureCodes from "./api/procedureCodes";
 import Fees from "./api/fees";
+import FeeScheds from "./api/feeScheds";
 import Diseases from "./api/diseases";
 import Allergies from "./api/allergies";
 import MedicationPats from "./api/medicationPats";
@@ -157,6 +158,10 @@ declare class OpenDental {
      * Create a new instance of the Fees API.
      */
     static Fees(): Fees;
+    /**
+   * Create a new instance of the FeeScheds API.
+   */
+    static FeeScheds(): FeeScheds;
     /**
      * Create a new instance of the Diseases API.
      */

package/dist/openDental.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAG9C,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAE/C,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,qBAAqB;IAOnC;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,UAAU;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,IAAI;IAOlB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,YAAY;IAO1B;;OAEG;WACW,YAAY;CAI3B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,qBAAqB,MAAM,yBAAyB,CAAC;AAC5D,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,IAAI,MAAM,YAAY,CAAC;AAC9B,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAG9C,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAC;AAE/C,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,qBAAqB;IAOnC;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,UAAU;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,IAAI;IAOlB;;KAEC;WACa,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,YAAY;IAO1B;;OAEG;WACW,YAAY;CAI3B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -67,6 +67,7 @@ const claimProcs_1 = __importDefault(require("./api/claimProcs"));
 const adjustments_1 = __importDefault(require("./api/adjustments"));
 const procedureCodes_1 = __importDefault(require("./api/procedureCodes"));
 const fees_1 = __importDefault(require("./api/fees"));
+const feeScheds_1 = __importDefault(require("./api/feeScheds"));
 const diseases_1 = __importDefault(require("./api/diseases"));
 const allergies_1 = __importDefault(require("./api/allergies"));
 const medicationPats_1 = __importDefault(require("./api/medicationPats"));
@@ -349,6 +350,15 @@ class OpenDental {
         }
         return new fees_1.default(this.httpClient);
     }
+    /**
+   * Create a new instance of the FeeScheds API.
+   */
+    static FeeScheds() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new feeScheds_1.default(this.httpClient);
+    }
     /**
      * Create a new instance of the Diseases API.
      */

package/dist/types/feeSchedsTypes.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Represents a fee schedules in Open Dental
+ * @see https://www.opendental.com/site/apifeescheds.html
+ */
+export interface FeeSched {
+    FeeSchedNum?: number;
+    Description?: string;
+    FeeSchedType?: "Normal" | "CoPay" | "OutNetwork" | "FixedBenefit" | "ManualBlueBook";
+    ItemOrder?: number;
+    IsHidden?: "true" | "false";
+    IsGlobal?: "true" | "false";
+    SecUserNumEntry?: number;
+    SecDateEntry?: string;
+    SecDateTEdit?: string;
+}
+/**
+ * Parameters for Create Fee Schedule.
+ * @see https://www.opendental.com/site/apifeescheds.html
+ */
+export interface CreateFeeSchedParams {
+    Description: string;
+    FeeSchedType: "Normal" | "CoPay" | "OutNetwork" | "FixedBenefit" | "ManualBlueBook";
+    IsHidden?: "true" | "false";
+    IsGlobal?: "true" | "false";
+}
+/**
+ * Parameters for Update Fee Schedule.
+ * @see https://www.opendental.com/site/apifeescheds.html
+ */
+export interface UpdateFeeSchedParams {
+    FeeSchedNum: number;
+    Description: string;
+    IsHidden?: "true" | "false";
+    IsGlobal?: "true" | "false";
+}
+//# sourceMappingURL=feeSchedsTypes.d.ts.map

package/dist/types/feeSchedsTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feeSchedsTypes.d.ts","sourceRoot":"","sources":["../../src/types/feeSchedsTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,cAAc,GAAG,gBAAgB,CAAC;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,cAAc,GAAG,gBAAgB,CAAC;IACpF,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B"}

package/dist/types/feeSchedsTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "2.4.15",
+    "version": "2.4.17",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/api/feeScheds.ts

@@ -0,0 +1,30 @@
+import HttpClient from "../utils/httpClient";
+import {
+  FeeSched,
+  CreateFeeSchedParams,
+  UpdateFeeSchedParams,
+} from "../types/feeSchedsTypes";
+
+export default class FeeScheds {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch fee schedules with optional filtering and pagination.
+   * @param {Object} params - The parameters for filtering and pagination.
+   * @param {number} [params.Offset] - Optional. Pagination offset for results.
+   * @returns {Promise<FeeSched[]>} - A list of fees.
+   */
+  public async getFeeScheds({ Offset }: { Offset?: number }): Promise<FeeSched[]> {
+    const params: Record<string, unknown> = {};
+
+    if (Offset !== undefined) {
+      params.Offset = Offset;
+    }
+
+    return this.httpClient.get<FeeSched[]>("/feescheds", params);
+  }
+}

package/src/openDental.ts

@@ -28,6 +28,7 @@ import ClaimProcs from "./api/claimProcs";
 import Adjustments from "./api/adjustments";
 import ProcedureCodes from "./api/procedureCodes";
 import Fees from "./api/fees"; 
+import FeeScheds from "./api/feeScheds"; 
 import Diseases from "./api/diseases";
 import Allergies from "./api/allergies";
 import MedicationPats from "./api/medicationPats";
@@ -347,6 +348,16 @@ class OpenDental {
     return new Fees(this.httpClient);
   }
 
+  /**
+ * Create a new instance of the FeeScheds API.
+ */
+  public static FeeScheds() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new FeeScheds(this.httpClient);
+  }
+
   /**
    * Create a new instance of the Diseases API.
    */

package/src/types/feeSchedsTypes.ts

@@ -0,0 +1,38 @@
+/**
+ * Represents a fee schedules in Open Dental
+ * @see https://www.opendental.com/site/apifeescheds.html
+ */
+export interface FeeSched {
+    FeeSchedNum?: number; //
+    Description?: string; //
+    FeeSchedType?: "Normal" | "CoPay" | "OutNetwork" | "FixedBenefit" | "ManualBlueBook"; //
+    ItemOrder?: number; //
+    IsHidden?: "true" | "false"; //
+    IsGlobal?: "true" | "false"; //
+    SecUserNumEntry?: number; //
+    SecDateEntry?: string; // String in "yyyy-MM-dd" format. 
+    SecDateTEdit?: string; // String in "yyyy-MM-dd" format. 
+  }
+
+  /**
+   * Parameters for Create Fee Schedule.
+   * @see https://www.opendental.com/site/apifeescheds.html
+   */
+  export interface CreateFeeSchedParams {
+    Description: string; // Required. The name of the fee schedule.
+    FeeSchedType: "Normal" | "CoPay" | "OutNetwork" | "FixedBenefit" | "ManualBlueBook"; // Required. Either "Normal", "CoPay", "OutNetwork", "FixedBenefit", or "ManualBlueBook". FeeSchedType cannot be changed
+    IsHidden?: "true" | "false"; // Optional. Either "true" or "false". Default false.
+    IsGlobal?: "true" | "false"; // Optional. Either "true" or "false". Default false.
+  }
+
+  /**
+   * Parameters for Update Fee Schedule.
+   * @see https://www.opendental.com/site/apifeescheds.html
+   */
+  export interface UpdateFeeSchedParams {
+    FeeSchedNum: number; // Required in the URL.
+    Description: string; // The name of the fee schedule.
+    IsHidden?: "true" | "false"; // Either "true" or "false".
+    IsGlobal?: "true" | "false"; // Either "true" or "false".
+  }
+