candidhealth 1.8.1 → 1.9.0

package/api/resources/encounters/client/Client.d.ts

@@ -10,16 +10,8 @@ export declare namespace Encounters {
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         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;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class Encounters {

package/api/resources/encounters/resources/v4/client/Client.d.ts

@@ -10,6 +10,8 @@ export declare namespace V4 {
         /** 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 V4 {
         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 V4 {
@@ -40,10 +44,11 @@ export declare class V4 {
      *         primaryPayerNames: "Medicare,Medicaid",
      *         searchTerm: "doe",
      *         externalId: CandidApi.EncounterExternalId("123456"),
-     *         diagnosesUpdatedSince: "2019-08-24T14:15:22Z"
+     *         diagnosesUpdatedSince: new Date("2019-08-24T14:15:22.000Z")
      *     })
      */
-    getAll(request?: CandidApi.encounters.v4.GetAllEncountersRequest, requestOptions?: V4.RequestOptions): Promise<core.APIResponse<CandidApi.encounters.v4.EncounterPage, CandidApi.encounters.v4.getAll.Error>>;
+    getAll(request?: CandidApi.encounters.v4.GetAllEncountersRequest, requestOptions?: V4.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.encounters.v4.EncounterPage, CandidApi.encounters.v4.getAll.Error>>;
+    private __getAll;
     /**
      * @param {CandidApi.EncounterId} encounterId
      * @param {V4.RequestOptions} requestOptions - Request-specific configuration.
@@ -51,79 +56,21 @@ export declare class V4 {
      * @example
      *     await client.encounters.v4.get(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"))
      */
-    get(encounterId: CandidApi.EncounterId, requestOptions?: V4.RequestOptions): Promise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.get.Error>>;
-    /**
-     * @param {CandidApi.encountersUniversal.UniversalEncounterCreate} request
-     * @param {V4.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.encounters.v4.createUniversal({
-     *         externalId: CandidApi.EncounterExternalId("external_id"),
-     *         patientAuthorizedRelease: true,
-     *         benefitsAssignedToProvider: true,
-     *         providerAcceptsAssignment: true,
-     *         billableStatus: "BILLABLE",
-     *         patient: {
-     *             firstName: "first_name",
-     *             lastName: "last_name",
-     *             gender: "male",
-     *             externalId: "external_id",
-     *             dateOfBirth: "2023-01-15",
-     *             address: {
-     *                 address1: "address1",
-     *                 city: "city",
-     *                 state: "AA",
-     *                 zipCode: "zip_code"
-     *             }
-     *         },
-     *         responsibleParty: "INSURANCE_PAY",
-     *         billingProvider: {
-     *             address: {
-     *                 address1: "address1",
-     *                 city: "city",
-     *                 state: "AA",
-     *                 zipCode: "zip_code",
-     *                 zipPlusFourCode: "zip_plus_four_code"
-     *             },
-     *             taxId: "tax_id",
-     *             npi: "npi"
-     *         },
-     *         submissionExpectation: "TARGET_PROFESSIONAL"
-     *     })
-     */
-    createUniversal(request: CandidApi.encountersUniversal.UniversalEncounterCreate, requestOptions?: V4.RequestOptions): Promise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.createUniversal.Error>>;
+    get(encounterId: CandidApi.EncounterId, requestOptions?: V4.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.get.Error>>;
+    private __get;
     /**
      * @param {CandidApi.encounters.v4.EncounterCreate} request
      * @param {V4.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.encounters.v4.create({
-     *         externalId: CandidApi.EncounterExternalId("external_id"),
-     *         patientAuthorizedRelease: true,
-     *         benefitsAssignedToProvider: true,
-     *         providerAcceptsAssignment: true,
-     *         billableStatus: "BILLABLE",
-     *         patient: {
-     *             firstName: "first_name",
-     *             lastName: "last_name",
-     *             gender: "male",
-     *             externalId: "external_id",
-     *             dateOfBirth: "2023-01-15",
-     *             address: {
-     *                 address1: "address1",
-     *                 city: "city",
-     *                 state: "AA",
-     *                 zipCode: "zip_code"
-     *             }
-     *         },
-     *         responsibleParty: "INSURANCE_PAY",
      *         billingProvider: {
      *             address: {
+     *                 zipPlusFourCode: "zip_plus_four_code",
      *                 address1: "address1",
      *                 city: "city",
      *                 state: "AA",
-     *                 zipCode: "zip_code",
-     *                 zipPlusFourCode: "zip_plus_four_code"
+     *                 zipCode: "zip_code"
      *             },
      *             taxId: "tax_id",
      *             npi: "npi"
@@ -138,55 +85,30 @@ export declare class V4 {
      *         placeOfServiceCode: "01",
      *         renderingProvider: {
      *             npi: "npi"
-     *         }
-     *     })
-     */
-    create(request: CandidApi.encounters.v4.EncounterCreate, requestOptions?: V4.RequestOptions): Promise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.create.Error>>;
-    /**
-     * Create an encounter from a pre-encounter patient and appointment. This endpoint is intended to be used by consumers who are managing
-     * patients and appointments in the pre-encounter service and is currently under development. Consumers who are not taking advantage
-     * of the pre-encounter service should use the standard create endpoint.
-     *
-     * The endpoint will create an encounter from the provided fields, pulling information from the provided patient and appointment objects
-     * where applicable. In particular, the following fields are populated from the patient and appointment objects:
-     *   - Patient
-     *   - Referring Provider
-     *   - Subscriber Primary
-     *   - Subscriber Secondary
-     *   - Referral Number
-     *   - Responsible Party
-     *   - Guarantor
-     *
-     * Utilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the
-     * encounter has not already been submitted or adjudicated.
-     *
-     * @param {CandidApi.encountersUniversal.UniversalEncounterCreateFromPreEncounter} request
-     * @param {V4.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.encounters.v4.createFromPreEncounterPatientUniversal({
-     *         externalId: CandidApi.EncounterExternalId("external_id"),
-     *         patientAuthorizedRelease: true,
-     *         benefitsAssignedToProvider: true,
-     *         providerAcceptsAssignment: true,
-     *         billableStatus: "BILLABLE",
-     *         preEncounterPatientId: CandidApi.PreEncounterPatientId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
-     *         preEncounterAppointmentIds: [CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
-     *         billingProvider: {
+     *         },
+     *         patient: {
+     *             externalId: "external_id",
+     *             dateOfBirth: "2023-01-15",
      *             address: {
      *                 address1: "address1",
      *                 city: "city",
      *                 state: "AA",
-     *                 zipCode: "zip_code",
-     *                 zipPlusFourCode: "zip_plus_four_code"
+     *                 zipCode: "zip_code"
      *             },
-     *             taxId: "tax_id",
-     *             npi: "npi"
+     *             firstName: "first_name",
+     *             lastName: "last_name",
+     *             gender: "male"
      *         },
-     *         submissionExpectation: "TARGET_PROFESSIONAL"
+     *         responsibleParty: "INSURANCE_PAY",
+     *         externalId: CandidApi.EncounterExternalId("external_id"),
+     *         patientAuthorizedRelease: true,
+     *         benefitsAssignedToProvider: true,
+     *         providerAcceptsAssignment: true,
+     *         billableStatus: "BILLABLE"
      *     })
      */
-    createFromPreEncounterPatientUniversal(request: CandidApi.encountersUniversal.UniversalEncounterCreateFromPreEncounter, requestOptions?: V4.RequestOptions): Promise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.createFromPreEncounterPatientUniversal.Error>>;
+    create(request: CandidApi.encounters.v4.EncounterCreate, requestOptions?: V4.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.create.Error>>;
+    private __create;
     /**
      * Create an encounter from a pre-encounter patient and appointment. This endpoint is intended to be used by consumers who are managing
      * patients and appointments in the pre-encounter service and is currently under development. Consumers who are not taking advantage
@@ -210,47 +132,39 @@ export declare class V4 {
      *
      * @example
      *     await client.encounters.v4.createFromPreEncounterPatient({
-     *         externalId: CandidApi.EncounterExternalId("external_id"),
-     *         patientAuthorizedRelease: true,
-     *         benefitsAssignedToProvider: true,
-     *         providerAcceptsAssignment: true,
-     *         billableStatus: "BILLABLE",
+     *         renderingProvider: {
+     *             npi: "npi"
+     *         },
+     *         placeOfServiceCode: "01",
+     *         diagnoses: [{
+     *                 codeType: "ABF",
+     *                 code: "code"
+     *             }, {
+     *                 codeType: "ABF",
+     *                 code: "code"
+     *             }],
      *         preEncounterPatientId: CandidApi.PreEncounterPatientId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
      *         preEncounterAppointmentIds: [CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
      *         billingProvider: {
      *             address: {
+     *                 zipPlusFourCode: "zip_plus_four_code",
      *                 address1: "address1",
      *                 city: "city",
      *                 state: "AA",
-     *                 zipCode: "zip_code",
-     *                 zipPlusFourCode: "zip_plus_four_code"
+     *                 zipCode: "zip_code"
      *             },
      *             taxId: "tax_id",
      *             npi: "npi"
      *         },
-     *         renderingProvider: {
-     *             npi: "npi"
-     *         },
-     *         placeOfServiceCode: "01",
-     *         diagnoses: [{
-     *                 codeType: "ABF",
-     *                 code: "code"
-     *             }, {
-     *                 codeType: "ABF",
-     *                 code: "code"
-     *             }]
+     *         externalId: CandidApi.EncounterExternalId("external_id"),
+     *         patientAuthorizedRelease: true,
+     *         benefitsAssignedToProvider: true,
+     *         providerAcceptsAssignment: true,
+     *         billableStatus: "BILLABLE"
      *     })
      */
-    createFromPreEncounterPatient(request: CandidApi.encounters.v4.EncounterCreateFromPreEncounter, requestOptions?: V4.RequestOptions): Promise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.createFromPreEncounterPatient.Error>>;
-    /**
-     * @param {CandidApi.EncounterId} encounterId
-     * @param {CandidApi.encountersUniversal.UniversalEncounterUpdate} request
-     * @param {V4.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.encounters.v4.updateUniversal(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {})
-     */
-    updateUniversal(encounterId: CandidApi.EncounterId, request: CandidApi.encountersUniversal.UniversalEncounterUpdate, requestOptions?: V4.RequestOptions): Promise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.updateUniversal.Error>>;
+    createFromPreEncounterPatient(request: CandidApi.encounters.v4.EncounterCreateFromPreEncounter, requestOptions?: V4.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.createFromPreEncounterPatient.Error>>;
+    private __createFromPreEncounterPatient;
     /**
      * @param {CandidApi.EncounterId} encounterId
      * @param {CandidApi.encounters.v4.EncounterUpdate} request
@@ -259,6 +173,7 @@ export declare class V4 {
      * @example
      *     await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {})
      */
-    update(encounterId: CandidApi.EncounterId, request: CandidApi.encounters.v4.EncounterUpdate, requestOptions?: V4.RequestOptions): Promise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.update.Error>>;
+    update(encounterId: CandidApi.EncounterId, request: CandidApi.encounters.v4.EncounterUpdate, requestOptions?: V4.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.update.Error>>;
+    private __update;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }