candidhealth 0.6.2 → 0.6.4

package/dist/api/resources/exports/resources/v3/types/GetExportsResponse.d.ts

@@ -1,6 +1,15 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         name: "John Doe",
+ *         createdAt: new Date("2021-10-07T00:00:00.000Z"),
+ *         authenticatedDownloadUrl: "https://example.com",
+ *         authenticatedDownloadUrlExpiration: new Date("2021-10-07T00:02:00.000Z")
+ *     }
+ */
 export interface GetExportsResponse {
     /** Report name; contains date strings representing the start and end date of the export. */
     name: string;

package/dist/api/resources/guarantor/resources/v1/client/Client.js

@@ -48,7 +48,7 @@ class V1 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.2",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             body: await serializers.guarantor.v1.GuarantorCreate.jsonOrThrow(request, {
@@ -94,7 +94,7 @@ class V1 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.2",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             timeoutMs: 60000,
@@ -123,7 +123,7 @@ class V1 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.2",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             body: await serializers.guarantor.v1.GuarantorUpdate.jsonOrThrow(request, {

package/dist/api/resources/guarantor/resources/v1/client/requests/GuarantorUpdate.d.ts

@@ -5,7 +5,12 @@ import * as CandidApi from "../../../../../..";
 export interface GuarantorUpdate {
     firstName?: string;
     lastName?: string;
+    /** A unique identifier for the guarantor assigned by an external system. */
     externalId?: string;
+    /**
+     * Date formatted as YYYY-MM-DD; eg: 2019-08-25.
+     *
+     */
     dateOfBirth?: string;
     address?: CandidApi.StreetAddressShortZip;
     phoneNumbers?: CandidApi.PhoneNumber[];

package/dist/api/resources/guarantor/resources/v1/types/Guarantor.d.ts

@@ -2,6 +2,31 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../..";
+/**
+ * @example
+ *     {
+ *         guarantorId: CandidApi.guarantor.v1.GuarantorId("8BBDBE63-58D3-4D40-98C9-40403C050977"),
+ *         phoneNumbers: [{
+ *                 number: "1234567890",
+ *                 type: CandidApi.PhoneNumberType.Home
+ *             }],
+ *         phoneConsent: true,
+ *         email: CandidApi.Email("johndoe@joincandidhealth.com"),
+ *         emailConsent: true,
+ *         firstName: "John",
+ *         lastName: "Doe",
+ *         externalId: "49460F77-6456-41F1-AC6D-0AED08614D39",
+ *         dateOfBirth: "2000-01-01",
+ *         address: {
+ *             address1: "123 Main St",
+ *             address2: "Apt 1",
+ *             city: "New York",
+ *             state: CandidApi.State.Ny,
+ *             zipCode: "10001",
+ *             zipPlusFourCode: "1234"
+ *         }
+ *     }
+ */
 export interface Guarantor extends CandidApi.guarantor.v1.GuarantorBase {
     guarantorId: CandidApi.guarantor.v1.GuarantorId;
     phoneNumbers: CandidApi.PhoneNumber[];

package/dist/api/resources/identifiers/types/Identifier.d.ts

@@ -2,6 +2,18 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         identifierId: CandidApi.IdentifierId("123e4567-e89b-12d3-a456-426614174000"),
+ *         identifierCode: CandidApi.IdentifierCode.Mcr,
+ *         identifierValue: {
+ *             type: "medicare_provider_identifier",
+ *             state: CandidApi.State.Ca,
+ *             providerNumber: "1234567890"
+ *         }
+ *     }
+ */
 export interface Identifier extends CandidApi.IdentifierBase {
     identifierId: CandidApi.IdentifierId;
 }

package/dist/api/resources/individual/types/Patient.d.ts

@@ -2,6 +2,32 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         individualId: CandidApi.IndividualId("93DDBEBF-4956-4482-9A6C-21499B7E4E5D"),
+ *         phoneNumbers: [{
+ *                 number: "1234567890",
+ *                 type: CandidApi.PhoneNumberType.Home
+ *             }],
+ *         phoneConsent: true,
+ *         email: CandidApi.Email("johndoe@joincandidhealth.com"),
+ *         emailConsent: true,
+ *         externalId: "49460F77-6456-41F1-AC6D-0AED08614D39",
+ *         dateOfBirth: CandidApi.Date_("2000-01-01"),
+ *         address: {
+ *             address1: "123 Main St",
+ *             address2: "Apt 1",
+ *             city: "New York",
+ *             state: CandidApi.State.Ny,
+ *             zipCode: "10001",
+ *             zipPlusFourCode: "1234"
+ *         },
+ *         firstName: "John",
+ *         lastName: "Doe",
+ *         gender: CandidApi.Gender.Male
+ *     }
+ */
 export interface Patient extends CandidApi.PatientBase {
     individualId: CandidApi.IndividualId;
     phoneNumbers: CandidApi.PhoneNumber[];

package/dist/api/resources/individual/types/Subscriber.d.ts

@@ -2,6 +2,39 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         individualId: CandidApi.IndividualId("797348A9-E7E8-4E59-8628-95390D079C0B"),
+ *         insuranceCard: {
+ *             insuranceCardId: CandidApi.InsuranceCardId("CA5B7711-4419-4161-9B7C-3494AC40C8D4"),
+ *             memberId: "E85313B4-0FFC-4119-8042-8161A4ECFF0A",
+ *             payerName: "John Doe",
+ *             payerId: "836DDAA6-863F-4020-ACCA-205A689F0002",
+ *             rxBin: "610014",
+ *             rxPcn: "MEDDPRIME",
+ *             imageUrlFront: "https://s3.amazonaws.com/front.jpg",
+ *             imageUrlBack: "https://s3.amazonaws.com/back.jpg",
+ *             groupNumber: "ABC12345",
+ *             planName: "Silver PPO Plan",
+ *             planType: CandidApi.SourceOfPaymentCode.SelfPay,
+ *             insuranceType: CandidApi.InsuranceTypeCode.C01
+ *         },
+ *         patientRelationshipToSubscriberCode: CandidApi.PatientRelationshipToInsuredCodeAll.Spouse,
+ *         dateOfBirth: CandidApi.Date_("2000-01-01"),
+ *         address: {
+ *             address1: "123 Main St",
+ *             address2: "Apt 1",
+ *             city: "New York",
+ *             state: CandidApi.State.Ny,
+ *             zipCode: "10001",
+ *             zipPlusFourCode: "1234"
+ *         },
+ *         firstName: "John",
+ *         lastName: "Doe",
+ *         gender: CandidApi.Gender.Male
+ *     }
+ */
 export interface Subscriber extends CandidApi.SubscriberBase {
     individualId: CandidApi.IndividualId;
     insuranceCard: CandidApi.InsuranceCard;

package/dist/api/resources/insuranceCard/types/InsuranceCard.d.ts

@@ -2,6 +2,23 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         insuranceCardId: CandidApi.InsuranceCardId("CA5B7711-4419-4161-9B7C-3494AC40C8D4"),
+ *         memberId: "E85313B4-0FFC-4119-8042-8161A4ECFF0A",
+ *         payerName: "John Doe",
+ *         payerId: "836DDAA6-863F-4020-ACCA-205A689F0002",
+ *         rxBin: "610014",
+ *         rxPcn: "MEDDPRIME",
+ *         imageUrlFront: "https://s3.amazonaws.com/front.jpg",
+ *         imageUrlBack: "https://s3.amazonaws.com/back.jpg",
+ *         groupNumber: "ABC12345",
+ *         planName: "Silver PPO Plan",
+ *         planType: CandidApi.SourceOfPaymentCode.SelfPay,
+ *         insuranceType: CandidApi.InsuranceTypeCode.C01
+ *     }
+ */
 export interface InsuranceCard extends CandidApi.InsuranceCardBase {
     insuranceCardId: CandidApi.InsuranceCardId;
     memberId: string;

package/dist/api/resources/organizationProviders/resources/v2/types/LicenseType.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type LicenseType = "MD" | "NP" | "PA" | "LMFT" | "LCPC" | "LCSW" | "PMHNP" | "FNP" | "LPCC" | "DO" | "RD" | "SLP" | "APRN" | "LPC" | "PHD" | "PSYD" | "LMSW" | "LMHC" | "OTHER_MASTERS" | "BCBA" | "UNKNOWN" | "RPH" | "PHT" | "LAC" | "LMT" | "DC" | "ND" | "MA" | "PT" | "IBCLC" | "RN" | "DPT" | "LCMHC";
+export declare type LicenseType = "MD" | "NP" | "PA" | "LMFT" | "LCPC" | "LCSW" | "PMHNP" | "FNP" | "LPCC" | "DO" | "RD" | "SLP" | "APRN" | "LPC" | "PHD" | "PSYD" | "LMSW" | "LMHC" | "OTHER_MASTERS" | "BCBA" | "UNKNOWN" | "RPH" | "PHT" | "LAC" | "LMT" | "DC" | "ND" | "MA" | "PT" | "IBCLC" | "RN" | "DPT" | "LCMHC" | "CNM" | "RNFA" | "ACSW" | "APC" | "BCABA" | "BHA" | "OD" | "DPM" | "DA" | "DDS" | "DEH" | "DMD" | "PTA" | "LCADC" | "LCAT" | "LCMHCS" | "LCMHCA" | "LCSWA" | "LICSW" | "LISW" | "LMFTS" | "LMFTA" | "LPCI" | "LSCSW" | "MHCA" | "MHT" | "RBT" | "RCSWI" | "RHMCI" | "LPN" | "OTD" | "OMS" | "MFTA" | "APCC";
 export declare const LicenseType: {
     readonly Md: "MD";
     readonly Np: "NP";
@@ -36,4 +36,38 @@ export declare const LicenseType: {
     readonly Rn: "RN";
     readonly Dpt: "DPT";
     readonly Lcmhc: "LCMHC";
+    readonly Cnm: "CNM";
+    readonly Rnfa: "RNFA";
+    readonly Acsw: "ACSW";
+    readonly Apc: "APC";
+    readonly Bcaba: "BCABA";
+    readonly Bha: "BHA";
+    readonly Od: "OD";
+    readonly Dpm: "DPM";
+    readonly Da: "DA";
+    readonly Dds: "DDS";
+    readonly Deh: "DEH";
+    readonly Dmd: "DMD";
+    readonly Pta: "PTA";
+    readonly Lcadc: "LCADC";
+    readonly Lcat: "LCAT";
+    readonly Lcmhcs: "LCMHCS";
+    readonly Lcmhca: "LCMHCA";
+    readonly Lcswa: "LCSWA";
+    readonly Licsw: "LICSW";
+    readonly Lisw: "LISW";
+    readonly Lmfts: "LMFTS";
+    readonly Lmfta: "LMFTA";
+    readonly Lpci: "LPCI";
+    readonly Lscsw: "LSCSW";
+    readonly Mhca: "MHCA";
+    readonly Mht: "MHT";
+    readonly Rbt: "RBT";
+    readonly Rcswi: "RCSWI";
+    readonly Rhmci: "RHMCI";
+    readonly Lpn: "LPN";
+    readonly Otd: "OTD";
+    readonly Oms: "OMS";
+    readonly Mfta: "MFTA";
+    readonly Apcc: "APCC";
 };

package/dist/api/resources/organizationProviders/resources/v2/types/LicenseType.js

@@ -38,4 +38,38 @@ exports.LicenseType = {
     Rn: "RN",
     Dpt: "DPT",
     Lcmhc: "LCMHC",
+    Cnm: "CNM",
+    Rnfa: "RNFA",
+    Acsw: "ACSW",
+    Apc: "APC",
+    Bcaba: "BCABA",
+    Bha: "BHA",
+    Od: "OD",
+    Dpm: "DPM",
+    Da: "DA",
+    Dds: "DDS",
+    Deh: "DEH",
+    Dmd: "DMD",
+    Pta: "PTA",
+    Lcadc: "LCADC",
+    Lcat: "LCAT",
+    Lcmhcs: "LCMHCS",
+    Lcmhca: "LCMHCA",
+    Lcswa: "LCSWA",
+    Licsw: "LICSW",
+    Lisw: "LISW",
+    Lmfts: "LMFTS",
+    Lmfta: "LMFTA",
+    Lpci: "LPCI",
+    Lscsw: "LSCSW",
+    Mhca: "MHCA",
+    Mht: "MHT",
+    Rbt: "RBT",
+    Rcswi: "RCSWI",
+    Rhmci: "RHMCI",
+    Lpn: "LPN",
+    Otd: "OTD",
+    Oms: "OMS",
+    Mfta: "MFTA",
+    Apcc: "APCC",
 };

package/dist/api/resources/organizationProviders/resources/v3/client/Client.js

@@ -49,7 +49,7 @@ class V3 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.2",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             timeoutMs: 60000,
@@ -115,7 +115,7 @@ class V3 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.2",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             queryParameters: _queryParams,
@@ -145,7 +145,7 @@ class V3 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.2",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             body: await serializers.organizationProviders.v3.OrganizationProviderCreateV2.jsonOrThrow(request, {
@@ -191,7 +191,7 @@ class V3 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.2",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             body: await serializers.organizationProviders.v3.OrganizationProviderUpdateV2.jsonOrThrow(request, {

package/dist/api/resources/organizationProviders/resources/v3/client/requests/GetAllOrganizationProvidersRequestV2.d.ts

@@ -8,27 +8,27 @@ export interface GetAllOrganizationProvidersRequestV2 {
      */
     limit?: number;
     /**
-     * Filter to a name or a part of a name
+     * Filter to a name or a part of a name.
      */
     searchTerm?: string;
     /**
-     * Filter to a specific NPI
+     * Filter to a specific NPI.
      */
     npi?: string;
     /**
-     * Filter to only rendering providers
+     * Filter to only rendering providers.
      */
     isRendering?: boolean;
     /**
-     * Filter to only billing providers
+     * Filter to only billing providers.
      */
     isBilling?: boolean;
     /**
-     * The page token to continue paging through a previous request
+     * The page token to continue paging through a previous request.
      */
     pageToken?: CandidApi.PageToken;
     /**
-     * Defaults to PROVIDER_NAME_ASC
+     * Defaults to PROVIDER_NAME_ASC.
      */
     sort?: CandidApi.organizationProviders.v2.OrganizationProviderSortOptions;
 }

package/dist/api/resources/organizationProviders/resources/v3/types/OrganizationProviderPageV2.d.ts

@@ -2,6 +2,35 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../..";
+/**
+ * @example
+ *     {
+ *         items: [{
+ *                 npi: "1234567890",
+ *                 isRendering: true,
+ *                 isBilling: true,
+ *                 firstName: "John",
+ *                 lastName: "Doe",
+ *                 organizationName: "Acme Medical",
+ *                 providerType: CandidApi.organizationProviders.v2.ProviderType.Individual,
+ *                 taxId: "123456789",
+ *                 taxonomyCode: "1234567890",
+ *                 licenseType: CandidApi.organizationProviders.v2.LicenseType.Md,
+ *                 employmentStartDate: "2020-10-07",
+ *                 employmentTerminationDate: "2021-10-07",
+ *                 organizationProviderId: CandidApi.organizationProviders.v2.OrganizationProviderId("965A563A-0285-4910-9569-E3739C0F6EAB"),
+ *                 qualifications: [{
+ *                         identifierId: CandidApi.IdentifierId("123e4567-e89b-12d3-a456-426614174000"),
+ *                         identifierCode: CandidApi.IdentifierCode.Mcr,
+ *                         identifierValue: {
+ *                             type: "medicare_provider_identifier",
+ *                             state: CandidApi.State.Ca,
+ *                             providerNumber: "1234567890"
+ *                         }
+ *                     }]
+ *             }]
+ *     }
+ */
 export interface OrganizationProviderPageV2 extends CandidApi.ResourcePage {
     items: CandidApi.organizationProviders.v3.OrganizationProviderV2[];
 }

package/dist/api/resources/organizationProviders/resources/v3/types/OrganizationProviderV2.d.ts

@@ -2,6 +2,33 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../..";
+/**
+ * @example
+ *     {
+ *         npi: "1234567890",
+ *         isRendering: true,
+ *         isBilling: true,
+ *         firstName: "John",
+ *         lastName: "Doe",
+ *         organizationName: "Acme Medical",
+ *         providerType: CandidApi.organizationProviders.v2.ProviderType.Individual,
+ *         taxId: "123456789",
+ *         taxonomyCode: "1234567890",
+ *         licenseType: CandidApi.organizationProviders.v2.LicenseType.Md,
+ *         employmentStartDate: "2020-10-07",
+ *         employmentTerminationDate: "2021-10-07",
+ *         organizationProviderId: CandidApi.organizationProviders.v2.OrganizationProviderId("965A563A-0285-4910-9569-E3739C0F6EAB"),
+ *         qualifications: [{
+ *                 identifierId: CandidApi.IdentifierId("123e4567-e89b-12d3-a456-426614174000"),
+ *                 identifierCode: CandidApi.IdentifierCode.Mcr,
+ *                 identifierValue: {
+ *                     type: "medicare_provider_identifier",
+ *                     state: CandidApi.State.Ca,
+ *                     providerNumber: "1234567890"
+ *                 }
+ *             }]
+ *     }
+ */
 export interface OrganizationProviderV2 {
     /** The NPI of the provider. This must be all digits [0-9] and exactly 10 characters long. */
     npi: string;
@@ -35,8 +62,8 @@ export interface OrganizationProviderV2 {
     employmentStartDate?: string;
     /** The employment termination date for the provider. */
     employmentTerminationDate?: string;
-    /** Auto-generated ID set on creation */
+    /** Auto-generated ID set on creation. */
     organizationProviderId: CandidApi.organizationProviders.v2.OrganizationProviderId;
-    /** Qualification given to a provider (PTAN, Medicaid Provider Id etc.) */
+    /** Qualification given to a provider (PTAN, Medicaid Provider Id etc.). */
     qualifications: CandidApi.Identifier[];
 }

package/dist/api/resources/patientPayments/resources/v3/types/PatientPayment.d.ts

@@ -2,6 +2,23 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../..";
+/**
+ * @example
+ *     {
+ *         patientPaymentId: CandidApi.patientPayments.v3.PatientPaymentId("CF237BE1-E793-4BBF-8958-61D5179D1D0D"),
+ *         organizationId: CandidApi.OrganizationId("0788CA2A-B20D-4B8E-B8D4-07FA0B3B4907"),
+ *         sourceInternalId: "D1A76039-D5C5-4323-A2FC-B7C8B6AEF6A4",
+ *         source: CandidApi.patientPayments.v3.PatientPaymentSource.ManualEntry,
+ *         amountCents: 2000,
+ *         paymentTimestamp: new Date("2023-01-01T00:00:00.000Z"),
+ *         status: CandidApi.patientPayments.v3.PatientPaymentStatus.Pending,
+ *         paymentName: "John Doe",
+ *         paymentNote: "test payment note",
+ *         patientExternalId: CandidApi.PatientExternalId("B7437260-D6B4-48CF-B9D7-753C09F34E76"),
+ *         encounterExternalId: CandidApi.EncounterExternalId("0F26B9C3-199F-4CBB-A166-B87EA7C631BB"),
+ *         serviceLineId: CandidApi.ServiceLineId("B557DC86-C629-478C-850A-02D45AC11783")
+ *     }
+ */
 export interface PatientPayment {
     patientPaymentId: CandidApi.patientPayments.v3.PatientPaymentId;
     organizationId: CandidApi.OrganizationId;

package/dist/api/resources/payers/resources/v3/client/Client.js

@@ -49,7 +49,7 @@ class V3 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.2",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             timeoutMs: 60000,
@@ -89,7 +89,7 @@ class V3 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.2",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             queryParameters: _queryParams,

package/dist/api/resources/payers/resources/v3/client/requests/GetAllPayersRequest.d.ts

@@ -4,7 +4,7 @@
 import * as CandidApi from "../../../../../..";
 export interface GetAllPayersRequest {
     /**
-     * Defaults to 100
+     * Maximum number of entities per page, defaults to 100.
      */
     limit?: number;
     searchTerm?: string;

package/dist/api/resources/payers/resources/v3/types/Payer.d.ts

@@ -2,11 +2,19 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../..";
+/**
+ * @example
+ *     {
+ *         payerUuid: CandidApi.payers.v3.PayerUuid("A6431FD2-0712-4714-B1B1-DD094DAF9F42"),
+ *         payerId: "12345",
+ *         payerName: "Payer Name"
+ *     }
+ */
 export interface Payer {
-    /** Auto-generated ID set on creation */
+    /** Auto-generated ID set on creation. */
     payerUuid: CandidApi.payers.v3.PayerUuid;
-    /** The primary national payer ID of the payer */
+    /** The primary national payer ID of the payer. */
     payerId: string;
-    /** The primary display name of the payer */
+    /** The primary display name of the payer. */
     payerName: string;
 }

package/dist/api/resources/payers/resources/v3/types/PayerPage.d.ts

@@ -2,6 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../..";
+/**
+ * @example
+ *     {
+ *         items: [{
+ *                 payerUuid: CandidApi.payers.v3.PayerUuid("A6431FD2-0712-4714-B1B1-DD094DAF9F42"),
+ *                 payerId: "12345",
+ *                 payerName: "Payer Name"
+ *             }]
+ *     }
+ */
 export interface PayerPage extends CandidApi.ResourcePage {
     items: CandidApi.payers.v3.Payer[];
 }

package/dist/api/resources/serviceFacility/types/EncounterServiceFacility.d.ts

@@ -2,6 +2,21 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         serviceFacilityId: CandidApi.ServiceFacilityId("2861487B-232C-4DED-A874-616A5DB0688F"),
+ *         organizationName: "Test Organization",
+ *         address: {
+ *             address1: "123 Main St",
+ *             address2: "Apt 1",
+ *             city: "New York",
+ *             state: CandidApi.State.Ny,
+ *             zipCode: "10001",
+ *             zipPlusFourCode: "1234"
+ *         }
+ *     }
+ */
 export interface EncounterServiceFacility {
     serviceFacilityId: CandidApi.ServiceFacilityId;
     organizationName: string;

package/dist/api/resources/serviceLines/resources/v2/types/ServiceLine.d.ts

@@ -2,6 +2,70 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../..";
+/**
+ * @example
+ *     {
+ *         modifiers: [CandidApi.ProcedureModifier.TwentyTwo],
+ *         chargeAmountCents: 10000,
+ *         allowedAmountCents: 8000,
+ *         insuranceBalanceCents: 0,
+ *         patientBalanceCents: 2000,
+ *         paidAmountCents: 8000,
+ *         patientResponsibilityCents: 2000,
+ *         diagnosisIdZero: CandidApi.DiagnosisId("4AC84BCD-12F5-4F86-A57B-E06749127C98"),
+ *         diagnosisIdOne: CandidApi.DiagnosisId("EEA5CA5A-8B43-45FD-8CBD-C6CC1103E759"),
+ *         diagnosisIdTwo: CandidApi.DiagnosisId("5C4AA029-2DB9-4202-916E-E93C708F65FF"),
+ *         diagnosisIdThree: CandidApi.DiagnosisId("81795126-A3AC-443C-B47E-7259A16AB4A2"),
+ *         serviceLineEraData: {
+ *             serviceLineAdjustments: [{
+ *                     createdAt: new Date("2023-01-01T00:00:00.000Z"),
+ *                     adjustmentGroupCode: "CO",
+ *                     adjustmentReasonCode: "CO",
+ *                     adjustmentAmountCents: 1000,
+ *                     adjustmentNote: "test_note"
+ *                 }],
+ *             remittanceAdviceRemarkCodes: ["N362"]
+ *         },
+ *         serviceLineManualAdjustments: [{
+ *                 createdAt: new Date("2023-01-01T00:00:00.000Z"),
+ *                 adjustmentGroupCode: "CO",
+ *                 adjustmentReasonCode: "CO",
+ *                 adjustmentAmountCents: 1000,
+ *                 adjustmentNote: "test_note"
+ *             }],
+ *         relatedInvoices: [{
+ *                 id: CandidApi.InvoiceId("901BE2F1-41BC-456E-9987-4FE2F84F9D75"),
+ *                 createdAt: new Date("2023-01-01T00:00:00.000Z"),
+ *                 updatedAt: new Date("2023-01-01T00:00:00.000Z"),
+ *                 organzationId: CandidApi.OrganizationId("F13F73D4-4344-46EA-9D93-33BCFFBB9F36"),
+ *                 sourceId: "9B626577-8808-4F28-9ED1-F0DFF0D49BBC",
+ *                 sourceCustomerId: "624D1972-8C69-4C2F-AEFA-10856F734DB3",
+ *                 patientExternalId: CandidApi.PatientExternalId("10FED4D6-4C5A-48DF-838A-EEF45A74788D"),
+ *                 note: "test_note",
+ *                 dueDate: CandidApi.Date_("2023-10-10"),
+ *                 status: CandidApi.InvoiceStatus.Draft,
+ *                 url: "https://example.com",
+ *                 customerInvoiceUrl: "https://example.com",
+ *                 items: [{
+ *                         serviceLineId: CandidApi.ServiceLineId("CED00F23-6E68-4678-9DBC-F5AA2969A565"),
+ *                         amountCents: 500
+ *                     }]
+ *             }],
+ *         denialReason: {
+ *             reason: CandidApi.serviceLines.v2.DenialReasonContent.AuthorizationRequired
+ *         },
+ *         placeOfServiceCode: CandidApi.FacilityTypeCode.Pharmacy,
+ *         serviceLineId: CandidApi.ServiceLineId("CED00F23-6E68-4678-9DBC-F5AA2969A565"),
+ *         procedureCode: "99213",
+ *         quantity: CandidApi.Decimal("1"),
+ *         units: CandidApi.ServiceLineUnits.Mj,
+ *         claimId: CandidApi.ClaimId("026A1FB8-748E-4859-A2D7-3EA9E07D25AE"),
+ *         dateOfServiceRange: {
+ *             startDate: CandidApi.Date_("2023-01-01"),
+ *             endDate: CandidApi.Date_("2023-01-03")
+ *         }
+ *     }
+ */
 export interface ServiceLine {
     modifiers?: CandidApi.ProcedureModifier[];
     chargeAmountCents?: number;

package/dist/api/resources/tags/types/Tag.d.ts

@@ -2,6 +2,15 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         creatorId: "00EB5A46-35C6-441B-9751-AF307AEF5888",
+ *         tagId: CandidApi.TagId("void-claim-submitted"),
+ *         description: "to indicate claims where a void claim has been submitted",
+ *         color: CandidApi.TagColorEnum.Black
+ *     }
+ */
 export interface Tag extends CandidApi.TagCreate {
     creatorId: string;
 }