candidhealth 0.23.0 → 0.24.1

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

@@ -3,333 +3,24 @@
  */
 import * as environments from "../../../../../../environments";
 import * as core from "../../../../../../core";
-import * as CandidApi from "../../../../../index";
+import { V1 } from "../resources/v1/client/Client";
 export declare namespace Patients {
     interface Options {
-        environment?: core.Supplier<environments.CandidApiEnvironment | string>;
+        environment?: core.Supplier<environments.CandidApiEnvironment | environments.CandidApiEnvironmentUrls>;
         token?: core.Supplier<core.BearerToken | undefined>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
     }
 }
 export declare class Patients {
     protected readonly _options: Patients.Options;
     constructor(_options?: Patients.Options);
-    /**
-     * Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.
-     *
-     * @param {CandidApi.preEncounter.MutablePatient} request
-     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await candidApi.preEncounter.patients.create({
-     *         name: {
-     *             family: "string",
-     *             given: ["string"],
-     *             use: CandidApi.preEncounter.NameUse.Usual,
-     *             period: {}
-     *         },
-     *         otherNames: [{
-     *                 family: "string",
-     *                 given: ["string"],
-     *                 use: CandidApi.preEncounter.NameUse.Usual,
-     *                 period: {}
-     *             }],
-     *         gender: CandidApi.preEncounter.Gender.Female,
-     *         birthDate: "2023-01-15",
-     *         maritalStatus: CandidApi.preEncounter.MaritalStatus.Annulled,
-     *         deceased: new Date("2024-01-15T09:30:00.000Z"),
-     *         multipleBirth: 1,
-     *         primaryAddress: {
-     *             use: CandidApi.preEncounter.AddressUse.Home,
-     *             line: ["string"],
-     *             city: "string",
-     *             state: "string",
-     *             postalCode: "string",
-     *             country: "string",
-     *             period: {}
-     *         },
-     *         otherAddresses: [{
-     *                 use: CandidApi.preEncounter.AddressUse.Home,
-     *                 line: ["string"],
-     *                 city: "string",
-     *                 state: "string",
-     *                 postalCode: "string",
-     *                 country: "string",
-     *                 period: {}
-     *             }],
-     *         primaryTelecom: {
-     *             value: "string",
-     *             use: CandidApi.preEncounter.ContactPointUse.Home,
-     *             period: {
-     *                 start: "2023-01-15",
-     *                 end: "2023-01-15"
-     *             }
-     *         },
-     *         otherTelecoms: [{
-     *                 value: "string",
-     *                 use: CandidApi.preEncounter.ContactPointUse.Home,
-     *                 period: {
-     *                     start: "2023-01-15",
-     *                     end: "2023-01-15"
-     *                 }
-     *             }],
-     *         photo: "string",
-     *         language: "string",
-     *         externalProvenance: {
-     *             externalId: "string",
-     *             systemName: "string"
-     *         },
-     *         contacts: [{
-     *                 relationship: [CandidApi.preEncounter.Relationship.Self],
-     *                 name: {
-     *                     family: "string",
-     *                     given: ["string"],
-     *                     use: CandidApi.preEncounter.NameUse.Usual,
-     *                     period: {}
-     *                 },
-     *                 gender: CandidApi.preEncounter.Gender.Female,
-     *                 telecoms: [{
-     *                         value: "string",
-     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
-     *                         period: {
-     *                             start: "2023-01-15",
-     *                             end: "2023-01-15"
-     *                         }
-     *                     }],
-     *                 addresses: [{
-     *                         use: CandidApi.preEncounter.AddressUse.Home,
-     *                         line: ["string"],
-     *                         city: "string",
-     *                         state: "string",
-     *                         postalCode: "string",
-     *                         country: "string",
-     *                         period: {}
-     *                     }],
-     *                 period: {
-     *                     start: "2023-01-15",
-     *                     end: "2023-01-15"
-     *                 }
-     *             }],
-     *         generalPractitioners: [{
-     *                 name: {
-     *                     family: "string",
-     *                     given: ["string"],
-     *                     use: CandidApi.preEncounter.NameUse.Usual,
-     *                     period: {}
-     *                 },
-     *                 telecoms: [{
-     *                         value: "string",
-     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
-     *                         period: {
-     *                             start: "2023-01-15",
-     *                             end: "2023-01-15"
-     *                         }
-     *                     }],
-     *                 addresses: [{
-     *                         use: CandidApi.preEncounter.AddressUse.Home,
-     *                         line: ["string"],
-     *                         city: "string",
-     *                         state: "string",
-     *                         postalCode: "string",
-     *                         country: "string",
-     *                         period: {}
-     *                     }],
-     *                 period: {
-     *                     start: "2023-01-15",
-     *                     end: "2023-01-15"
-     *                 }
-     *             }]
-     *     })
-     */
-    create(request: CandidApi.preEncounter.MutablePatient, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient, CandidApi.preEncounter.patients.create.Error>>;
-    /**
-     * Gets a patient.
-     *
-     * @param {CandidApi.preEncounter.PatientId} id
-     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await candidApi.preEncounter.patients.get(CandidApi.preEncounter.PatientId("string"))
-     */
-    get(id: CandidApi.preEncounter.PatientId, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient, CandidApi.preEncounter.patients.get.Error>>;
-    /**
-     * Gets a patient along with it's full history. The return list is ordered by version ascending.
-     *
-     * @param {CandidApi.preEncounter.PatientId} id
-     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await candidApi.preEncounter.patients.getHistory(CandidApi.preEncounter.PatientId("string"))
-     */
-    getHistory(id: CandidApi.preEncounter.PatientId, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient[], CandidApi.preEncounter.patients.getHistory.Error>>;
-    /**
-     * Updates a patient. The path must contain the most recent version to prevent races. Updating historic versions is not supported.
-     *
-     * @param {CandidApi.preEncounter.PatientId} id
-     * @param {number} version
-     * @param {CandidApi.preEncounter.MutablePatient} request
-     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await candidApi.preEncounter.patients.update(CandidApi.preEncounter.PatientId("string"), 1, {
-     *         name: {
-     *             family: "string",
-     *             given: ["string"],
-     *             use: CandidApi.preEncounter.NameUse.Usual,
-     *             period: {}
-     *         },
-     *         otherNames: [{
-     *                 family: "string",
-     *                 given: ["string"],
-     *                 use: CandidApi.preEncounter.NameUse.Usual,
-     *                 period: {}
-     *             }],
-     *         gender: CandidApi.preEncounter.Gender.Female,
-     *         birthDate: "2023-01-15",
-     *         maritalStatus: CandidApi.preEncounter.MaritalStatus.Annulled,
-     *         deceased: new Date("2024-01-15T09:30:00.000Z"),
-     *         multipleBirth: 1,
-     *         primaryAddress: {
-     *             use: CandidApi.preEncounter.AddressUse.Home,
-     *             line: ["string"],
-     *             city: "string",
-     *             state: "string",
-     *             postalCode: "string",
-     *             country: "string",
-     *             period: {}
-     *         },
-     *         otherAddresses: [{
-     *                 use: CandidApi.preEncounter.AddressUse.Home,
-     *                 line: ["string"],
-     *                 city: "string",
-     *                 state: "string",
-     *                 postalCode: "string",
-     *                 country: "string",
-     *                 period: {}
-     *             }],
-     *         primaryTelecom: {
-     *             value: "string",
-     *             use: CandidApi.preEncounter.ContactPointUse.Home,
-     *             period: {
-     *                 start: "2023-01-15",
-     *                 end: "2023-01-15"
-     *             }
-     *         },
-     *         otherTelecoms: [{
-     *                 value: "string",
-     *                 use: CandidApi.preEncounter.ContactPointUse.Home,
-     *                 period: {
-     *                     start: "2023-01-15",
-     *                     end: "2023-01-15"
-     *                 }
-     *             }],
-     *         photo: "string",
-     *         language: "string",
-     *         externalProvenance: {
-     *             externalId: "string",
-     *             systemName: "string"
-     *         },
-     *         contacts: [{
-     *                 relationship: [CandidApi.preEncounter.Relationship.Self],
-     *                 name: {
-     *                     family: "string",
-     *                     given: ["string"],
-     *                     use: CandidApi.preEncounter.NameUse.Usual,
-     *                     period: {}
-     *                 },
-     *                 gender: CandidApi.preEncounter.Gender.Female,
-     *                 telecoms: [{
-     *                         value: "string",
-     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
-     *                         period: {
-     *                             start: "2023-01-15",
-     *                             end: "2023-01-15"
-     *                         }
-     *                     }],
-     *                 addresses: [{
-     *                         use: CandidApi.preEncounter.AddressUse.Home,
-     *                         line: ["string"],
-     *                         city: "string",
-     *                         state: "string",
-     *                         postalCode: "string",
-     *                         country: "string",
-     *                         period: {}
-     *                     }],
-     *                 period: {
-     *                     start: "2023-01-15",
-     *                     end: "2023-01-15"
-     *                 }
-     *             }],
-     *         generalPractitioners: [{
-     *                 name: {
-     *                     family: "string",
-     *                     given: ["string"],
-     *                     use: CandidApi.preEncounter.NameUse.Usual,
-     *                     period: {}
-     *                 },
-     *                 telecoms: [{
-     *                         value: "string",
-     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
-     *                         period: {
-     *                             start: "2023-01-15",
-     *                             end: "2023-01-15"
-     *                         }
-     *                     }],
-     *                 addresses: [{
-     *                         use: CandidApi.preEncounter.AddressUse.Home,
-     *                         line: ["string"],
-     *                         city: "string",
-     *                         state: "string",
-     *                         postalCode: "string",
-     *                         country: "string",
-     *                         period: {}
-     *                     }],
-     *                 period: {
-     *                     start: "2023-01-15",
-     *                     end: "2023-01-15"
-     *                 }
-     *             }]
-     *     })
-     */
-    update(id: CandidApi.preEncounter.PatientId, version: number, request: CandidApi.preEncounter.MutablePatient, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient, CandidApi.preEncounter.patients.update.Error>>;
-    /**
-     * Sets a patient as deactivated. The path must contain the most recent version to prevent races. Dactivating historic versions is not supported. Subsequent updates via PUT to the patient will "reactivate" the patient and set the deactivated flag to false.
-     *
-     * @param {CandidApi.preEncounter.PatientId} id
-     * @param {number} version
-     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await candidApi.preEncounter.patients.deactivate(CandidApi.preEncounter.PatientId("string"), 1)
-     */
-    deactivate(id: CandidApi.preEncounter.PatientId, version: number, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<void, CandidApi.preEncounter.patients.deactivate.Error>>;
-    /**
-     * Searches for patients that match the query parameters.
-     *
-     * @param {CandidApi.preEncounter.PatientsSearchRequest} request
-     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await candidApi.preEncounter.patients.search({
-     *         nameContains: "string"
-     *     })
-     */
-    search(request?: CandidApi.preEncounter.PatientsSearchRequest, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient[], CandidApi.preEncounter.patients.search.Error>>;
-    /**
-     * Scans up to 100 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt descending.
-     *
-     * @param {CandidApi.preEncounter.PatientScanRequest} request
-     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await candidApi.preEncounter.patients.scan({
-     *         since: new Date("2024-01-15T09:30:00.000Z")
-     *     })
-     */
-    scan(request: CandidApi.preEncounter.PatientScanRequest, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient[], CandidApi.preEncounter.patients.scan.Error>>;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    protected _v1: V1 | undefined;
+    get v1(): V1;
 }