candidhealth 1.15.0 → 1.17.0

package/reference.md

@@ -807,6 +807,320 @@ await client.chargeCapture.v1.updatePostBilledChanges({
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.contracts.v2.get(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**contractId:** `CandidApi.ContractId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v2.<a href="/src/api/resources/contracts/resources/v2/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.ContractsPage, CandidApi.contracts.v2.getMulti.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.contracts.v2.getMulti();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.contracts.v2.GetMultiContractsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v2.<a href="/src/api/resources/contracts/resources/v2/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.ContractWithProviders, CandidApi.contracts.v2.create.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new contract within the user's current organization
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.contracts.v2.create({
+    contractingProviderId: CandidApi.ContractingProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+    renderingProviderIds: new Set([CandidApi.RenderingProviderid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]),
+    payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+    effectiveDate: CandidApi.Date_("effective_date"),
+    regions: {
+        type: "states",
+        states: ["AA", "AA"]
+    },
+    commercialInsuranceTypes: {
+        type: "allApply"
+    },
+    medicareInsuranceTypes: {
+        type: "allApply"
+    },
+    medicaidInsuranceTypes: {
+        type: "allApply"
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.contracts.v2.ContractCreate` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v2.<a href="/src/api/resources/contracts/resources/v2/client/Client.ts">delete</a>(contractId) -> core.APIResponse<void, CandidApi.contracts.v2.delete.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.contracts.v2.delete(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**contractId:** `CandidApi.ContractId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v2.<a href="/src/api/resources/contracts/resources/v2/client/Client.ts">update</a>(contractId, { ...params }) -> core.APIResponse<CandidApi.ContractWithProviders, CandidApi.contracts.v2.update.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.contracts.v2.update(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**contractId:** `CandidApi.ContractId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.contracts.v2.ContractUpdate` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## Contracts V3
+<details><summary><code>client.contracts.v3.<a href="/src/api/resources/contracts/resources/v3/client/Client.ts">get</a>(contractId) -> core.APIResponse<CandidApi.ContractWithProvidersUnion, CandidApi.contracts.v3.get.Error></code></summary>
+<dl>
+<dd>
+
 #### 🔌 Usage
 
 <dl>
@@ -816,7 +1130,7 @@ await client.chargeCapture.v1.updatePostBilledChanges({
 <dd>
 
 ```typescript
-await client.contracts.v2.get(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+await client.contracts.v3.get(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
 
 ```
 </dd>
@@ -840,7 +1154,7 @@ await client.contracts.v2.get(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd
 <dl>
 <dd>
 
-**requestOptions:** `V2.RequestOptions` 
+**requestOptions:** `V3.RequestOptions` 
     
 </dd>
 </dl>
@@ -852,7 +1166,7 @@ await client.contracts.v2.get(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd
 </dl>
 </details>
 
-<details><summary><code>client.contracts.v2.<a href="/src/api/resources/contracts/resources/v2/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.ContractsPage, CandidApi.contracts.v2.getMulti.Error></code></summary>
+<details><summary><code>client.contracts.v3.<a href="/src/api/resources/contracts/resources/v3/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.ContractsPage, CandidApi.contracts.v3.getMulti.Error></code></summary>
 <dl>
 <dd>
 
@@ -865,7 +1179,7 @@ await client.contracts.v2.get(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd
 <dd>
 
 ```typescript
-await client.contracts.v2.getMulti();
+await client.contracts.v3.getMulti();
 
 ```
 </dd>
@@ -881,7 +1195,7 @@ await client.contracts.v2.getMulti();
 <dl>
 <dd>
 
-**request:** `CandidApi.contracts.v2.GetMultiContractsRequest` 
+**request:** `CandidApi.contracts.v3.GetMultiContractsRequest` 
     
 </dd>
 </dl>
@@ -889,7 +1203,7 @@ await client.contracts.v2.getMulti();
 <dl>
 <dd>
 
-**requestOptions:** `V2.RequestOptions` 
+**requestOptions:** `V3.RequestOptions` 
     
 </dd>
 </dl>
@@ -901,7 +1215,7 @@ await client.contracts.v2.getMulti();
 </dl>
 </details>
 
-<details><summary><code>client.contracts.v2.<a href="/src/api/resources/contracts/resources/v2/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.ContractWithProviders, CandidApi.contracts.v2.create.Error></code></summary>
+<details><summary><code>client.contracts.v3.<a href="/src/api/resources/contracts/resources/v3/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.ContractWithProvidersUnion, CandidApi.contracts.v3.create.Error></code></summary>
 <dl>
 <dd>
 
@@ -928,9 +1242,11 @@ Creates a new contract within the user's current organization
 <dd>
 
 ```typescript
-await client.contracts.v2.create({
-    contractingProviderId: CandidApi.ContractingProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+await client.contracts.v3.create({
+    type: "professional",
     renderingProviderIds: new Set([CandidApi.RenderingProviderid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]),
+    contractType: "professional",
+    contractingProviderId: CandidApi.ContractingProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
     payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
     effectiveDate: CandidApi.Date_("effective_date"),
     regions: {
@@ -962,7 +1278,7 @@ await client.contracts.v2.create({
 <dl>
 <dd>
 
-**request:** `CandidApi.contracts.v2.ContractCreate` 
+**request:** `CandidApi.ContractCreateUnion` 
     
 </dd>
 </dl>
@@ -970,7 +1286,7 @@ await client.contracts.v2.create({
 <dl>
 <dd>
 
-**requestOptions:** `V2.RequestOptions` 
+**requestOptions:** `V3.RequestOptions` 
     
 </dd>
 </dl>
@@ -982,7 +1298,7 @@ await client.contracts.v2.create({
 </dl>
 </details>
 
-<details><summary><code>client.contracts.v2.<a href="/src/api/resources/contracts/resources/v2/client/Client.ts">delete</a>(contractId) -> core.APIResponse<void, CandidApi.contracts.v2.delete.Error></code></summary>
+<details><summary><code>client.contracts.v3.<a href="/src/api/resources/contracts/resources/v3/client/Client.ts">delete</a>(contractId) -> core.APIResponse<void, CandidApi.contracts.v3.delete.Error></code></summary>
 <dl>
 <dd>
 
@@ -995,7 +1311,7 @@ await client.contracts.v2.create({
 <dd>
 
 ```typescript
-await client.contracts.v2.delete(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+await client.contracts.v3.delete(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
 
 ```
 </dd>
@@ -1019,7 +1335,7 @@ await client.contracts.v2.delete(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7
 <dl>
 <dd>
 
-**requestOptions:** `V2.RequestOptions` 
+**requestOptions:** `V3.RequestOptions` 
     
 </dd>
 </dl>
@@ -1031,7 +1347,7 @@ await client.contracts.v2.delete(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7
 </dl>
 </details>
 
-<details><summary><code>client.contracts.v2.<a href="/src/api/resources/contracts/resources/v2/client/Client.ts">update</a>(contractId, { ...params }) -> core.APIResponse<CandidApi.ContractWithProviders, CandidApi.contracts.v2.update.Error></code></summary>
+<details><summary><code>client.contracts.v3.<a href="/src/api/resources/contracts/resources/v3/client/Client.ts">update</a>(contractId, { ...params }) -> core.APIResponse<CandidApi.ContractWithProvidersUnion, CandidApi.contracts.v3.update.Error></code></summary>
 <dl>
 <dd>
 
@@ -1044,7 +1360,9 @@ await client.contracts.v2.delete(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7
 <dd>
 
 ```typescript
-await client.contracts.v2.update(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+await client.contracts.v3.update(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
+    type: "professional"
+});
 
 ```
 </dd>
@@ -1068,7 +1386,7 @@ await client.contracts.v2.update(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7
 <dl>
 <dd>
 
-**request:** `CandidApi.contracts.v2.ContractUpdate` 
+**request:** `CandidApi.ContractUpdateUnion` 
     
 </dd>
 </dl>
@@ -1076,7 +1394,132 @@ await client.contracts.v2.update(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7
 <dl>
 <dd>
 
-**requestOptions:** `V2.RequestOptions` 
+**requestOptions:** `V3.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v3.<a href="/src/api/resources/contracts/resources/v3/client/Client.ts">createContractServiceFacility</a>(contractId, { ...params }) -> core.APIResponse<CandidApi.ContractServiceFacility, CandidApi.contracts.v3.createContractServiceFacility.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.contracts.v3.createContractServiceFacility(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
+    serviceFacilityId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+    providerIds: new Set(["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"])
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**contractId:** `CandidApi.ContractId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.contracts.v3.ContractServiceFacilityCreate` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V3.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v3.<a href="/src/api/resources/contracts/resources/v3/client/Client.ts">updateContractServiceFacility</a>(contractId, contractServiceFacilityId, { ...params }) -> core.APIResponse<CandidApi.ContractServiceFacility, CandidApi.contracts.v3.updateContractServiceFacility.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.contracts.v3.updateContractServiceFacility(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.ContractServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**contractId:** `CandidApi.ContractId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**contractServiceFacilityId:** `CandidApi.ContractServiceFacilityId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.contracts.v3.ContractServiceFacilityUpdate` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V3.RequestOptions` 
     
 </dd>
 </dl>
@@ -3749,6 +4192,119 @@ await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Events V1
+<details><summary><code>client.events.v1.<a href="/src/api/resources/events/resources/v1/client/Client.ts">scan</a>({ ...params }) -> core.APIResponse<CandidApi.EventScanPage, CandidApi.events.v1.scan.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Scans the last 30 days of events. All results are sorted by created date, descending.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.events.v1.scan();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.events.v1.GetEventScanRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.events.v1.<a href="/src/api/resources/events/resources/v1/client/Client.ts">get</a>(eventId) -> core.APIResponse<CandidApi.Event, CandidApi.events.v1.get.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.events.v1.get(CandidApi.EventId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**eventId:** `CandidApi.EventId` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -7829,8 +8385,6 @@ await client.organizationServiceFacilities.v2.delete(CandidApi.OrganizationServi
 <dl>
 <dd>
 
-NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.
-
 Retrieve a list of inventory records based on the provided filters. Each inventory record provides the latest invoiceable status of the associated claim.
 The response is paginated, and the `page_token` can be used to retrieve subsequent pages. Initial requests should not include `page_token`.
 </dd>
@@ -7895,8 +8449,6 @@ await client.patientAr.v1.listInventory();
 <dl>
 <dd>
 
-NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.
-
 Provides detailed itemization of invoice data for a specific claim.
 </dd>
 </dl>