npm - @corti/sdk - Versions diffs - 0.0.0-alpha.10 → 0.0.0-rc - Mend

@corti/sdk 0.0.0-alpha.10 → 0.0.0-rc

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1997) hide show

package/reference.md DELETED Viewed

@@ -1,1726 +0,0 @@
-# Reference
-## interactions
-<details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">list</a>({ ...params }) -> core.Page<Corti.ResponseInteraction></code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Lists all existing interactions. Results can be filtered by encounter status and patient identifier.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-const response = await client.interactions.list();
-for await (const item of response) {
-    console.log(item);
-}
-// Or you can manually iterate page-by-page
-const page = await client.interactions.list();
-while (page.hasNextPage()) {
-    page = page.getNextPage();
-}
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Corti.InteractionsListRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Interactions.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">create</a>({ ...params }) -> Corti.ResponseInteractionCreate</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Creates a new interaction.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.interactions.create({
-    encounter: {
-        identifier: "identifier",
-        status: "planned",
-        type: "first_consultation",
-    },
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Corti.RequestInteractionCreate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Interactions.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">get</a>(id) -> Corti.ResponseInteraction</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Retrieves a previously recorded interaction by its unique identifier (interaction ID).
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.interactions.get("f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction to retrieve. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Interactions.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">delete</a>(id) -> void</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Deletes an existing interaction.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.interactions.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction to delete. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Interactions.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">update</a>(id, { ...params }) -> Corti.ResponseInteraction</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Modifies an existing interaction by updating specific fields without overwriting the entire record.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.interactions.update("f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction to update. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Corti.RequestInteractionUpdate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Interactions.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## recordings
-<details><summary><code>client.recordings.<a href="/src/api/resources/recordings/client/Client.ts">list</a>(id) -> Corti.ResponseRecordingList</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Retrieve a list of recordings for a given interaction.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.recordings.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction for which recordings should be retrieved. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Recordings.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.recordings.<a href="/src/api/resources/recordings/client/Client.ts">delete</a>(id, recordingId) -> void</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Delete a specific recording for a given interaction.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.recordings.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction for which the recording should be deleted from. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**recordingId:** `Corti.Uuid` — The unique identifier of the recording to be deleted. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Recordings.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## transcripts
-<details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">list</a>(id, { ...params }) -> core.Page<Corti.ResponseTranscriptListAllTranscriptsItem></code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Retrieves a list of transcripts for a given interaction.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-const response = await client.transcripts.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
-for await (const item of response) {
-    console.log(item);
-}
-// Or you can manually iterate page-by-page
-const page = await client.transcripts.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
-while (page.hasNextPage()) {
-    page = page.getNextPage();
-}
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction for which transcripts should be retrieved. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Corti.TranscriptsListRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Transcripts.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">create</a>(id, { ...params }) -> Corti.ResponseTranscriptCreate</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Creates a new transcript for an interaction.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.transcripts.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
-    recordingId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
-    primaryLanguage: "en",
-    modelName: "premier",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction for which the transcript is created. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Corti.TranscriptCreate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Transcripts.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">get</a>(id, transcriptId) -> Corti.ResponseTranscriptCreate</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Retrieves the transcript for a specific interaction.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.transcripts.get("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction containing the transcript. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**transcriptId:** `Corti.Uuid` — The unique identifier of the transcript to retrieve. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Transcripts.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">delete</a>(id, transcriptId) -> void</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Deletes a specific transcript associated with an interaction.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.transcripts.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction to which the transcript belongs. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**transcriptId:** `Corti.Uuid` — The unique identifier of the transcript to delete. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Transcripts.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## facts
-<details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">factgroupsList</a>() -> Corti.ResponseFactGroupsFiltered</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.facts.factgroupsList();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**requestOptions:** `Facts.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">list</a>(id) -> Corti.ResponseFactsList</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Retrieves a list of facts for a given interaction.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.facts.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction for which facts should be retrieved. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Facts.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">create</a>(id, { ...params }) -> Corti.ResponseFactsCreate</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Adds new facts to an interaction.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.facts.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
-    facts: [
-        {
-            text: "text",
-            group: "other",
-        },
-    ],
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction to which the facts belong. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Corti.RequestFactsCreate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Facts.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">batchUpdate</a>(id, { ...params }) -> Corti.ResponseFactsUpdate</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Updates multiple facts associated with an interaction. If the interaction `status = "in progress"`, the updated facts will be sent to the client over WebSocket.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.facts.batchUpdate("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
-    facts: [
-        {
-            factId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
-        },
-    ],
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction for which facts are being updated. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Corti.RequestFactsUpdate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Facts.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">update</a>(id, factId, { ...params }) -> Corti.ResponseFactUpdate</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Updates an existing fact within a specific interaction. If the interaction `status = "in progress"`, the updated fact will be sent to the client via WebSocket. To discard a fact, simply set `discarded = true`.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.facts.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479", {
-    text: "text",
-    source: "core",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The unique identifier of the interaction to which the fact belongs. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**factId:** `Corti.Uuid` — The unique identifier of the fact to update. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Corti.RequestFactUpdate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Facts.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## documents
-<details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">list</a>(id) -> Corti.ResponseDocumentList</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-List Documents
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.documents.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The interaction ID representing the context for the request. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Documents.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">create</a>(id, { ...params }) -> Corti.ResponseDocumentRead</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Generate Document.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.documents.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
-    context: [
-        {
-            type: "facts",
-            data: [
-                {
-                    text: "text",
-                    source: "core",
-                },
-            ],
-        },
-    ],
-    templateKey: "templateKey",
-    outputLanguage: "outputLanguage",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The interaction ID representing the context for the request. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Corti.RequestDocumentCreate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Documents.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">get</a>(id, documentId, { ...params }) -> Corti.ResponseDocumentRead</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Get Document.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.documents.get("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The interaction ID representing the context for the request. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**documentId:** `Corti.Uuid` — The document ID representing the context for the request. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Corti.DocumentsGetRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Documents.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">delete</a>(id, documentId) -> void</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.documents.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The interaction ID representing the context for the request. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**documentId:** `Corti.Uuid` — The document ID representing the context for the request. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Documents.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">update</a>(id, documentId, { ...params }) -> Corti.ResponseDocumentRead</code></summary>
-<dl>
-<dd>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.documents.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**id:** `Corti.Uuid` — The interaction ID representing the context for the request. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**documentId:** `Corti.Uuid` — The document ID representing the context for the request. Must be a valid UUID.
-</dd>
-</dl>
-<dl>
-<dd>
-**request:** `Corti.RequestDocumentUpdate`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Documents.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## Templates
-<details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">sectionsList</a>({ ...params }) -> Corti.ResponseAllTemplateSections</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Retrieves a list of template sections with optional filters for organization and language.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.templates.sectionsList();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Corti.TemplatesSectionsListRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Templates.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">list</a>({ ...params }) -> Corti.ResponseAllTemplates</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Retrieves a list of templates with optional filters for organization, language, and status.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.templates.list();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Corti.TemplatesListRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Templates.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-<details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">get</a>(key) -> Corti.TemplateFiltered</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Retrieves template by key.
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.templates.get("key");
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**key:** `string` — The key of the template
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Templates.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>
-## Auth
-<details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">getToken</a>({ ...params }) -> Corti.GetTokenResponse</code></summary>
-<dl>
-<dd>
-#### 📝 Description
-<dl>
-<dd>
-<dl>
-<dd>
-Obtain an OAuth2 access token using client credentials
-</dd>
-</dl>
-</dd>
-</dl>
-#### 🔌 Usage
-<dl>
-<dd>
-<dl>
-<dd>
-```typescript
-await client.auth.getToken({
-    client_id: "client_id",
-    client_secret: "client_secret",
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-#### ⚙️ Parameters
-<dl>
-<dd>
-<dl>
-<dd>
-**request:** `Corti.AuthGetTokenRequest`
-</dd>
-</dl>
-<dl>
-<dd>
-**requestOptions:** `Auth.RequestOptions`
-</dd>
-</dl>
-</dd>
-</dl>
-</dd>
-</dl>
-</details>