@ai-matrx/api 0.0.0-stage → 0.1.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 (146) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/LICENSE +21 -0
  3. package/README.md +18 -2
  4. package/dist/account.cjs +670 -0
  5. package/dist/account.d.cts +3246 -0
  6. package/dist/account.d.ts +3246 -0
  7. package/dist/account.js +558 -0
  8. package/dist/agents.cjs +598 -0
  9. package/dist/agents.d.cts +3417 -0
  10. package/dist/agents.d.ts +3417 -0
  11. package/dist/agents.js +497 -0
  12. package/dist/ai.cjs +109 -0
  13. package/dist/ai.d.cts +493 -0
  14. package/dist/ai.d.ts +493 -0
  15. package/dist/ai.js +91 -0
  16. package/dist/apps.cjs +394 -0
  17. package/dist/apps.d.cts +1094 -0
  18. package/dist/apps.d.ts +1094 -0
  19. package/dist/apps.js +328 -0
  20. package/dist/architecture.cjs +1223 -0
  21. package/dist/architecture.d.cts +4701 -0
  22. package/dist/architecture.d.ts +4701 -0
  23. package/dist/architecture.js +1016 -0
  24. package/dist/audio.cjs +226 -0
  25. package/dist/audio.d.cts +723 -0
  26. package/dist/audio.d.ts +723 -0
  27. package/dist/audio.js +188 -0
  28. package/dist/chat.cjs +538 -0
  29. package/dist/chat.d.cts +2251 -0
  30. package/dist/chat.d.ts +2251 -0
  31. package/dist/chat.js +447 -0
  32. package/dist/chunk-2SXAAKGV.cjs +279 -0
  33. package/dist/chunk-AY5N6EA4.js +43 -0
  34. package/dist/chunk-BMQI7UET.cjs +48 -0
  35. package/dist/chunk-FNIYADWI.cjs +59 -0
  36. package/dist/chunk-KIEAFMKB.js +264 -0
  37. package/dist/chunk-UONBYRE4.js +1012 -0
  38. package/dist/chunk-YTEOFGFC.js +57 -0
  39. package/dist/chunk-YUDQWDCM.cjs +1047 -0
  40. package/dist/code.cjs +561 -0
  41. package/dist/code.d.cts +1976 -0
  42. package/dist/code.d.ts +1976 -0
  43. package/dist/code.js +467 -0
  44. package/dist/commerce.cjs +22 -0
  45. package/dist/commerce.d.cts +45 -0
  46. package/dist/commerce.d.ts +45 -0
  47. package/dist/commerce.js +18 -0
  48. package/dist/communications.cjs +215 -0
  49. package/dist/communications.d.cts +948 -0
  50. package/dist/communications.d.ts +948 -0
  51. package/dist/communications.js +179 -0
  52. package/dist/computer.cjs +330 -0
  53. package/dist/computer.d.cts +733 -0
  54. package/dist/computer.d.ts +733 -0
  55. package/dist/computer.js +275 -0
  56. package/dist/content.cjs +425 -0
  57. package/dist/content.d.cts +1796 -0
  58. package/dist/content.d.ts +1796 -0
  59. package/dist/content.js +354 -0
  60. package/dist/credentials.cjs +22 -0
  61. package/dist/credentials.d.cts +82 -0
  62. package/dist/credentials.d.ts +82 -0
  63. package/dist/credentials.js +1 -0
  64. package/dist/crm.cjs +271 -0
  65. package/dist/crm.d.cts +1731 -0
  66. package/dist/crm.d.ts +1731 -0
  67. package/dist/crm.js +226 -0
  68. package/dist/data.cjs +382 -0
  69. package/dist/data.d.cts +1860 -0
  70. package/dist/data.d.ts +1860 -0
  71. package/dist/data.js +318 -0
  72. package/dist/education.cjs +28 -0
  73. package/dist/education.d.cts +73 -0
  74. package/dist/education.d.ts +73 -0
  75. package/dist/education.js +23 -0
  76. package/dist/files.cjs +1330 -0
  77. package/dist/files.d.cts +4956 -0
  78. package/dist/files.d.ts +4956 -0
  79. package/dist/files.js +1104 -0
  80. package/dist/human-resources.cjs +178 -0
  81. package/dist/human-resources.d.cts +1208 -0
  82. package/dist/human-resources.d.ts +1208 -0
  83. package/dist/human-resources.js +148 -0
  84. package/dist/index-C2E-Cp19.d.ts +385 -0
  85. package/dist/index-wC2vtb70.d.cts +385 -0
  86. package/dist/index.cjs +1934 -0
  87. package/dist/index.d.cts +2006 -0
  88. package/dist/index.d.ts +2006 -0
  89. package/dist/index.js +1668 -0
  90. package/dist/integrations.cjs +5116 -0
  91. package/dist/integrations.d.cts +19213 -0
  92. package/dist/integrations.d.ts +19213 -0
  93. package/dist/integrations.js +4263 -0
  94. package/dist/intelligence.cjs +1305 -0
  95. package/dist/intelligence.d.cts +4658 -0
  96. package/dist/intelligence.d.ts +4658 -0
  97. package/dist/intelligence.js +1196 -0
  98. package/dist/knowledge.cjs +1113 -0
  99. package/dist/knowledge.d.cts +5427 -0
  100. package/dist/knowledge.d.ts +5427 -0
  101. package/dist/knowledge.js +921 -0
  102. package/dist/legal.cjs +225 -0
  103. package/dist/legal.d.cts +1038 -0
  104. package/dist/legal.d.ts +1038 -0
  105. package/dist/legal.js +187 -0
  106. package/dist/marketing.cjs +1155 -0
  107. package/dist/marketing.d.cts +7741 -0
  108. package/dist/marketing.d.ts +7741 -0
  109. package/dist/marketing.js +951 -0
  110. package/dist/masterwork.cjs +283 -0
  111. package/dist/masterwork.d.cts +1938 -0
  112. package/dist/masterwork.d.ts +1938 -0
  113. package/dist/masterwork.js +231 -0
  114. package/dist/media.cjs +610 -0
  115. package/dist/media.d.cts +2270 -0
  116. package/dist/media.d.ts +2270 -0
  117. package/dist/media.js +507 -0
  118. package/dist/net.cjs +67 -0
  119. package/dist/net.d.cts +204 -0
  120. package/dist/net.d.ts +204 -0
  121. package/dist/net.js +2 -0
  122. package/dist/platform.cjs +150 -0
  123. package/dist/platform.d.cts +572 -0
  124. package/dist/platform.d.ts +572 -0
  125. package/dist/platform.js +125 -0
  126. package/dist/publish.cjs +248 -0
  127. package/dist/publish.d.cts +1431 -0
  128. package/dist/publish.d.ts +1431 -0
  129. package/dist/publish.js +206 -0
  130. package/dist/schemas.cjs +2 -0
  131. package/dist/schemas.d.cts +1353 -0
  132. package/dist/schemas.d.ts +1353 -0
  133. package/dist/schemas.js +1 -0
  134. package/dist/stream.cjs +44 -0
  135. package/dist/stream.d.cts +2 -0
  136. package/dist/stream.d.ts +2 -0
  137. package/dist/stream.js +3 -0
  138. package/dist/web.cjs +1045 -0
  139. package/dist/web.d.cts +4186 -0
  140. package/dist/web.d.ts +4186 -0
  141. package/dist/web.js +867 -0
  142. package/dist/workflows.cjs +825 -0
  143. package/dist/workflows.d.cts +4699 -0
  144. package/dist/workflows.d.ts +4699 -0
  145. package/dist/workflows.js +686 -0
  146. package/package.json +418 -4
@@ -0,0 +1,1796 @@
1
+ import { A as Api, C as CallOptions, a as ApiStream, N as NdjsonEvent } from './index-C2E-Cp19.js';
2
+ import { JsonValue } from './schemas.js';
3
+ import './credentials.js';
4
+
5
+ /**
6
+ * GENERATED by @ai-matrx/api scripts/generate.mjs from aidream/api-contract — never edit by hand.
7
+ * CONTRACT_SHA256 50a790edb39e682b46e0fa9e674faf5ce2a0ba7de2cd01930a497fca4c47844a
8
+ */
9
+
10
+ /** ChunkRow */
11
+ type ChunkRow = {
12
+ chunk_id: string;
13
+ chunk_index: number;
14
+ chunk_kind: string;
15
+ parent_chunk_id?: string | null;
16
+ primary_page_id?: string | null;
17
+ page_numbers?: number[] | null;
18
+ page_spans?: {
19
+ [key: string]: JsonValue;
20
+ }[] | null;
21
+ content_text: string;
22
+ token_count?: number | null;
23
+ section_kind?: string | null;
24
+ section_subtype?: string | null;
25
+ };
26
+ /** ConflictResolveRequest */
27
+ type ConflictResolveRequest = {
28
+ resolution?: string;
29
+ merged_content?: string | null;
30
+ };
31
+ /** ContentBlockDetailResponse */
32
+ type ContentBlockDetailResponse = {
33
+ content_block: {
34
+ [key: string]: JsonValue;
35
+ };
36
+ related: JsonValue;
37
+ };
38
+ /** ContentBlockListResponse */
39
+ type ContentBlockListResponse = {
40
+ content_blocks?: {
41
+ [key: string]: JsonValue;
42
+ }[];
43
+ count: number;
44
+ category_id?: string | null;
45
+ };
46
+ /** ContentType */
47
+ type ContentType = "generic" | "transcript" | "conversation" | "document";
48
+ /** CreateFolderRequest */
49
+ type CreateFolderRequest_MatrxLocal = {
50
+ name: string;
51
+ parent_id?: string | null;
52
+ };
53
+ /** CreateNoteRequest */
54
+ type CreateNoteRequest = {
55
+ label?: string;
56
+ content?: string;
57
+ folder_name?: string;
58
+ folder_id?: string | null;
59
+ tags?: string[];
60
+ metadata?: {
61
+ [key: string]: unknown;
62
+ };
63
+ };
64
+ /** One block of a generated Word document. */
65
+ type DocBlock = {
66
+ /** Block kind: 'heading'/'paragraph'/'bullet'/'numbered'/'quote' render `text`; 'table' renders `rows`; 'page_break' starts a new page and uses no other field. */
67
+ type: "heading" | "paragraph" | "bullet" | "numbered" | "table" | "page_break" | "quote";
68
+ /** Body text for heading/paragraph/quote blocks, or ONE list line for a bullet/numbered block (one block per line). Ignored by table/page_break. */
69
+ text?: string;
70
+ /** Heading depth 1-6 for 'heading' blocks (1 = chapter title). Ignored elsewhere. */
71
+ level?: number;
72
+ /** Table cells for 'table' blocks, outer list = rows, inner list = one row's cell strings. The first row is styled as the header when `header` is true. */
73
+ rows?: string[][];
74
+ /** For 'table' blocks: treat the first row of `rows` as a styled header row. */
75
+ header?: boolean;
76
+ };
77
+ /** DocumentDetail */
78
+ type DocumentDetail = {
79
+ id: string;
80
+ owner_id: string;
81
+ organization_id?: string | null;
82
+ name: string;
83
+ mime_type?: string | null;
84
+ total_pages?: number | null;
85
+ source_kind: string;
86
+ source_id: string;
87
+ derivation_kind: string;
88
+ created_at: string;
89
+ updated_at: string;
90
+ has_structured_json: boolean;
91
+ has_clean_content: boolean;
92
+ raw_content_chars?: number;
93
+ clean_content_chars?: number;
94
+ chunk_count?: number;
95
+ section_histogram?: {
96
+ [key: string]: number;
97
+ };
98
+ pages?: PageSummary[];
99
+ lineage?: DocumentLineage | null;
100
+ };
101
+ /** Compact lineage breadcrumb chain for the viewer header. */
102
+ type DocumentLineage = {
103
+ binary_parent_file_id?: string | null;
104
+ binary_parent_kind?: string | null;
105
+ binary_parent_metadata?: {
106
+ [key: string]: JsonValue;
107
+ } | null;
108
+ processing_parent_id?: string | null;
109
+ processing_parent_kind?: string | null;
110
+ };
111
+ /** DocumentLookupResult */
112
+ type DocumentLookupResult = {
113
+ document_id: string | null;
114
+ found: boolean;
115
+ name?: string | null;
116
+ };
117
+ /** Canonical AI-authorable shape for a Word document (.docx). */
118
+ type DocumentSpec = {
119
+ /** Document title rendered as the top-level heading. Omit for an untitled document. */
120
+ title?: string | null;
121
+ /** Ordered content blocks (headings, paragraphs, lists, tables, quotes, page breaks) rendered top to bottom. */
122
+ blocks?: DocBlock[];
123
+ };
124
+ /** EsignActArgs */
125
+ type EsignActArgs = {
126
+ /** Organization context for the request; omitted to use the authenticated context. */
127
+ organization_id?: string | null;
128
+ /** Optional associated project selected by the caller. */
129
+ project_id?: string | null;
130
+ /** Optional associated task selected by the caller. */
131
+ task_id?: string | null;
132
+ /** Stable application slug that initiated the request. */
133
+ source_app?: string | null;
134
+ /** Stable feature slug within the source application. */
135
+ source_feature?: string | null;
136
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
137
+ initiation?: ("user" | "auto") | null;
138
+ document_id?: string | null;
139
+ disclosure_id?: string | null;
140
+ kind?: ("typed" | "drawn" | "uploaded") | null;
141
+ target?: ("signature" | "initials") | null;
142
+ source?: ("this_device" | "phone" | "saved") | null;
143
+ values?: {
144
+ [key: string]: unknown;
145
+ } | null;
146
+ message_to_sender?: string | null;
147
+ full_name?: string | null;
148
+ email?: string | null;
149
+ message?: string | null;
150
+ typed_name?: string | null;
151
+ typed_style?: string | null;
152
+ strokes?: unknown[] | null;
153
+ image_data_url?: string | null;
154
+ observed?: {
155
+ [key: string]: string;
156
+ }[] | null;
157
+ action_id?: string | null;
158
+ reason?: string | null;
159
+ handoff_id?: string | null;
160
+ saved_signature_id?: string | null;
161
+ save_to_profile?: boolean | null;
162
+ make_default?: boolean | null;
163
+ secret?: string | null;
164
+ phone?: string | null;
165
+ parts?: (("documents" | "certificate")[]) | null;
166
+ combine?: boolean | null;
167
+ document_ids?: string[] | null;
168
+ time_zone?: string | null;
169
+ };
170
+ /** EsignDetectFieldsAnswer */
171
+ type EsignDetectFieldsAnswer = {
172
+ candidates: EsignFieldCandidate[];
173
+ };
174
+ /** EsignDetectFieldsBody */
175
+ type EsignDetectFieldsBody = {
176
+ /** Organization context for the request; omitted to use the authenticated context. */
177
+ organization_id?: string | null;
178
+ /** Optional associated project selected by the caller. */
179
+ project_id?: string | null;
180
+ /** Optional associated task selected by the caller. */
181
+ task_id?: string | null;
182
+ /** Stable application slug that initiated the request. */
183
+ source_app?: string | null;
184
+ /** Stable feature slug within the source application. */
185
+ source_feature?: string | null;
186
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
187
+ initiation?: ("user" | "auto") | null;
188
+ file_id: string;
189
+ };
190
+ /** EsignDownloadAnswer */
191
+ type EsignDownloadAnswer = {
192
+ files: EsignDownloadFile[];
193
+ };
194
+ /** EsignDownloadBody */
195
+ type EsignDownloadBody = {
196
+ /** Organization context for the request; omitted to use the authenticated context. */
197
+ organization_id?: string | null;
198
+ /** Optional associated project selected by the caller. */
199
+ project_id?: string | null;
200
+ /** Optional associated task selected by the caller. */
201
+ task_id?: string | null;
202
+ /** Stable application slug that initiated the request. */
203
+ source_app?: string | null;
204
+ /** Stable feature slug within the source application. */
205
+ source_feature?: string | null;
206
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
207
+ initiation?: ("user" | "auto") | null;
208
+ parts?: ("documents" | "certificate")[];
209
+ combine?: boolean;
210
+ document_ids?: string[] | null;
211
+ };
212
+ /** EsignDownloadFile */
213
+ type EsignDownloadFile = {
214
+ name: string;
215
+ mime_type: string;
216
+ content_base64: string;
217
+ };
218
+ /** EsignDraftSendAnswer */
219
+ type EsignDraftSendAnswer = {
220
+ envelope_id: string;
221
+ status: string;
222
+ notified: number;
223
+ warnings?: EsignSendWarning[];
224
+ };
225
+ /** EsignDraftSendBody */
226
+ type EsignDraftSendBody = {
227
+ /** Organization context for the request; omitted to use the authenticated context. */
228
+ organization_id?: string | null;
229
+ /** Optional associated project selected by the caller. */
230
+ project_id?: string | null;
231
+ /** Optional associated task selected by the caller. */
232
+ task_id?: string | null;
233
+ /** Stable application slug that initiated the request. */
234
+ source_app?: string | null;
235
+ /** Stable feature slug within the source application. */
236
+ source_feature?: string | null;
237
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
238
+ initiation?: ("user" | "auto") | null;
239
+ };
240
+ /** EsignEnvelopeActAnswer */
241
+ type EsignEnvelopeActAnswer = {
242
+ granted: boolean;
243
+ reason?: string | null;
244
+ [key: string]: unknown;
245
+ };
246
+ /** EsignFieldCandidate */
247
+ type EsignFieldCandidate = {
248
+ candidate_id: string;
249
+ kind: string;
250
+ page: number;
251
+ x: number;
252
+ y: number;
253
+ w: number;
254
+ h: number;
255
+ label: string;
256
+ source: "acroform" | "text_anchor" | "line";
257
+ confidence: number;
258
+ [key: string]: unknown;
259
+ };
260
+ /** Where one signer fills one mark: a box on a page, as fractions of the page (top-left origin). */
261
+ type EsignFieldInput = {
262
+ /** 0-based index into file_ids */
263
+ document_index: number;
264
+ /** 0-based index into signers */
265
+ signer_index: number;
266
+ kind: "signature" | "initials" | "date_signed" | "full_name";
267
+ page: number;
268
+ x: number;
269
+ y: number;
270
+ w: number;
271
+ h: number;
272
+ };
273
+ /** EsignFinalizeAnswer */
274
+ type EsignFinalizeAnswer = {
275
+ granted: boolean;
276
+ reason?: string | null;
277
+ copies?: {
278
+ [key: string]: unknown;
279
+ }[] | null;
280
+ certificate_id?: string | null;
281
+ certificate_file_id?: string | null;
282
+ emails_sent?: number | null;
283
+ [key: string]: unknown;
284
+ };
285
+ /** EsignHandoffOpenAnswer */
286
+ type EsignHandoffOpenAnswer = {
287
+ ok: boolean;
288
+ message?: string | null;
289
+ target?: ("signature" | "initials") | null;
290
+ first_name?: string | null;
291
+ sender_name?: string | null;
292
+ organization_name?: string | null;
293
+ expires_at?: string | null;
294
+ allowed?: {
295
+ [key: string]: boolean;
296
+ } | null;
297
+ };
298
+ /** EsignHandoffOpenBody */
299
+ type EsignHandoffOpenBody = {
300
+ /** Organization context for the request; omitted to use the authenticated context. */
301
+ organization_id?: string | null;
302
+ /** Optional associated project selected by the caller. */
303
+ project_id?: string | null;
304
+ /** Optional associated task selected by the caller. */
305
+ task_id?: string | null;
306
+ /** Stable application slug that initiated the request. */
307
+ source_app?: string | null;
308
+ /** Stable feature slug within the source application. */
309
+ source_feature?: string | null;
310
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
311
+ initiation?: ("user" | "auto") | null;
312
+ secret: string;
313
+ };
314
+ /** EsignHandoffSubmitAnswer */
315
+ type EsignHandoffSubmitAnswer = {
316
+ ok: boolean;
317
+ message?: string | null;
318
+ };
319
+ /** EsignHandoffSubmitBody */
320
+ type EsignHandoffSubmitBody = {
321
+ /** Organization context for the request; omitted to use the authenticated context. */
322
+ organization_id?: string | null;
323
+ /** Optional associated project selected by the caller. */
324
+ project_id?: string | null;
325
+ /** Optional associated task selected by the caller. */
326
+ task_id?: string | null;
327
+ /** Stable application slug that initiated the request. */
328
+ source_app?: string | null;
329
+ /** Stable feature slug within the source application. */
330
+ source_feature?: string | null;
331
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
332
+ initiation?: ("user" | "auto") | null;
333
+ secret: string;
334
+ method: "drawn" | "uploaded";
335
+ image_data_url: string;
336
+ strokes?: unknown[] | null;
337
+ };
338
+ /** EsignInternalActBody */
339
+ type EsignInternalActBody = {
340
+ /** Organization context for the request; omitted to use the authenticated context. */
341
+ organization_id?: string | null;
342
+ /** Optional associated project selected by the caller. */
343
+ project_id?: string | null;
344
+ /** Optional associated task selected by the caller. */
345
+ task_id?: string | null;
346
+ /** Stable application slug that initiated the request. */
347
+ source_app?: string | null;
348
+ /** Stable feature slug within the source application. */
349
+ source_feature?: string | null;
350
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
351
+ initiation?: ("user" | "auto") | null;
352
+ action: "load" | "preview" | "consent" | "adopt" | "sign" | "decline" | "document" | "signed_copy" | "save_values" | "acknowledge" | "history" | "delegate" | "handoff_start" | "handoff_text" | "handoff_status" | "handoff_cancel" | "download";
353
+ args?: EsignActArgs;
354
+ };
355
+ /** EsignOutsiderActBody */
356
+ type EsignOutsiderActBody = {
357
+ /** Organization context for the request; omitted to use the authenticated context. */
358
+ organization_id?: string | null;
359
+ /** Optional associated project selected by the caller. */
360
+ project_id?: string | null;
361
+ /** Optional associated task selected by the caller. */
362
+ task_id?: string | null;
363
+ /** Stable application slug that initiated the request. */
364
+ source_app?: string | null;
365
+ /** Stable feature slug within the source application. */
366
+ source_feature?: string | null;
367
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
368
+ initiation?: ("user" | "auto") | null;
369
+ session: string;
370
+ action: "load" | "preview" | "consent" | "adopt" | "sign" | "decline" | "document" | "signed_copy" | "save_values" | "acknowledge" | "history" | "delegate" | "handoff_start" | "handoff_text" | "handoff_status" | "handoff_cancel" | "download";
371
+ args?: EsignActArgs;
372
+ };
373
+ /** EsignOutsiderCodeAnswer */
374
+ type EsignOutsiderCodeAnswer = {
375
+ ok: boolean;
376
+ message?: string | null;
377
+ code_sent?: boolean | null;
378
+ no_code_required?: boolean | null;
379
+ code_required?: "access_code" | null;
380
+ channel?: ("email" | "sms") | null;
381
+ reason?: "code_locked" | null;
382
+ locked_until?: string | null;
383
+ };
384
+ /** EsignOutsiderOpenAnswer */
385
+ type EsignOutsiderOpenAnswer = {
386
+ ok: boolean;
387
+ message?: string | null;
388
+ verification_factor?: string | null;
389
+ masked_target?: string | null;
390
+ landing?: {
391
+ [key: string]: unknown;
392
+ } | null;
393
+ };
394
+ /** EsignOutsiderVerifyAnswer */
395
+ type EsignOutsiderVerifyAnswer = {
396
+ ok: boolean;
397
+ message?: string | null;
398
+ reason?: ("code_wrong" | "code_locked") | null;
399
+ attempts_left?: number | null;
400
+ locked_until?: string | null;
401
+ session?: string | null;
402
+ expires_at?: string | null;
403
+ };
404
+ /** EsignResendBody */
405
+ type EsignResendBody = {
406
+ /** Organization context for the request; omitted to use the authenticated context. */
407
+ organization_id?: string | null;
408
+ /** Optional associated project selected by the caller. */
409
+ project_id?: string | null;
410
+ /** Optional associated task selected by the caller. */
411
+ task_id?: string | null;
412
+ /** Stable application slug that initiated the request. */
413
+ source_app?: string | null;
414
+ /** Stable feature slug within the source application. */
415
+ source_feature?: string | null;
416
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
417
+ initiation?: ("user" | "auto") | null;
418
+ email?: string | null;
419
+ };
420
+ /** EsignSecretBody */
421
+ type EsignSecretBody = {
422
+ /** Organization context for the request; omitted to use the authenticated context. */
423
+ organization_id?: string | null;
424
+ /** Optional associated project selected by the caller. */
425
+ project_id?: string | null;
426
+ /** Optional associated task selected by the caller. */
427
+ task_id?: string | null;
428
+ /** Stable application slug that initiated the request. */
429
+ source_app?: string | null;
430
+ /** Stable feature slug within the source application. */
431
+ source_feature?: string | null;
432
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
433
+ initiation?: ("user" | "auto") | null;
434
+ token: string;
435
+ };
436
+ /** EsignSendAnswer */
437
+ type EsignSendAnswer = {
438
+ envelope_id: string;
439
+ status: string;
440
+ notified: number;
441
+ };
442
+ /** EsignSendBody */
443
+ type EsignSendBody = {
444
+ /** Organization context for the request; omitted to use the authenticated context. */
445
+ organization_id?: string | null;
446
+ /** Optional associated project selected by the caller. */
447
+ project_id?: string | null;
448
+ /** Optional associated task selected by the caller. */
449
+ task_id?: string | null;
450
+ /** Stable application slug that initiated the request. */
451
+ source_app?: string | null;
452
+ /** Stable feature slug within the source application. */
453
+ source_feature?: string | null;
454
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
455
+ initiation?: ("user" | "auto") | null;
456
+ title: string;
457
+ message?: string | null;
458
+ file_ids: string[];
459
+ signers: EsignSignerInput[];
460
+ signing_order?: "sequential" | "parallel";
461
+ expires_in_days?: number | null;
462
+ fields?: EsignFieldInput[];
463
+ };
464
+ /** EsignSendWarning */
465
+ type EsignSendWarning = {
466
+ code: "signer_without_signature_field";
467
+ recipient_key?: string | null;
468
+ };
469
+ /** EsignSignerInput */
470
+ type EsignSignerInput = {
471
+ full_name: string;
472
+ email: string;
473
+ user_id?: string | null;
474
+ };
475
+ /** Every act's answer. ``granted`` decides; ``reason`` is the refusal's code. The other */
476
+ type EsignSigningAnswer = {
477
+ granted: boolean;
478
+ reason?: string | null;
479
+ envelope?: {
480
+ [key: string]: unknown;
481
+ } | null;
482
+ me?: {
483
+ [key: string]: unknown;
484
+ } | null;
485
+ other_signers?: {
486
+ [key: string]: unknown;
487
+ }[] | null;
488
+ documents?: {
489
+ [key: string]: unknown;
490
+ }[] | null;
491
+ consent?: {
492
+ [key: string]: unknown;
493
+ } | null;
494
+ signature_options?: {
495
+ [key: string]: unknown;
496
+ } | null;
497
+ branding?: {
498
+ [key: string]: unknown;
499
+ } | null;
500
+ document_id?: string | null;
501
+ name?: string | null;
502
+ content_hash?: string | null;
503
+ mime_type?: string | null;
504
+ content_base64?: string | null;
505
+ signed_copies?: {
506
+ [key: string]: unknown;
507
+ }[] | null;
508
+ signup_hint?: string | null;
509
+ [key: string]: unknown;
510
+ };
511
+ /** EsignVerifyBody */
512
+ type EsignVerifyBody = {
513
+ /** Organization context for the request; omitted to use the authenticated context. */
514
+ organization_id?: string | null;
515
+ /** Optional associated project selected by the caller. */
516
+ project_id?: string | null;
517
+ /** Optional associated task selected by the caller. */
518
+ task_id?: string | null;
519
+ /** Stable application slug that initiated the request. */
520
+ source_app?: string | null;
521
+ /** Stable feature slug within the source application. */
522
+ source_feature?: string | null;
523
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
524
+ initiation?: ("user" | "auto") | null;
525
+ token: string;
526
+ code?: string | null;
527
+ };
528
+ /** EsignVoidBody */
529
+ type EsignVoidBody = {
530
+ /** Organization context for the request; omitted to use the authenticated context. */
531
+ organization_id?: string | null;
532
+ /** Optional associated project selected by the caller. */
533
+ project_id?: string | null;
534
+ /** Optional associated task selected by the caller. */
535
+ task_id?: string | null;
536
+ /** Stable application slug that initiated the request. */
537
+ source_app?: string | null;
538
+ /** Stable feature slug within the source application. */
539
+ source_feature?: string | null;
540
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
541
+ initiation?: ("user" | "auto") | null;
542
+ reason: string;
543
+ };
544
+ /** Keyword */
545
+ type Keyword = {
546
+ text: string;
547
+ count: number;
548
+ };
549
+ /** LabelMetadata */
550
+ type LabelMetadata = {
551
+ label: string;
552
+ keywords: Keyword[];
553
+ content_type: ContentType;
554
+ char_count: number;
555
+ token_count: number;
556
+ cost_usd: number;
557
+ };
558
+ /** LabelRequest */
559
+ type LabelRequest = {
560
+ text?: string | null;
561
+ transcript_id?: string | null;
562
+ conversation_id?: string | null;
563
+ content_type?: ContentType;
564
+ studio_session_id?: string | null;
565
+ persist_transcript_id?: string | null;
566
+ persist_label?: boolean;
567
+ max_chars?: number;
568
+ label_max_chars?: number;
569
+ top_n?: number;
570
+ forbidden_words?: string[];
571
+ debug?: boolean;
572
+ };
573
+ /** One node in the lineage tree (used by GET /lineage). */
574
+ type LineageNode = {
575
+ id: string;
576
+ kind: string;
577
+ label?: string | null;
578
+ derivation_kind?: string | null;
579
+ derivation_metadata?: {
580
+ [key: string]: JsonValue;
581
+ } | null;
582
+ created_at?: string | null;
583
+ };
584
+ /** LineageTree */
585
+ type LineageTree = {
586
+ document_id: string;
587
+ binary_ancestors?: LineageNode[];
588
+ binary_descendants?: LineageNode[];
589
+ processing_ancestors?: LineageNode[];
590
+ processing_descendants?: LineageNode[];
591
+ };
592
+ /** MappingRequest */
593
+ type MappingRequest = {
594
+ folder_id: string;
595
+ local_path: string;
596
+ };
597
+ /** NoteExcludeRequest */
598
+ type NoteExcludeRequest = {
599
+ excluded?: boolean;
600
+ };
601
+ /** Conversion options. `target` exists for forward-compat; only "pdf". */
602
+ type OfficeConvertRequest = {
603
+ target?: string;
604
+ };
605
+ /** AI-facing markdown view of an existing Office file. */
606
+ type OfficeExtractionResponse = {
607
+ /** cld_files id of the Office file that was read. */
608
+ file_id: string;
609
+ /** Office family detected from the bytes: 'docx', 'pptx', 'xlsx' (or legacy 'doc'/'ppt'/'xls'). */
610
+ office_kind: string;
611
+ /** MIME type recorded for the file, when known. */
612
+ mime_type?: string | null;
613
+ /** Stored display filename of the file, when known. */
614
+ file_name?: string | null;
615
+ /** Whole-document markdown (all portions joined) — the main AI-facing body. */
616
+ markdown?: string;
617
+ /** Per-slide / per-sheet / per-section breakdown of the document, in order. */
618
+ portions?: OfficePortionOut[];
619
+ /** Non-fatal extraction problems (unreadable elements, truncation) worth surfacing to the user. */
620
+ warnings?: string[];
621
+ };
622
+ /** One of the three specs plus how to store the result. Exactly one of */
623
+ type OfficeGenerationRequest = {
624
+ document?: DocumentSpec | null;
625
+ presentation?: PresentationSpec | null;
626
+ spreadsheet?: SpreadsheetSpec | null;
627
+ file_name?: string | null;
628
+ published_to_web?: boolean | null;
629
+ shown_to?: ("only_me" | "my_team" | "everyone" | "everyone_on_ai_matrx") | null;
630
+ visibility?: ("personal" | "internal" | "link" | "public" | "shared" | "private") | null;
631
+ };
632
+ /** FileRef-shaped result the client binds to directly. */
633
+ type OfficeGenerationResponse = {
634
+ /** cld_files id of the stored Office file — the durable identity; keep this, not a URL. */
635
+ file_id: string;
636
+ /** Office family of the generated file: 'docx', 'pptx', or 'xlsx'. */
637
+ office_kind: string;
638
+ /** Exact OpenXML MIME type of the stored bytes. */
639
+ mime_type: string;
640
+ /** Stored display filename of the generated asset. */
641
+ file_name?: string | null;
642
+ /** Size of the generated file in bytes. */
643
+ byte_size: number;
644
+ /** Always-renderable URL for the file per the platform URL contract; bind UIs to this. */
645
+ url?: string | null;
646
+ /** Durable attachment-download URL (Content-Disposition: attachment). */
647
+ download_url?: string | null;
648
+ /** Permanent CDN URL, present only when the file is public. */
649
+ cdn_url?: string | null;
650
+ /** Whether the stored file is published to the web (False by default). */
651
+ published_to_web?: boolean;
652
+ /** List filter of the stored file ('only_me' by default). */
653
+ shown_to?: string | null;
654
+ };
655
+ /** One slide / sheet / section of an extracted document (FE-facing). */
656
+ type OfficePortionOut = {
657
+ /** 0-based position of this portion within the document. */
658
+ index: number;
659
+ /** 1-based portion number (the slide/sheet/page number a person would cite). */
660
+ number: number;
661
+ /** What this portion is: 'slide' (pptx), 'sheet' (xlsx), 'section' (docx), or 'page'. */
662
+ kind: string;
663
+ /** Portion title when the document declares one (slide title, sheet name, section heading). */
664
+ title?: string | null;
665
+ /** AI-ready markdown rendering of just this portion's content. */
666
+ markdown?: string;
667
+ };
668
+ /** PageDetail */
669
+ type PageDetail = {
670
+ page_index: number;
671
+ page_number: number;
672
+ width?: number | null;
673
+ height?: number | null;
674
+ rotation?: number | null;
675
+ raw_text?: string;
676
+ cleaned_text?: string;
677
+ section_kind?: string | null;
678
+ section_subtype?: string | null;
679
+ section_title?: string | null;
680
+ is_continuation?: boolean;
681
+ used_ocr?: boolean;
682
+ extraction_method?: string | null;
683
+ blocks?: {
684
+ [key: string]: JsonValue;
685
+ }[] | null;
686
+ words?: {
687
+ [key: string]: JsonValue;
688
+ }[] | null;
689
+ chunk_ids?: string[];
690
+ image_url?: string | null;
691
+ };
692
+ /** PageSummary */
693
+ type PageSummary = {
694
+ page_index: number;
695
+ page_number: number;
696
+ width?: number | null;
697
+ height?: number | null;
698
+ rotation?: number | null;
699
+ raw_char_count?: number;
700
+ cleaned_char_count?: number;
701
+ section_kind?: string | null;
702
+ section_subtype?: string | null;
703
+ section_title?: string | null;
704
+ extraction_method?: string | null;
705
+ used_ocr?: boolean;
706
+ has_image?: boolean;
707
+ };
708
+ /** Canonical AI-authorable shape for a PowerPoint deck (.pptx). */
709
+ type PresentationSpec = {
710
+ /** Deck title rendered on the opening title slide. */
711
+ title?: string | null;
712
+ /** Subtitle rendered under the title on the opening slide. */
713
+ subtitle?: string | null;
714
+ /** Ordered slides after the title slide, rendered in list order. */
715
+ slides?: SlideSpec[];
716
+ };
717
+ /** ProcessBlocksRequest */
718
+ type ProcessBlocksRequest = {
719
+ /** Raw text or markdown content to process into blocks */
720
+ content: string;
721
+ /** If true, each block includes the raw_content field before parsing */
722
+ include_raw?: boolean;
723
+ };
724
+ /** ProcessBlocksResponse */
725
+ type ProcessBlocksResponse = {
726
+ block_count: number;
727
+ blocks: {
728
+ [key: string]: JsonValue;
729
+ }[];
730
+ };
731
+ /** ProcessContentBody */
732
+ type ProcessContentBody = {
733
+ /** Organization context for the request; omitted to use the authenticated context. */
734
+ organization_id?: string | null;
735
+ /** Optional associated project selected by the caller. */
736
+ project_id?: string | null;
737
+ /** Optional associated task selected by the caller. */
738
+ task_id?: string | null;
739
+ /** Stable application slug that initiated the request. */
740
+ source_app?: string | null;
741
+ /** Stable feature slug within the source application. */
742
+ source_feature?: string | null;
743
+ /** How the client initiated this request: 'user' for a direct human action, 'auto' for client-code automation. Omit for API callers. */
744
+ initiation?: ("user" | "auto") | null;
745
+ content_type?: string;
746
+ file_name?: string | null;
747
+ storage_uri?: string | null;
748
+ embedding_model?: string;
749
+ clean_concurrency?: number;
750
+ clean_dispatch?: "auto" | "live" | "batch";
751
+ force_ocr?: boolean;
752
+ force?: boolean;
753
+ run_clean?: boolean;
754
+ run_ner?: boolean;
755
+ run_enrich?: boolean;
756
+ heartbeat_interval_s?: number;
757
+ debug?: boolean;
758
+ };
759
+ /** PullRemoteChangeRequest */
760
+ type PullRemoteChangeRequest = {
761
+ note_id: string;
762
+ };
763
+ /** RenderedCaptureRequest */
764
+ type RenderedCaptureRequest = {
765
+ record_type: "html_page" | "canvas_item";
766
+ record_id: string;
767
+ width: number;
768
+ color_scheme?: "light" | "dark";
769
+ device_scale_factor?: number;
770
+ full_page?: boolean;
771
+ include_image?: boolean;
772
+ file_name?: string | null;
773
+ };
774
+ /** RenderedCaptureResponse */
775
+ type RenderedCaptureResponse = {
776
+ file_id: string;
777
+ width: number;
778
+ height: number;
779
+ record_type: string;
780
+ record_id: string;
781
+ html_page_id: string;
782
+ console_errors?: string[];
783
+ image_base64?: string | null;
784
+ };
785
+ /** RevertRequest */
786
+ type RevertRequest_MatrxLocal = {
787
+ version_number: number;
788
+ };
789
+ /** ShareRequest */
790
+ type ShareRequest = {
791
+ note_id?: string | null;
792
+ folder_id?: string | null;
793
+ shared_with_id?: string | null;
794
+ permission?: string;
795
+ is_public?: boolean;
796
+ };
797
+ /** One sheet of a generated workbook. */
798
+ type SheetSpec = {
799
+ /** Worksheet tab name shown at the bottom of the workbook. */
800
+ name?: string;
801
+ /** Column header labels written as the sheet's first row. */
802
+ columns?: string[];
803
+ /** Data rows below the header, outer list = rows, inner list = one row's cell values in column order (strings, numbers, booleans, or null for blank). */
804
+ rows?: ((string | number | boolean | null)[])[];
805
+ /** Freeze the header row so it stays visible while scrolling. */
806
+ freeze_header?: boolean;
807
+ };
808
+ /** SimulateProviderRetryRequest */
809
+ type SimulateProviderRetryRequest = {
810
+ /** Provider label to put on provider_retry events */
811
+ provider?: string;
812
+ /** Model label to put on provider_retry events */
813
+ model?: string;
814
+ /** Optional request id for action URLs */
815
+ request_id?: string | null;
816
+ conversation_id?: string | null;
817
+ /** Retry delays to advertise in seconds. The simulator does not sleep for the full delay. */
818
+ delays?: number[];
819
+ /** Milliseconds to wait between simulated events. */
820
+ event_spacing_ms?: number;
821
+ };
822
+ /** One slide of a generated presentation. */
823
+ type SlideSpec = {
824
+ /** Slide title shown in the slide's title placeholder. */
825
+ title?: string | null;
826
+ /** Bullet lines for the slide body, one string per bullet (no nesting). When set, `body` is not used. */
827
+ bullets?: string[];
828
+ /** Free-text slide body used when `bullets` is empty. */
829
+ body?: string;
830
+ /** Speaker notes attached to the slide (visible in presenter view only). */
831
+ notes?: string;
832
+ /** Slide layout: 'title' (title slide), 'title_content' (title + body/bullets), 'section' (section divider), or 'blank'. */
833
+ layout?: "title" | "title_content" | "section" | "blank";
834
+ };
835
+ /** Canonical AI-authorable shape for an Excel workbook (.xlsx). */
836
+ type SpreadsheetSpec = {
837
+ /** Worksheets of the workbook, one tab per entry, in tab order. */
838
+ sheets?: SheetSpec[];
839
+ };
840
+ /** SyncTriggerRequest */
841
+ type SyncTriggerRequest = {
842
+ mode?: string;
843
+ };
844
+ /** UpdateFolderRequest */
845
+ type UpdateFolderRequest = {
846
+ name?: string | null;
847
+ parent_id?: string | null;
848
+ path?: string | null;
849
+ position?: number | null;
850
+ };
851
+ /** UpdateNoteRequest */
852
+ type UpdateNoteRequest = {
853
+ label?: string | null;
854
+ content?: string | null;
855
+ folder_name?: string | null;
856
+ folder_id?: string | null;
857
+ tags?: string[] | null;
858
+ metadata?: {
859
+ [key: string]: unknown;
860
+ } | null;
861
+ position?: number | null;
862
+ };
863
+ /** UpdateShareRequest */
864
+ type UpdateShareRequest = {
865
+ permission?: string | null;
866
+ is_public?: boolean | null;
867
+ };
868
+ type EsignOutsiderOpenArgs = {
869
+ body: EsignSecretBody;
870
+ };
871
+ type EsignOutsiderOpenResult = EsignOutsiderOpenAnswer;
872
+ /** Esign Outsider Open */
873
+ /** `POST /esign/signing/outsider/open` · aidream · auth scoped · org exempt */
874
+ declare function esignOutsiderOpen(api: Api, args: EsignOutsiderOpenArgs, options?: CallOptions): Promise<EsignOutsiderOpenResult>;
875
+ type EsignOutsiderCodeArgs = {
876
+ body: EsignSecretBody;
877
+ };
878
+ type EsignOutsiderCodeResult = EsignOutsiderCodeAnswer;
879
+ /** Esign Outsider Code */
880
+ /** `POST /esign/signing/outsider/code` · aidream · auth scoped · org exempt */
881
+ declare function esignOutsiderCode(api: Api, args: EsignOutsiderCodeArgs, options?: CallOptions): Promise<EsignOutsiderCodeResult>;
882
+ type EsignOutsiderVerifyArgs = {
883
+ body: EsignVerifyBody;
884
+ };
885
+ type EsignOutsiderVerifyResult = EsignOutsiderVerifyAnswer;
886
+ /** Esign Outsider Verify */
887
+ /** `POST /esign/signing/outsider/verify` · aidream · auth scoped · org exempt */
888
+ declare function esignOutsiderVerify(api: Api, args: EsignOutsiderVerifyArgs, options?: CallOptions): Promise<EsignOutsiderVerifyResult>;
889
+ type EsignOutsiderActArgs = {
890
+ body: EsignOutsiderActBody;
891
+ };
892
+ type EsignOutsiderActResult = EsignSigningAnswer;
893
+ /** Esign Outsider Act */
894
+ /** `POST /esign/signing/outsider/act` · aidream · auth public · org exempt */
895
+ declare function esignOutsiderAct(api: Api, args: EsignOutsiderActArgs, options?: CallOptions): Promise<EsignOutsiderActResult>;
896
+ type EsignHandoffOpenArgs = {
897
+ body: EsignHandoffOpenBody;
898
+ };
899
+ type EsignHandoffOpenResult = EsignHandoffOpenAnswer;
900
+ /** Esign Handoff Open */
901
+ /** `POST /esign/signing/handoff/open` · aidream · auth scoped · org exempt */
902
+ declare function esignHandoffOpen(api: Api, args: EsignHandoffOpenArgs, options?: CallOptions): Promise<EsignHandoffOpenResult>;
903
+ type EsignHandoffSubmitArgs = {
904
+ body: EsignHandoffSubmitBody;
905
+ };
906
+ type EsignHandoffSubmitResult = EsignHandoffSubmitAnswer;
907
+ /** Esign Handoff Submit */
908
+ /** `POST /esign/signing/handoff/submit` · aidream · auth scoped · org exempt */
909
+ declare function esignHandoffSubmit(api: Api, args: EsignHandoffSubmitArgs, options?: CallOptions): Promise<EsignHandoffSubmitResult>;
910
+ type EsignInternalActArgs = {
911
+ path: {
912
+ envelope_id: string;
913
+ };
914
+ body: EsignInternalActBody;
915
+ };
916
+ type EsignInternalActResult = EsignSigningAnswer;
917
+ /** Esign Internal Act */
918
+ /** `POST /esign/signing/envelope/{envelope_id}/act` · aidream · auth guest · org exempt */
919
+ declare function esignInternalAct(api: Api, args: EsignInternalActArgs, options?: CallOptions): Promise<EsignInternalActResult>;
920
+ type EsignSendArgs = {
921
+ body: EsignSendBody;
922
+ };
923
+ type EsignSendResult = EsignSendAnswer;
924
+ /** Esign Send */
925
+ /** `POST /esign/envelopes` · aidream · auth user · org required */
926
+ declare function esignSend(api: Api, args: EsignSendArgs, options?: CallOptions): Promise<EsignSendResult>;
927
+ type EsignRemindArgs = {
928
+ path: {
929
+ envelope_id: string;
930
+ };
931
+ };
932
+ type EsignRemindResult = EsignEnvelopeActAnswer;
933
+ /** Esign Remind */
934
+ /** `POST /esign/envelopes/{envelope_id}/remind` · aidream · auth user · org required */
935
+ declare function esignRemind(api: Api, args: EsignRemindArgs, options?: CallOptions): Promise<EsignRemindResult>;
936
+ type EsignResendArgs = {
937
+ path: {
938
+ envelope_id: string;
939
+ signer_id: string;
940
+ };
941
+ body: EsignResendBody;
942
+ };
943
+ type EsignResendResult = EsignEnvelopeActAnswer;
944
+ /** Esign Resend */
945
+ /** `POST /esign/envelopes/{envelope_id}/signers/{signer_id}/resend` · aidream · auth user · org required */
946
+ declare function esignResend(api: Api, args: EsignResendArgs, options?: CallOptions): Promise<EsignResendResult>;
947
+ type EsignVoidArgs = {
948
+ path: {
949
+ envelope_id: string;
950
+ };
951
+ body: EsignVoidBody;
952
+ };
953
+ type EsignVoidResult = EsignEnvelopeActAnswer;
954
+ /** Esign Void */
955
+ /** `POST /esign/envelopes/{envelope_id}/void` · aidream · auth user · org required */
956
+ declare function esignVoid(api: Api, args: EsignVoidArgs, options?: CallOptions): Promise<EsignVoidResult>;
957
+ type EsignVerifyArgs = {
958
+ path: {
959
+ envelope_id: string;
960
+ };
961
+ };
962
+ type EsignVerifyResult = EsignEnvelopeActAnswer;
963
+ /** Esign Verify */
964
+ /** `POST /esign/envelopes/{envelope_id}/verify` · aidream · auth user · org required */
965
+ declare function esignVerify(api: Api, args: EsignVerifyArgs, options?: CallOptions): Promise<EsignVerifyResult>;
966
+ type EsignSignedCopyArgs = {
967
+ path: {
968
+ envelope_id: string;
969
+ };
970
+ };
971
+ type EsignSignedCopyResult = EsignEnvelopeActAnswer;
972
+ /** Esign Signed Copy */
973
+ /** `POST /esign/envelopes/{envelope_id}/signed-copy` · aidream · auth user · org required */
974
+ declare function esignSignedCopy(api: Api, args: EsignSignedCopyArgs, options?: CallOptions): Promise<EsignSignedCopyResult>;
975
+ type EsignDraftSendArgs = {
976
+ path: {
977
+ envelope_id: string;
978
+ };
979
+ body: EsignDraftSendBody;
980
+ };
981
+ type EsignDraftSendResult = EsignDraftSendAnswer;
982
+ /** Esign Draft Send */
983
+ /** `POST /esign/drafts/{envelope_id}/send` · aidream · auth user · org required */
984
+ declare function esignDraftSend(api: Api, args: EsignDraftSendArgs, options?: CallOptions): Promise<EsignDraftSendResult>;
985
+ type EsignDownloadArgs = {
986
+ path: {
987
+ envelope_id: string;
988
+ };
989
+ body: EsignDownloadBody;
990
+ };
991
+ type EsignDownloadResult = EsignDownloadAnswer;
992
+ /** Esign Download */
993
+ /** `POST /esign/envelopes/{envelope_id}/download` · aidream · auth user · org required */
994
+ declare function esignDownload(api: Api, args: EsignDownloadArgs, options?: CallOptions): Promise<EsignDownloadResult>;
995
+ type EsignFinalizeArgs = {
996
+ path: {
997
+ envelope_id: string;
998
+ };
999
+ };
1000
+ type EsignFinalizeResult = EsignFinalizeAnswer;
1001
+ /** Esign Finalize */
1002
+ /** `POST /esign/envelopes/{envelope_id}/finalize` · aidream · auth user · org required */
1003
+ declare function esignFinalize(api: Api, args: EsignFinalizeArgs, options?: CallOptions): Promise<EsignFinalizeResult>;
1004
+ type EsignDetectFieldsArgs = {
1005
+ body: EsignDetectFieldsBody;
1006
+ };
1007
+ type EsignDetectFieldsResult = EsignDetectFieldsAnswer;
1008
+ /** Esign Detect Fields */
1009
+ /** `POST /esign/detect-fields` · aidream · auth user · org required */
1010
+ declare function esignDetectFields(api: Api, args: EsignDetectFieldsArgs, options?: CallOptions): Promise<EsignDetectFieldsResult>;
1011
+ type GetAllContentBlocksArgs = {
1012
+ [key: string]: never;
1013
+ };
1014
+ type GetAllContentBlocksResult = ContentBlockListResponse;
1015
+ /** Get All Content Blocks */
1016
+ /** `GET /content-blocks` · aidream · auth guest · org optional */
1017
+ declare function getAllContentBlocks(api: Api, args?: GetAllContentBlocksArgs, options?: CallOptions): Promise<GetAllContentBlocksResult>;
1018
+ type GetContentBlocksByCategoryArgs = {
1019
+ path: {
1020
+ category_id: string;
1021
+ };
1022
+ };
1023
+ type GetContentBlocksByCategoryResult = ContentBlockListResponse;
1024
+ /** Get Content Blocks By Category */
1025
+ /** `GET /content-blocks/category/{category_id}` · aidream · auth guest · org optional */
1026
+ declare function getContentBlocksByCategory(api: Api, args: GetContentBlocksByCategoryArgs, options?: CallOptions): Promise<GetContentBlocksByCategoryResult>;
1027
+ type GetContentBlockByIdArgs = {
1028
+ path: {
1029
+ block_id: string;
1030
+ };
1031
+ };
1032
+ type GetContentBlockByIdResult = ContentBlockDetailResponse;
1033
+ /** Get Content Block By Id */
1034
+ /** `GET /content-blocks/{block_id}` · aidream · auth guest · org optional */
1035
+ declare function getContentBlockById(api: Api, args: GetContentBlockByIdArgs, options?: CallOptions): Promise<GetContentBlockByIdResult>;
1036
+ type FindDocumentByCldFileArgs = {
1037
+ path: {
1038
+ cld_file_id: string;
1039
+ };
1040
+ };
1041
+ type FindDocumentByCldFileResult = DocumentLookupResult;
1042
+ /** Find Document By Cld File */
1043
+ /** `GET /document/by-cld-file/{cld_file_id}` · aidream · auth guest · org optional */
1044
+ declare function findDocumentByCldFile(api: Api, args: FindDocumentByCldFileArgs, options?: CallOptions): Promise<FindDocumentByCldFileResult>;
1045
+ type GetDocumentOverviewArgs = {
1046
+ path: {
1047
+ doc_id: string;
1048
+ };
1049
+ };
1050
+ type GetDocumentOverviewResult = DocumentDetail;
1051
+ /** Get Document Overview */
1052
+ /** `GET /document/{doc_id}` · aidream · auth guest · org optional */
1053
+ declare function getDocumentOverview(api: Api, args: GetDocumentOverviewArgs, options?: CallOptions): Promise<GetDocumentOverviewResult>;
1054
+ type GetDocumentLineageArgs = {
1055
+ path: {
1056
+ doc_id: string;
1057
+ };
1058
+ };
1059
+ type GetDocumentLineageResult = LineageTree;
1060
+ /** Get Document Lineage */
1061
+ /** `GET /document/{doc_id}/lineage` · aidream · auth guest · org optional */
1062
+ declare function getDocumentLineage(api: Api, args: GetDocumentLineageArgs, options?: CallOptions): Promise<GetDocumentLineageResult>;
1063
+ type GetDocumentPagesArgs = {
1064
+ path: {
1065
+ doc_id: string;
1066
+ };
1067
+ query?: {
1068
+ from?: number;
1069
+ to?: number | null;
1070
+ };
1071
+ };
1072
+ type GetDocumentPagesResult = PageSummary[];
1073
+ /** Get Document Pages */
1074
+ /** `GET /document/{doc_id}/pages` · aidream · auth guest · org optional */
1075
+ declare function getDocumentPages(api: Api, args: GetDocumentPagesArgs, options?: CallOptions): Promise<GetDocumentPagesResult>;
1076
+ type GetDocumentPageArgs = {
1077
+ path: {
1078
+ doc_id: string;
1079
+ page_index: number;
1080
+ };
1081
+ query?: {
1082
+ include_blocks?: boolean;
1083
+ include_words?: boolean;
1084
+ };
1085
+ };
1086
+ type GetDocumentPageResult = PageDetail;
1087
+ /** Get Document Page */
1088
+ /** `GET /document/{doc_id}/page/{page_index}` · aidream · auth guest · org optional */
1089
+ declare function getDocumentPage(api: Api, args: GetDocumentPageArgs, options?: CallOptions): Promise<GetDocumentPageResult>;
1090
+ type GetDocumentPageImageArgs = {
1091
+ path: {
1092
+ doc_id: string;
1093
+ page_index: number;
1094
+ };
1095
+ query?: {
1096
+ dpi?: number;
1097
+ redirect?: boolean;
1098
+ };
1099
+ };
1100
+ type GetDocumentPageImageResult = unknown;
1101
+ /** Get Document Page Image */
1102
+ /** `GET /document/{doc_id}/page/{page_index}/image` · aidream · auth guest · org optional */
1103
+ declare function getDocumentPageImage(api: Api, args: GetDocumentPageImageArgs, options?: CallOptions): Promise<GetDocumentPageImageResult>;
1104
+ type GetDocumentChunksArgs = {
1105
+ path: {
1106
+ doc_id: string;
1107
+ };
1108
+ query?: {
1109
+ parent_only?: boolean;
1110
+ children_only?: boolean;
1111
+ section_kind?: string | null;
1112
+ limit?: number;
1113
+ };
1114
+ };
1115
+ type GetDocumentChunksResult = ChunkRow[];
1116
+ /** Get Document Chunks */
1117
+ /** `GET /document/{doc_id}/chunks` · aidream · auth guest · org optional */
1118
+ declare function getDocumentChunks(api: Api, args: GetDocumentChunksArgs, options?: CallOptions): Promise<GetDocumentChunksResult>;
1119
+ type CaptureArgs = {
1120
+ body: RenderedCaptureRequest;
1121
+ };
1122
+ type CaptureResult = RenderedCaptureResponse;
1123
+ /** Capture */
1124
+ /** `POST /rendered-output/capture` · aidream · auth user · org required */
1125
+ declare function capture(api: Api, args: CaptureArgs, options?: CallOptions): Promise<CaptureResult>;
1126
+ type ProcessBlocksArgs = {
1127
+ body: ProcessBlocksRequest;
1128
+ };
1129
+ type ProcessBlocksResult = ProcessBlocksResponse;
1130
+ /** Process Blocks */
1131
+ /** `POST /utilities/block-processing/process` · aidream · auth guest · org exempt */
1132
+ declare function processBlocks(api: Api, args: ProcessBlocksArgs, options?: CallOptions): Promise<ProcessBlocksResult>;
1133
+ type ProcessBlocksStreamArgs = {
1134
+ body: ProcessBlocksRequest;
1135
+ };
1136
+ type ProcessBlocksStreamResult = unknown;
1137
+ /** Process Blocks Stream */
1138
+ /** `POST /utilities/block-processing/process/stream` · aidream · auth guest · org exempt · ndjson */
1139
+ declare function processBlocksStream(api: Api, args: ProcessBlocksStreamArgs, options?: CallOptions): Promise<ApiStream<NdjsonEvent>>;
1140
+ type SimulateProviderRetryStreamArgs = {
1141
+ body: SimulateProviderRetryRequest;
1142
+ };
1143
+ type SimulateProviderRetryStreamResult = unknown;
1144
+ /** Simulate Provider Retry Stream */
1145
+ /** `POST /utilities/block-processing/simulate/provider-retry` · aidream · auth guest · org required · ndjson */
1146
+ declare function simulateProviderRetryStream(api: Api, args: SimulateProviderRetryStreamArgs, options?: CallOptions): Promise<ApiStream<NdjsonEvent>>;
1147
+ type ProcessFileArgs = {
1148
+ path: {
1149
+ cld_file_id: string;
1150
+ };
1151
+ body: ProcessContentBody;
1152
+ };
1153
+ type ProcessFileResult = unknown;
1154
+ /** Process File */
1155
+ /** `POST /content-processing/{cld_file_id}` · aidream · auth guest · org required · ndjson */
1156
+ declare function processFile(api: Api, args: ProcessFileArgs, options?: CallOptions): Promise<ApiStream<NdjsonEvent>>;
1157
+ type GenerateOfficeArgs = {
1158
+ body: OfficeGenerationRequest;
1159
+ };
1160
+ type GenerateOfficeResult = OfficeGenerationResponse;
1161
+ /** Generate Office */
1162
+ /** `POST /office/generate` · aidream · auth guest · org required */
1163
+ declare function generateOffice(api: Api, args: GenerateOfficeArgs, options?: CallOptions): Promise<GenerateOfficeResult>;
1164
+ type ExtractOfficeMarkdownArgs = {
1165
+ path: {
1166
+ file_id: string;
1167
+ };
1168
+ };
1169
+ type ExtractOfficeMarkdownResult = OfficeExtractionResponse;
1170
+ /** Extract Office Markdown */
1171
+ /** `GET /office/{file_id}/markdown` · aidream · auth guest · org optional */
1172
+ declare function extractOfficeMarkdown(api: Api, args: ExtractOfficeMarkdownArgs, options?: CallOptions): Promise<ExtractOfficeMarkdownResult>;
1173
+ type ConvertOfficeFileArgs = {
1174
+ path: {
1175
+ file_id: string;
1176
+ };
1177
+ body?: OfficeConvertRequest | null;
1178
+ };
1179
+ type ConvertOfficeFileResult = OfficeGenerationResponse;
1180
+ /** Convert Office File */
1181
+ /** `POST /office/{file_id}/convert` · aidream · auth guest · org required */
1182
+ declare function convertOfficeFile(api: Api, args: ConvertOfficeFileArgs, options?: CallOptions): Promise<ConvertOfficeFileResult>;
1183
+ type LabelArgs = {
1184
+ body: LabelRequest;
1185
+ };
1186
+ type LabelResult = LabelMetadata;
1187
+ /** Label content with GLiNER2 */
1188
+ /** `POST /content-label` · aidream · auth guest · org required */
1189
+ declare function label(api: Api, args: LabelArgs, options?: CallOptions): Promise<LabelResult>;
1190
+ type GetFolderTreeArgs = {
1191
+ [key: string]: never;
1192
+ };
1193
+ type GetFolderTreeResult = {
1194
+ [key: string]: unknown;
1195
+ };
1196
+ /** Get Folder Tree */
1197
+ /** `GET /notes/tree` · matrx-local · auth loopback_token · org exempt */
1198
+ declare function getFolderTree(api: Api, args?: GetFolderTreeArgs, options?: CallOptions): Promise<GetFolderTreeResult>;
1199
+ type CreateFolderArgs = {
1200
+ body: CreateFolderRequest_MatrxLocal;
1201
+ };
1202
+ type CreateFolderResult = {
1203
+ [key: string]: unknown;
1204
+ };
1205
+ /** Create Folder */
1206
+ /** `POST /notes/folders` · matrx-local · auth loopback_token · org exempt */
1207
+ declare function createFolder(api: Api, args: CreateFolderArgs, options?: CallOptions): Promise<CreateFolderResult>;
1208
+ type UpdateFolderArgs = {
1209
+ path: {
1210
+ folder_id: string;
1211
+ };
1212
+ body: UpdateFolderRequest;
1213
+ };
1214
+ type UpdateFolderResult = {
1215
+ [key: string]: unknown;
1216
+ };
1217
+ /** Update Folder */
1218
+ /** `PUT /notes/folders/{folder_id}` · matrx-local · auth loopback_token · org exempt */
1219
+ declare function updateFolder(api: Api, args: UpdateFolderArgs, options?: CallOptions): Promise<UpdateFolderResult>;
1220
+ type DeleteFolderArgs = {
1221
+ path: {
1222
+ folder_id: string;
1223
+ };
1224
+ };
1225
+ type DeleteFolderResult = {
1226
+ [key: string]: string;
1227
+ };
1228
+ /** Delete Folder */
1229
+ /** `DELETE /notes/folders/{folder_id}` · matrx-local · auth loopback_token · org exempt */
1230
+ declare function deleteFolder(api: Api, args: DeleteFolderArgs, options?: CallOptions): Promise<DeleteFolderResult>;
1231
+ type ListNotesArgs = {
1232
+ query?: {
1233
+ folder_id?: string | null;
1234
+ search?: string | null;
1235
+ };
1236
+ };
1237
+ type ListNotesResult = {
1238
+ [key: string]: unknown;
1239
+ }[];
1240
+ /** List Notes */
1241
+ /** `GET /notes/notes` · matrx-local · auth loopback_token · org exempt */
1242
+ declare function listNotes(api: Api, args?: ListNotesArgs, options?: CallOptions): Promise<ListNotesResult>;
1243
+ type CreateNoteArgs = {
1244
+ body: CreateNoteRequest;
1245
+ };
1246
+ type CreateNoteResult = {
1247
+ [key: string]: unknown;
1248
+ };
1249
+ /** Create Note */
1250
+ /** `POST /notes/notes` · matrx-local · auth loopback_token · org exempt */
1251
+ declare function createNote(api: Api, args: CreateNoteArgs, options?: CallOptions): Promise<CreateNoteResult>;
1252
+ type GetNoteArgs = {
1253
+ path: {
1254
+ note_id: string;
1255
+ };
1256
+ };
1257
+ type GetNoteResult = {
1258
+ [key: string]: unknown;
1259
+ };
1260
+ /** Get Note */
1261
+ /** `GET /notes/notes/{note_id}` · matrx-local · auth loopback_token · org exempt */
1262
+ declare function getNote(api: Api, args: GetNoteArgs, options?: CallOptions): Promise<GetNoteResult>;
1263
+ type UpdateNoteArgs = {
1264
+ path: {
1265
+ note_id: string;
1266
+ };
1267
+ body: UpdateNoteRequest;
1268
+ };
1269
+ type UpdateNoteResult = {
1270
+ [key: string]: unknown;
1271
+ };
1272
+ /** Update Note */
1273
+ /** `PUT /notes/notes/{note_id}` · matrx-local · auth loopback_token · org exempt */
1274
+ declare function updateNote(api: Api, args: UpdateNoteArgs, options?: CallOptions): Promise<UpdateNoteResult>;
1275
+ type DeleteNoteArgs = {
1276
+ path: {
1277
+ note_id: string;
1278
+ };
1279
+ };
1280
+ type DeleteNoteResult = {
1281
+ [key: string]: string;
1282
+ };
1283
+ /** Delete Note */
1284
+ /** `DELETE /notes/notes/{note_id}` · matrx-local · auth loopback_token · org exempt */
1285
+ declare function deleteNote(api: Api, args: DeleteNoteArgs, options?: CallOptions): Promise<DeleteNoteResult>;
1286
+ type SetNoteExcludedArgs = {
1287
+ path: {
1288
+ note_id: string;
1289
+ };
1290
+ body: NoteExcludeRequest;
1291
+ };
1292
+ type SetNoteExcludedResult = {
1293
+ [key: string]: unknown;
1294
+ };
1295
+ /** Set Note Excluded */
1296
+ /** `POST /notes/notes/{note_id}/exclude` · matrx-local · auth loopback_token · org exempt */
1297
+ declare function setNoteExcluded(api: Api, args: SetNoteExcludedArgs, options?: CallOptions): Promise<SetNoteExcludedResult>;
1298
+ type GetNoteSyncStatusArgs = {
1299
+ path: {
1300
+ note_id: string;
1301
+ };
1302
+ };
1303
+ type GetNoteSyncStatusResult = {
1304
+ [key: string]: unknown;
1305
+ };
1306
+ /** Get Note Sync Status */
1307
+ /** `GET /notes/notes/{note_id}/sync-status` · matrx-local · auth loopback_token · org exempt */
1308
+ declare function getNoteSyncStatus(api: Api, args: GetNoteSyncStatusArgs, options?: CallOptions): Promise<GetNoteSyncStatusResult>;
1309
+ type ListVersionsArgs = {
1310
+ path: {
1311
+ note_id: string;
1312
+ };
1313
+ };
1314
+ type ListVersionsResult = {
1315
+ [key: string]: unknown;
1316
+ }[];
1317
+ /** List Versions */
1318
+ /** `GET /notes/notes/{note_id}/versions` · matrx-local · auth loopback_token · org exempt */
1319
+ declare function listVersions(api: Api, args: ListVersionsArgs, options?: CallOptions): Promise<ListVersionsResult>;
1320
+ type RevertNoteArgs = {
1321
+ path: {
1322
+ note_id: string;
1323
+ };
1324
+ body: RevertRequest_MatrxLocal;
1325
+ };
1326
+ type RevertNoteResult = {
1327
+ [key: string]: unknown;
1328
+ };
1329
+ /** Revert Note */
1330
+ /** `POST /notes/notes/{note_id}/revert` · matrx-local · auth loopback_token · org exempt */
1331
+ declare function revertNote(api: Api, args: RevertNoteArgs, options?: CallOptions): Promise<RevertNoteResult>;
1332
+ type SyncStatusArgs = {
1333
+ [key: string]: never;
1334
+ };
1335
+ type SyncStatusResult = {
1336
+ [key: string]: unknown;
1337
+ };
1338
+ /** Sync Status */
1339
+ /** `GET /notes/sync/status` · matrx-local · auth loopback_token · org exempt */
1340
+ declare function syncStatus(api: Api, args?: SyncStatusArgs, options?: CallOptions): Promise<SyncStatusResult>;
1341
+ type ResetDeleteBreakerArgs = {
1342
+ [key: string]: never;
1343
+ };
1344
+ type ResetDeleteBreakerResult = {
1345
+ [key: string]: unknown;
1346
+ };
1347
+ /** Reset Delete Breaker */
1348
+ /** `POST /notes/sync/delete-breaker/reset` · matrx-local · auth loopback_token · org exempt */
1349
+ declare function resetDeleteBreaker(api: Api, args?: ResetDeleteBreakerArgs, options?: CallOptions): Promise<ResetDeleteBreakerResult>;
1350
+ type TriggerSyncArgs = {
1351
+ body: SyncTriggerRequest;
1352
+ };
1353
+ type TriggerSyncResult = {
1354
+ [key: string]: unknown;
1355
+ };
1356
+ /** Trigger Sync */
1357
+ /** `POST /notes/sync/trigger` · matrx-local · auth loopback_token · org exempt */
1358
+ declare function triggerSync(api: Api, args: TriggerSyncArgs, options?: CallOptions): Promise<TriggerSyncResult>;
1359
+ type PullChangesArgs = {
1360
+ [key: string]: never;
1361
+ };
1362
+ type PullChangesResult = {
1363
+ [key: string]: unknown;
1364
+ };
1365
+ /** Pull Changes */
1366
+ /** `POST /notes/sync/pull` · matrx-local · auth loopback_token · org exempt */
1367
+ declare function pullChanges(api: Api, args?: PullChangesArgs, options?: CallOptions): Promise<PullChangesResult>;
1368
+ type PullSingleNoteArgs = {
1369
+ body: PullRemoteChangeRequest;
1370
+ };
1371
+ type PullSingleNoteResult = {
1372
+ [key: string]: unknown;
1373
+ };
1374
+ /** Pull Single Note */
1375
+ /** `POST /notes/sync/pull-note` · matrx-local · auth loopback_token · org exempt */
1376
+ declare function pullSingleNote(api: Api, args: PullSingleNoteArgs, options?: CallOptions): Promise<PullSingleNoteResult>;
1377
+ type RegisterDeviceArgs = {
1378
+ [key: string]: never;
1379
+ };
1380
+ type RegisterDeviceResult = {
1381
+ [key: string]: unknown;
1382
+ };
1383
+ /** Register Device */
1384
+ /** `POST /notes/sync/register-device` · matrx-local · auth loopback_token · org exempt */
1385
+ declare function registerDevice(api: Api, args?: RegisterDeviceArgs, options?: CallOptions): Promise<RegisterDeviceResult>;
1386
+ type StartWatcherArgs = {
1387
+ [key: string]: never;
1388
+ };
1389
+ type StartWatcherResult = {
1390
+ [key: string]: string;
1391
+ };
1392
+ /** Start Watcher */
1393
+ /** `POST /notes/sync/start-watcher` · matrx-local · auth loopback_token · org exempt */
1394
+ declare function startWatcher(api: Api, args?: StartWatcherArgs, options?: CallOptions): Promise<StartWatcherResult>;
1395
+ type StopWatcherArgs = {
1396
+ [key: string]: never;
1397
+ };
1398
+ type StopWatcherResult = {
1399
+ [key: string]: string;
1400
+ };
1401
+ /** Stop Watcher */
1402
+ /** `POST /notes/sync/stop-watcher` · matrx-local · auth loopback_token · org exempt */
1403
+ declare function stopWatcher(api: Api, args?: StopWatcherArgs, options?: CallOptions): Promise<StopWatcherResult>;
1404
+ type ListConflictsArgs = {
1405
+ [key: string]: never;
1406
+ };
1407
+ type ListConflictsResult = {
1408
+ [key: string]: unknown;
1409
+ };
1410
+ /** List Conflicts */
1411
+ /** `GET /notes/conflicts` · matrx-local · auth loopback_token · org exempt */
1412
+ declare function listConflicts(api: Api, args?: ListConflictsArgs, options?: CallOptions): Promise<ListConflictsResult>;
1413
+ type ResolveConflictArgs = {
1414
+ path: {
1415
+ note_id: string;
1416
+ };
1417
+ body: ConflictResolveRequest;
1418
+ };
1419
+ type ResolveConflictResult = {
1420
+ [key: string]: unknown;
1421
+ };
1422
+ /** Resolve Conflict */
1423
+ /** `POST /notes/conflicts/{note_id}/resolve` · matrx-local · auth loopback_token · org exempt */
1424
+ declare function resolveConflict(api: Api, args: ResolveConflictArgs, options?: CallOptions): Promise<ResolveConflictResult>;
1425
+ type ListSharesArgs = {
1426
+ [key: string]: never;
1427
+ };
1428
+ type ListSharesResult = {
1429
+ [key: string]: unknown;
1430
+ }[];
1431
+ /** List Shares */
1432
+ /** `GET /notes/shares` · matrx-local · auth loopback_token · org exempt */
1433
+ declare function listShares(api: Api, args?: ListSharesArgs, options?: CallOptions): Promise<ListSharesResult>;
1434
+ type CreateShareArgs = {
1435
+ body: ShareRequest;
1436
+ };
1437
+ type CreateShareResult = {
1438
+ [key: string]: unknown;
1439
+ };
1440
+ /** Create Share */
1441
+ /** `POST /notes/shares` · matrx-local · auth loopback_token · org exempt */
1442
+ declare function createShare(api: Api, args: CreateShareArgs, options?: CallOptions): Promise<CreateShareResult>;
1443
+ type UpdateShareArgs = {
1444
+ path: {
1445
+ share_id: string;
1446
+ };
1447
+ body: UpdateShareRequest;
1448
+ };
1449
+ type UpdateShareResult = {
1450
+ [key: string]: unknown;
1451
+ };
1452
+ /** Update Share */
1453
+ /** `PUT /notes/shares/{share_id}` · matrx-local · auth loopback_token · org exempt */
1454
+ declare function updateShare(api: Api, args: UpdateShareArgs, options?: CallOptions): Promise<UpdateShareResult>;
1455
+ type DeleteShareArgs = {
1456
+ path: {
1457
+ share_id: string;
1458
+ };
1459
+ };
1460
+ type DeleteShareResult = {
1461
+ [key: string]: string;
1462
+ };
1463
+ /** Delete Share */
1464
+ /** `DELETE /notes/shares/{share_id}` · matrx-local · auth loopback_token · org exempt */
1465
+ declare function deleteShare(api: Api, args: DeleteShareArgs, options?: CallOptions): Promise<DeleteShareResult>;
1466
+ type ListMappingsArgs = {
1467
+ [key: string]: never;
1468
+ };
1469
+ type ListMappingsResult = {
1470
+ [key: string]: unknown;
1471
+ };
1472
+ /** List Mappings */
1473
+ /** `GET /notes/mappings` · matrx-local · auth loopback_token · org exempt */
1474
+ declare function listMappings(api: Api, args?: ListMappingsArgs, options?: CallOptions): Promise<ListMappingsResult>;
1475
+ type CreateMappingArgs = {
1476
+ body: MappingRequest;
1477
+ };
1478
+ type CreateMappingResult = {
1479
+ [key: string]: unknown;
1480
+ };
1481
+ /** Create Mapping */
1482
+ /** `POST /notes/mappings` · matrx-local · auth loopback_token · org exempt */
1483
+ declare function createMapping(api: Api, args: CreateMappingArgs, options?: CallOptions): Promise<CreateMappingResult>;
1484
+ type DeleteMappingArgs = {
1485
+ path: {
1486
+ mapping_id: string;
1487
+ };
1488
+ query?: {
1489
+ folder_id?: string | null;
1490
+ local_path?: string | null;
1491
+ };
1492
+ };
1493
+ type DeleteMappingResult = {
1494
+ [key: string]: string;
1495
+ };
1496
+ /** Delete Mapping */
1497
+ /** `DELETE /notes/mappings/{mapping_id}` · matrx-local · auth loopback_token · org exempt */
1498
+ declare function deleteMapping(api: Api, args: DeleteMappingArgs, options?: CallOptions): Promise<DeleteMappingResult>;
1499
+ type ListLocalFoldersArgs = {
1500
+ [key: string]: never;
1501
+ };
1502
+ type ListLocalFoldersResult = string[];
1503
+ /** List Local Folders */
1504
+ /** `GET /notes/local/folders` · matrx-local · auth loopback_token · org exempt */
1505
+ declare function listLocalFolders(api: Api, args?: ListLocalFoldersArgs, options?: CallOptions): Promise<ListLocalFoldersResult>;
1506
+ type ScanLocalFilesArgs = {
1507
+ [key: string]: never;
1508
+ };
1509
+ type ScanLocalFilesResult = {
1510
+ [key: string]: string;
1511
+ }[];
1512
+ /** Scan Local Files */
1513
+ /** `GET /notes/local/files` · matrx-local · auth loopback_token · org exempt */
1514
+ declare function scanLocalFiles(api: Api, args?: ScanLocalFilesArgs, options?: CallOptions): Promise<ScanLocalFilesResult>;
1515
+ type ReadLocalFileArgs = {
1516
+ path: {
1517
+ file_path: string;
1518
+ };
1519
+ };
1520
+ type ReadLocalFileResult = {
1521
+ [key: string]: unknown;
1522
+ };
1523
+ /** Read Local File */
1524
+ /** `GET /notes/local/files/{file_path}` · matrx-local · auth loopback_token · org exempt */
1525
+ declare function readLocalFile(api: Api, args: ReadLocalFileArgs, options?: CallOptions): Promise<ReadLocalFileResult>;
1526
+ /** Every JSON operation of this domain by `METHOD path` — for path-keyed calls. */
1527
+ interface Operations {
1528
+ "POST /esign/signing/outsider/open": {
1529
+ args: EsignOutsiderOpenArgs;
1530
+ result: EsignOutsiderOpenResult;
1531
+ };
1532
+ "POST /esign/signing/outsider/code": {
1533
+ args: EsignOutsiderCodeArgs;
1534
+ result: EsignOutsiderCodeResult;
1535
+ };
1536
+ "POST /esign/signing/outsider/verify": {
1537
+ args: EsignOutsiderVerifyArgs;
1538
+ result: EsignOutsiderVerifyResult;
1539
+ };
1540
+ "POST /esign/signing/outsider/act": {
1541
+ args: EsignOutsiderActArgs;
1542
+ result: EsignOutsiderActResult;
1543
+ };
1544
+ "POST /esign/signing/handoff/open": {
1545
+ args: EsignHandoffOpenArgs;
1546
+ result: EsignHandoffOpenResult;
1547
+ };
1548
+ "POST /esign/signing/handoff/submit": {
1549
+ args: EsignHandoffSubmitArgs;
1550
+ result: EsignHandoffSubmitResult;
1551
+ };
1552
+ "POST /esign/signing/envelope/{envelope_id}/act": {
1553
+ args: EsignInternalActArgs;
1554
+ result: EsignInternalActResult;
1555
+ };
1556
+ "POST /esign/envelopes": {
1557
+ args: EsignSendArgs;
1558
+ result: EsignSendResult;
1559
+ };
1560
+ "POST /esign/envelopes/{envelope_id}/remind": {
1561
+ args: EsignRemindArgs;
1562
+ result: EsignRemindResult;
1563
+ };
1564
+ "POST /esign/envelopes/{envelope_id}/signers/{signer_id}/resend": {
1565
+ args: EsignResendArgs;
1566
+ result: EsignResendResult;
1567
+ };
1568
+ "POST /esign/envelopes/{envelope_id}/void": {
1569
+ args: EsignVoidArgs;
1570
+ result: EsignVoidResult;
1571
+ };
1572
+ "POST /esign/envelopes/{envelope_id}/verify": {
1573
+ args: EsignVerifyArgs;
1574
+ result: EsignVerifyResult;
1575
+ };
1576
+ "POST /esign/envelopes/{envelope_id}/signed-copy": {
1577
+ args: EsignSignedCopyArgs;
1578
+ result: EsignSignedCopyResult;
1579
+ };
1580
+ "POST /esign/drafts/{envelope_id}/send": {
1581
+ args: EsignDraftSendArgs;
1582
+ result: EsignDraftSendResult;
1583
+ };
1584
+ "POST /esign/envelopes/{envelope_id}/download": {
1585
+ args: EsignDownloadArgs;
1586
+ result: EsignDownloadResult;
1587
+ };
1588
+ "POST /esign/envelopes/{envelope_id}/finalize": {
1589
+ args: EsignFinalizeArgs;
1590
+ result: EsignFinalizeResult;
1591
+ };
1592
+ "POST /esign/detect-fields": {
1593
+ args: EsignDetectFieldsArgs;
1594
+ result: EsignDetectFieldsResult;
1595
+ };
1596
+ "GET /content-blocks": {
1597
+ args: GetAllContentBlocksArgs;
1598
+ result: GetAllContentBlocksResult;
1599
+ };
1600
+ "GET /content-blocks/category/{category_id}": {
1601
+ args: GetContentBlocksByCategoryArgs;
1602
+ result: GetContentBlocksByCategoryResult;
1603
+ };
1604
+ "GET /content-blocks/{block_id}": {
1605
+ args: GetContentBlockByIdArgs;
1606
+ result: GetContentBlockByIdResult;
1607
+ };
1608
+ "GET /document/by-cld-file/{cld_file_id}": {
1609
+ args: FindDocumentByCldFileArgs;
1610
+ result: FindDocumentByCldFileResult;
1611
+ };
1612
+ "GET /document/{doc_id}": {
1613
+ args: GetDocumentOverviewArgs;
1614
+ result: GetDocumentOverviewResult;
1615
+ };
1616
+ "GET /document/{doc_id}/lineage": {
1617
+ args: GetDocumentLineageArgs;
1618
+ result: GetDocumentLineageResult;
1619
+ };
1620
+ "GET /document/{doc_id}/pages": {
1621
+ args: GetDocumentPagesArgs;
1622
+ result: GetDocumentPagesResult;
1623
+ };
1624
+ "GET /document/{doc_id}/page/{page_index}": {
1625
+ args: GetDocumentPageArgs;
1626
+ result: GetDocumentPageResult;
1627
+ };
1628
+ "GET /document/{doc_id}/page/{page_index}/image": {
1629
+ args: GetDocumentPageImageArgs;
1630
+ result: GetDocumentPageImageResult;
1631
+ };
1632
+ "GET /document/{doc_id}/chunks": {
1633
+ args: GetDocumentChunksArgs;
1634
+ result: GetDocumentChunksResult;
1635
+ };
1636
+ "POST /rendered-output/capture": {
1637
+ args: CaptureArgs;
1638
+ result: CaptureResult;
1639
+ };
1640
+ "POST /utilities/block-processing/process": {
1641
+ args: ProcessBlocksArgs;
1642
+ result: ProcessBlocksResult;
1643
+ };
1644
+ "POST /office/generate": {
1645
+ args: GenerateOfficeArgs;
1646
+ result: GenerateOfficeResult;
1647
+ };
1648
+ "GET /office/{file_id}/markdown": {
1649
+ args: ExtractOfficeMarkdownArgs;
1650
+ result: ExtractOfficeMarkdownResult;
1651
+ };
1652
+ "POST /office/{file_id}/convert": {
1653
+ args: ConvertOfficeFileArgs;
1654
+ result: ConvertOfficeFileResult;
1655
+ };
1656
+ "POST /content-label": {
1657
+ args: LabelArgs;
1658
+ result: LabelResult;
1659
+ };
1660
+ "GET /notes/tree": {
1661
+ args: GetFolderTreeArgs;
1662
+ result: GetFolderTreeResult;
1663
+ };
1664
+ "POST /notes/folders": {
1665
+ args: CreateFolderArgs;
1666
+ result: CreateFolderResult;
1667
+ };
1668
+ "PUT /notes/folders/{folder_id}": {
1669
+ args: UpdateFolderArgs;
1670
+ result: UpdateFolderResult;
1671
+ };
1672
+ "DELETE /notes/folders/{folder_id}": {
1673
+ args: DeleteFolderArgs;
1674
+ result: DeleteFolderResult;
1675
+ };
1676
+ "GET /notes/notes": {
1677
+ args: ListNotesArgs;
1678
+ result: ListNotesResult;
1679
+ };
1680
+ "POST /notes/notes": {
1681
+ args: CreateNoteArgs;
1682
+ result: CreateNoteResult;
1683
+ };
1684
+ "GET /notes/notes/{note_id}": {
1685
+ args: GetNoteArgs;
1686
+ result: GetNoteResult;
1687
+ };
1688
+ "PUT /notes/notes/{note_id}": {
1689
+ args: UpdateNoteArgs;
1690
+ result: UpdateNoteResult;
1691
+ };
1692
+ "DELETE /notes/notes/{note_id}": {
1693
+ args: DeleteNoteArgs;
1694
+ result: DeleteNoteResult;
1695
+ };
1696
+ "POST /notes/notes/{note_id}/exclude": {
1697
+ args: SetNoteExcludedArgs;
1698
+ result: SetNoteExcludedResult;
1699
+ };
1700
+ "GET /notes/notes/{note_id}/sync-status": {
1701
+ args: GetNoteSyncStatusArgs;
1702
+ result: GetNoteSyncStatusResult;
1703
+ };
1704
+ "GET /notes/notes/{note_id}/versions": {
1705
+ args: ListVersionsArgs;
1706
+ result: ListVersionsResult;
1707
+ };
1708
+ "POST /notes/notes/{note_id}/revert": {
1709
+ args: RevertNoteArgs;
1710
+ result: RevertNoteResult;
1711
+ };
1712
+ "GET /notes/sync/status": {
1713
+ args: SyncStatusArgs;
1714
+ result: SyncStatusResult;
1715
+ };
1716
+ "POST /notes/sync/delete-breaker/reset": {
1717
+ args: ResetDeleteBreakerArgs;
1718
+ result: ResetDeleteBreakerResult;
1719
+ };
1720
+ "POST /notes/sync/trigger": {
1721
+ args: TriggerSyncArgs;
1722
+ result: TriggerSyncResult;
1723
+ };
1724
+ "POST /notes/sync/pull": {
1725
+ args: PullChangesArgs;
1726
+ result: PullChangesResult;
1727
+ };
1728
+ "POST /notes/sync/pull-note": {
1729
+ args: PullSingleNoteArgs;
1730
+ result: PullSingleNoteResult;
1731
+ };
1732
+ "POST /notes/sync/register-device": {
1733
+ args: RegisterDeviceArgs;
1734
+ result: RegisterDeviceResult;
1735
+ };
1736
+ "POST /notes/sync/start-watcher": {
1737
+ args: StartWatcherArgs;
1738
+ result: StartWatcherResult;
1739
+ };
1740
+ "POST /notes/sync/stop-watcher": {
1741
+ args: StopWatcherArgs;
1742
+ result: StopWatcherResult;
1743
+ };
1744
+ "GET /notes/conflicts": {
1745
+ args: ListConflictsArgs;
1746
+ result: ListConflictsResult;
1747
+ };
1748
+ "POST /notes/conflicts/{note_id}/resolve": {
1749
+ args: ResolveConflictArgs;
1750
+ result: ResolveConflictResult;
1751
+ };
1752
+ "GET /notes/shares": {
1753
+ args: ListSharesArgs;
1754
+ result: ListSharesResult;
1755
+ };
1756
+ "POST /notes/shares": {
1757
+ args: CreateShareArgs;
1758
+ result: CreateShareResult;
1759
+ };
1760
+ "PUT /notes/shares/{share_id}": {
1761
+ args: UpdateShareArgs;
1762
+ result: UpdateShareResult;
1763
+ };
1764
+ "DELETE /notes/shares/{share_id}": {
1765
+ args: DeleteShareArgs;
1766
+ result: DeleteShareResult;
1767
+ };
1768
+ "GET /notes/mappings": {
1769
+ args: ListMappingsArgs;
1770
+ result: ListMappingsResult;
1771
+ };
1772
+ "POST /notes/mappings": {
1773
+ args: CreateMappingArgs;
1774
+ result: CreateMappingResult;
1775
+ };
1776
+ "DELETE /notes/mappings/{mapping_id}": {
1777
+ args: DeleteMappingArgs;
1778
+ result: DeleteMappingResult;
1779
+ };
1780
+ "GET /notes/local/folders": {
1781
+ args: ListLocalFoldersArgs;
1782
+ result: ListLocalFoldersResult;
1783
+ };
1784
+ "GET /notes/local/files": {
1785
+ args: ScanLocalFilesArgs;
1786
+ result: ScanLocalFilesResult;
1787
+ };
1788
+ "GET /notes/local/files/{file_path}": {
1789
+ args: ReadLocalFileArgs;
1790
+ result: ReadLocalFileResult;
1791
+ };
1792
+ }
1793
+ /** Path-keyed call, scoped to this domain only (never a global path map). */
1794
+ declare function call<K extends keyof Operations>(api: Api, key: K, args?: Operations[K]["args"], options?: CallOptions): Promise<Operations[K]["result"]>;
1795
+
1796
+ export { type CaptureArgs, type CaptureResult, type ChunkRow, type ConflictResolveRequest, type ContentBlockDetailResponse, type ContentBlockListResponse, type ContentType, type ConvertOfficeFileArgs, type ConvertOfficeFileResult, type CreateFolderArgs, type CreateFolderRequest_MatrxLocal, type CreateFolderResult, type CreateMappingArgs, type CreateMappingResult, type CreateNoteArgs, type CreateNoteRequest, type CreateNoteResult, type CreateShareArgs, type CreateShareResult, type DeleteFolderArgs, type DeleteFolderResult, type DeleteMappingArgs, type DeleteMappingResult, type DeleteNoteArgs, type DeleteNoteResult, type DeleteShareArgs, type DeleteShareResult, type DocBlock, type DocumentDetail, type DocumentLineage, type DocumentLookupResult, type DocumentSpec, type EsignActArgs, type EsignDetectFieldsAnswer, type EsignDetectFieldsArgs, type EsignDetectFieldsBody, type EsignDetectFieldsResult, type EsignDownloadAnswer, type EsignDownloadArgs, type EsignDownloadBody, type EsignDownloadFile, type EsignDownloadResult, type EsignDraftSendAnswer, type EsignDraftSendArgs, type EsignDraftSendBody, type EsignDraftSendResult, type EsignEnvelopeActAnswer, type EsignFieldCandidate, type EsignFieldInput, type EsignFinalizeAnswer, type EsignFinalizeArgs, type EsignFinalizeResult, type EsignHandoffOpenAnswer, type EsignHandoffOpenArgs, type EsignHandoffOpenBody, type EsignHandoffOpenResult, type EsignHandoffSubmitAnswer, type EsignHandoffSubmitArgs, type EsignHandoffSubmitBody, type EsignHandoffSubmitResult, type EsignInternalActArgs, type EsignInternalActBody, type EsignInternalActResult, type EsignOutsiderActArgs, type EsignOutsiderActBody, type EsignOutsiderActResult, type EsignOutsiderCodeAnswer, type EsignOutsiderCodeArgs, type EsignOutsiderCodeResult, type EsignOutsiderOpenAnswer, type EsignOutsiderOpenArgs, type EsignOutsiderOpenResult, type EsignOutsiderVerifyAnswer, type EsignOutsiderVerifyArgs, type EsignOutsiderVerifyResult, type EsignRemindArgs, type EsignRemindResult, type EsignResendArgs, type EsignResendBody, type EsignResendResult, type EsignSecretBody, type EsignSendAnswer, type EsignSendArgs, type EsignSendBody, type EsignSendResult, type EsignSendWarning, type EsignSignedCopyArgs, type EsignSignedCopyResult, type EsignSignerInput, type EsignSigningAnswer, type EsignVerifyArgs, type EsignVerifyBody, type EsignVerifyResult, type EsignVoidArgs, type EsignVoidBody, type EsignVoidResult, type ExtractOfficeMarkdownArgs, type ExtractOfficeMarkdownResult, type FindDocumentByCldFileArgs, type FindDocumentByCldFileResult, type GenerateOfficeArgs, type GenerateOfficeResult, type GetAllContentBlocksArgs, type GetAllContentBlocksResult, type GetContentBlockByIdArgs, type GetContentBlockByIdResult, type GetContentBlocksByCategoryArgs, type GetContentBlocksByCategoryResult, type GetDocumentChunksArgs, type GetDocumentChunksResult, type GetDocumentLineageArgs, type GetDocumentLineageResult, type GetDocumentOverviewArgs, type GetDocumentOverviewResult, type GetDocumentPageArgs, type GetDocumentPageImageArgs, type GetDocumentPageImageResult, type GetDocumentPageResult, type GetDocumentPagesArgs, type GetDocumentPagesResult, type GetFolderTreeArgs, type GetFolderTreeResult, type GetNoteArgs, type GetNoteResult, type GetNoteSyncStatusArgs, type GetNoteSyncStatusResult, type Keyword, type LabelArgs, type LabelMetadata, type LabelRequest, type LabelResult, type LineageNode, type LineageTree, type ListConflictsArgs, type ListConflictsResult, type ListLocalFoldersArgs, type ListLocalFoldersResult, type ListMappingsArgs, type ListMappingsResult, type ListNotesArgs, type ListNotesResult, type ListSharesArgs, type ListSharesResult, type ListVersionsArgs, type ListVersionsResult, type MappingRequest, type NoteExcludeRequest, type OfficeConvertRequest, type OfficeExtractionResponse, type OfficeGenerationRequest, type OfficeGenerationResponse, type OfficePortionOut, type Operations, type PageDetail, type PageSummary, type PresentationSpec, type ProcessBlocksArgs, type ProcessBlocksRequest, type ProcessBlocksResponse, type ProcessBlocksResult, type ProcessBlocksStreamArgs, type ProcessBlocksStreamResult, type ProcessContentBody, type ProcessFileArgs, type ProcessFileResult, type PullChangesArgs, type PullChangesResult, type PullRemoteChangeRequest, type PullSingleNoteArgs, type PullSingleNoteResult, type ReadLocalFileArgs, type ReadLocalFileResult, type RegisterDeviceArgs, type RegisterDeviceResult, type RenderedCaptureRequest, type RenderedCaptureResponse, type ResetDeleteBreakerArgs, type ResetDeleteBreakerResult, type ResolveConflictArgs, type ResolveConflictResult, type RevertNoteArgs, type RevertNoteResult, type RevertRequest_MatrxLocal, type ScanLocalFilesArgs, type ScanLocalFilesResult, type SetNoteExcludedArgs, type SetNoteExcludedResult, type ShareRequest, type SheetSpec, type SimulateProviderRetryRequest, type SimulateProviderRetryStreamArgs, type SimulateProviderRetryStreamResult, type SlideSpec, type SpreadsheetSpec, type StartWatcherArgs, type StartWatcherResult, type StopWatcherArgs, type StopWatcherResult, type SyncStatusArgs, type SyncStatusResult, type SyncTriggerRequest, type TriggerSyncArgs, type TriggerSyncResult, type UpdateFolderArgs, type UpdateFolderRequest, type UpdateFolderResult, type UpdateNoteArgs, type UpdateNoteRequest, type UpdateNoteResult, type UpdateShareArgs, type UpdateShareRequest, type UpdateShareResult, call, capture, convertOfficeFile, createFolder, createMapping, createNote, createShare, deleteFolder, deleteMapping, deleteNote, deleteShare, esignDetectFields, esignDownload, esignDraftSend, esignFinalize, esignHandoffOpen, esignHandoffSubmit, esignInternalAct, esignOutsiderAct, esignOutsiderCode, esignOutsiderOpen, esignOutsiderVerify, esignRemind, esignResend, esignSend, esignSignedCopy, esignVerify, esignVoid, extractOfficeMarkdown, findDocumentByCldFile, generateOffice, getAllContentBlocks, getContentBlockById, getContentBlocksByCategory, getDocumentChunks, getDocumentLineage, getDocumentOverview, getDocumentPage, getDocumentPageImage, getDocumentPages, getFolderTree, getNote, getNoteSyncStatus, label, listConflicts, listLocalFolders, listMappings, listNotes, listShares, listVersions, processBlocks, processBlocksStream, processFile, pullChanges, pullSingleNote, readLocalFile, registerDevice, resetDeleteBreaker, resolveConflict, revertNote, scanLocalFiles, setNoteExcluded, simulateProviderRetryStream, startWatcher, stopWatcher, syncStatus, triggerSync, updateFolder, updateNote, updateShare };