@rinse-dental/open-dental 0.1.5 → 0.1.6

package/dist/api/operatories.d.ts

@@ -0,0 +1,23 @@
+import HttpClient from "../utils/httpClient";
+import { Operatory, GetOperatoriesParams } from "../types/operatoryTypes";
+export default class Operatories {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single patfield by its ID.
+     * @param {number} OperatoryNum - The ID of the patfield.
+     * @returns {Promise<Operatory>} - The patient data.
+     * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+     */
+    getPatField(OperatoryNum: number): Promise<Operatory>;
+    /**
+     * Fetch multiple patients with optional filtering and pagination.
+     * @param {Object} params - Filtering and pagination parameters.
+     * @param {string} [params.ClinicNum] - Filter by clinicnum
+     * @param {string} [params.Offset] - Filter by clinicnum
+    * @returns {Promise<Operatory[]>} - A list of summarized patient data.
+     * @throws {Error} - If the API returns an error.
+     */
+    getOperatories({ ClinicNum, Offset, }?: GetOperatoriesParams): Promise<Operatory[]>;
+}
+//# sourceMappingURL=operatories.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"operatories.d.ts","sourceRoot":"","sources":["../../src/api/operatories.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,SAAS,EACT,oBAAoB,EACvB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAQlE;;;;;;;OAOG;IACY,cAAc,CAAC,EAC1B,SAAS,EACT,MAAM,GACP,GAAE,oBAAyB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAOtD"}

package/dist/api/operatories.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Operatories {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single patfield by its ID.
+     * @param {number} OperatoryNum - The ID of the patfield.
+     * @returns {Promise<Operatory>} - The patient data.
+     * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+     */
+    async getPatField(OperatoryNum) {
+        if (!OperatoryNum || typeof OperatoryNum !== "number") {
+            throw new Error("Invalid parameter: PatNum must be a valid number.");
+        }
+        return await this.httpClient.get(`/operatories/${OperatoryNum}`);
+    }
+    /**
+     * Fetch multiple patients with optional filtering and pagination.
+     * @param {Object} params - Filtering and pagination parameters.
+     * @param {string} [params.ClinicNum] - Filter by clinicnum
+     * @param {string} [params.Offset] - Filter by clinicnum
+    * @returns {Promise<Operatory[]>} - A list of summarized patient data.
+     * @throws {Error} - If the API returns an error.
+     */
+    async getOperatories({ ClinicNum, Offset, } = {}) {
+        return await this.httpClient.get("/operatories", {
+            ClinicNum,
+            Offset,
+        });
+    }
+}
+exports.default = Operatories;

package/dist/api/providers.d.ts

@@ -0,0 +1,73 @@
+import HttpClient from "../utils/httpClient";
+import { Provider, GetProviderParams, createProviderParams, updateProviderParams } from "../types/providerTypes";
+export default class Providers {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Fetch a single provider by its ID.
+     * @param {number} ProvNum - The ID of the provider.
+     * @returns {Promise<Provider>} - The provider data.
+     * @throws {Error} - If `ProvNum` is not valid or the API returns an error.
+     */
+    getProvider(ProvNum: number): Promise<Provider>;
+    /**
+     * Fetch multiple providers with optional filtering and pagination.
+     * @param {Object} params - Filtering and pagination parameters.
+     * @param {number} [params.ClinicNum] - Get providers by ClinicNum
+     * @param {string} [params.DateTStamp] - Get providers altered after the specified date and time
+     * @param {string} [params.Offset] - Pagination
+    * @returns {Promise<Provider[]>} - A list of summarized patient data.
+     * @throws {Error} - If the API returns an error.
+     */
+    getProviders({ ClinicNum, DateTStamp, Offset, }?: GetProviderParams): Promise<Provider[]>;
+    /**
+     * Creates a provider. Cannot create PatFields associated with hidden PatFieldDefs.
+     * @param {Object} data - The data for the new patfield.
+     * @param {string} data.Abbr - Required.
+     * @param {string} data.LName - Optional.
+     * @param {string} data.FName - Optional.
+     * @param {string} data.MI - Optional.
+     * @param {string} data.Suffix - Optional.
+     * @param {number} data.FeeSched - Optional.
+     * @param {number} data.Specialty - Optional.
+     * @param {string} data.SSN - Optional.
+     * @param {'true' | 'false'} data.IsSecondary - Optional.
+     * @param {'true' | 'false'} data.IsHidden - Optional.
+     * @param {'true' | 'false'} data.UsingTIN - Optional.
+     * @param {'true' | 'false'} data.SigOnFile - Optional.
+     * @param {'true' | 'false'} data.IsNotPerson - Optional.
+     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
+     * @param {string} data.Birthdate - Optional.
+     * @param {string} data.SchedNote - Optional.
+     * @param {string} data.PreferredName - Optional.
+     * @returns {Promise<Provider>} - The created PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    createProvider({ Abbr, LName, FName, MI, Suffix, FeeSched, Specialty, SSN, IsSecondary, IsHidden, UsingTIN, SigOnFile, IsNotPerson, IsHiddenReport, Birthdate, SchedNote, PreferredName, }: createProviderParams): Promise<Provider>;
+    /**
+     * Update a provider.
+     * @param {number} ProvNum - The ID of the provider.
+     * @param {Object} data - The data for the new patfield.
+     * @param {string} data.Abbr - Optional but must not be blank.
+     * @param {string} data.LName - Optional.
+     * @param {string} data.FName - Optional.
+     * @param {string} data.MI - Optional.
+     * @param {string} data.Suffix - Optional.
+     * @param {number} data.FeeSched - Optional.
+     * @param {number} data.Specialty - Optional.
+     * @param {string} data.SSN - Optional.
+     * @param {'true' | 'false'} data.IsSecondary - Optional.
+     * @param {'true' | 'false'} data.IsHidden - Optional.
+     * @param {'true' | 'false'} data.UsingTIN - Optional.
+     * @param {'true' | 'false'} data.SigOnFile - Optional.
+     * @param {'true' | 'false'} data.IsNotPerson - Optional.
+     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
+     * @param {string} data.Birthdate - Optional.
+     * @param {string} data.SchedNote - Optional.
+     * @param {string} data.PreferredName - Optional.
+     * @returns {Promise<Provider>} - The created PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    updateProvider({ ProvNum, Abbr, LName, FName, MI, Suffix, Specialty, SSN, NationalProvID, StateLicense, UsingTIN, SigOnFile, PreferredName, }: updateProviderParams): Promise<Provider>;
+}
+//# sourceMappingURL=providers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../src/api/providers.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,QAAQ,EACR,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACvB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQ5D;;;;;;;;OAQG;IACY,YAAY,CAAC,EACxB,SAAS,EACT,UAAU,EACV,MAAM,GACP,GAAE,iBAAsB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAS/C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,cAAc,CAAC,EACxB,IAAI,EACJ,KAAK,EACL,KAAK,EACL,EAAE,EACF,MAAM,EACN,QAAQ,EACR,SAAS,EACT,GAAG,EACH,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,WAAW,EACX,cAAc,EACd,SAAS,EACT,SAAS,EACT,aAAa,GACd,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAyB7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,cAAc,CAAC,EAC1B,OAAO,EACP,IAAI,EACJ,KAAK,EACL,KAAK,EACL,EAAE,EACF,MAAM,EACN,SAAS,EACT,GAAG,EACH,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,aAAa,GACd,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;CAmB9C"}

package/dist/api/providers.js

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Providers {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Fetch a single provider by its ID.
+     * @param {number} ProvNum - The ID of the provider.
+     * @returns {Promise<Provider>} - The provider data.
+     * @throws {Error} - If `ProvNum` is not valid or the API returns an error.
+     */
+    async getProvider(ProvNum) {
+        if (!ProvNum || typeof ProvNum !== "number") {
+            throw new Error("Invalid parameter: PatNum must be a valid number.");
+        }
+        return await this.httpClient.get(`/providers/${ProvNum}`);
+    }
+    /**
+     * Fetch multiple providers with optional filtering and pagination.
+     * @param {Object} params - Filtering and pagination parameters.
+     * @param {number} [params.ClinicNum] - Get providers by ClinicNum
+     * @param {string} [params.DateTStamp] - Get providers altered after the specified date and time
+     * @param {string} [params.Offset] - Pagination
+    * @returns {Promise<Provider[]>} - A list of summarized patient data.
+     * @throws {Error} - If the API returns an error.
+     */
+    async getProviders({ ClinicNum, DateTStamp, Offset, } = {}) {
+        return await this.httpClient.get("/providers", {
+            ClinicNum,
+            DateTStamp,
+            Offset,
+        });
+    }
+    /**
+     * Creates a provider. Cannot create PatFields associated with hidden PatFieldDefs.
+     * @param {Object} data - The data for the new patfield.
+     * @param {string} data.Abbr - Required.
+     * @param {string} data.LName - Optional.
+     * @param {string} data.FName - Optional.
+     * @param {string} data.MI - Optional.
+     * @param {string} data.Suffix - Optional.
+     * @param {number} data.FeeSched - Optional.
+     * @param {number} data.Specialty - Optional.
+     * @param {string} data.SSN - Optional.
+     * @param {'true' | 'false'} data.IsSecondary - Optional.
+     * @param {'true' | 'false'} data.IsHidden - Optional.
+     * @param {'true' | 'false'} data.UsingTIN - Optional.
+     * @param {'true' | 'false'} data.SigOnFile - Optional.
+     * @param {'true' | 'false'} data.IsNotPerson - Optional.
+     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
+     * @param {string} data.Birthdate - Optional.
+     * @param {string} data.SchedNote - Optional.
+     * @param {string} data.PreferredName - Optional.
+     * @returns {Promise<Provider>} - The created PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    async createProvider({ Abbr, LName, FName, MI, Suffix, FeeSched, Specialty, SSN, IsSecondary, IsHidden, UsingTIN, SigOnFile, IsNotPerson, IsHiddenReport, Birthdate, SchedNote, PreferredName, }) {
+        if (!Abbr) {
+            throw new Error("Invalid data: All Abbr is required.");
+        }
+        return await this.httpClient.post("/providers", {
+            Abbr,
+            LName,
+            FName,
+            MI,
+            Suffix,
+            FeeSched,
+            Specialty,
+            SSN,
+            IsSecondary,
+            IsHidden,
+            UsingTIN,
+            SigOnFile,
+            IsNotPerson,
+            IsHiddenReport,
+            Birthdate,
+            SchedNote,
+            PreferredName,
+        });
+    }
+    /**
+     * Update a provider.
+     * @param {number} ProvNum - The ID of the provider.
+     * @param {Object} data - The data for the new patfield.
+     * @param {string} data.Abbr - Optional but must not be blank.
+     * @param {string} data.LName - Optional.
+     * @param {string} data.FName - Optional.
+     * @param {string} data.MI - Optional.
+     * @param {string} data.Suffix - Optional.
+     * @param {number} data.FeeSched - Optional.
+     * @param {number} data.Specialty - Optional.
+     * @param {string} data.SSN - Optional.
+     * @param {'true' | 'false'} data.IsSecondary - Optional.
+     * @param {'true' | 'false'} data.IsHidden - Optional.
+     * @param {'true' | 'false'} data.UsingTIN - Optional.
+     * @param {'true' | 'false'} data.SigOnFile - Optional.
+     * @param {'true' | 'false'} data.IsNotPerson - Optional.
+     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
+     * @param {string} data.Birthdate - Optional.
+     * @param {string} data.SchedNote - Optional.
+     * @param {string} data.PreferredName - Optional.
+     * @returns {Promise<Provider>} - The created PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    async updateProvider({ ProvNum, Abbr, LName, FName, MI, Suffix, Specialty, SSN, NationalProvID, StateLicense, UsingTIN, SigOnFile, PreferredName, }) {
+        if (!ProvNum) {
+            throw new Error("Invalid data: ProvNum is required.");
+        }
+        return await this.httpClient.put(`/providers/${ProvNum}`, {
+            Abbr,
+            LName,
+            FName,
+            MI,
+            Suffix,
+            Specialty,
+            SSN,
+            NationalProvID,
+            StateLicense,
+            UsingTIN,
+            SigOnFile,
+            PreferredName,
+        });
+    }
+}
+exports.default = Providers;

package/dist/openDental.d.ts

@@ -7,6 +7,8 @@ import ProcedureLogs from "./api/procedureLog";
 import Recalls from "./api/recalls";
 import TreatmentPlans from "./api/treatplans";
 import Schedules from "./api/schedules";
+import Providers from "./api/providers";
+import Operatories from "./api/operatories";
 declare class OpenDental {
     private static httpClient;
     /**
@@ -49,6 +51,14 @@ declare class OpenDental {
      * Create a new instance of the Schedules API.
      */
     static Schedules(): Schedules;
+    /**
+     * Create a new instance of the Schedules API.
+     */
+    static Providers(): Providers;
+    /**
+     * Create a new instance of the Schedules API.
+     */
+    static Operatories(): Operatories;
 }
 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;AAGxC,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;CAQ1B;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;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;CAM5B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -14,6 +14,8 @@ const procedureLog_1 = __importDefault(require("./api/procedureLog"));
 const recalls_1 = __importDefault(require("./api/recalls"));
 const treatplans_1 = __importDefault(require("./api/treatplans"));
 const schedules_1 = __importDefault(require("./api/schedules"));
+const providers_1 = __importDefault(require("./api/providers"));
+const operatories_1 = __importDefault(require("./api/operatories"));
 class OpenDental {
     static httpClient;
     /**
@@ -108,5 +110,23 @@ class OpenDental {
         }
         return new schedules_1.default(this.httpClient);
     }
+    /**
+     * Create a new instance of the Schedules API.
+     */
+    static Providers() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new providers_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the Schedules API.
+     */
+    static Operatories() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new operatories_1.default(this.httpClient);
+    }
 }
 exports.OpenDental = OpenDental;

package/dist/types/operatoryTypes.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Parameters for fetching multiple patients.
+ * @see https://www.opendental.com/site/apioperatories.html
+ * Version Added: 24.1.10
+ */
+export interface Operatory {
+    OperatoryNum?: number;
+    OpName?: string;
+    Abbrev?: string;
+    ItemOrder?: number;
+    IsHidden?: 'true' | 'false';
+    ProvDentist?: number;
+    ProvHygienist?: string;
+    IsHygiene?: 'true' | 'false';
+    SetProspective?: 'true' | 'false';
+    IsWebSched?: 'true' | 'false';
+    OperatoryType?: number;
+    operatoryType?: string;
+}
+export interface GetOperatoriesParams {
+    ClinicNum?: number;
+    Offset?: number;
+}
+//# sourceMappingURL=operatoryTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"operatoryTypes.d.ts","sourceRoot":"","sources":["../../src/types/operatoryTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/types/operatoryTypes.js

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

package/dist/types/providerTypes.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Parameters for fetching multiple patients.
+ * @see https://www.opendental.com/site/apiproviders.html
+ * Version Added: 24.4.17
+ */
+export interface Provider {
+    ProvNum?: number;
+    Abbr?: number;
+    LName?: string;
+    FName?: string;
+    MI?: string;
+    Suffix?: string;
+    FeeSched?: number;
+    Specialty?: number;
+    SSN?: string;
+    StateLicense?: string;
+    IsSecondary?: 'true' | 'false';
+    provColor?: string;
+    IsHidden?: 'true' | 'false';
+    UsingTIN?: string;
+    SigOnFile?: 'true' | 'false';
+    NationalProvID?: string;
+    DateTStamp?: string;
+    IsNotPerson?: 'true' | 'false';
+    ProvStatus?: string;
+    IsHiddenReport?: 'true' | 'false';
+    Birthdate?: string;
+    SchedNote?: string;
+    PreferredName?: string;
+    serverDateTime?: string;
+}
+export interface GetProviderParams {
+    ClinicNum?: number;
+    DateTStamp?: string;
+    Offset?: number;
+}
+export interface createProviderParams {
+    Abbr: number;
+    LName?: string;
+    FName?: string;
+    MI?: string;
+    Suffix?: string;
+    FeeSched?: number;
+    Specialty?: number;
+    SSN?: string;
+    IsSecondary?: 'true' | 'false';
+    IsHidden?: 'true' | 'false';
+    UsingTIN?: string;
+    SigOnFile?: 'true' | 'false';
+    IsNotPerson?: 'true' | 'false';
+    IsHiddenReport?: 'true' | 'false';
+    Birthdate?: string;
+    SchedNote?: string;
+    PreferredName?: string;
+}
+export interface updateProviderParams {
+    ProvNum: number;
+    Abbr?: number;
+    LName?: string;
+    FName?: string;
+    MI?: string;
+    Suffix?: string;
+    PreferredName?: string;
+    Specialty?: number;
+    SigOnFile?: 'true' | 'false';
+    NationalProvID?: string;
+    StateLicense?: string;
+    SSN?: string;
+    UsingTIN?: string;
+}
+//# sourceMappingURL=providerTypes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"providerTypes.d.ts","sourceRoot":"","sources":["../../src/types/providerTypes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

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

package/src/api/operatories.ts

@@ -0,0 +1,46 @@
+import HttpClient from "../utils/httpClient";
+import {
+    Operatory,
+    GetOperatoriesParams,
+} from "../types/operatoryTypes";
+
+export default class Operatories {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch a single patfield by its ID.
+   * @param {number} OperatoryNum - The ID of the patfield.
+   * @returns {Promise<Operatory>} - The patient data.
+   * @throws {Error} - If `PatNum` is not valid or the API returns an error.
+   */
+  public async getPatField(OperatoryNum: number): Promise<Operatory> {
+    if (!OperatoryNum || typeof OperatoryNum !== "number") {
+        throw new Error("Invalid parameter: PatNum must be a valid number.");
+    }
+
+    return await this.httpClient.get<Operatory>(`/operatories/${OperatoryNum}`);
+  }
+
+  /**
+   * Fetch multiple patients with optional filtering and pagination.
+   * @param {Object} params - Filtering and pagination parameters.
+   * @param {string} [params.ClinicNum] - Filter by clinicnum
+   * @param {string} [params.Offset] - Filter by clinicnum
+  * @returns {Promise<Operatory[]>} - A list of summarized patient data.
+   * @throws {Error} - If the API returns an error.
+   */
+    public async getOperatories({
+      ClinicNum,
+      Offset,
+    }: GetOperatoriesParams = {}): Promise<Operatory[]> {
+
+      return await this.httpClient.get<Operatory[]>("/operatories", {
+        ClinicNum,
+        Offset,
+      });
+    }
+}

package/src/api/providers.ts

@@ -0,0 +1,175 @@
+import HttpClient from "../utils/httpClient";
+import {
+    Provider,
+    GetProviderParams,
+    createProviderParams,
+    updateProviderParams,
+} from "../types/providerTypes";
+
+export default class Providers {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch a single provider by its ID.
+   * @param {number} ProvNum - The ID of the provider.
+   * @returns {Promise<Provider>} - The provider data.
+   * @throws {Error} - If `ProvNum` is not valid or the API returns an error.
+   */
+  public async getProvider(ProvNum: number): Promise<Provider> {
+    if (!ProvNum || typeof ProvNum !== "number") {
+        throw new Error("Invalid parameter: PatNum must be a valid number.");
+    }
+
+    return await this.httpClient.get<Provider>(`/providers/${ProvNum}`);
+  }
+
+  /**
+   * Fetch multiple providers with optional filtering and pagination.
+   * @param {Object} params - Filtering and pagination parameters.
+   * @param {number} [params.ClinicNum] - Get providers by ClinicNum
+   * @param {string} [params.DateTStamp] - Get providers altered after the specified date and time
+   * @param {string} [params.Offset] - Pagination
+  * @returns {Promise<Provider[]>} - A list of summarized patient data.
+   * @throws {Error} - If the API returns an error.
+   */
+    public async getProviders({
+      ClinicNum,
+      DateTStamp,
+      Offset,
+    }: GetProviderParams = {}): Promise<Provider[]> {
+
+      return await this.httpClient.get<Provider[]>("/providers", {
+        ClinicNum,
+        DateTStamp,
+        Offset,
+      });
+    }
+
+    /**
+     * Creates a provider. Cannot create PatFields associated with hidden PatFieldDefs.
+     * @param {Object} data - The data for the new patfield.
+     * @param {string} data.Abbr - Required.
+     * @param {string} data.LName - Optional.
+     * @param {string} data.FName - Optional.
+     * @param {string} data.MI - Optional.
+     * @param {string} data.Suffix - Optional.
+     * @param {number} data.FeeSched - Optional.
+     * @param {number} data.Specialty - Optional.
+     * @param {string} data.SSN - Optional.
+     * @param {'true' | 'false'} data.IsSecondary - Optional.
+     * @param {'true' | 'false'} data.IsHidden - Optional.
+     * @param {'true' | 'false'} data.UsingTIN - Optional.
+     * @param {'true' | 'false'} data.SigOnFile - Optional.
+     * @param {'true' | 'false'} data.IsNotPerson - Optional.
+     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
+     * @param {string} data.Birthdate - Optional.
+     * @param {string} data.SchedNote - Optional.
+     * @param {string} data.PreferredName - Optional.
+     * @returns {Promise<Provider>} - The created PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    public async createProvider({
+        Abbr,
+        LName,
+        FName,
+        MI,
+        Suffix,
+        FeeSched,
+        Specialty,
+        SSN,
+        IsSecondary,
+        IsHidden,
+        UsingTIN,
+        SigOnFile,
+        IsNotPerson,
+        IsHiddenReport,
+        Birthdate,
+        SchedNote,
+        PreferredName,
+      }: createProviderParams): Promise<Provider> {
+        if (!Abbr) {
+            throw new Error("Invalid data: All Abbr is required.");
+        }
+        return await this.httpClient.post<Provider>("/providers", {
+          Abbr,
+          LName,
+          FName,
+          MI,
+          Suffix,
+          FeeSched,
+          Specialty,
+          SSN,
+          IsSecondary,
+          IsHidden,
+          UsingTIN,
+          SigOnFile,
+          IsNotPerson,
+          IsHiddenReport,
+          Birthdate,
+          SchedNote,
+          PreferredName,
+        });
+      }
+
+    /**
+     * Update a provider.
+     * @param {number} ProvNum - The ID of the provider.
+     * @param {Object} data - The data for the new patfield.
+     * @param {string} data.Abbr - Optional but must not be blank.
+     * @param {string} data.LName - Optional.
+     * @param {string} data.FName - Optional.
+     * @param {string} data.MI - Optional.
+     * @param {string} data.Suffix - Optional.
+     * @param {number} data.FeeSched - Optional.
+     * @param {number} data.Specialty - Optional.
+     * @param {string} data.SSN - Optional.
+     * @param {'true' | 'false'} data.IsSecondary - Optional.
+     * @param {'true' | 'false'} data.IsHidden - Optional.
+     * @param {'true' | 'false'} data.UsingTIN - Optional.
+     * @param {'true' | 'false'} data.SigOnFile - Optional.
+     * @param {'true' | 'false'} data.IsNotPerson - Optional.
+     * @param {'true' | 'false'} data.IsHiddenReport - Optional.
+     * @param {string} data.Birthdate - Optional.
+     * @param {string} data.SchedNote - Optional.
+     * @param {string} data.PreferredName - Optional.
+     * @returns {Promise<Provider>} - The created PatField.
+     * @throws {Error} - If the data is invalid or the API returns an error.
+     */
+    public async updateProvider({
+      ProvNum,
+      Abbr,
+      LName,
+      FName,
+      MI,
+      Suffix,
+      Specialty,
+      SSN,
+      NationalProvID,
+      StateLicense,
+      UsingTIN,
+      SigOnFile,
+      PreferredName,
+    }: updateProviderParams): Promise<Provider> {
+      if (!ProvNum) {
+          throw new Error("Invalid data: ProvNum is required.");
+      }
+      return await this.httpClient.put<Provider>(`/providers/${ProvNum}`, {
+        Abbr,
+        LName,
+        FName,
+        MI,
+        Suffix,
+        Specialty,
+        SSN,
+        NationalProvID,
+        StateLicense,
+        UsingTIN,
+        SigOnFile,
+        PreferredName,
+      });
+    }
+}

package/src/openDental.ts

@@ -8,7 +8,8 @@ import ProcedureLogs from "./api/procedureLog";
 import Recalls from "./api/recalls";
 import TreatmentPlans from "./api/treatplans";
 import Schedules from "./api/schedules";
-
+import Providers from "./api/providers";
+import Operatories from "./api/operatories";
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -117,8 +118,26 @@ class OpenDental {
       }
       return new Schedules(this.httpClient);
     }
+  
+  /**
+   * Create a new instance of the Schedules API.
+   */
+    public static Providers() {
+      if (!this.httpClient) {
+        throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+      }
+      return new Providers(this.httpClient);
+    }
 
-
+  /**
+   * Create a new instance of the Schedules API.
+   */
+    public static Operatories() {
+      if (!this.httpClient) {
+        throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+      }
+      return new Operatories(this.httpClient);
+    }
 }
 
 export { OpenDental };

package/src/types/operatoryTypes.ts

@@ -0,0 +1,24 @@
+/**
+ * Parameters for fetching multiple patients.
+ * @see https://www.opendental.com/site/apioperatories.html
+ * Version Added: 24.1.10
+ */
+export interface Operatory {
+    OperatoryNum?: number; //Unique identifier for an operatory
+    OpName?: string; //
+    Abbrev?: string; //
+    ItemOrder?: number; //
+    IsHidden?: 'true' | 'false'; //
+    ProvDentist?: number; // 
+    ProvHygienist?: string; //"YYYY-MM-DD" 
+    IsHygiene?: 'true' | 'false'; //
+    SetProspective?: 'true' | 'false'; //
+    IsWebSched?: 'true' | 'false'; //
+    OperatoryType?: number; //"YYYY-MM-DD" 
+    operatoryType?: string; //"YYYY-MM-DD" 
+  }
+
+  export interface GetOperatoriesParams {
+    ClinicNum?: number; //
+    Offset?: number; //
+  }

package/src/types/providerTypes.ts

@@ -0,0 +1,73 @@
+/**
+ * Parameters for fetching multiple patients.
+ * @see https://www.opendental.com/site/apiproviders.html
+ * Version Added: 24.4.17
+ */
+export interface Provider {
+    ProvNum?: number; //Unique identifier for provider
+    Abbr?: number; //
+    LName?: string; //
+    FName?: string; //
+    MI?: string; //
+    Suffix?: string; //
+    FeeSched?: number; //FK to feesched
+    Specialty?: number; //FK to speciality
+    SSN?: string; // 
+    StateLicense?: string; // 
+    IsSecondary?: 'true' | 'false'; //
+    provColor?: string; //
+    IsHidden?: 'true' | 'false'; //
+    UsingTIN?: string; //
+    SigOnFile?: 'true' | 'false'; //
+    NationalProvID?: string; //
+    DateTStamp?: string; //
+    IsNotPerson?: 'true' | 'false'; //
+    ProvStatus?: string; //
+    IsHiddenReport?: 'true' | 'false'; //
+    Birthdate?: string; //"YYYY-MM-DD" 
+    SchedNote?: string; //
+    PreferredName?: string; //
+    serverDateTime?: string; //
+  }
+
+  export interface GetProviderParams {
+    ClinicNum?: number; //Optional. Specifying a ClinicNum returns list of non-hidden providers that are either not restricted to a clinic, or are restricted to the ClinicNum provided. When using ClinicNum, a serverDateTime will not be returned.
+    DateTStamp?: string; // (added in version 21.3): Optional. String in "yyyy-MM-dd HH:mm:ss" format. Get providers altered after the specified date and time. This is a good way for you to keep a synchronized copy of providers. Store serverDateTime that gets returned, and use it to run the next GET.
+    Offset?: number; // 
+  }
+
+  export interface createProviderParams {
+    Abbr: number; //Unique identifier for patient
+    LName?: string; // 
+    FName?: string; // 
+    MI?: string; //
+    Suffix?: string; //
+    FeeSched?: number; //FK to feesched
+    Specialty?: number; //FK to speciality
+    SSN?: string; // 
+    IsSecondary?: 'true' | 'false'; //
+    IsHidden?: 'true' | 'false'; //
+    UsingTIN?: string; //
+    SigOnFile?: 'true' | 'false'; //
+    IsNotPerson?: 'true' | 'false'; //
+    IsHiddenReport?: 'true' | 'false'; //
+    Birthdate?: string; //"YYYY-MM-DD" 
+    SchedNote?: string; //
+    PreferredName?: string; //
+  }
+
+  export interface updateProviderParams {
+    ProvNum: number //Unique identifier for provider
+    Abbr?: number; //
+    LName?: string; // 
+    FName?: string; // 
+    MI?: string; //
+    Suffix?: string; //
+    PreferredName?: string; //
+    Specialty?: number; //FK to speciality
+    SigOnFile?: 'true' | 'false'; //
+    NationalProvID?: string; //
+    StateLicense?: string; // 
+    SSN?: string; // 
+    UsingTIN?: string; //    
+  }