@rinse-dental/open-dental 1.5.1 → 1.6.0

package/dist/api/procedureCodes.d.ts

@@ -0,0 +1,22 @@
+import HttpClient from "../utils/httpClient";
+import { ProcedureCode, GetProcedureCodeParams } from "../types/procedureCodeTypes";
+export default class ProcedureCodes {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single inssub by its ID.
+     * @param {number} CodeNum - The unique identifier for the inssub.
+     * @returns {Promise<ProcedureCode>} - The inssub object.
+     * @throws {Error} - If `InsSubNum` is not provided.
+     */
+    getProcedureCode(CodeNum: number): Promise<ProcedureCode>;
+    /**
+      * Fetch multiple inssubs with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {string} [params.DateTStamp] - String in "yyyy-MM-dd HH:mm:ss" format. Get ProcedureCodes altered on and after the specified date and time.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<ProcedureCode[]>} - A list of inssubs.
+      */
+    getProcedureCodes({ DateTStamp, Offset, }?: GetProcedureCodeParams): Promise<ProcedureCode[]>;
+}
+//# sourceMappingURL=procedureCodes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"procedureCodes.d.ts","sourceRoot":"","sources":["../../src/api/procedureCodes.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,aAAa,EACb,sBAAsB,EACvB,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAOtE;;;;;;QAMI;IACS,iBAAiB,CAAC,EAC7B,UAAU,EACV,MAAM,GACP,GAAE,sBAA2B,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;CAQ1D"}

package/dist/api/procedureCodes.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ProcedureCodes {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single inssub by its ID.
+     * @param {number} CodeNum - The unique identifier for the inssub.
+     * @returns {Promise<ProcedureCode>} - The inssub object.
+     * @throws {Error} - If `InsSubNum` is not provided.
+     */
+    async getProcedureCode(CodeNum) {
+        if (!CodeNum) {
+            throw new Error("CodeNum is required.");
+        }
+        return this.httpClient.get(`/procedurecodes/${CodeNum}`);
+    }
+    /**
+      * Fetch multiple inssubs with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {string} [params.DateTStamp] - String in "yyyy-MM-dd HH:mm:ss" format. Get ProcedureCodes altered on and after the specified date and time.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<ProcedureCode[]>} - A list of inssubs.
+      */
+    async getProcedureCodes({ DateTStamp, Offset, } = {}) {
+        const params = {
+            DateTStamp,
+            Offset,
+        };
+        return this.httpClient.get("/procedurecodes", params);
+    }
+}
+exports.default = ProcedureCodes;

package/dist/openDental.d.ts

@@ -22,6 +22,7 @@ import InsPlans from "./api/insPlans";
 import Benefits from "./api/benefits";
 import ClaimProcs from "./api/claimProcs";
 import Adjustments from "./api/adjustments";
+import ProcedureCodes from "./api/procedureCodes";
 declare class OpenDental {
     private static httpClient;
     /**
@@ -124,6 +125,10 @@ declare class OpenDental {
      * Create a new instance of the Adjustments API.
      */
     static Adjustments(): Adjustments;
+    /**
+     * Create a new instance of the ProcedureCodes API.
+     */
+    static ProcedureCodes(): ProcedureCodes;
 }
 export { OpenDental };
 //# sourceMappingURL=openDental.d.ts.map

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,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,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;AAE5C,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;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAOzB;;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;CAM1B;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,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,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;AAElD,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;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAOzB;;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;CAO7B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -29,6 +29,7 @@ const insPlans_1 = __importDefault(require("./api/insPlans"));
 const benefits_1 = __importDefault(require("./api/benefits"));
 const claimProcs_1 = __importDefault(require("./api/claimProcs"));
 const adjustments_1 = __importDefault(require("./api/adjustments"));
+const procedureCodes_1 = __importDefault(require("./api/procedureCodes"));
 class OpenDental {
     static httpClient;
     /**
@@ -258,5 +259,14 @@ class OpenDental {
         }
         return new adjustments_1.default(this.httpClient);
     }
+    /**
+     * Create a new instance of the ProcedureCodes API.
+     */
+    static ProcedureCodes() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new procedureCodes_1.default(this.httpClient);
+    }
 }
 exports.OpenDental = OpenDental;

package/dist/types/procedureCodeTypes.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Represents a procedure code in the Open Dental system.
+ * @see https://www.opendental.com/site/apiprocedurecodes.html
+ */
+export interface ProcedureCode {
+    CodeNum?: number;
+    ProcCode?: string;
+    Descript?: string;
+    AbbrDesc?: string;
+    ProcTime?: string;
+    ProcCat?: number;
+    procCat?: string;
+    TreatArea?: string;
+    NoBillIns?: number;
+    IsProsth?: "true" | "false";
+    DefaultNote?: string;
+    IsHygiene?: "true" | "false";
+    AlternateCode1?: string;
+    MedicalCode?: string;
+    IsTaxed?: "true" | "false";
+    PaintType?: string;
+    LaymanTerm?: string;
+    IsCanadianLab?: "true" | "false";
+    BaseUnits?: number;
+    SubstitutionCode?: string;
+    SubstOnlyIf?: string;
+    DateTStamp?: string;
+    DrugNDC?: string;
+    RevenueCodeDefault?: string;
+    ProvNumDefault?: number;
+    CanadaTimeUnits?: number;
+    IsRadiology?: "true" | "false";
+    DefaultClaimNote?: string;
+    DefaultTPNote?: string;
+    PaintText?: string;
+    AreaAlsoToothRange?: "true" | "false";
+    DiagnosticCodes?: string;
+}
+/**
+ * Gets a list of ProcedureCodes
+ * @see https://www.opendental.com/site/apiprocedurecodes.html
+ */
+export interface GetProcedureCodeParams {
+    DateTStamp?: string;
+    Offset?: number;
+}
+//# sourceMappingURL=procedureCodeTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"procedureCodeTypes.d.ts","sourceRoot":"","sources":["../../src/types/procedureCodeTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/procedureCodeTypes.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": "1.5.1",
+    "version": "1.6.0",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/release.sh

@@ -40,6 +40,6 @@ git push origin "$NEW_TAG"
 gh release create "$NEW_TAG" --title "Release $NEW_TAG" --notes "$COMMIT_MSG"
 
 
-#example ./release.sh "Some commit message" patch 
-#example ./release.sh "Added insplans and benefits" minor
+#example ./release.sh "added adjustments to index" patch 
+#example ./release.sh "Added adjustments" minor
 #example ./release.sh "Some commit message" major 

package/src/api/procedureCodes.ts

@@ -0,0 +1,45 @@
+import HttpClient from "../utils/httpClient";
+import {
+  ProcedureCode,
+  GetProcedureCodeParams,
+} from "../types/procedureCodeTypes";
+
+export default class ProcedureCodes {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch a single inssub by its ID.
+   * @param {number} CodeNum - The unique identifier for the inssub.
+   * @returns {Promise<ProcedureCode>} - The inssub object.
+   * @throws {Error} - If `InsSubNum` is not provided.
+   */
+  public async getProcedureCode(CodeNum: number): Promise<ProcedureCode> {
+    if (!CodeNum) {
+      throw new Error("CodeNum is required.");
+    }
+    return this.httpClient.get<ProcedureCode>(`/procedurecodes/${CodeNum}`);
+  }
+
+  /**
+    * Fetch multiple inssubs with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {string} [params.DateTStamp] - String in "yyyy-MM-dd HH:mm:ss" format. Get ProcedureCodes altered on and after the specified date and time.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<ProcedureCode[]>} - A list of inssubs.
+    */
+  public async getProcedureCodes({
+    DateTStamp,
+    Offset,
+  }: GetProcedureCodeParams = {}): Promise<ProcedureCode[]> {
+    const params = {
+      DateTStamp,
+      Offset,
+    };
+  
+    return this.httpClient.get<ProcedureCode[]>("/procedurecodes", params);
+  }
+}

package/src/openDental.ts

@@ -23,6 +23,7 @@ import InsPlans from "./api/insPlans";
 import Benefits from "./api/benefits";
 import ClaimProcs from "./api/claimProcs";
 import Adjustments from "./api/adjustments";
+import ProcedureCodes from "./api/procedureCodes";
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -281,6 +282,17 @@ class OpenDental {
     }
     return new Adjustments(this.httpClient);
   }
+
+  /**
+   * Create a new instance of the ProcedureCodes API.
+   */
+  public static ProcedureCodes() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new ProcedureCodes(this.httpClient);
+  }
+
 }
 
 export { OpenDental };

package/src/types/procedureCodeTypes.ts

@@ -0,0 +1,48 @@
+/**
+ * Represents a procedure code in the Open Dental system. 
+ * @see https://www.opendental.com/site/apiprocedurecodes.html
+ */
+export interface ProcedureCode {
+    CodeNum?: number; //PK
+    ProcCode?: string; //
+    Descript?: string; //
+    AbbrDesc?: string; //
+    ProcTime?: string; //
+    ProcCat?: number; //
+    procCat?: string; //
+    TreatArea?: string; //
+    NoBillIns?: number; //
+    IsProsth?: "true" | "false"; //
+    DefaultNote?: string; //
+    IsHygiene?: "true" | "false"; //
+    AlternateCode1?: string; //
+    MedicalCode?: string; //
+    IsTaxed?: "true" | "false"; //
+    PaintType?: string; //
+    LaymanTerm?: string; //
+    IsCanadianLab?: "true" | "false"; //
+    BaseUnits?: number; //
+    SubstitutionCode?: string; //
+    SubstOnlyIf?: string; //
+    DateTStamp?: string; //String in "yyyy-MM-dd HH:mm:ss" format.
+    DrugNDC?: string; //
+    RevenueCodeDefault?: string; //
+    ProvNumDefault?: number; //
+    CanadaTimeUnits?: number; //
+    IsRadiology?: "true" | "false"; //
+    DefaultClaimNote?: string; //
+    DefaultTPNote?: string; //
+    PaintText?: string; //
+    AreaAlsoToothRange?: "true" | "false"; //
+    DiagnosticCodes?: string; //
+  }
+
+  /**
+   * Gets a list of ProcedureCodes
+   * @see https://www.opendental.com/site/apiprocedurecodes.html
+   */
+  export interface GetProcedureCodeParams {
+    DateTStamp?: string; //String in "yyyy-MM-dd HH:mm:ss" format. Get ProcedureCodes altered on and after the specified date and time.
+    Offset?: number; // Pagination offset for results
+  }
+