candidhealth 1.8.1 → 1.9.1

package/api/resources/preEncounter/resources/patients/resources/v1/client/Client.d.ts

@@ -10,6 +10,8 @@ export declare namespace V1 {
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -18,8 +20,10 @@ export declare namespace V1 {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class V1 {
@@ -172,7 +176,8 @@ export declare class V1 {
      *         }
      *     })
      */
-    create(request: CandidApi.preEncounter.patients.v1.CreatePatientRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.create.Error>>;
+    create(request: CandidApi.preEncounter.patients.v1.CreatePatientRequest, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.create.Error>>;
+    private __create;
     /**
      * Adds a patient and hydrates their MRN with a pre-existing MRN.  Once this patient is created their MRN will not be editable. BadRequestError is returned when the MRN is greater than 20 characters. VersionConflictError is returned when the patient's external ID is already in use.
      *
@@ -182,6 +187,7 @@ export declare class V1 {
      * @example
      *     await client.preEncounter.patients.v1.createWithMrn({
      *         body: {
+     *             mrn: "mrn",
      *             name: {
      *                 family: "family",
      *                 given: ["given", "given"],
@@ -316,12 +322,12 @@ export declare class V1 {
      *                 }],
      *             filingOrder: {
      *                 coverages: [CandidApi.preEncounter.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.preEncounter.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]
-     *             },
-     *             mrn: "mrn"
+     *             }
      *         }
      *     })
      */
-    createWithMrn(request: CandidApi.preEncounter.patients.v1.CreatePatientWithMrnRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.createWithMrn.Error>>;
+    createWithMrn(request: CandidApi.preEncounter.patients.v1.CreatePatientWithMrnRequest, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.createWithMrn.Error>>;
+    private __createWithMrn;
     /**
      * Searches for patients that match the query parameters.
      *
@@ -331,7 +337,8 @@ export declare class V1 {
      * @example
      *     await client.preEncounter.patients.v1.getMulti()
      */
-    getMulti(request?: CandidApi.preEncounter.patients.v1.PatientsSearchRequestPaginated, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.PatientPage, CandidApi.preEncounter.patients.v1.getMulti.Error>>;
+    getMulti(request?: CandidApi.preEncounter.patients.v1.PatientsSearchRequestPaginated, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.patients.v1.PatientPage, CandidApi.preEncounter.patients.v1.getMulti.Error>>;
+    private __getMulti;
     /**
      * Searches for referring providers that match the query parameters.  The search is case-insensitive, supports fuzzy matching, and matches against provider name and NPI. The search criteria must be an alphanumeric string, and the search is limited to the first 20 results.
      *
@@ -343,7 +350,8 @@ export declare class V1 {
      *         searchCriteria: "search_criteria"
      *     })
      */
-    searchProviders(request: CandidApi.preEncounter.patients.v1.SearchProvidersRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.ExternalProvider[], CandidApi.preEncounter.patients.v1.searchProviders.Error>>;
+    searchProviders(request: CandidApi.preEncounter.patients.v1.SearchProvidersRequest, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.ExternalProvider[], CandidApi.preEncounter.patients.v1.searchProviders.Error>>;
+    private __searchProviders;
     /**
      * Gets a patient.
      *
@@ -353,7 +361,8 @@ export declare class V1 {
      * @example
      *     await client.preEncounter.patients.v1.get(CandidApi.preEncounter.PatientId("id"))
      */
-    get(id: CandidApi.preEncounter.PatientId, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.get.Error>>;
+    get(id: CandidApi.preEncounter.PatientId, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.get.Error>>;
+    private __get;
     /**
      * Gets a patient by mrn.
      *
@@ -363,7 +372,8 @@ export declare class V1 {
      * @example
      *     await client.preEncounter.patients.v1.getByMrn("mrn")
      */
-    getByMrn(mrn: string, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.getByMrn.Error>>;
+    getByMrn(mrn: string, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.getByMrn.Error>>;
+    private __getByMrn;
     /**
      * Gets a patient along with it's full history.  The return list is ordered by version ascending.
      *
@@ -373,7 +383,8 @@ export declare class V1 {
      * @example
      *     await client.preEncounter.patients.v1.getHistory(CandidApi.preEncounter.PatientId("id"))
      */
-    getHistory(id: CandidApi.preEncounter.PatientId, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.getHistory.Error>>;
+    getHistory(id: CandidApi.preEncounter.PatientId, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.getHistory.Error>>;
+    private __getHistory;
     /**
      * Updates a patient. The path must contain the next version number to prevent race conditions. For example, if the current version of the patient is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the patient. Updating historic versions is not supported.
      *
@@ -521,7 +532,8 @@ export declare class V1 {
      *         }
      *     })
      */
-    update(id: CandidApi.preEncounter.PatientId, version: string, request: CandidApi.preEncounter.patients.v1.MutablePatient, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.update.Error>>;
+    update(id: CandidApi.preEncounter.PatientId, version: string, request: CandidApi.preEncounter.patients.v1.MutablePatient, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.update.Error>>;
+    private __update;
     /**
      * Sets a patient as deactivated.  The path must contain the most recent version plus 1 to prevent race conditions.  Deactivating historic versions is not supported.
      *
@@ -532,7 +544,8 @@ export declare class V1 {
      * @example
      *     await client.preEncounter.patients.v1.deactivate(CandidApi.preEncounter.PatientId("id"), "version")
      */
-    deactivate(id: CandidApi.preEncounter.PatientId, version: string, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<void, CandidApi.preEncounter.patients.v1.deactivate.Error>>;
+    deactivate(id: CandidApi.preEncounter.PatientId, version: string, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, CandidApi.preEncounter.patients.v1.deactivate.Error>>;
+    private __deactivate;
     /**
      * Removes the deactivated flag for a patient.  The path must contain the most recent version plus 1 to prevent race conditions.  Reactivating historic versions is not supported.
      *
@@ -543,7 +556,8 @@ export declare class V1 {
      * @example
      *     await client.preEncounter.patients.v1.reactivate(CandidApi.preEncounter.PatientId("id"), "version")
      */
-    reactivate(id: CandidApi.preEncounter.PatientId, version: string, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<void, CandidApi.preEncounter.patients.v1.reactivate.Error>>;
+    reactivate(id: CandidApi.preEncounter.PatientId, version: string, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<void, CandidApi.preEncounter.patients.v1.reactivate.Error>>;
+    private __reactivate;
     /**
      * Returns a list of Patients based on the search criteria.
      *
@@ -553,7 +567,8 @@ export declare class V1 {
      * @example
      *     await client.preEncounter.patients.v1.search()
      */
-    search(request?: CandidApi.preEncounter.patients.v1.PatientGetMultiRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.search.Error>>;
+    search(request?: CandidApi.preEncounter.patients.v1.PatientGetMultiRequest, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.search.Error>>;
+    private __search;
     /**
      * Scans up to 100 patient updates.  The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.
      *
@@ -562,9 +577,10 @@ export declare class V1 {
      *
      * @example
      *     await client.preEncounter.patients.v1.scan({
-     *         since: "2024-01-15T09:30:00Z"
+     *         since: new Date("2024-01-15T09:30:00.000Z")
      *     })
      */
-    scan(request: CandidApi.preEncounter.patients.v1.PatientScanRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.scan.Error>>;
+    scan(request: CandidApi.preEncounter.patients.v1.PatientScanRequest, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.scan.Error>>;
+    private __scan;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }