candidhealth 0.24.2 → 0.24.3

package/reference.md

@@ -462,6 +462,279 @@ await client.contracts.v2.update(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7
 </dl>
 </details>
 
+## CustomSchemas V1
+
+<details><summary><code>client.customSchemas.v1.<a href="/src/api/resources/customSchemas/resources/v1/client/Client.ts">getMulti</a>() -> core.APIResponse<CandidApi.SchemaGetMultiResponse, CandidApi.customSchemas.v1.getMulti.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns all custom schemas.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.customSchemas.v1.getMulti();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.customSchemas.v1.<a href="/src/api/resources/customSchemas/resources/v1/client/Client.ts">get</a>(schemaId) -> core.APIResponse<CandidApi.Schema, CandidApi.customSchemas.v1.get.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Return a custom schema with a given ID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.customSchemas.v1.get(CandidApi.SchemaId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**schemaId:** `CandidApi.SchemaId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.customSchemas.v1.<a href="/src/api/resources/customSchemas/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Schema, CandidApi.customSchemas.v1.create.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a custom schema. Schema keys can be referenced as inputs in user-configurable rules in the Rules
+Engine, and key-value pairs can be attached to claims via the Encounters API.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.customSchemas.v1.create({
+    name: "string",
+    description: "string",
+    fields: [
+        {
+            key: "string",
+            type: CandidApi.Primitive.Boolean,
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.customSchemas.v1.SchemaCreate`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.customSchemas.v1.<a href="/src/api/resources/customSchemas/resources/v1/client/Client.ts">update</a>(schemaId, { ...params }) -> core.APIResponse<CandidApi.Schema, CandidApi.customSchemas.v1.update.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update the name, description, or keys on a preexisting schema.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.customSchemas.v1.update(CandidApi.SchemaId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
+    name: "string",
+    description: "string",
+    fieldsToAdd: [
+        {
+            key: "string",
+            type: CandidApi.Primitive.Boolean,
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**schemaId:** `CandidApi.SchemaId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.customSchemas.v1.SchemaUpdate`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Eligibility V2
 
 <details><summary><code>client.eligibility.v2.<a href="/src/api/resources/eligibility/resources/v2/client/Client.ts">submitEligibilityCheck</a>({ ...params }) -> core.APIResponse<unknown, CandidApi.eligibility.v2.submitEligibilityCheck.Error></code></summary>
@@ -1146,6 +1419,17 @@ await client.encounters.v4.create({
         ],
     },
     tagIds: [CandidApi.TagId("string")],
+    schemaInstances: [
+        {
+            schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
+            content: {
+                provider_category: "internist",
+                is_urgent_care: true,
+                bmi: 24.2,
+                age: 38,
+            },
+        },
+    ],
     externalId: CandidApi.EncounterExternalId("string"),
     priorAuthorizationNumber: CandidApi.PriorAuthorizationNumber("string"),
     patientAuthorizedRelease: true,
@@ -1353,6 +1637,17 @@ await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0
     lastMenstrualPeriodDate: "2023-01-15",
     delayReasonCode: CandidApi.DelayReasonCode.C1,
     patientAuthorizedRelease: true,
+    schemaInstances: [
+        {
+            schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
+            content: {
+                provider_category: "internist",
+                is_urgent_care: true,
+                bmi: 24.2,
+                age: 38,
+            },
+        },
+    ],
 });
 ```
 

package/serialization/resources/commons/types/Primitive.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as CandidApi from "../../../../api/index";
+import * as core from "../../../../core";
+export declare const Primitive: core.serialization.Schema<serializers.Primitive.Raw, CandidApi.Primitive>;
+export declare namespace Primitive {
+    type Raw = "BOOLEAN" | "DOUBLE" | "INTEGER" | "STRING";
+}

package/serialization/resources/commons/types/Primitive.js

@@ -0,0 +1,31 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Primitive = void 0;
+const core = __importStar(require("../../../../core"));
+exports.Primitive = core.serialization.enum_(["BOOLEAN", "DOUBLE", "INTEGER", "STRING"]);

package/serialization/resources/commons/types/SchemaId.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as CandidApi from "../../../../api/index";
+import * as core from "../../../../core";
+export declare const SchemaId: core.serialization.Schema<serializers.SchemaId.Raw, CandidApi.SchemaId>;
+export declare namespace SchemaId {
+    type Raw = string;
+}

package/serialization/resources/commons/types/SchemaId.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaId = void 0;
+const CandidApi = __importStar(require("../../../../api/index"));
+const core = __importStar(require("../../../../core"));
+exports.SchemaId = core.serialization
+    .string()
+    .transform({
+    transform: CandidApi.SchemaId,
+    untransform: (value) => value,
+});

package/serialization/resources/commons/types/index.d.ts

@@ -14,6 +14,8 @@ export * from "./TaskNoteId";
 export * from "./ProviderId";
 export * from "./InvoiceId";
 export * from "./RateId";
+export * from "./SchemaId";
+export * from "./Primitive";
 export * from "./LinkUrl";
 export * from "./PageToken";
 export * from "./SortDirection";

package/serialization/resources/commons/types/index.js

@@ -30,6 +30,8 @@ __exportStar(require("./TaskNoteId"), exports);
 __exportStar(require("./ProviderId"), exports);
 __exportStar(require("./InvoiceId"), exports);
 __exportStar(require("./RateId"), exports);
+__exportStar(require("./SchemaId"), exports);
+__exportStar(require("./Primitive"), exports);
 __exportStar(require("./LinkUrl"), exports);
 __exportStar(require("./PageToken"), exports);
 __exportStar(require("./SortDirection"), exports);

package/serialization/resources/customSchemas/index.d.ts

@@ -0,0 +1 @@
+export * from "./resources";

package/serialization/resources/customSchemas/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resources"), exports);

package/serialization/resources/customSchemas/resources/index.d.ts

@@ -0,0 +1 @@
+export * as v1 from "./v1";

package/serialization/resources/customSchemas/resources/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v1 = void 0;
+exports.v1 = __importStar(require("./v1"));

package/serialization/resources/customSchemas/resources/v1/client/create.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../../index";
+import * as CandidApi from "../../../../../../api/index";
+import * as core from "../../../../../../core";
+import { SchemaValidationFailure } from "../types/SchemaValidationFailure";
+export declare const Error: core.serialization.Schema<serializers.customSchemas.v1.create.Error.Raw, CandidApi.customSchemas.v1.create.Error>;
+export declare namespace Error {
+    type Raw = Error.SchemaValidationHttpFailure;
+    interface SchemaValidationHttpFailure {
+        errorName: "SchemaValidationHttpFailure";
+        content: SchemaValidationFailure.Raw;
+    }
+}

package/serialization/resources/customSchemas/resources/v1/client/create.js

@@ -0,0 +1,61 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Error = void 0;
+const CandidApi = __importStar(require("../../../../../../api/index"));
+const core = __importStar(require("../../../../../../core"));
+const SchemaValidationFailure_1 = require("../types/SchemaValidationFailure");
+exports.Error = core.serialization
+    .union("errorName", {
+    SchemaValidationHttpFailure: core.serialization.object({
+        content: SchemaValidationFailure_1.SchemaValidationFailure,
+    }),
+})
+    .transform({
+    transform: (value) => {
+        switch (value.errorName) {
+            case "SchemaValidationHttpFailure":
+                return CandidApi.customSchemas.v1.create.Error.schemaValidationHttpFailure(value.content);
+        }
+    },
+    untransform: (_a) => {
+        var { _visit } = _a, value = __rest(_a, ["_visit"]);
+        return value;
+    },
+});

package/serialization/resources/customSchemas/resources/v1/client/get.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../../index";
+import * as CandidApi from "../../../../../../api/index";
+import * as core from "../../../../../../core";
+import { EntityNotFoundErrorMessage } from "../../../../commons/types/EntityNotFoundErrorMessage";
+import { UnauthorizedErrorMessage } from "../../../../commons/types/UnauthorizedErrorMessage";
+export declare const Error: core.serialization.Schema<serializers.customSchemas.v1.get.Error.Raw, CandidApi.customSchemas.v1.get.Error>;
+export declare namespace Error {
+    type Raw = Error.EntityNotFoundError | Error.UnauthorizedError;
+    interface EntityNotFoundError {
+        errorName: "EntityNotFoundError";
+        content: EntityNotFoundErrorMessage.Raw;
+    }
+    interface UnauthorizedError {
+        errorName: "UnauthorizedError";
+        content: UnauthorizedErrorMessage.Raw;
+    }
+}

package/serialization/resources/customSchemas/resources/v1/client/get.js

@@ -0,0 +1,67 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Error = void 0;
+const CandidApi = __importStar(require("../../../../../../api/index"));
+const core = __importStar(require("../../../../../../core"));
+const EntityNotFoundErrorMessage_1 = require("../../../../commons/types/EntityNotFoundErrorMessage");
+const UnauthorizedErrorMessage_1 = require("../../../../commons/types/UnauthorizedErrorMessage");
+exports.Error = core.serialization
+    .union("errorName", {
+    EntityNotFoundError: core.serialization.object({
+        content: EntityNotFoundErrorMessage_1.EntityNotFoundErrorMessage,
+    }),
+    UnauthorizedError: core.serialization.object({
+        content: UnauthorizedErrorMessage_1.UnauthorizedErrorMessage,
+    }),
+})
+    .transform({
+    transform: (value) => {
+        switch (value.errorName) {
+            case "EntityNotFoundError":
+                return CandidApi.customSchemas.v1.get.Error.entityNotFoundError(value.content);
+            case "UnauthorizedError":
+                return CandidApi.customSchemas.v1.get.Error.unauthorizedError(value.content);
+        }
+    },
+    untransform: (_a) => {
+        var { _visit } = _a, value = __rest(_a, ["_visit"]);
+        return value;
+    },
+});

package/serialization/resources/customSchemas/resources/v1/client/getMulti.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../../index";
+import * as CandidApi from "../../../../../../api/index";
+import * as core from "../../../../../../core";
+import { UnauthorizedErrorMessage } from "../../../../commons/types/UnauthorizedErrorMessage";
+export declare const Error: core.serialization.Schema<serializers.customSchemas.v1.getMulti.Error.Raw, CandidApi.customSchemas.v1.getMulti.Error>;
+export declare namespace Error {
+    type Raw = Error.UnauthorizedError;
+    interface UnauthorizedError {
+        errorName: "UnauthorizedError";
+        content: UnauthorizedErrorMessage.Raw;
+    }
+}