@corti/sdk 0.1.5-alpha → 0.2.0

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 (214) hide show
  1. package/README.md +26 -13
  2. package/dist/cjs/Client.js +2 -2
  3. package/dist/cjs/api/errors/NotFoundError.d.ts +1 -2
  4. package/dist/cjs/api/index.d.ts +4 -0
  5. package/dist/cjs/api/index.js +4 -0
  6. package/dist/cjs/api/resources/documents/client/Client.d.ts +3 -3
  7. package/dist/cjs/api/resources/documents/client/Client.js +4 -10
  8. package/dist/cjs/api/resources/facts/client/Client.d.ts +6 -4
  9. package/dist/cjs/api/resources/facts/client/Client.js +6 -4
  10. package/dist/cjs/api/resources/facts/client/requests/FactsUpdateRequest.d.ts +2 -2
  11. package/dist/cjs/api/resources/index.d.ts +1 -2
  12. package/dist/cjs/api/resources/index.js +2 -3
  13. package/dist/cjs/api/resources/interactions/client/Client.d.ts +5 -5
  14. package/dist/cjs/api/resources/interactions/client/Client.js +5 -5
  15. package/dist/cjs/api/resources/recordings/client/Client.d.ts +4 -4
  16. package/dist/cjs/api/resources/recordings/client/Client.js +6 -18
  17. package/dist/cjs/api/resources/templates/client/Client.d.ts +2 -2
  18. package/dist/cjs/api/resources/templates/client/Client.js +2 -2
  19. package/dist/cjs/api/resources/transcripts/client/Client.d.ts +5 -6
  20. package/dist/cjs/api/resources/transcripts/client/Client.js +5 -6
  21. package/dist/cjs/api/resources/transcripts/client/requests/TranscriptsCreateRequest.d.ts +1 -4
  22. package/dist/cjs/api/resources/transcripts/index.d.ts +0 -1
  23. package/dist/cjs/api/resources/transcripts/index.js +0 -1
  24. package/dist/cjs/api/types/CommonTranscriptRequest.d.ts +17 -0
  25. package/dist/cjs/api/types/{CommonTranscript.d.ts → CommonTranscriptResponse.d.ts} +1 -1
  26. package/dist/cjs/api/types/DocumentsContext.d.ts +11 -5
  27. package/dist/cjs/api/types/DocumentsContextWithFacts.d.ts +8 -0
  28. package/dist/cjs/api/types/DocumentsContextWithString.d.ts +7 -0
  29. package/dist/cjs/api/types/DocumentsContextWithString.js +5 -0
  30. package/dist/cjs/api/types/DocumentsContextWithTranscript.d.ts +8 -0
  31. package/dist/cjs/api/types/DocumentsContextWithTranscript.js +5 -0
  32. package/dist/cjs/api/types/DocumentsCreateRequest.d.ts +7 -1
  33. package/dist/cjs/api/types/DocumentsCreateRequestWithTemplate.d.ts +2 -4
  34. package/dist/cjs/api/types/DocumentsCreateRequestWithTemplateKey.d.ts +2 -4
  35. package/dist/cjs/api/types/DocumentsTemplate.d.ts +1 -10
  36. package/dist/cjs/api/types/DocumentsTemplateWithSectionKeys.d.ts +11 -0
  37. package/dist/cjs/api/types/DocumentsTemplateWithSectionKeys.js +5 -0
  38. package/dist/cjs/api/types/FactsBatchUpdateInput.d.ts +1 -1
  39. package/dist/cjs/api/types/FactsCreateItem.d.ts +1 -1
  40. package/dist/cjs/api/types/FactsListItem.d.ts +1 -1
  41. package/dist/cjs/api/types/TranscriptsData.d.ts +1 -1
  42. package/dist/cjs/api/types/TranscriptsResponse.d.ts +1 -1
  43. package/dist/cjs/api/types/index.d.ts +6 -4
  44. package/dist/cjs/api/types/index.js +6 -4
  45. package/dist/cjs/custom/CortiClient.js +4 -4
  46. package/dist/cjs/custom/RefreshBearerProvider.d.ts +10 -5
  47. package/dist/cjs/custom/RefreshBearerProvider.js +1 -1
  48. package/dist/cjs/custom/index.d.ts +1 -0
  49. package/dist/cjs/{serialization/resources/transcripts/types → custom}/index.js +1 -1
  50. package/dist/cjs/custom/utils/getEnvironmentFromString.js +1 -0
  51. package/dist/cjs/environments.d.ts +3 -0
  52. package/dist/cjs/environments.js +2 -0
  53. package/dist/cjs/serialization/resources/index.d.ts +1 -2
  54. package/dist/cjs/serialization/resources/index.js +2 -3
  55. package/dist/cjs/serialization/resources/transcripts/client/requests/TranscriptsCreateRequest.d.ts +0 -2
  56. package/dist/cjs/serialization/resources/transcripts/client/requests/TranscriptsCreateRequest.js +0 -2
  57. package/dist/cjs/serialization/resources/transcripts/index.d.ts +0 -1
  58. package/dist/cjs/serialization/resources/transcripts/index.js +0 -1
  59. package/dist/cjs/serialization/types/CommonTranscriptRequest.d.ts +17 -0
  60. package/dist/cjs/serialization/types/CommonTranscriptRequest.js +48 -0
  61. package/dist/cjs/serialization/types/{CommonTranscript.d.ts → CommonTranscriptResponse.d.ts} +2 -2
  62. package/dist/cjs/serialization/types/{CommonTranscript.js → CommonTranscriptResponse.js} +2 -2
  63. package/dist/cjs/serialization/types/DocumentsContext.d.ts +13 -6
  64. package/dist/cjs/serialization/types/DocumentsContext.js +12 -5
  65. package/dist/cjs/serialization/types/DocumentsContextWithFacts.d.ts +13 -0
  66. package/dist/cjs/serialization/{resources/transcripts/types/TranscriptsCreateRequestModelName.js → types/DocumentsContextWithFacts.js} +6 -3
  67. package/dist/cjs/serialization/types/DocumentsContextWithString.d.ts +12 -0
  68. package/dist/cjs/serialization/types/{DocumentsContextTypeEnum.js → DocumentsContextWithString.js} +4 -2
  69. package/dist/cjs/serialization/types/DocumentsContextWithTranscript.d.ts +13 -0
  70. package/dist/cjs/serialization/types/{DocumentsContextData.js → DocumentsContextWithTranscript.js} +5 -8
  71. package/dist/cjs/serialization/types/DocumentsCreateRequest.d.ts +1 -2
  72. package/dist/cjs/serialization/types/DocumentsCreateRequest.js +0 -2
  73. package/dist/cjs/serialization/types/DocumentsCreateRequestWithTemplate.d.ts +0 -1
  74. package/dist/cjs/serialization/types/DocumentsCreateRequestWithTemplate.js +0 -1
  75. package/dist/cjs/serialization/types/DocumentsCreateRequestWithTemplateKey.d.ts +0 -1
  76. package/dist/cjs/serialization/types/DocumentsCreateRequestWithTemplateKey.js +0 -1
  77. package/dist/cjs/serialization/types/DocumentsTemplate.d.ts +2 -7
  78. package/dist/cjs/serialization/types/DocumentsTemplate.js +2 -41
  79. package/dist/cjs/serialization/types/DocumentsTemplateWithSectionKeys.d.ts +14 -0
  80. package/dist/cjs/serialization/types/DocumentsTemplateWithSectionKeys.js +45 -0
  81. package/dist/cjs/serialization/types/TranscriptsData.d.ts +2 -2
  82. package/dist/cjs/serialization/types/TranscriptsData.js +2 -2
  83. package/dist/cjs/serialization/types/TranscriptsResponse.d.ts +2 -2
  84. package/dist/cjs/serialization/types/TranscriptsResponse.js +2 -2
  85. package/dist/cjs/serialization/types/index.d.ts +6 -4
  86. package/dist/cjs/serialization/types/index.js +6 -4
  87. package/dist/cjs/version.d.ts +1 -1
  88. package/dist/cjs/version.js +1 -1
  89. package/dist/esm/Client.mjs +2 -2
  90. package/dist/esm/api/errors/NotFoundError.d.mts +1 -2
  91. package/dist/esm/api/index.d.mts +4 -0
  92. package/dist/esm/api/index.mjs +4 -0
  93. package/dist/esm/api/resources/documents/client/Client.d.mts +3 -3
  94. package/dist/esm/api/resources/documents/client/Client.mjs +4 -10
  95. package/dist/esm/api/resources/facts/client/Client.d.mts +6 -4
  96. package/dist/esm/api/resources/facts/client/Client.mjs +6 -4
  97. package/dist/esm/api/resources/facts/client/requests/FactsUpdateRequest.d.mts +2 -2
  98. package/dist/esm/api/resources/index.d.mts +1 -2
  99. package/dist/esm/api/resources/index.mjs +1 -2
  100. package/dist/esm/api/resources/interactions/client/Client.d.mts +5 -5
  101. package/dist/esm/api/resources/interactions/client/Client.mjs +5 -5
  102. package/dist/esm/api/resources/recordings/client/Client.d.mts +4 -4
  103. package/dist/esm/api/resources/recordings/client/Client.mjs +6 -18
  104. package/dist/esm/api/resources/templates/client/Client.d.mts +2 -2
  105. package/dist/esm/api/resources/templates/client/Client.mjs +2 -2
  106. package/dist/esm/api/resources/transcripts/client/Client.d.mts +5 -6
  107. package/dist/esm/api/resources/transcripts/client/Client.mjs +5 -6
  108. package/dist/esm/api/resources/transcripts/client/requests/TranscriptsCreateRequest.d.mts +1 -4
  109. package/dist/esm/api/resources/transcripts/index.d.mts +0 -1
  110. package/dist/esm/api/resources/transcripts/index.mjs +0 -1
  111. package/dist/esm/api/types/CommonTranscriptRequest.d.mts +17 -0
  112. package/dist/esm/api/types/{CommonTranscript.d.mts → CommonTranscriptResponse.d.mts} +1 -1
  113. package/dist/esm/api/types/DocumentsContext.d.mts +11 -5
  114. package/dist/esm/api/types/DocumentsContextWithFacts.d.mts +8 -0
  115. package/dist/esm/api/types/DocumentsContextWithString.d.mts +7 -0
  116. package/dist/esm/api/types/DocumentsContextWithString.mjs +4 -0
  117. package/dist/esm/api/types/DocumentsContextWithTranscript.d.mts +8 -0
  118. package/dist/esm/api/types/DocumentsContextWithTranscript.mjs +4 -0
  119. package/dist/esm/api/types/DocumentsCreateRequest.d.mts +7 -1
  120. package/dist/esm/api/types/DocumentsCreateRequestWithTemplate.d.mts +2 -4
  121. package/dist/esm/api/types/DocumentsCreateRequestWithTemplateKey.d.mts +2 -4
  122. package/dist/esm/api/types/DocumentsTemplate.d.mts +1 -10
  123. package/dist/esm/api/types/DocumentsTemplateWithSectionKeys.d.mts +11 -0
  124. package/dist/esm/api/types/DocumentsTemplateWithSectionKeys.mjs +4 -0
  125. package/dist/esm/api/types/FactsBatchUpdateInput.d.mts +1 -1
  126. package/dist/esm/api/types/FactsCreateItem.d.mts +1 -1
  127. package/dist/esm/api/types/FactsListItem.d.mts +1 -1
  128. package/dist/esm/api/types/TranscriptsData.d.mts +1 -1
  129. package/dist/esm/api/types/TranscriptsResponse.d.mts +1 -1
  130. package/dist/esm/api/types/index.d.mts +6 -4
  131. package/dist/esm/api/types/index.mjs +6 -4
  132. package/dist/esm/custom/CortiClient.mjs +4 -4
  133. package/dist/esm/custom/RefreshBearerProvider.d.mts +10 -5
  134. package/dist/esm/custom/RefreshBearerProvider.mjs +1 -1
  135. package/dist/esm/custom/index.d.mts +1 -0
  136. package/dist/esm/custom/index.mjs +1 -0
  137. package/dist/esm/custom/utils/getEnvironmentFromString.mjs +1 -0
  138. package/dist/esm/environments.d.mts +3 -0
  139. package/dist/esm/environments.mjs +2 -0
  140. package/dist/esm/serialization/resources/index.d.mts +1 -2
  141. package/dist/esm/serialization/resources/index.mjs +1 -2
  142. package/dist/esm/serialization/resources/transcripts/client/requests/TranscriptsCreateRequest.d.mts +0 -2
  143. package/dist/esm/serialization/resources/transcripts/client/requests/TranscriptsCreateRequest.mjs +0 -2
  144. package/dist/esm/serialization/resources/transcripts/index.d.mts +0 -1
  145. package/dist/esm/serialization/resources/transcripts/index.mjs +0 -1
  146. package/dist/esm/serialization/types/CommonTranscriptRequest.d.mts +17 -0
  147. package/dist/esm/serialization/types/CommonTranscriptRequest.mjs +12 -0
  148. package/dist/esm/serialization/types/{CommonTranscript.d.mts → CommonTranscriptResponse.d.mts} +2 -2
  149. package/dist/esm/serialization/types/{CommonTranscript.mjs → CommonTranscriptResponse.mjs} +1 -1
  150. package/dist/esm/serialization/types/DocumentsContext.d.mts +13 -6
  151. package/dist/esm/serialization/types/DocumentsContext.mjs +12 -5
  152. package/dist/esm/serialization/types/DocumentsContextWithFacts.d.mts +13 -0
  153. package/dist/esm/serialization/types/DocumentsContextWithFacts.mjs +8 -0
  154. package/dist/esm/serialization/types/DocumentsContextWithString.d.mts +12 -0
  155. package/dist/esm/serialization/types/{DocumentsContextTypeEnum.mjs → DocumentsContextWithString.mjs} +3 -1
  156. package/dist/esm/serialization/types/DocumentsContextWithTranscript.d.mts +13 -0
  157. package/dist/esm/serialization/types/DocumentsContextWithTranscript.mjs +8 -0
  158. package/dist/esm/serialization/types/DocumentsCreateRequest.d.mts +1 -2
  159. package/dist/esm/serialization/types/DocumentsCreateRequest.mjs +0 -2
  160. package/dist/esm/serialization/types/DocumentsCreateRequestWithTemplate.d.mts +0 -1
  161. package/dist/esm/serialization/types/DocumentsCreateRequestWithTemplate.mjs +0 -1
  162. package/dist/esm/serialization/types/DocumentsCreateRequestWithTemplateKey.d.mts +0 -1
  163. package/dist/esm/serialization/types/DocumentsCreateRequestWithTemplateKey.mjs +0 -1
  164. package/dist/esm/serialization/types/DocumentsTemplate.d.mts +2 -7
  165. package/dist/esm/serialization/types/DocumentsTemplate.mjs +2 -8
  166. package/dist/esm/serialization/types/DocumentsTemplateWithSectionKeys.d.mts +14 -0
  167. package/dist/esm/serialization/types/DocumentsTemplateWithSectionKeys.mjs +9 -0
  168. package/dist/esm/serialization/types/TranscriptsData.d.mts +2 -2
  169. package/dist/esm/serialization/types/TranscriptsData.mjs +2 -2
  170. package/dist/esm/serialization/types/TranscriptsResponse.d.mts +2 -2
  171. package/dist/esm/serialization/types/TranscriptsResponse.mjs +2 -2
  172. package/dist/esm/serialization/types/index.d.mts +6 -4
  173. package/dist/esm/serialization/types/index.mjs +6 -4
  174. package/dist/esm/version.d.mts +1 -1
  175. package/dist/esm/version.mjs +1 -1
  176. package/package.json +2 -2
  177. package/dist/cjs/api/resources/transcripts/types/TranscriptsCreateRequestModelName.d.ts +0 -12
  178. package/dist/cjs/api/resources/transcripts/types/TranscriptsCreateRequestModelName.js +0 -11
  179. package/dist/cjs/api/resources/transcripts/types/index.d.ts +0 -1
  180. package/dist/cjs/api/resources/transcripts/types/index.js +0 -17
  181. package/dist/cjs/api/types/DocumentsContextData.d.ts +0 -14
  182. package/dist/cjs/api/types/DocumentsContextTypeEnum.d.ts +0 -9
  183. package/dist/cjs/api/types/DocumentsContextTypeEnum.js +0 -11
  184. package/dist/cjs/api/types/DocumentsCreateRequestWithTemplateId.d.ts +0 -16
  185. package/dist/cjs/serialization/resources/transcripts/types/TranscriptsCreateRequestModelName.d.ts +0 -10
  186. package/dist/cjs/serialization/resources/transcripts/types/index.d.ts +0 -1
  187. package/dist/cjs/serialization/types/DocumentsContextData.d.ts +0 -12
  188. package/dist/cjs/serialization/types/DocumentsContextTypeEnum.d.ts +0 -10
  189. package/dist/cjs/serialization/types/DocumentsCreateRequestWithTemplateId.d.ts +0 -18
  190. package/dist/cjs/serialization/types/DocumentsCreateRequestWithTemplateId.js +0 -49
  191. package/dist/esm/api/resources/transcripts/types/TranscriptsCreateRequestModelName.d.mts +0 -12
  192. package/dist/esm/api/resources/transcripts/types/TranscriptsCreateRequestModelName.mjs +0 -8
  193. package/dist/esm/api/resources/transcripts/types/index.d.mts +0 -1
  194. package/dist/esm/api/resources/transcripts/types/index.mjs +0 -1
  195. package/dist/esm/api/types/DocumentsContextData.d.mts +0 -14
  196. package/dist/esm/api/types/DocumentsContextTypeEnum.d.mts +0 -9
  197. package/dist/esm/api/types/DocumentsContextTypeEnum.mjs +0 -8
  198. package/dist/esm/api/types/DocumentsCreateRequestWithTemplateId.d.mts +0 -16
  199. package/dist/esm/serialization/resources/transcripts/types/TranscriptsCreateRequestModelName.d.mts +0 -10
  200. package/dist/esm/serialization/resources/transcripts/types/TranscriptsCreateRequestModelName.mjs +0 -5
  201. package/dist/esm/serialization/resources/transcripts/types/index.d.mts +0 -1
  202. package/dist/esm/serialization/resources/transcripts/types/index.mjs +0 -1
  203. package/dist/esm/serialization/types/DocumentsContextData.d.mts +0 -12
  204. package/dist/esm/serialization/types/DocumentsContextData.mjs +0 -11
  205. package/dist/esm/serialization/types/DocumentsContextTypeEnum.d.mts +0 -10
  206. package/dist/esm/serialization/types/DocumentsCreateRequestWithTemplateId.d.mts +0 -18
  207. package/dist/esm/serialization/types/DocumentsCreateRequestWithTemplateId.mjs +0 -13
  208. package/reference.md +0 -1706
  209. /package/dist/cjs/api/types/{CommonTranscript.js → CommonTranscriptRequest.js} +0 -0
  210. /package/dist/cjs/api/types/{DocumentsContextData.js → CommonTranscriptResponse.js} +0 -0
  211. /package/dist/cjs/api/types/{DocumentsCreateRequestWithTemplateId.js → DocumentsContextWithFacts.js} +0 -0
  212. /package/dist/esm/api/types/{CommonTranscript.mjs → CommonTranscriptRequest.mjs} +0 -0
  213. /package/dist/esm/api/types/{DocumentsContextData.mjs → CommonTranscriptResponse.mjs} +0 -0
  214. /package/dist/esm/api/types/{DocumentsCreateRequestWithTemplateId.mjs → DocumentsContextWithFacts.mjs} +0 -0
package/reference.md DELETED
@@ -1,1706 +0,0 @@
1
- # Reference
2
-
3
- ## interactions
4
-
5
- <details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">list</a>({ ...params }) -> core.Page<Corti.InteractionsGetResponse></code></summary>
6
- <dl>
7
- <dd>
8
-
9
- #### 📝 Description
10
-
11
- <dl>
12
- <dd>
13
-
14
- <dl>
15
- <dd>
16
-
17
- Lists all existing interactions. Results can be filtered by encounter status and patient identifier.
18
-
19
- </dd>
20
- </dl>
21
- </dd>
22
- </dl>
23
-
24
- #### 🔌 Usage
25
-
26
- <dl>
27
- <dd>
28
-
29
- <dl>
30
- <dd>
31
-
32
- ```typescript
33
- const response = await client.interactions.list();
34
- for await (const item of response) {
35
- console.log(item);
36
- }
37
-
38
- // Or you can manually iterate page-by-page
39
- let page = await client.interactions.list();
40
- while (page.hasNextPage()) {
41
- page = page.getNextPage();
42
- }
43
- ```
44
-
45
- </dd>
46
- </dl>
47
- </dd>
48
- </dl>
49
-
50
- #### ⚙️ Parameters
51
-
52
- <dl>
53
- <dd>
54
-
55
- <dl>
56
- <dd>
57
-
58
- **request:** `Corti.InteractionsListRequest`
59
-
60
- </dd>
61
- </dl>
62
-
63
- <dl>
64
- <dd>
65
-
66
- **requestOptions:** `Interactions.RequestOptions`
67
-
68
- </dd>
69
- </dl>
70
- </dd>
71
- </dl>
72
-
73
- </dd>
74
- </dl>
75
- </details>
76
-
77
- <details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">create</a>({ ...params }) -> Corti.InteractionsCreateResponse</code></summary>
78
- <dl>
79
- <dd>
80
-
81
- #### 📝 Description
82
-
83
- <dl>
84
- <dd>
85
-
86
- <dl>
87
- <dd>
88
-
89
- Creates a new interaction.
90
-
91
- </dd>
92
- </dl>
93
- </dd>
94
- </dl>
95
-
96
- #### 🔌 Usage
97
-
98
- <dl>
99
- <dd>
100
-
101
- <dl>
102
- <dd>
103
-
104
- ```typescript
105
- await client.interactions.create({
106
- encounter: {
107
- identifier: "identifier",
108
- status: "planned",
109
- type: "first_consultation",
110
- },
111
- });
112
- ```
113
-
114
- </dd>
115
- </dl>
116
- </dd>
117
- </dl>
118
-
119
- #### ⚙️ Parameters
120
-
121
- <dl>
122
- <dd>
123
-
124
- <dl>
125
- <dd>
126
-
127
- **request:** `Corti.InteractionsCreateRequest`
128
-
129
- </dd>
130
- </dl>
131
-
132
- <dl>
133
- <dd>
134
-
135
- **requestOptions:** `Interactions.RequestOptions`
136
-
137
- </dd>
138
- </dl>
139
- </dd>
140
- </dl>
141
-
142
- </dd>
143
- </dl>
144
- </details>
145
-
146
- <details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">get</a>(id) -> Corti.InteractionsGetResponse</code></summary>
147
- <dl>
148
- <dd>
149
-
150
- #### 📝 Description
151
-
152
- <dl>
153
- <dd>
154
-
155
- <dl>
156
- <dd>
157
-
158
- Retrieves a previously recorded interaction by its unique identifier (interaction ID).
159
-
160
- </dd>
161
- </dl>
162
- </dd>
163
- </dl>
164
-
165
- #### 🔌 Usage
166
-
167
- <dl>
168
- <dd>
169
-
170
- <dl>
171
- <dd>
172
-
173
- ```typescript
174
- await client.interactions.get("f47ac10b-58cc-4372-a567-0e02b2c3d479");
175
- ```
176
-
177
- </dd>
178
- </dl>
179
- </dd>
180
- </dl>
181
-
182
- #### ⚙️ Parameters
183
-
184
- <dl>
185
- <dd>
186
-
187
- <dl>
188
- <dd>
189
-
190
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
191
-
192
- </dd>
193
- </dl>
194
-
195
- <dl>
196
- <dd>
197
-
198
- **requestOptions:** `Interactions.RequestOptions`
199
-
200
- </dd>
201
- </dl>
202
- </dd>
203
- </dl>
204
-
205
- </dd>
206
- </dl>
207
- </details>
208
-
209
- <details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">delete</a>(id) -> void</code></summary>
210
- <dl>
211
- <dd>
212
-
213
- #### 📝 Description
214
-
215
- <dl>
216
- <dd>
217
-
218
- <dl>
219
- <dd>
220
-
221
- Deletes an existing interaction.
222
-
223
- </dd>
224
- </dl>
225
- </dd>
226
- </dl>
227
-
228
- #### 🔌 Usage
229
-
230
- <dl>
231
- <dd>
232
-
233
- <dl>
234
- <dd>
235
-
236
- ```typescript
237
- await client.interactions.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479");
238
- ```
239
-
240
- </dd>
241
- </dl>
242
- </dd>
243
- </dl>
244
-
245
- #### ⚙️ Parameters
246
-
247
- <dl>
248
- <dd>
249
-
250
- <dl>
251
- <dd>
252
-
253
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
254
-
255
- </dd>
256
- </dl>
257
-
258
- <dl>
259
- <dd>
260
-
261
- **requestOptions:** `Interactions.RequestOptions`
262
-
263
- </dd>
264
- </dl>
265
- </dd>
266
- </dl>
267
-
268
- </dd>
269
- </dl>
270
- </details>
271
-
272
- <details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">update</a>(id, { ...params }) -> Corti.InteractionsGetResponse</code></summary>
273
- <dl>
274
- <dd>
275
-
276
- #### 📝 Description
277
-
278
- <dl>
279
- <dd>
280
-
281
- <dl>
282
- <dd>
283
-
284
- Modifies an existing interaction by updating specific fields without overwriting the entire record.
285
-
286
- </dd>
287
- </dl>
288
- </dd>
289
- </dl>
290
-
291
- #### 🔌 Usage
292
-
293
- <dl>
294
- <dd>
295
-
296
- <dl>
297
- <dd>
298
-
299
- ```typescript
300
- await client.interactions.update("f47ac10b-58cc-4372-a567-0e02b2c3d479");
301
- ```
302
-
303
- </dd>
304
- </dl>
305
- </dd>
306
- </dl>
307
-
308
- #### ⚙️ Parameters
309
-
310
- <dl>
311
- <dd>
312
-
313
- <dl>
314
- <dd>
315
-
316
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
317
-
318
- </dd>
319
- </dl>
320
-
321
- <dl>
322
- <dd>
323
-
324
- **request:** `Corti.InteractionsUpdateRequest`
325
-
326
- </dd>
327
- </dl>
328
-
329
- <dl>
330
- <dd>
331
-
332
- **requestOptions:** `Interactions.RequestOptions`
333
-
334
- </dd>
335
- </dl>
336
- </dd>
337
- </dl>
338
-
339
- </dd>
340
- </dl>
341
- </details>
342
-
343
- ## recordings
344
-
345
- <details><summary><code>client.recordings.<a href="/src/api/resources/recordings/client/Client.ts">list</a>(id) -> Corti.RecordingsListResponse</code></summary>
346
- <dl>
347
- <dd>
348
-
349
- #### 📝 Description
350
-
351
- <dl>
352
- <dd>
353
-
354
- <dl>
355
- <dd>
356
-
357
- Retrieve a list of recordings for a given interaction.
358
-
359
- </dd>
360
- </dl>
361
- </dd>
362
- </dl>
363
-
364
- #### 🔌 Usage
365
-
366
- <dl>
367
- <dd>
368
-
369
- <dl>
370
- <dd>
371
-
372
- ```typescript
373
- await client.recordings.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
374
- ```
375
-
376
- </dd>
377
- </dl>
378
- </dd>
379
- </dl>
380
-
381
- #### ⚙️ Parameters
382
-
383
- <dl>
384
- <dd>
385
-
386
- <dl>
387
- <dd>
388
-
389
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
390
-
391
- </dd>
392
- </dl>
393
-
394
- <dl>
395
- <dd>
396
-
397
- **requestOptions:** `Recordings.RequestOptions`
398
-
399
- </dd>
400
- </dl>
401
- </dd>
402
- </dl>
403
-
404
- </dd>
405
- </dl>
406
- </details>
407
-
408
- <details><summary><code>client.recordings.<a href="/src/api/resources/recordings/client/Client.ts">delete</a>(id, recordingId) -> void</code></summary>
409
- <dl>
410
- <dd>
411
-
412
- #### 📝 Description
413
-
414
- <dl>
415
- <dd>
416
-
417
- <dl>
418
- <dd>
419
-
420
- Delete a specific recording for a given interaction.
421
-
422
- </dd>
423
- </dl>
424
- </dd>
425
- </dl>
426
-
427
- #### 🔌 Usage
428
-
429
- <dl>
430
- <dd>
431
-
432
- <dl>
433
- <dd>
434
-
435
- ```typescript
436
- await client.recordings.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
437
- ```
438
-
439
- </dd>
440
- </dl>
441
- </dd>
442
- </dl>
443
-
444
- #### ⚙️ Parameters
445
-
446
- <dl>
447
- <dd>
448
-
449
- <dl>
450
- <dd>
451
-
452
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
453
-
454
- </dd>
455
- </dl>
456
-
457
- <dl>
458
- <dd>
459
-
460
- **recordingId:** `Corti.Uuid` — The unique identifier of the recording. Must be a valid UUID.
461
-
462
- </dd>
463
- </dl>
464
-
465
- <dl>
466
- <dd>
467
-
468
- **requestOptions:** `Recordings.RequestOptions`
469
-
470
- </dd>
471
- </dl>
472
- </dd>
473
- </dl>
474
-
475
- </dd>
476
- </dl>
477
- </details>
478
-
479
- ## transcripts
480
-
481
- <details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">list</a>(id, { ...params }) -> Corti.TranscriptsListResponse</code></summary>
482
- <dl>
483
- <dd>
484
-
485
- #### 📝 Description
486
-
487
- <dl>
488
- <dd>
489
-
490
- <dl>
491
- <dd>
492
-
493
- Retrieves a list of transcripts for a given interaction.
494
-
495
- </dd>
496
- </dl>
497
- </dd>
498
- </dl>
499
-
500
- #### 🔌 Usage
501
-
502
- <dl>
503
- <dd>
504
-
505
- <dl>
506
- <dd>
507
-
508
- ```typescript
509
- await client.transcripts.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
510
- ```
511
-
512
- </dd>
513
- </dl>
514
- </dd>
515
- </dl>
516
-
517
- #### ⚙️ Parameters
518
-
519
- <dl>
520
- <dd>
521
-
522
- <dl>
523
- <dd>
524
-
525
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
526
-
527
- </dd>
528
- </dl>
529
-
530
- <dl>
531
- <dd>
532
-
533
- **request:** `Corti.TranscriptsListRequest`
534
-
535
- </dd>
536
- </dl>
537
-
538
- <dl>
539
- <dd>
540
-
541
- **requestOptions:** `Transcripts.RequestOptions`
542
-
543
- </dd>
544
- </dl>
545
- </dd>
546
- </dl>
547
-
548
- </dd>
549
- </dl>
550
- </details>
551
-
552
- <details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">create</a>(id, { ...params }) -> Corti.TranscriptsResponse</code></summary>
553
- <dl>
554
- <dd>
555
-
556
- #### 📝 Description
557
-
558
- <dl>
559
- <dd>
560
-
561
- <dl>
562
- <dd>
563
-
564
- Creates a new transcript for an interaction.
565
-
566
- </dd>
567
- </dl>
568
- </dd>
569
- </dl>
570
-
571
- #### 🔌 Usage
572
-
573
- <dl>
574
- <dd>
575
-
576
- <dl>
577
- <dd>
578
-
579
- ```typescript
580
- await client.transcripts.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
581
- recordingId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
582
- primaryLanguage: "en",
583
- modelName: "base",
584
- });
585
- ```
586
-
587
- </dd>
588
- </dl>
589
- </dd>
590
- </dl>
591
-
592
- #### ⚙️ Parameters
593
-
594
- <dl>
595
- <dd>
596
-
597
- <dl>
598
- <dd>
599
-
600
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
601
-
602
- </dd>
603
- </dl>
604
-
605
- <dl>
606
- <dd>
607
-
608
- **request:** `Corti.TranscriptsCreateRequest`
609
-
610
- </dd>
611
- </dl>
612
-
613
- <dl>
614
- <dd>
615
-
616
- **requestOptions:** `Transcripts.RequestOptions`
617
-
618
- </dd>
619
- </dl>
620
- </dd>
621
- </dl>
622
-
623
- </dd>
624
- </dl>
625
- </details>
626
-
627
- <details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">get</a>(id, transcriptId) -> Corti.TranscriptsResponse</code></summary>
628
- <dl>
629
- <dd>
630
-
631
- #### 📝 Description
632
-
633
- <dl>
634
- <dd>
635
-
636
- <dl>
637
- <dd>
638
-
639
- Retrieves the transcript for a specific interaction.
640
-
641
- </dd>
642
- </dl>
643
- </dd>
644
- </dl>
645
-
646
- #### 🔌 Usage
647
-
648
- <dl>
649
- <dd>
650
-
651
- <dl>
652
- <dd>
653
-
654
- ```typescript
655
- await client.transcripts.get("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
656
- ```
657
-
658
- </dd>
659
- </dl>
660
- </dd>
661
- </dl>
662
-
663
- #### ⚙️ Parameters
664
-
665
- <dl>
666
- <dd>
667
-
668
- <dl>
669
- <dd>
670
-
671
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
672
-
673
- </dd>
674
- </dl>
675
-
676
- <dl>
677
- <dd>
678
-
679
- **transcriptId:** `Corti.Uuid` — The unique identifier of the transcript. Must be a valid UUID.
680
-
681
- </dd>
682
- </dl>
683
-
684
- <dl>
685
- <dd>
686
-
687
- **requestOptions:** `Transcripts.RequestOptions`
688
-
689
- </dd>
690
- </dl>
691
- </dd>
692
- </dl>
693
-
694
- </dd>
695
- </dl>
696
- </details>
697
-
698
- <details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">delete</a>(id, transcriptId) -> void</code></summary>
699
- <dl>
700
- <dd>
701
-
702
- #### 📝 Description
703
-
704
- <dl>
705
- <dd>
706
-
707
- <dl>
708
- <dd>
709
-
710
- Deletes a specific transcript associated with an interaction.
711
-
712
- </dd>
713
- </dl>
714
- </dd>
715
- </dl>
716
-
717
- #### 🔌 Usage
718
-
719
- <dl>
720
- <dd>
721
-
722
- <dl>
723
- <dd>
724
-
725
- ```typescript
726
- await client.transcripts.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
727
- ```
728
-
729
- </dd>
730
- </dl>
731
- </dd>
732
- </dl>
733
-
734
- #### ⚙️ Parameters
735
-
736
- <dl>
737
- <dd>
738
-
739
- <dl>
740
- <dd>
741
-
742
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
743
-
744
- </dd>
745
- </dl>
746
-
747
- <dl>
748
- <dd>
749
-
750
- **transcriptId:** `Corti.Uuid` — The unique identifier of the transcript. Must be a valid UUID.
751
-
752
- </dd>
753
- </dl>
754
-
755
- <dl>
756
- <dd>
757
-
758
- **requestOptions:** `Transcripts.RequestOptions`
759
-
760
- </dd>
761
- </dl>
762
- </dd>
763
- </dl>
764
-
765
- </dd>
766
- </dl>
767
- </details>
768
-
769
- ## facts
770
-
771
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">factGroupsList</a>() -> Corti.FactsFactGroupsListResponse</code></summary>
772
- <dl>
773
- <dd>
774
-
775
- #### 🔌 Usage
776
-
777
- <dl>
778
- <dd>
779
-
780
- <dl>
781
- <dd>
782
-
783
- ```typescript
784
- await client.facts.factGroupsList();
785
- ```
786
-
787
- </dd>
788
- </dl>
789
- </dd>
790
- </dl>
791
-
792
- #### ⚙️ Parameters
793
-
794
- <dl>
795
- <dd>
796
-
797
- <dl>
798
- <dd>
799
-
800
- **requestOptions:** `Facts.RequestOptions`
801
-
802
- </dd>
803
- </dl>
804
- </dd>
805
- </dl>
806
-
807
- </dd>
808
- </dl>
809
- </details>
810
-
811
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">list</a>(id) -> Corti.FactsListResponse</code></summary>
812
- <dl>
813
- <dd>
814
-
815
- #### 📝 Description
816
-
817
- <dl>
818
- <dd>
819
-
820
- <dl>
821
- <dd>
822
-
823
- Retrieves a list of facts for a given interaction.
824
-
825
- </dd>
826
- </dl>
827
- </dd>
828
- </dl>
829
-
830
- #### 🔌 Usage
831
-
832
- <dl>
833
- <dd>
834
-
835
- <dl>
836
- <dd>
837
-
838
- ```typescript
839
- await client.facts.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
840
- ```
841
-
842
- </dd>
843
- </dl>
844
- </dd>
845
- </dl>
846
-
847
- #### ⚙️ Parameters
848
-
849
- <dl>
850
- <dd>
851
-
852
- <dl>
853
- <dd>
854
-
855
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
856
-
857
- </dd>
858
- </dl>
859
-
860
- <dl>
861
- <dd>
862
-
863
- **requestOptions:** `Facts.RequestOptions`
864
-
865
- </dd>
866
- </dl>
867
- </dd>
868
- </dl>
869
-
870
- </dd>
871
- </dl>
872
- </details>
873
-
874
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">create</a>(id, { ...params }) -> Corti.FactsCreateResponse</code></summary>
875
- <dl>
876
- <dd>
877
-
878
- #### 📝 Description
879
-
880
- <dl>
881
- <dd>
882
-
883
- <dl>
884
- <dd>
885
-
886
- Adds new facts to an interaction.
887
-
888
- </dd>
889
- </dl>
890
- </dd>
891
- </dl>
892
-
893
- #### 🔌 Usage
894
-
895
- <dl>
896
- <dd>
897
-
898
- <dl>
899
- <dd>
900
-
901
- ```typescript
902
- await client.facts.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
903
- facts: [
904
- {
905
- text: "text",
906
- group: "other",
907
- },
908
- ],
909
- });
910
- ```
911
-
912
- </dd>
913
- </dl>
914
- </dd>
915
- </dl>
916
-
917
- #### ⚙️ Parameters
918
-
919
- <dl>
920
- <dd>
921
-
922
- <dl>
923
- <dd>
924
-
925
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
926
-
927
- </dd>
928
- </dl>
929
-
930
- <dl>
931
- <dd>
932
-
933
- **request:** `Corti.FactsCreateRequest`
934
-
935
- </dd>
936
- </dl>
937
-
938
- <dl>
939
- <dd>
940
-
941
- **requestOptions:** `Facts.RequestOptions`
942
-
943
- </dd>
944
- </dl>
945
- </dd>
946
- </dl>
947
-
948
- </dd>
949
- </dl>
950
- </details>
951
-
952
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">batchUpdate</a>(id, { ...params }) -> Corti.FactsBatchUpdateResponse</code></summary>
953
- <dl>
954
- <dd>
955
-
956
- #### 📝 Description
957
-
958
- <dl>
959
- <dd>
960
-
961
- <dl>
962
- <dd>
963
-
964
- Updates multiple facts associated with an interaction. If the interaction `status = "in progress"`, the updated facts will be sent to the client over WebSocket.
965
-
966
- </dd>
967
- </dl>
968
- </dd>
969
- </dl>
970
-
971
- #### 🔌 Usage
972
-
973
- <dl>
974
- <dd>
975
-
976
- <dl>
977
- <dd>
978
-
979
- ```typescript
980
- await client.facts.batchUpdate("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
981
- facts: [
982
- {
983
- factId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
984
- },
985
- ],
986
- });
987
- ```
988
-
989
- </dd>
990
- </dl>
991
- </dd>
992
- </dl>
993
-
994
- #### ⚙️ Parameters
995
-
996
- <dl>
997
- <dd>
998
-
999
- <dl>
1000
- <dd>
1001
-
1002
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1003
-
1004
- </dd>
1005
- </dl>
1006
-
1007
- <dl>
1008
- <dd>
1009
-
1010
- **request:** `Corti.FactsBatchUpdateRequest`
1011
-
1012
- </dd>
1013
- </dl>
1014
-
1015
- <dl>
1016
- <dd>
1017
-
1018
- **requestOptions:** `Facts.RequestOptions`
1019
-
1020
- </dd>
1021
- </dl>
1022
- </dd>
1023
- </dl>
1024
-
1025
- </dd>
1026
- </dl>
1027
- </details>
1028
-
1029
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">update</a>(id, factId, { ...params }) -> Corti.FactsUpdateResponse</code></summary>
1030
- <dl>
1031
- <dd>
1032
-
1033
- #### 📝 Description
1034
-
1035
- <dl>
1036
- <dd>
1037
-
1038
- <dl>
1039
- <dd>
1040
-
1041
- 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`.
1042
-
1043
- </dd>
1044
- </dl>
1045
- </dd>
1046
- </dl>
1047
-
1048
- #### 🔌 Usage
1049
-
1050
- <dl>
1051
- <dd>
1052
-
1053
- <dl>
1054
- <dd>
1055
-
1056
- ```typescript
1057
- await client.facts.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
1058
- ```
1059
-
1060
- </dd>
1061
- </dl>
1062
- </dd>
1063
- </dl>
1064
-
1065
- #### ⚙️ Parameters
1066
-
1067
- <dl>
1068
- <dd>
1069
-
1070
- <dl>
1071
- <dd>
1072
-
1073
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1074
-
1075
- </dd>
1076
- </dl>
1077
-
1078
- <dl>
1079
- <dd>
1080
-
1081
- **factId:** `Corti.Uuid` — The unique identifier of the fact to update. Must be a valid UUID.
1082
-
1083
- </dd>
1084
- </dl>
1085
-
1086
- <dl>
1087
- <dd>
1088
-
1089
- **request:** `Corti.FactsUpdateRequest`
1090
-
1091
- </dd>
1092
- </dl>
1093
-
1094
- <dl>
1095
- <dd>
1096
-
1097
- **requestOptions:** `Facts.RequestOptions`
1098
-
1099
- </dd>
1100
- </dl>
1101
- </dd>
1102
- </dl>
1103
-
1104
- </dd>
1105
- </dl>
1106
- </details>
1107
-
1108
- ## documents
1109
-
1110
- <details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">list</a>(id) -> Corti.DocumentsListResponse</code></summary>
1111
- <dl>
1112
- <dd>
1113
-
1114
- #### 📝 Description
1115
-
1116
- <dl>
1117
- <dd>
1118
-
1119
- <dl>
1120
- <dd>
1121
-
1122
- List Documents
1123
-
1124
- </dd>
1125
- </dl>
1126
- </dd>
1127
- </dl>
1128
-
1129
- #### 🔌 Usage
1130
-
1131
- <dl>
1132
- <dd>
1133
-
1134
- <dl>
1135
- <dd>
1136
-
1137
- ```typescript
1138
- await client.documents.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
1139
- ```
1140
-
1141
- </dd>
1142
- </dl>
1143
- </dd>
1144
- </dl>
1145
-
1146
- #### ⚙️ Parameters
1147
-
1148
- <dl>
1149
- <dd>
1150
-
1151
- <dl>
1152
- <dd>
1153
-
1154
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1155
-
1156
- </dd>
1157
- </dl>
1158
-
1159
- <dl>
1160
- <dd>
1161
-
1162
- **requestOptions:** `Documents.RequestOptions`
1163
-
1164
- </dd>
1165
- </dl>
1166
- </dd>
1167
- </dl>
1168
-
1169
- </dd>
1170
- </dl>
1171
- </details>
1172
-
1173
- <details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">create</a>(id, { ...params }) -> Corti.DocumentsGetResponse</code></summary>
1174
- <dl>
1175
- <dd>
1176
-
1177
- #### 📝 Description
1178
-
1179
- <dl>
1180
- <dd>
1181
-
1182
- <dl>
1183
- <dd>
1184
-
1185
- Generate Document.
1186
-
1187
- </dd>
1188
- </dl>
1189
- </dd>
1190
- </dl>
1191
-
1192
- #### 🔌 Usage
1193
-
1194
- <dl>
1195
- <dd>
1196
-
1197
- <dl>
1198
- <dd>
1199
-
1200
- ```typescript
1201
- await client.documents.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
1202
- context: [
1203
- {
1204
- type: "facts",
1205
- data: [
1206
- {
1207
- text: "text",
1208
- source: "core",
1209
- },
1210
- ],
1211
- },
1212
- ],
1213
- templateKey: "templateKey",
1214
- outputLanguage: "outputLanguage",
1215
- });
1216
- ```
1217
-
1218
- </dd>
1219
- </dl>
1220
- </dd>
1221
- </dl>
1222
-
1223
- #### ⚙️ Parameters
1224
-
1225
- <dl>
1226
- <dd>
1227
-
1228
- <dl>
1229
- <dd>
1230
-
1231
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1232
-
1233
- </dd>
1234
- </dl>
1235
-
1236
- <dl>
1237
- <dd>
1238
-
1239
- **request:** `Corti.DocumentsCreateRequest`
1240
-
1241
- </dd>
1242
- </dl>
1243
-
1244
- <dl>
1245
- <dd>
1246
-
1247
- **requestOptions:** `Documents.RequestOptions`
1248
-
1249
- </dd>
1250
- </dl>
1251
- </dd>
1252
- </dl>
1253
-
1254
- </dd>
1255
- </dl>
1256
- </details>
1257
-
1258
- <details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">get</a>(id, documentId) -> Corti.DocumentsGetResponse</code></summary>
1259
- <dl>
1260
- <dd>
1261
-
1262
- #### 📝 Description
1263
-
1264
- <dl>
1265
- <dd>
1266
-
1267
- <dl>
1268
- <dd>
1269
-
1270
- Get Document.
1271
-
1272
- </dd>
1273
- </dl>
1274
- </dd>
1275
- </dl>
1276
-
1277
- #### 🔌 Usage
1278
-
1279
- <dl>
1280
- <dd>
1281
-
1282
- <dl>
1283
- <dd>
1284
-
1285
- ```typescript
1286
- await client.documents.get("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
1287
- ```
1288
-
1289
- </dd>
1290
- </dl>
1291
- </dd>
1292
- </dl>
1293
-
1294
- #### ⚙️ Parameters
1295
-
1296
- <dl>
1297
- <dd>
1298
-
1299
- <dl>
1300
- <dd>
1301
-
1302
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1303
-
1304
- </dd>
1305
- </dl>
1306
-
1307
- <dl>
1308
- <dd>
1309
-
1310
- **documentId:** `Corti.Uuid` — The document ID representing the context for the request. Must be a valid UUID.
1311
-
1312
- </dd>
1313
- </dl>
1314
-
1315
- <dl>
1316
- <dd>
1317
-
1318
- **requestOptions:** `Documents.RequestOptions`
1319
-
1320
- </dd>
1321
- </dl>
1322
- </dd>
1323
- </dl>
1324
-
1325
- </dd>
1326
- </dl>
1327
- </details>
1328
-
1329
- <details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">delete</a>(id, documentId) -> void</code></summary>
1330
- <dl>
1331
- <dd>
1332
-
1333
- #### 🔌 Usage
1334
-
1335
- <dl>
1336
- <dd>
1337
-
1338
- <dl>
1339
- <dd>
1340
-
1341
- ```typescript
1342
- await client.documents.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
1343
- ```
1344
-
1345
- </dd>
1346
- </dl>
1347
- </dd>
1348
- </dl>
1349
-
1350
- #### ⚙️ Parameters
1351
-
1352
- <dl>
1353
- <dd>
1354
-
1355
- <dl>
1356
- <dd>
1357
-
1358
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1359
-
1360
- </dd>
1361
- </dl>
1362
-
1363
- <dl>
1364
- <dd>
1365
-
1366
- **documentId:** `Corti.Uuid` — The document ID representing the context for the request. Must be a valid UUID.
1367
-
1368
- </dd>
1369
- </dl>
1370
-
1371
- <dl>
1372
- <dd>
1373
-
1374
- **requestOptions:** `Documents.RequestOptions`
1375
-
1376
- </dd>
1377
- </dl>
1378
- </dd>
1379
- </dl>
1380
-
1381
- </dd>
1382
- </dl>
1383
- </details>
1384
-
1385
- <details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">update</a>(id, documentId, { ...params }) -> Corti.DocumentsGetResponse</code></summary>
1386
- <dl>
1387
- <dd>
1388
-
1389
- #### 🔌 Usage
1390
-
1391
- <dl>
1392
- <dd>
1393
-
1394
- <dl>
1395
- <dd>
1396
-
1397
- ```typescript
1398
- await client.documents.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
1399
- ```
1400
-
1401
- </dd>
1402
- </dl>
1403
- </dd>
1404
- </dl>
1405
-
1406
- #### ⚙️ Parameters
1407
-
1408
- <dl>
1409
- <dd>
1410
-
1411
- <dl>
1412
- <dd>
1413
-
1414
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1415
-
1416
- </dd>
1417
- </dl>
1418
-
1419
- <dl>
1420
- <dd>
1421
-
1422
- **documentId:** `Corti.Uuid` — The document ID representing the context for the request. Must be a valid UUID.
1423
-
1424
- </dd>
1425
- </dl>
1426
-
1427
- <dl>
1428
- <dd>
1429
-
1430
- **request:** `Corti.DocumentsUpdateRequest`
1431
-
1432
- </dd>
1433
- </dl>
1434
-
1435
- <dl>
1436
- <dd>
1437
-
1438
- **requestOptions:** `Documents.RequestOptions`
1439
-
1440
- </dd>
1441
- </dl>
1442
- </dd>
1443
- </dl>
1444
-
1445
- </dd>
1446
- </dl>
1447
- </details>
1448
-
1449
- ## Templates
1450
-
1451
- <details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">sectionList</a>({ ...params }) -> Corti.TemplatesSectionListResponse</code></summary>
1452
- <dl>
1453
- <dd>
1454
-
1455
- #### 📝 Description
1456
-
1457
- <dl>
1458
- <dd>
1459
-
1460
- <dl>
1461
- <dd>
1462
-
1463
- Retrieves a list of template sections with optional filters for organization and language.
1464
-
1465
- </dd>
1466
- </dl>
1467
- </dd>
1468
- </dl>
1469
-
1470
- #### 🔌 Usage
1471
-
1472
- <dl>
1473
- <dd>
1474
-
1475
- <dl>
1476
- <dd>
1477
-
1478
- ```typescript
1479
- await client.templates.sectionList();
1480
- ```
1481
-
1482
- </dd>
1483
- </dl>
1484
- </dd>
1485
- </dl>
1486
-
1487
- #### ⚙️ Parameters
1488
-
1489
- <dl>
1490
- <dd>
1491
-
1492
- <dl>
1493
- <dd>
1494
-
1495
- **request:** `Corti.TemplatesSectionListRequest`
1496
-
1497
- </dd>
1498
- </dl>
1499
-
1500
- <dl>
1501
- <dd>
1502
-
1503
- **requestOptions:** `Templates.RequestOptions`
1504
-
1505
- </dd>
1506
- </dl>
1507
- </dd>
1508
- </dl>
1509
-
1510
- </dd>
1511
- </dl>
1512
- </details>
1513
-
1514
- <details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">list</a>({ ...params }) -> Corti.TemplatesListResponse</code></summary>
1515
- <dl>
1516
- <dd>
1517
-
1518
- #### 📝 Description
1519
-
1520
- <dl>
1521
- <dd>
1522
-
1523
- <dl>
1524
- <dd>
1525
-
1526
- Retrieves a list of templates with optional filters for organization, language, and status.
1527
-
1528
- </dd>
1529
- </dl>
1530
- </dd>
1531
- </dl>
1532
-
1533
- #### 🔌 Usage
1534
-
1535
- <dl>
1536
- <dd>
1537
-
1538
- <dl>
1539
- <dd>
1540
-
1541
- ```typescript
1542
- await client.templates.list();
1543
- ```
1544
-
1545
- </dd>
1546
- </dl>
1547
- </dd>
1548
- </dl>
1549
-
1550
- #### ⚙️ Parameters
1551
-
1552
- <dl>
1553
- <dd>
1554
-
1555
- <dl>
1556
- <dd>
1557
-
1558
- **request:** `Corti.TemplatesListRequest`
1559
-
1560
- </dd>
1561
- </dl>
1562
-
1563
- <dl>
1564
- <dd>
1565
-
1566
- **requestOptions:** `Templates.RequestOptions`
1567
-
1568
- </dd>
1569
- </dl>
1570
- </dd>
1571
- </dl>
1572
-
1573
- </dd>
1574
- </dl>
1575
- </details>
1576
-
1577
- <details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">get</a>(key) -> Corti.TemplatesItem</code></summary>
1578
- <dl>
1579
- <dd>
1580
-
1581
- #### 📝 Description
1582
-
1583
- <dl>
1584
- <dd>
1585
-
1586
- <dl>
1587
- <dd>
1588
-
1589
- Retrieves template by key.
1590
-
1591
- </dd>
1592
- </dl>
1593
- </dd>
1594
- </dl>
1595
-
1596
- #### 🔌 Usage
1597
-
1598
- <dl>
1599
- <dd>
1600
-
1601
- <dl>
1602
- <dd>
1603
-
1604
- ```typescript
1605
- await client.templates.get("key");
1606
- ```
1607
-
1608
- </dd>
1609
- </dl>
1610
- </dd>
1611
- </dl>
1612
-
1613
- #### ⚙️ Parameters
1614
-
1615
- <dl>
1616
- <dd>
1617
-
1618
- <dl>
1619
- <dd>
1620
-
1621
- **key:** `string` — The key of the template
1622
-
1623
- </dd>
1624
- </dl>
1625
-
1626
- <dl>
1627
- <dd>
1628
-
1629
- **requestOptions:** `Templates.RequestOptions`
1630
-
1631
- </dd>
1632
- </dl>
1633
- </dd>
1634
- </dl>
1635
-
1636
- </dd>
1637
- </dl>
1638
- </details>
1639
-
1640
- ## Auth
1641
-
1642
- <details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">getToken</a>({ ...params }) -> Corti.GetTokenResponse</code></summary>
1643
- <dl>
1644
- <dd>
1645
-
1646
- #### 📝 Description
1647
-
1648
- <dl>
1649
- <dd>
1650
-
1651
- <dl>
1652
- <dd>
1653
-
1654
- Obtain an OAuth2 access token using client credentials
1655
-
1656
- </dd>
1657
- </dl>
1658
- </dd>
1659
- </dl>
1660
-
1661
- #### 🔌 Usage
1662
-
1663
- <dl>
1664
- <dd>
1665
-
1666
- <dl>
1667
- <dd>
1668
-
1669
- ```typescript
1670
- await client.auth.getToken({
1671
- clientId: "client_id",
1672
- clientSecret: "client_secret",
1673
- });
1674
- ```
1675
-
1676
- </dd>
1677
- </dl>
1678
- </dd>
1679
- </dl>
1680
-
1681
- #### ⚙️ Parameters
1682
-
1683
- <dl>
1684
- <dd>
1685
-
1686
- <dl>
1687
- <dd>
1688
-
1689
- **request:** `Corti.AuthGetTokenRequest`
1690
-
1691
- </dd>
1692
- </dl>
1693
-
1694
- <dl>
1695
- <dd>
1696
-
1697
- **requestOptions:** `Auth.RequestOptions`
1698
-
1699
- </dd>
1700
- </dl>
1701
- </dd>
1702
- </dl>
1703
-
1704
- </dd>
1705
- </dl>
1706
- </details>