@documenso/sdk-typescript 0.1.1

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 (685) hide show
  1. package/.devcontainer/README.md +30 -0
  2. package/.devcontainer/devcontainer.json +45 -0
  3. package/FUNCTIONS.md +104 -0
  4. package/LICENSE +21 -0
  5. package/README.md +533 -0
  6. package/RUNTIMES.md +48 -0
  7. package/core.d.ts +10 -0
  8. package/core.d.ts.map +1 -0
  9. package/core.js +17 -0
  10. package/core.js.map +1 -0
  11. package/docs/sdks/directlink/README.md +246 -0
  12. package/docs/sdks/documenso/README.md +7 -0
  13. package/docs/sdks/documensofields/README.md +480 -0
  14. package/docs/sdks/documensorecipients/README.md +430 -0
  15. package/docs/sdks/documensotemplatesfields/README.md +456 -0
  16. package/docs/sdks/documensotemplatesrecipients/README.md +440 -0
  17. package/docs/sdks/documents/README.md +724 -0
  18. package/docs/sdks/fields/README.md +87 -0
  19. package/docs/sdks/recipients/README.md +87 -0
  20. package/docs/sdks/templates/README.md +566 -0
  21. package/funcs/documentsCreateV0.d.ts +16 -0
  22. package/funcs/documentsCreateV0.d.ts.map +1 -0
  23. package/funcs/documentsCreateV0.js +112 -0
  24. package/funcs/documentsCreateV0.js.map +1 -0
  25. package/funcs/documentsDelete.d.ts +13 -0
  26. package/funcs/documentsDelete.d.ts.map +1 -0
  27. package/funcs/documentsDelete.js +109 -0
  28. package/funcs/documentsDelete.js.map +1 -0
  29. package/funcs/documentsDistribute.d.ts +16 -0
  30. package/funcs/documentsDistribute.d.ts.map +1 -0
  31. package/funcs/documentsDistribute.js +111 -0
  32. package/funcs/documentsDistribute.js.map +1 -0
  33. package/funcs/documentsDuplicate.d.ts +13 -0
  34. package/funcs/documentsDuplicate.d.ts.map +1 -0
  35. package/funcs/documentsDuplicate.js +108 -0
  36. package/funcs/documentsDuplicate.js.map +1 -0
  37. package/funcs/documentsFieldsCreate.d.ts +16 -0
  38. package/funcs/documentsFieldsCreate.d.ts.map +1 -0
  39. package/funcs/documentsFieldsCreate.js +111 -0
  40. package/funcs/documentsFieldsCreate.js.map +1 -0
  41. package/funcs/documentsFieldsCreateMany.d.ts +16 -0
  42. package/funcs/documentsFieldsCreateMany.d.ts.map +1 -0
  43. package/funcs/documentsFieldsCreateMany.js +111 -0
  44. package/funcs/documentsFieldsCreateMany.js.map +1 -0
  45. package/funcs/documentsFieldsDelete.d.ts +13 -0
  46. package/funcs/documentsFieldsDelete.d.ts.map +1 -0
  47. package/funcs/documentsFieldsDelete.js +109 -0
  48. package/funcs/documentsFieldsDelete.js.map +1 -0
  49. package/funcs/documentsFieldsUpdate.d.ts +16 -0
  50. package/funcs/documentsFieldsUpdate.d.ts.map +1 -0
  51. package/funcs/documentsFieldsUpdate.js +111 -0
  52. package/funcs/documentsFieldsUpdate.js.map +1 -0
  53. package/funcs/documentsFieldsUpdateMany.d.ts +16 -0
  54. package/funcs/documentsFieldsUpdateMany.d.ts.map +1 -0
  55. package/funcs/documentsFieldsUpdateMany.js +111 -0
  56. package/funcs/documentsFieldsUpdateMany.js.map +1 -0
  57. package/funcs/documentsFind.d.ts +16 -0
  58. package/funcs/documentsFind.d.ts.map +1 -0
  59. package/funcs/documentsFind.js +121 -0
  60. package/funcs/documentsFind.js.map +1 -0
  61. package/funcs/documentsGet.d.ts +16 -0
  62. package/funcs/documentsGet.d.ts.map +1 -0
  63. package/funcs/documentsGet.js +116 -0
  64. package/funcs/documentsGet.js.map +1 -0
  65. package/funcs/documentsMoveToTeam.d.ts +16 -0
  66. package/funcs/documentsMoveToTeam.d.ts.map +1 -0
  67. package/funcs/documentsMoveToTeam.js +111 -0
  68. package/funcs/documentsMoveToTeam.js.map +1 -0
  69. package/funcs/documentsRecipientsCreate.d.ts +16 -0
  70. package/funcs/documentsRecipientsCreate.d.ts.map +1 -0
  71. package/funcs/documentsRecipientsCreate.js +112 -0
  72. package/funcs/documentsRecipientsCreate.js.map +1 -0
  73. package/funcs/documentsRecipientsCreateMany.d.ts +16 -0
  74. package/funcs/documentsRecipientsCreateMany.d.ts.map +1 -0
  75. package/funcs/documentsRecipientsCreateMany.js +112 -0
  76. package/funcs/documentsRecipientsCreateMany.js.map +1 -0
  77. package/funcs/documentsRecipientsDelete.d.ts +13 -0
  78. package/funcs/documentsRecipientsDelete.d.ts.map +1 -0
  79. package/funcs/documentsRecipientsDelete.js +110 -0
  80. package/funcs/documentsRecipientsDelete.js.map +1 -0
  81. package/funcs/documentsRecipientsUpdate.d.ts +16 -0
  82. package/funcs/documentsRecipientsUpdate.d.ts.map +1 -0
  83. package/funcs/documentsRecipientsUpdate.js +112 -0
  84. package/funcs/documentsRecipientsUpdate.js.map +1 -0
  85. package/funcs/documentsRecipientsUpdateMany.d.ts +16 -0
  86. package/funcs/documentsRecipientsUpdateMany.d.ts.map +1 -0
  87. package/funcs/documentsRecipientsUpdateMany.js +112 -0
  88. package/funcs/documentsRecipientsUpdateMany.js.map +1 -0
  89. package/funcs/documentsRedistribute.d.ts +16 -0
  90. package/funcs/documentsRedistribute.d.ts.map +1 -0
  91. package/funcs/documentsRedistribute.js +112 -0
  92. package/funcs/documentsRedistribute.js.map +1 -0
  93. package/funcs/documentsUpdate.d.ts +13 -0
  94. package/funcs/documentsUpdate.d.ts.map +1 -0
  95. package/funcs/documentsUpdate.js +108 -0
  96. package/funcs/documentsUpdate.js.map +1 -0
  97. package/funcs/fieldsGet.d.ts +16 -0
  98. package/funcs/fieldsGet.d.ts.map +1 -0
  99. package/funcs/fieldsGet.js +116 -0
  100. package/funcs/fieldsGet.js.map +1 -0
  101. package/funcs/recipientsGet.d.ts +16 -0
  102. package/funcs/recipientsGet.d.ts.map +1 -0
  103. package/funcs/recipientsGet.js +116 -0
  104. package/funcs/recipientsGet.js.map +1 -0
  105. package/funcs/templatesDelete.d.ts +13 -0
  106. package/funcs/templatesDelete.d.ts.map +1 -0
  107. package/funcs/templatesDelete.js +109 -0
  108. package/funcs/templatesDelete.js.map +1 -0
  109. package/funcs/templatesDirectLinkCreate.d.ts +16 -0
  110. package/funcs/templatesDirectLinkCreate.d.ts.map +1 -0
  111. package/funcs/templatesDirectLinkCreate.js +112 -0
  112. package/funcs/templatesDirectLinkCreate.js.map +1 -0
  113. package/funcs/templatesDirectLinkDelete.d.ts +16 -0
  114. package/funcs/templatesDirectLinkDelete.d.ts.map +1 -0
  115. package/funcs/templatesDirectLinkDelete.js +113 -0
  116. package/funcs/templatesDirectLinkDelete.js.map +1 -0
  117. package/funcs/templatesDirectLinkToggle.d.ts +16 -0
  118. package/funcs/templatesDirectLinkToggle.d.ts.map +1 -0
  119. package/funcs/templatesDirectLinkToggle.js +112 -0
  120. package/funcs/templatesDirectLinkToggle.js.map +1 -0
  121. package/funcs/templatesDuplicate.d.ts +13 -0
  122. package/funcs/templatesDuplicate.d.ts.map +1 -0
  123. package/funcs/templatesDuplicate.js +108 -0
  124. package/funcs/templatesDuplicate.js.map +1 -0
  125. package/funcs/templatesFieldsCreate.d.ts +16 -0
  126. package/funcs/templatesFieldsCreate.d.ts.map +1 -0
  127. package/funcs/templatesFieldsCreate.js +111 -0
  128. package/funcs/templatesFieldsCreate.js.map +1 -0
  129. package/funcs/templatesFieldsCreateMany.d.ts +16 -0
  130. package/funcs/templatesFieldsCreateMany.d.ts.map +1 -0
  131. package/funcs/templatesFieldsCreateMany.js +111 -0
  132. package/funcs/templatesFieldsCreateMany.js.map +1 -0
  133. package/funcs/templatesFieldsDelete.d.ts +13 -0
  134. package/funcs/templatesFieldsDelete.d.ts.map +1 -0
  135. package/funcs/templatesFieldsDelete.js +109 -0
  136. package/funcs/templatesFieldsDelete.js.map +1 -0
  137. package/funcs/templatesFieldsUpdate.d.ts +16 -0
  138. package/funcs/templatesFieldsUpdate.d.ts.map +1 -0
  139. package/funcs/templatesFieldsUpdate.js +111 -0
  140. package/funcs/templatesFieldsUpdate.js.map +1 -0
  141. package/funcs/templatesFieldsUpdateMany.d.ts +16 -0
  142. package/funcs/templatesFieldsUpdateMany.d.ts.map +1 -0
  143. package/funcs/templatesFieldsUpdateMany.js +111 -0
  144. package/funcs/templatesFieldsUpdateMany.js.map +1 -0
  145. package/funcs/templatesFind.d.ts +16 -0
  146. package/funcs/templatesFind.d.ts.map +1 -0
  147. package/funcs/templatesFind.js +117 -0
  148. package/funcs/templatesFind.js.map +1 -0
  149. package/funcs/templatesGet.d.ts +13 -0
  150. package/funcs/templatesGet.d.ts.map +1 -0
  151. package/funcs/templatesGet.js +113 -0
  152. package/funcs/templatesGet.js.map +1 -0
  153. package/funcs/templatesMoveToTeam.d.ts +16 -0
  154. package/funcs/templatesMoveToTeam.d.ts.map +1 -0
  155. package/funcs/templatesMoveToTeam.js +111 -0
  156. package/funcs/templatesMoveToTeam.js.map +1 -0
  157. package/funcs/templatesRecipientsCreate.d.ts +16 -0
  158. package/funcs/templatesRecipientsCreate.d.ts.map +1 -0
  159. package/funcs/templatesRecipientsCreate.js +112 -0
  160. package/funcs/templatesRecipientsCreate.js.map +1 -0
  161. package/funcs/templatesRecipientsCreateMany.d.ts +16 -0
  162. package/funcs/templatesRecipientsCreateMany.d.ts.map +1 -0
  163. package/funcs/templatesRecipientsCreateMany.js +112 -0
  164. package/funcs/templatesRecipientsCreateMany.js.map +1 -0
  165. package/funcs/templatesRecipientsDelete.d.ts +13 -0
  166. package/funcs/templatesRecipientsDelete.d.ts.map +1 -0
  167. package/funcs/templatesRecipientsDelete.js +110 -0
  168. package/funcs/templatesRecipientsDelete.js.map +1 -0
  169. package/funcs/templatesRecipientsUpdate.d.ts +16 -0
  170. package/funcs/templatesRecipientsUpdate.d.ts.map +1 -0
  171. package/funcs/templatesRecipientsUpdate.js +112 -0
  172. package/funcs/templatesRecipientsUpdate.js.map +1 -0
  173. package/funcs/templatesRecipientsUpdateMany.d.ts +16 -0
  174. package/funcs/templatesRecipientsUpdateMany.d.ts.map +1 -0
  175. package/funcs/templatesRecipientsUpdateMany.js +112 -0
  176. package/funcs/templatesRecipientsUpdateMany.js.map +1 -0
  177. package/funcs/templatesUpdate.d.ts +13 -0
  178. package/funcs/templatesUpdate.d.ts.map +1 -0
  179. package/funcs/templatesUpdate.js +108 -0
  180. package/funcs/templatesUpdate.js.map +1 -0
  181. package/funcs/templatesUse.d.ts +16 -0
  182. package/funcs/templatesUse.d.ts.map +1 -0
  183. package/funcs/templatesUse.js +112 -0
  184. package/funcs/templatesUse.js.map +1 -0
  185. package/hooks/hooks.d.ts +24 -0
  186. package/hooks/hooks.d.ts.map +1 -0
  187. package/hooks/hooks.js +86 -0
  188. package/hooks/hooks.js.map +1 -0
  189. package/hooks/index.d.ts +3 -0
  190. package/hooks/index.d.ts.map +1 -0
  191. package/hooks/index.js +22 -0
  192. package/hooks/index.js.map +1 -0
  193. package/hooks/registration.d.ts +3 -0
  194. package/hooks/registration.d.ts.map +1 -0
  195. package/hooks/registration.js +15 -0
  196. package/hooks/registration.js.map +1 -0
  197. package/hooks/types.d.ts +77 -0
  198. package/hooks/types.d.ts.map +1 -0
  199. package/hooks/types.js +6 -0
  200. package/hooks/types.js.map +1 -0
  201. package/index.d.ts +4 -0
  202. package/index.d.ts.map +1 -0
  203. package/index.js +46 -0
  204. package/index.js.map +1 -0
  205. package/jsr.json +27 -0
  206. package/lib/base64.d.ts +10 -0
  207. package/lib/base64.d.ts.map +1 -0
  208. package/lib/base64.js +71 -0
  209. package/lib/base64.js.map +1 -0
  210. package/lib/config.d.ts +34 -0
  211. package/lib/config.d.ts.map +1 -0
  212. package/lib/config.js +35 -0
  213. package/lib/config.js.map +1 -0
  214. package/lib/dlv.d.ts +14 -0
  215. package/lib/dlv.d.ts.map +1 -0
  216. package/lib/dlv.js +49 -0
  217. package/lib/dlv.js.map +1 -0
  218. package/lib/encodings.d.ts +52 -0
  219. package/lib/encodings.d.ts.map +1 -0
  220. package/lib/encodings.js +368 -0
  221. package/lib/encodings.js.map +1 -0
  222. package/lib/env.d.ts +15 -0
  223. package/lib/env.d.ts.map +1 -0
  224. package/lib/env.js +65 -0
  225. package/lib/env.js.map +1 -0
  226. package/lib/files.d.ts +8 -0
  227. package/lib/files.d.ts.map +1 -0
  228. package/lib/files.js +36 -0
  229. package/lib/files.js.map +1 -0
  230. package/lib/http.d.ts +67 -0
  231. package/lib/http.d.ts.map +1 -0
  232. package/lib/http.js +217 -0
  233. package/lib/http.js.map +1 -0
  234. package/lib/is-plain-object.d.ts +2 -0
  235. package/lib/is-plain-object.d.ts.map +1 -0
  236. package/lib/is-plain-object.js +41 -0
  237. package/lib/is-plain-object.js.map +1 -0
  238. package/lib/logger.d.ts +6 -0
  239. package/lib/logger.d.ts.map +1 -0
  240. package/lib/logger.js +6 -0
  241. package/lib/logger.js.map +1 -0
  242. package/lib/matchers.d.ts +64 -0
  243. package/lib/matchers.d.ts.map +1 -0
  244. package/lib/matchers.js +204 -0
  245. package/lib/matchers.js.map +1 -0
  246. package/lib/primitives.d.ts +23 -0
  247. package/lib/primitives.d.ts.map +1 -0
  248. package/lib/primitives.js +104 -0
  249. package/lib/primitives.js.map +1 -0
  250. package/lib/retries.d.ts +38 -0
  251. package/lib/retries.d.ts.map +1 -0
  252. package/lib/retries.js +154 -0
  253. package/lib/retries.js.map +1 -0
  254. package/lib/schemas.d.ts +19 -0
  255. package/lib/schemas.d.ts.map +1 -0
  256. package/lib/schemas.js +59 -0
  257. package/lib/schemas.js.map +1 -0
  258. package/lib/sdks.d.ts +60 -0
  259. package/lib/sdks.d.ts.map +1 -0
  260. package/lib/sdks.js +280 -0
  261. package/lib/sdks.js.map +1 -0
  262. package/lib/security.d.ts +82 -0
  263. package/lib/security.d.ts.map +1 -0
  264. package/lib/security.js +139 -0
  265. package/lib/security.js.map +1 -0
  266. package/lib/url.d.ts +5 -0
  267. package/lib/url.d.ts.map +1 -0
  268. package/lib/url.js +25 -0
  269. package/lib/url.js.map +1 -0
  270. package/local-openapi.json +21024 -0
  271. package/models/components/index.d.ts +2 -0
  272. package/models/components/index.d.ts.map +1 -0
  273. package/models/components/index.js +21 -0
  274. package/models/components/index.js.map +1 -0
  275. package/models/components/security.d.ts +29 -0
  276. package/models/components/security.d.ts.map +1 -0
  277. package/models/components/security.js +69 -0
  278. package/models/components/security.js.map +1 -0
  279. package/models/errors/apierror.d.ts +8 -0
  280. package/models/errors/apierror.d.ts.map +1 -0
  281. package/models/errors/apierror.js +21 -0
  282. package/models/errors/apierror.js.map +1 -0
  283. package/models/errors/errorbadrequest.d.ts +84 -0
  284. package/models/errors/errorbadrequest.d.ts.map +1 -0
  285. package/models/errors/errorbadrequest.js +115 -0
  286. package/models/errors/errorbadrequest.js.map +1 -0
  287. package/models/errors/errorinternalservererror.d.ts +84 -0
  288. package/models/errors/errorinternalservererror.d.ts.map +1 -0
  289. package/models/errors/errorinternalservererror.js +116 -0
  290. package/models/errors/errorinternalservererror.js.map +1 -0
  291. package/models/errors/errornotfound.d.ts +84 -0
  292. package/models/errors/errornotfound.d.ts.map +1 -0
  293. package/models/errors/errornotfound.js +115 -0
  294. package/models/errors/errornotfound.js.map +1 -0
  295. package/models/errors/httpclienterrors.d.ts +44 -0
  296. package/models/errors/httpclienterrors.d.ts.map +1 -0
  297. package/models/errors/httpclienterrors.js +78 -0
  298. package/models/errors/httpclienterrors.js.map +1 -0
  299. package/models/errors/index.d.ts +7 -0
  300. package/models/errors/index.d.ts.map +1 -0
  301. package/models/errors/index.js +26 -0
  302. package/models/errors/index.js.map +1 -0
  303. package/models/errors/sdkvalidationerror.d.ts +20 -0
  304. package/models/errors/sdkvalidationerror.d.ts.map +1 -0
  305. package/models/errors/sdkvalidationerror.js +115 -0
  306. package/models/errors/sdkvalidationerror.js.map +1 -0
  307. package/models/operations/documentcreatedocumenttemporary.d.ts +3565 -0
  308. package/models/operations/documentcreatedocumenttemporary.d.ts.map +1 -0
  309. package/models/operations/documentcreatedocumenttemporary.js +3203 -0
  310. package/models/operations/documentcreatedocumenttemporary.js.map +1 -0
  311. package/models/operations/documentdeletedocument.d.ts +29 -0
  312. package/models/operations/documentdeletedocument.d.ts.map +1 -0
  313. package/models/operations/documentdeletedocument.js +69 -0
  314. package/models/operations/documentdeletedocument.js.map +1 -0
  315. package/models/operations/documentduplicatedocument.d.ts +57 -0
  316. package/models/operations/documentduplicatedocument.d.ts.map +1 -0
  317. package/models/operations/documentduplicatedocument.js +96 -0
  318. package/models/operations/documentduplicatedocument.js.map +1 -0
  319. package/models/operations/documentfinddocuments.d.ts +817 -0
  320. package/models/operations/documentfinddocuments.d.ts.map +1 -0
  321. package/models/operations/documentfinddocuments.js +694 -0
  322. package/models/operations/documentfinddocuments.js.map +1 -0
  323. package/models/operations/documentgetdocumentwithdetailsbyid.d.ts +1528 -0
  324. package/models/operations/documentgetdocumentwithdetailsbyid.d.ts.map +1 -0
  325. package/models/operations/documentgetdocumentwithdetailsbyid.js +1447 -0
  326. package/models/operations/documentgetdocumentwithdetailsbyid.js.map +1 -0
  327. package/models/operations/documentmovedocumenttoteam.d.ts +306 -0
  328. package/models/operations/documentmovedocumenttoteam.d.ts.map +1 -0
  329. package/models/operations/documentmovedocumenttoteam.js +286 -0
  330. package/models/operations/documentmovedocumenttoteam.js.map +1 -0
  331. package/models/operations/documentresenddocument.d.ts +34 -0
  332. package/models/operations/documentresenddocument.d.ts.map +1 -0
  333. package/models/operations/documentresenddocument.js +71 -0
  334. package/models/operations/documentresenddocument.js.map +1 -0
  335. package/models/operations/documentsenddocument.d.ts +544 -0
  336. package/models/operations/documentsenddocument.d.ts.map +1 -0
  337. package/models/operations/documentsenddocument.js +444 -0
  338. package/models/operations/documentsenddocument.js.map +1 -0
  339. package/models/operations/documentsetsettingsfordocument.d.ts +719 -0
  340. package/models/operations/documentsetsettingsfordocument.d.ts.map +1 -0
  341. package/models/operations/documentsetsettingsfordocument.js +583 -0
  342. package/models/operations/documentsetsettingsfordocument.js.map +1 -0
  343. package/models/operations/fieldcreatedocumentfield.d.ts +2276 -0
  344. package/models/operations/fieldcreatedocumentfield.d.ts.map +1 -0
  345. package/models/operations/fieldcreatedocumentfield.js +2167 -0
  346. package/models/operations/fieldcreatedocumentfield.js.map +1 -0
  347. package/models/operations/fieldcreatedocumentfields.d.ts +2301 -0
  348. package/models/operations/fieldcreatedocumentfields.d.ts.map +1 -0
  349. package/models/operations/fieldcreatedocumentfields.js +2189 -0
  350. package/models/operations/fieldcreatedocumentfields.js.map +1 -0
  351. package/models/operations/fieldcreatetemplatefield.d.ts +2276 -0
  352. package/models/operations/fieldcreatetemplatefield.d.ts.map +1 -0
  353. package/models/operations/fieldcreatetemplatefield.js +2161 -0
  354. package/models/operations/fieldcreatetemplatefield.js.map +1 -0
  355. package/models/operations/fieldcreatetemplatefields.d.ts +2301 -0
  356. package/models/operations/fieldcreatetemplatefields.d.ts.map +1 -0
  357. package/models/operations/fieldcreatetemplatefields.js +2189 -0
  358. package/models/operations/fieldcreatetemplatefields.js.map +1 -0
  359. package/models/operations/fielddeletedocumentfield.d.ts +29 -0
  360. package/models/operations/fielddeletedocumentfield.d.ts.map +1 -0
  361. package/models/operations/fielddeletedocumentfield.js +69 -0
  362. package/models/operations/fielddeletedocumentfield.js.map +1 -0
  363. package/models/operations/fielddeletetemplatefield.d.ts +29 -0
  364. package/models/operations/fielddeletetemplatefield.d.ts.map +1 -0
  365. package/models/operations/fielddeletetemplatefield.js +69 -0
  366. package/models/operations/fielddeletetemplatefield.js.map +1 -0
  367. package/models/operations/fieldgetfield.d.ts +774 -0
  368. package/models/operations/fieldgetfield.d.ts.map +1 -0
  369. package/models/operations/fieldgetfield.js +820 -0
  370. package/models/operations/fieldgetfield.js.map +1 -0
  371. package/models/operations/fieldupdatedocumentfield.d.ts +2276 -0
  372. package/models/operations/fieldupdatedocumentfield.d.ts.map +1 -0
  373. package/models/operations/fieldupdatedocumentfield.js +2161 -0
  374. package/models/operations/fieldupdatedocumentfield.js.map +1 -0
  375. package/models/operations/fieldupdatedocumentfields.d.ts +2301 -0
  376. package/models/operations/fieldupdatedocumentfields.d.ts.map +1 -0
  377. package/models/operations/fieldupdatedocumentfields.js +2189 -0
  378. package/models/operations/fieldupdatedocumentfields.js.map +1 -0
  379. package/models/operations/fieldupdatetemplatefield.d.ts +2276 -0
  380. package/models/operations/fieldupdatetemplatefield.d.ts.map +1 -0
  381. package/models/operations/fieldupdatetemplatefield.js +2161 -0
  382. package/models/operations/fieldupdatetemplatefield.js.map +1 -0
  383. package/models/operations/fieldupdatetemplatefields.d.ts +2301 -0
  384. package/models/operations/fieldupdatetemplatefields.d.ts.map +1 -0
  385. package/models/operations/fieldupdatetemplatefields.js +2189 -0
  386. package/models/operations/fieldupdatetemplatefields.js.map +1 -0
  387. package/models/operations/index.d.ts +42 -0
  388. package/models/operations/index.d.ts.map +1 -0
  389. package/models/operations/index.js +61 -0
  390. package/models/operations/index.js.map +1 -0
  391. package/models/operations/recipientcreatedocumentrecipient.d.ts +437 -0
  392. package/models/operations/recipientcreatedocumentrecipient.d.ts.map +1 -0
  393. package/models/operations/recipientcreatedocumentrecipient.js +389 -0
  394. package/models/operations/recipientcreatedocumentrecipient.js.map +1 -0
  395. package/models/operations/recipientcreatedocumentrecipients.d.ts +462 -0
  396. package/models/operations/recipientcreatedocumentrecipients.d.ts.map +1 -0
  397. package/models/operations/recipientcreatedocumentrecipients.js +419 -0
  398. package/models/operations/recipientcreatedocumentrecipients.js.map +1 -0
  399. package/models/operations/recipientcreatetemplaterecipient.d.ts +437 -0
  400. package/models/operations/recipientcreatetemplaterecipient.d.ts.map +1 -0
  401. package/models/operations/recipientcreatetemplaterecipient.js +389 -0
  402. package/models/operations/recipientcreatetemplaterecipient.js.map +1 -0
  403. package/models/operations/recipientcreatetemplaterecipients.d.ts +462 -0
  404. package/models/operations/recipientcreatetemplaterecipients.d.ts.map +1 -0
  405. package/models/operations/recipientcreatetemplaterecipients.js +419 -0
  406. package/models/operations/recipientcreatetemplaterecipients.js.map +1 -0
  407. package/models/operations/recipientdeletedocumentrecipient.d.ts +29 -0
  408. package/models/operations/recipientdeletedocumentrecipient.d.ts.map +1 -0
  409. package/models/operations/recipientdeletedocumentrecipient.js +69 -0
  410. package/models/operations/recipientdeletedocumentrecipient.js.map +1 -0
  411. package/models/operations/recipientdeletetemplaterecipient.d.ts +29 -0
  412. package/models/operations/recipientdeletetemplaterecipient.d.ts.map +1 -0
  413. package/models/operations/recipientdeletetemplaterecipient.js +69 -0
  414. package/models/operations/recipientdeletetemplaterecipient.js.map +1 -0
  415. package/models/operations/recipientgetrecipient.d.ts +1041 -0
  416. package/models/operations/recipientgetrecipient.d.ts.map +1 -0
  417. package/models/operations/recipientgetrecipient.js +1033 -0
  418. package/models/operations/recipientgetrecipient.js.map +1 -0
  419. package/models/operations/recipientupdatedocumentrecipient.d.ts +1185 -0
  420. package/models/operations/recipientupdatedocumentrecipient.d.ts.map +1 -0
  421. package/models/operations/recipientupdatedocumentrecipient.js +1146 -0
  422. package/models/operations/recipientupdatedocumentrecipient.js.map +1 -0
  423. package/models/operations/recipientupdatedocumentrecipients.d.ts +1210 -0
  424. package/models/operations/recipientupdatedocumentrecipients.d.ts.map +1 -0
  425. package/models/operations/recipientupdatedocumentrecipients.js +1175 -0
  426. package/models/operations/recipientupdatedocumentrecipients.js.map +1 -0
  427. package/models/operations/recipientupdatetemplaterecipient.d.ts +1185 -0
  428. package/models/operations/recipientupdatetemplaterecipient.d.ts.map +1 -0
  429. package/models/operations/recipientupdatetemplaterecipient.js +1146 -0
  430. package/models/operations/recipientupdatetemplaterecipient.js.map +1 -0
  431. package/models/operations/recipientupdatetemplaterecipients.d.ts +1210 -0
  432. package/models/operations/recipientupdatetemplaterecipients.d.ts.map +1 -0
  433. package/models/operations/recipientupdatetemplaterecipients.js +1175 -0
  434. package/models/operations/recipientupdatetemplaterecipients.js.map +1 -0
  435. package/models/operations/templatecreatedocumentfromtemplate.d.ts +1575 -0
  436. package/models/operations/templatecreatedocumentfromtemplate.d.ts.map +1 -0
  437. package/models/operations/templatecreatedocumentfromtemplate.js +1485 -0
  438. package/models/operations/templatecreatedocumentfromtemplate.js.map +1 -0
  439. package/models/operations/templatecreatetemplatedirectlink.d.ts +72 -0
  440. package/models/operations/templatecreatetemplatedirectlink.d.ts.map +1 -0
  441. package/models/operations/templatecreatetemplatedirectlink.js +108 -0
  442. package/models/operations/templatecreatetemplatedirectlink.js.map +1 -0
  443. package/models/operations/templatedeletetemplate.d.ts +29 -0
  444. package/models/operations/templatedeletetemplate.d.ts.map +1 -0
  445. package/models/operations/templatedeletetemplate.js +69 -0
  446. package/models/operations/templatedeletetemplate.js.map +1 -0
  447. package/models/operations/templatedeletetemplatedirectlink.d.ts +29 -0
  448. package/models/operations/templatedeletetemplatedirectlink.d.ts.map +1 -0
  449. package/models/operations/templatedeletetemplatedirectlink.js +69 -0
  450. package/models/operations/templatedeletetemplatedirectlink.js.map +1 -0
  451. package/models/operations/templateduplicatetemplate.d.ts +230 -0
  452. package/models/operations/templateduplicatetemplate.d.ts.map +1 -0
  453. package/models/operations/templateduplicatetemplate.js +234 -0
  454. package/models/operations/templateduplicatetemplate.js.map +1 -0
  455. package/models/operations/templatefindtemplates.d.ts +1471 -0
  456. package/models/operations/templatefindtemplates.d.ts.map +1 -0
  457. package/models/operations/templatefindtemplates.js +1391 -0
  458. package/models/operations/templatefindtemplates.js.map +1 -0
  459. package/models/operations/templategettemplatebyid.d.ts +1526 -0
  460. package/models/operations/templategettemplatebyid.d.ts.map +1 -0
  461. package/models/operations/templategettemplatebyid.js +1458 -0
  462. package/models/operations/templategettemplatebyid.js.map +1 -0
  463. package/models/operations/templatemovetemplatetoteam.d.ts +238 -0
  464. package/models/operations/templatemovetemplatetoteam.d.ts.map +1 -0
  465. package/models/operations/templatemovetemplatetoteam.js +236 -0
  466. package/models/operations/templatemovetemplatetoteam.js.map +1 -0
  467. package/models/operations/templatetoggletemplatedirectlink.d.ts +69 -0
  468. package/models/operations/templatetoggletemplatedirectlink.d.ts.map +1 -0
  469. package/models/operations/templatetoggletemplatedirectlink.js +108 -0
  470. package/models/operations/templatetoggletemplatedirectlink.js.map +1 -0
  471. package/models/operations/templateupdatetemplate.d.ts +673 -0
  472. package/models/operations/templateupdatetemplate.d.ts.map +1 -0
  473. package/models/operations/templateupdatetemplate.js +547 -0
  474. package/models/operations/templateupdatetemplate.js.map +1 -0
  475. package/package.json +27 -0
  476. package/sdk/directlink.d.ts +26 -0
  477. package/sdk/directlink.d.ts.map +1 -0
  478. package/sdk/directlink.js +42 -0
  479. package/sdk/directlink.js.map +1 -0
  480. package/sdk/documensofields.d.ts +37 -0
  481. package/sdk/documensofields.d.ts.map +1 -0
  482. package/sdk/documensofields.js +59 -0
  483. package/sdk/documensofields.js.map +1 -0
  484. package/sdk/documensorecipients.d.ts +37 -0
  485. package/sdk/documensorecipients.d.ts.map +1 -0
  486. package/sdk/documensorecipients.js +59 -0
  487. package/sdk/documensorecipients.js.map +1 -0
  488. package/sdk/documensotemplatesfields.d.ts +37 -0
  489. package/sdk/documensotemplatesfields.d.ts.map +1 -0
  490. package/sdk/documensotemplatesfields.js +59 -0
  491. package/sdk/documensotemplatesfields.js.map +1 -0
  492. package/sdk/documensotemplatesrecipients.d.ts +37 -0
  493. package/sdk/documensotemplatesrecipients.d.ts.map +1 -0
  494. package/sdk/documensotemplatesrecipients.js +59 -0
  495. package/sdk/documensotemplatesrecipients.js.map +1 -0
  496. package/sdk/documents.d.ts +65 -0
  497. package/sdk/documents.d.ts.map +1 -0
  498. package/sdk/documents.js +101 -0
  499. package/sdk/documents.js.map +1 -0
  500. package/sdk/fields.d.ts +12 -0
  501. package/sdk/fields.d.ts.map +1 -0
  502. package/sdk/fields.js +22 -0
  503. package/sdk/fields.js.map +1 -0
  504. package/sdk/index.d.ts +2 -0
  505. package/sdk/index.d.ts.map +1 -0
  506. package/sdk/index.js +21 -0
  507. package/sdk/index.js.map +1 -0
  508. package/sdk/recipients.d.ts +12 -0
  509. package/sdk/recipients.d.ts.map +1 -0
  510. package/sdk/recipients.js +22 -0
  511. package/sdk/recipients.js.map +1 -0
  512. package/sdk/sdk.d.ts +16 -0
  513. package/sdk/sdk.d.ts.map +1 -0
  514. package/sdk/sdk.js +27 -0
  515. package/sdk/sdk.js.map +1 -0
  516. package/sdk/templates.d.ts +51 -0
  517. package/sdk/templates.d.ts.map +1 -0
  518. package/sdk/templates.js +82 -0
  519. package/sdk/templates.js.map +1 -0
  520. package/src/core.ts +13 -0
  521. package/src/funcs/documentsCreateV0.ts +142 -0
  522. package/src/funcs/documentsDelete.ts +136 -0
  523. package/src/funcs/documentsDistribute.ts +138 -0
  524. package/src/funcs/documentsDuplicate.ts +137 -0
  525. package/src/funcs/documentsFieldsCreate.ts +140 -0
  526. package/src/funcs/documentsFieldsCreateMany.ts +140 -0
  527. package/src/funcs/documentsFieldsDelete.ts +138 -0
  528. package/src/funcs/documentsFieldsUpdate.ts +140 -0
  529. package/src/funcs/documentsFieldsUpdateMany.ts +140 -0
  530. package/src/funcs/documentsFind.ts +152 -0
  531. package/src/funcs/documentsGet.ts +152 -0
  532. package/src/funcs/documentsMoveToTeam.ts +143 -0
  533. package/src/funcs/documentsRecipientsCreate.ts +142 -0
  534. package/src/funcs/documentsRecipientsCreateMany.ts +142 -0
  535. package/src/funcs/documentsRecipientsDelete.ts +137 -0
  536. package/src/funcs/documentsRecipientsUpdate.ts +142 -0
  537. package/src/funcs/documentsRecipientsUpdateMany.ts +142 -0
  538. package/src/funcs/documentsRedistribute.ts +139 -0
  539. package/src/funcs/documentsUpdate.ts +140 -0
  540. package/src/funcs/fieldsGet.ts +146 -0
  541. package/src/funcs/recipientsGet.ts +147 -0
  542. package/src/funcs/templatesDelete.ts +136 -0
  543. package/src/funcs/templatesDirectLinkCreate.ts +142 -0
  544. package/src/funcs/templatesDirectLinkDelete.ts +140 -0
  545. package/src/funcs/templatesDirectLinkToggle.ts +142 -0
  546. package/src/funcs/templatesDuplicate.ts +137 -0
  547. package/src/funcs/templatesFieldsCreate.ts +140 -0
  548. package/src/funcs/templatesFieldsCreateMany.ts +140 -0
  549. package/src/funcs/templatesFieldsDelete.ts +138 -0
  550. package/src/funcs/templatesFieldsUpdate.ts +140 -0
  551. package/src/funcs/templatesFieldsUpdateMany.ts +140 -0
  552. package/src/funcs/templatesFind.ts +148 -0
  553. package/src/funcs/templatesGet.ts +144 -0
  554. package/src/funcs/templatesMoveToTeam.ts +143 -0
  555. package/src/funcs/templatesRecipientsCreate.ts +142 -0
  556. package/src/funcs/templatesRecipientsCreateMany.ts +142 -0
  557. package/src/funcs/templatesRecipientsDelete.ts +137 -0
  558. package/src/funcs/templatesRecipientsUpdate.ts +142 -0
  559. package/src/funcs/templatesRecipientsUpdateMany.ts +142 -0
  560. package/src/funcs/templatesUpdate.ts +135 -0
  561. package/src/funcs/templatesUse.ts +142 -0
  562. package/src/hooks/hooks.ts +132 -0
  563. package/src/hooks/index.ts +6 -0
  564. package/src/hooks/registration.ts +14 -0
  565. package/src/hooks/types.ts +109 -0
  566. package/src/index.ts +7 -0
  567. package/src/lib/base64.ts +37 -0
  568. package/src/lib/config.ts +61 -0
  569. package/src/lib/dlv.ts +53 -0
  570. package/src/lib/encodings.ts +483 -0
  571. package/src/lib/env.ts +41 -0
  572. package/src/lib/files.ts +40 -0
  573. package/src/lib/http.ts +323 -0
  574. package/src/lib/is-plain-object.ts +43 -0
  575. package/src/lib/logger.ts +9 -0
  576. package/src/lib/matchers.ts +322 -0
  577. package/src/lib/primitives.ts +136 -0
  578. package/src/lib/retries.ts +219 -0
  579. package/src/lib/schemas.ts +86 -0
  580. package/src/lib/sdks.ts +400 -0
  581. package/src/lib/security.ts +254 -0
  582. package/src/lib/url.ts +33 -0
  583. package/src/models/components/index.ts +5 -0
  584. package/src/models/components/security.ts +62 -0
  585. package/src/models/errors/apierror.ts +27 -0
  586. package/src/models/errors/errorbadrequest.ts +154 -0
  587. package/src/models/errors/errorinternalservererror.ts +165 -0
  588. package/src/models/errors/errornotfound.ts +162 -0
  589. package/src/models/errors/httpclienterrors.ts +62 -0
  590. package/src/models/errors/index.ts +10 -0
  591. package/src/models/errors/sdkvalidationerror.ts +97 -0
  592. package/src/models/operations/documentcreatedocumenttemporary.ts +6881 -0
  593. package/src/models/operations/documentdeletedocument.ts +69 -0
  594. package/src/models/operations/documentduplicatedocument.ts +137 -0
  595. package/src/models/operations/documentfinddocuments.ts +1287 -0
  596. package/src/models/operations/documentgetdocumentwithdetailsbyid.ts +3159 -0
  597. package/src/models/operations/documentmovedocumenttoteam.ts +529 -0
  598. package/src/models/operations/documentresenddocument.ts +76 -0
  599. package/src/models/operations/documentsenddocument.ts +844 -0
  600. package/src/models/operations/documentsetsettingsfordocument.ts +1180 -0
  601. package/src/models/operations/fieldcreatedocumentfield.ts +4802 -0
  602. package/src/models/operations/fieldcreatedocumentfields.ts +4995 -0
  603. package/src/models/operations/fieldcreatetemplatefield.ts +4984 -0
  604. package/src/models/operations/fieldcreatetemplatefields.ts +5089 -0
  605. package/src/models/operations/fielddeletedocumentfield.ts +71 -0
  606. package/src/models/operations/fielddeletetemplatefield.ts +71 -0
  607. package/src/models/operations/fieldgetfield.ts +1545 -0
  608. package/src/models/operations/fieldupdatedocumentfield.ts +4984 -0
  609. package/src/models/operations/fieldupdatedocumentfields.ts +5089 -0
  610. package/src/models/operations/fieldupdatetemplatefield.ts +4984 -0
  611. package/src/models/operations/fieldupdatetemplatefields.ts +5089 -0
  612. package/src/models/operations/index.ts +45 -0
  613. package/src/models/operations/recipientcreatedocumentrecipient.ts +731 -0
  614. package/src/models/operations/recipientcreatedocumentrecipients.ts +837 -0
  615. package/src/models/operations/recipientcreatetemplaterecipient.ts +751 -0
  616. package/src/models/operations/recipientcreatetemplaterecipients.ts +837 -0
  617. package/src/models/operations/recipientdeletedocumentrecipient.ts +79 -0
  618. package/src/models/operations/recipientdeletetemplaterecipient.ts +79 -0
  619. package/src/models/operations/recipientgetrecipient.ts +2060 -0
  620. package/src/models/operations/recipientupdatedocumentrecipient.ts +2523 -0
  621. package/src/models/operations/recipientupdatedocumentrecipients.ts +2639 -0
  622. package/src/models/operations/recipientupdatetemplaterecipient.ts +2523 -0
  623. package/src/models/operations/recipientupdatetemplaterecipients.ts +2639 -0
  624. package/src/models/operations/templatecreatedocumentfromtemplate.ts +3351 -0
  625. package/src/models/operations/templatecreatetemplatedirectlink.ts +180 -0
  626. package/src/models/operations/templatedeletetemplate.ts +69 -0
  627. package/src/models/operations/templatedeletetemplatedirectlink.ts +79 -0
  628. package/src/models/operations/templateduplicatetemplate.ts +406 -0
  629. package/src/models/operations/templatefindtemplates.ts +2831 -0
  630. package/src/models/operations/templategettemplatebyid.ts +2963 -0
  631. package/src/models/operations/templatemovetemplatetoteam.ts +418 -0
  632. package/src/models/operations/templatetoggletemplatedirectlink.ts +177 -0
  633. package/src/models/operations/templateupdatetemplate.ts +1030 -0
  634. package/src/sdk/directlink.ts +63 -0
  635. package/src/sdk/documensofields.ts +96 -0
  636. package/src/sdk/documensorecipients.ts +96 -0
  637. package/src/sdk/documensotemplatesfields.ts +96 -0
  638. package/src/sdk/documensotemplatesrecipients.ts +96 -0
  639. package/src/sdk/documents.ts +174 -0
  640. package/src/sdk/fields.ts +27 -0
  641. package/src/sdk/index.ts +5 -0
  642. package/src/sdk/recipients.ts +27 -0
  643. package/src/sdk/sdk.ts +31 -0
  644. package/src/sdk/templates.ts +143 -0
  645. package/src/types/blobs.ts +31 -0
  646. package/src/types/constdatetime.ts +15 -0
  647. package/src/types/enums.ts +16 -0
  648. package/src/types/fp.ts +50 -0
  649. package/src/types/index.ts +11 -0
  650. package/src/types/operations.ts +105 -0
  651. package/src/types/rfcdate.ts +54 -0
  652. package/src/types/streams.ts +21 -0
  653. package/tsconfig.json +41 -0
  654. package/types/blobs.d.ts +4 -0
  655. package/types/blobs.d.ts.map +1 -0
  656. package/types/blobs.js +62 -0
  657. package/types/blobs.js.map +1 -0
  658. package/types/constdatetime.d.ts +3 -0
  659. package/types/constdatetime.d.ts.map +1 -0
  660. package/types/constdatetime.js +46 -0
  661. package/types/constdatetime.js.map +1 -0
  662. package/types/enums.d.ts +12 -0
  663. package/types/enums.d.ts.map +1 -0
  664. package/types/enums.js +10 -0
  665. package/types/enums.js.map +1 -0
  666. package/types/fp.d.ts +31 -0
  667. package/types/fp.d.ts.map +1 -0
  668. package/types/fp.js +37 -0
  669. package/types/fp.js.map +1 -0
  670. package/types/index.d.ts +8 -0
  671. package/types/index.d.ts.map +1 -0
  672. package/types/index.js +16 -0
  673. package/types/index.js.map +1 -0
  674. package/types/operations.d.ts +27 -0
  675. package/types/operations.d.ts.map +1 -0
  676. package/types/operations.js +83 -0
  677. package/types/operations.js.map +1 -0
  678. package/types/rfcdate.d.ts +21 -0
  679. package/types/rfcdate.d.ts.map +1 -0
  680. package/types/rfcdate.js +46 -0
  681. package/types/rfcdate.js.map +1 -0
  682. package/types/streams.d.ts +2 -0
  683. package/types/streams.d.ts.map +1 -0
  684. package/types/streams.js +18 -0
  685. package/types/streams.js.map +1 -0
@@ -0,0 +1,724 @@
1
+ # Documents
2
+ (*documents*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [find](#find) - Find documents
9
+ * [get](#get) - Get document
10
+ * [createV0](#createv0) - Create document
11
+ * [update](#update) - Update document
12
+ * [delete](#delete) - Delete document
13
+ * [moveToTeam](#movetoteam) - Move document
14
+ * [distribute](#distribute) - Distribute document
15
+ * [redistribute](#redistribute) - Redistribute document
16
+ * [duplicate](#duplicate) - Duplicate document
17
+
18
+ ## find
19
+
20
+ Find documents based on a search criteria
21
+
22
+ ### Example Usage
23
+
24
+ ```typescript
25
+ import { Documenso } from "@documenso/sdk-typescript";
26
+
27
+ const documenso = new Documenso({
28
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
29
+ });
30
+
31
+ async function run() {
32
+ const result = await documenso.documents.find({});
33
+
34
+ // Handle the result
35
+ console.log(result);
36
+ }
37
+
38
+ run();
39
+ ```
40
+
41
+ ### Standalone function
42
+
43
+ The standalone function version of this method:
44
+
45
+ ```typescript
46
+ import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
47
+ import { documentsFind } from "@documenso/sdk-typescript/funcs/documentsFind.js";
48
+
49
+ // Use `DocumensoCore` for best tree-shaking performance.
50
+ // You can create one instance of it to use across an application.
51
+ const documenso = new DocumensoCore({
52
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
53
+ });
54
+
55
+ async function run() {
56
+ const res = await documentsFind(documenso, {});
57
+
58
+ if (!res.ok) {
59
+ throw res.error;
60
+ }
61
+
62
+ const { value: result } = res;
63
+
64
+ // Handle the result
65
+ console.log(result);
66
+ }
67
+
68
+ run();
69
+ ```
70
+
71
+ ### Parameters
72
+
73
+ | Parameter | Type | Required | Description |
74
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
75
+ | `request` | [operations.DocumentFindDocumentsRequest](../../models/operations/documentfinddocumentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
76
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
77
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
78
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
79
+
80
+ ### Response
81
+
82
+ **Promise\<[operations.DocumentFindDocumentsResponseBody](../../models/operations/documentfinddocumentsresponsebody.md)\>**
83
+
84
+ ### Errors
85
+
86
+ | Error Type | Status Code | Content Type |
87
+ | ------------------------------- | ------------------------------- | ------------------------------- |
88
+ | errors.ErrorBADREQUEST | 400 | application/json |
89
+ | errors.ErrorNOTFOUND | 404 | application/json |
90
+ | errors.Errorinternalservererror | 500 | application/json |
91
+ | errors.APIError | 4XX, 5XX | \*/\* |
92
+
93
+ ## get
94
+
95
+ Returns a document given an ID
96
+
97
+ ### Example Usage
98
+
99
+ ```typescript
100
+ import { Documenso } from "@documenso/sdk-typescript";
101
+
102
+ const documenso = new Documenso({
103
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
104
+ });
105
+
106
+ async function run() {
107
+ const result = await documenso.documents.get({
108
+ documentId: 6185.96,
109
+ });
110
+
111
+ // Handle the result
112
+ console.log(result);
113
+ }
114
+
115
+ run();
116
+ ```
117
+
118
+ ### Standalone function
119
+
120
+ The standalone function version of this method:
121
+
122
+ ```typescript
123
+ import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
124
+ import { documentsGet } from "@documenso/sdk-typescript/funcs/documentsGet.js";
125
+
126
+ // Use `DocumensoCore` for best tree-shaking performance.
127
+ // You can create one instance of it to use across an application.
128
+ const documenso = new DocumensoCore({
129
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
130
+ });
131
+
132
+ async function run() {
133
+ const res = await documentsGet(documenso, {
134
+ documentId: 6185.96,
135
+ });
136
+
137
+ if (!res.ok) {
138
+ throw res.error;
139
+ }
140
+
141
+ const { value: result } = res;
142
+
143
+ // Handle the result
144
+ console.log(result);
145
+ }
146
+
147
+ run();
148
+ ```
149
+
150
+ ### Parameters
151
+
152
+ | Parameter | Type | Required | Description |
153
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
154
+ | `request` | [operations.DocumentGetDocumentWithDetailsByIdRequest](../../models/operations/documentgetdocumentwithdetailsbyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
155
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
156
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
157
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
158
+
159
+ ### Response
160
+
161
+ **Promise\<[operations.DocumentGetDocumentWithDetailsByIdResponseBody](../../models/operations/documentgetdocumentwithdetailsbyidresponsebody.md)\>**
162
+
163
+ ### Errors
164
+
165
+ | Error Type | Status Code | Content Type |
166
+ | ------------------------------- | ------------------------------- | ------------------------------- |
167
+ | errors.ErrorBADREQUEST | 400 | application/json |
168
+ | errors.ErrorNOTFOUND | 404 | application/json |
169
+ | errors.Errorinternalservererror | 500 | application/json |
170
+ | errors.APIError | 4XX, 5XX | \*/\* |
171
+
172
+ ## createV0
173
+
174
+ You will need to upload the PDF to the provided URL returned. Note: Once V2 API is released, this will be removed since we will allow direct uploads, instead of using an upload URL.
175
+
176
+ ### Example Usage
177
+
178
+ ```typescript
179
+ import { Documenso } from "@documenso/sdk-typescript";
180
+
181
+ const documenso = new Documenso({
182
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
183
+ });
184
+
185
+ async function run() {
186
+ const result = await documenso.documents.createV0({
187
+ title: "<value>",
188
+ });
189
+
190
+ // Handle the result
191
+ console.log(result);
192
+ }
193
+
194
+ run();
195
+ ```
196
+
197
+ ### Standalone function
198
+
199
+ The standalone function version of this method:
200
+
201
+ ```typescript
202
+ import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
203
+ import { documentsCreateV0 } from "@documenso/sdk-typescript/funcs/documentsCreateV0.js";
204
+
205
+ // Use `DocumensoCore` for best tree-shaking performance.
206
+ // You can create one instance of it to use across an application.
207
+ const documenso = new DocumensoCore({
208
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
209
+ });
210
+
211
+ async function run() {
212
+ const res = await documentsCreateV0(documenso, {
213
+ title: "<value>",
214
+ });
215
+
216
+ if (!res.ok) {
217
+ throw res.error;
218
+ }
219
+
220
+ const { value: result } = res;
221
+
222
+ // Handle the result
223
+ console.log(result);
224
+ }
225
+
226
+ run();
227
+ ```
228
+
229
+ ### Parameters
230
+
231
+ | Parameter | Type | Required | Description |
232
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
233
+ | `request` | [operations.DocumentCreateDocumentTemporaryRequestBody](../../models/operations/documentcreatedocumenttemporaryrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
234
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
235
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
236
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
237
+
238
+ ### Response
239
+
240
+ **Promise\<[operations.DocumentCreateDocumentTemporaryResponseBody](../../models/operations/documentcreatedocumenttemporaryresponsebody.md)\>**
241
+
242
+ ### Errors
243
+
244
+ | Error Type | Status Code | Content Type |
245
+ | ------------------------------- | ------------------------------- | ------------------------------- |
246
+ | errors.ErrorBADREQUEST | 400 | application/json |
247
+ | errors.Errorinternalservererror | 500 | application/json |
248
+ | errors.APIError | 4XX, 5XX | \*/\* |
249
+
250
+ ## update
251
+
252
+ Update document
253
+
254
+ ### Example Usage
255
+
256
+ ```typescript
257
+ import { Documenso } from "@documenso/sdk-typescript";
258
+
259
+ const documenso = new Documenso({
260
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
261
+ });
262
+
263
+ async function run() {
264
+ const result = await documenso.documents.update({
265
+ documentId: 1694.90,
266
+ });
267
+
268
+ // Handle the result
269
+ console.log(result);
270
+ }
271
+
272
+ run();
273
+ ```
274
+
275
+ ### Standalone function
276
+
277
+ The standalone function version of this method:
278
+
279
+ ```typescript
280
+ import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
281
+ import { documentsUpdate } from "@documenso/sdk-typescript/funcs/documentsUpdate.js";
282
+
283
+ // Use `DocumensoCore` for best tree-shaking performance.
284
+ // You can create one instance of it to use across an application.
285
+ const documenso = new DocumensoCore({
286
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
287
+ });
288
+
289
+ async function run() {
290
+ const res = await documentsUpdate(documenso, {
291
+ documentId: 1694.90,
292
+ });
293
+
294
+ if (!res.ok) {
295
+ throw res.error;
296
+ }
297
+
298
+ const { value: result } = res;
299
+
300
+ // Handle the result
301
+ console.log(result);
302
+ }
303
+
304
+ run();
305
+ ```
306
+
307
+ ### Parameters
308
+
309
+ | Parameter | Type | Required | Description |
310
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
311
+ | `request` | [operations.DocumentSetSettingsForDocumentRequestBody](../../models/operations/documentsetsettingsfordocumentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
312
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
313
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
314
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
315
+
316
+ ### Response
317
+
318
+ **Promise\<[operations.DocumentSetSettingsForDocumentResponseBody](../../models/operations/documentsetsettingsfordocumentresponsebody.md)\>**
319
+
320
+ ### Errors
321
+
322
+ | Error Type | Status Code | Content Type |
323
+ | ------------------------------- | ------------------------------- | ------------------------------- |
324
+ | errors.ErrorBADREQUEST | 400 | application/json |
325
+ | errors.Errorinternalservererror | 500 | application/json |
326
+ | errors.APIError | 4XX, 5XX | \*/\* |
327
+
328
+ ## delete
329
+
330
+ Delete document
331
+
332
+ ### Example Usage
333
+
334
+ ```typescript
335
+ import { Documenso } from "@documenso/sdk-typescript";
336
+
337
+ const documenso = new Documenso({
338
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
339
+ });
340
+
341
+ async function run() {
342
+ const result = await documenso.documents.delete({
343
+ documentId: 3282.64,
344
+ });
345
+
346
+ // Handle the result
347
+ console.log(result);
348
+ }
349
+
350
+ run();
351
+ ```
352
+
353
+ ### Standalone function
354
+
355
+ The standalone function version of this method:
356
+
357
+ ```typescript
358
+ import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
359
+ import { documentsDelete } from "@documenso/sdk-typescript/funcs/documentsDelete.js";
360
+
361
+ // Use `DocumensoCore` for best tree-shaking performance.
362
+ // You can create one instance of it to use across an application.
363
+ const documenso = new DocumensoCore({
364
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
365
+ });
366
+
367
+ async function run() {
368
+ const res = await documentsDelete(documenso, {
369
+ documentId: 3282.64,
370
+ });
371
+
372
+ if (!res.ok) {
373
+ throw res.error;
374
+ }
375
+
376
+ const { value: result } = res;
377
+
378
+ // Handle the result
379
+ console.log(result);
380
+ }
381
+
382
+ run();
383
+ ```
384
+
385
+ ### Parameters
386
+
387
+ | Parameter | Type | Required | Description |
388
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
389
+ | `request` | [operations.DocumentDeleteDocumentRequestBody](../../models/operations/documentdeletedocumentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
390
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
391
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
392
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
393
+
394
+ ### Response
395
+
396
+ **Promise\<[any](../../models/.md)\>**
397
+
398
+ ### Errors
399
+
400
+ | Error Type | Status Code | Content Type |
401
+ | ------------------------------- | ------------------------------- | ------------------------------- |
402
+ | errors.ErrorBADREQUEST | 400 | application/json |
403
+ | errors.Errorinternalservererror | 500 | application/json |
404
+ | errors.APIError | 4XX, 5XX | \*/\* |
405
+
406
+ ## moveToTeam
407
+
408
+ Move a document from your personal account to a team
409
+
410
+ ### Example Usage
411
+
412
+ ```typescript
413
+ import { Documenso } from "@documenso/sdk-typescript";
414
+
415
+ const documenso = new Documenso({
416
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
417
+ });
418
+
419
+ async function run() {
420
+ const result = await documenso.documents.moveToTeam({
421
+ documentId: 1709.10,
422
+ teamId: 5536.69,
423
+ });
424
+
425
+ // Handle the result
426
+ console.log(result);
427
+ }
428
+
429
+ run();
430
+ ```
431
+
432
+ ### Standalone function
433
+
434
+ The standalone function version of this method:
435
+
436
+ ```typescript
437
+ import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
438
+ import { documentsMoveToTeam } from "@documenso/sdk-typescript/funcs/documentsMoveToTeam.js";
439
+
440
+ // Use `DocumensoCore` for best tree-shaking performance.
441
+ // You can create one instance of it to use across an application.
442
+ const documenso = new DocumensoCore({
443
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
444
+ });
445
+
446
+ async function run() {
447
+ const res = await documentsMoveToTeam(documenso, {
448
+ documentId: 1709.10,
449
+ teamId: 5536.69,
450
+ });
451
+
452
+ if (!res.ok) {
453
+ throw res.error;
454
+ }
455
+
456
+ const { value: result } = res;
457
+
458
+ // Handle the result
459
+ console.log(result);
460
+ }
461
+
462
+ run();
463
+ ```
464
+
465
+ ### Parameters
466
+
467
+ | Parameter | Type | Required | Description |
468
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
469
+ | `request` | [operations.DocumentMoveDocumentToTeamRequestBody](../../models/operations/documentmovedocumenttoteamrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
470
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
471
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
472
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
473
+
474
+ ### Response
475
+
476
+ **Promise\<[operations.DocumentMoveDocumentToTeamResponseBody](../../models/operations/documentmovedocumenttoteamresponsebody.md)\>**
477
+
478
+ ### Errors
479
+
480
+ | Error Type | Status Code | Content Type |
481
+ | ------------------------------- | ------------------------------- | ------------------------------- |
482
+ | errors.ErrorBADREQUEST | 400 | application/json |
483
+ | errors.Errorinternalservererror | 500 | application/json |
484
+ | errors.APIError | 4XX, 5XX | \*/\* |
485
+
486
+ ## distribute
487
+
488
+ Send the document out to recipients based on your distribution method
489
+
490
+ ### Example Usage
491
+
492
+ ```typescript
493
+ import { Documenso } from "@documenso/sdk-typescript";
494
+
495
+ const documenso = new Documenso({
496
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
497
+ });
498
+
499
+ async function run() {
500
+ const result = await documenso.documents.distribute({
501
+ documentId: 2400.95,
502
+ });
503
+
504
+ // Handle the result
505
+ console.log(result);
506
+ }
507
+
508
+ run();
509
+ ```
510
+
511
+ ### Standalone function
512
+
513
+ The standalone function version of this method:
514
+
515
+ ```typescript
516
+ import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
517
+ import { documentsDistribute } from "@documenso/sdk-typescript/funcs/documentsDistribute.js";
518
+
519
+ // Use `DocumensoCore` for best tree-shaking performance.
520
+ // You can create one instance of it to use across an application.
521
+ const documenso = new DocumensoCore({
522
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
523
+ });
524
+
525
+ async function run() {
526
+ const res = await documentsDistribute(documenso, {
527
+ documentId: 2400.95,
528
+ });
529
+
530
+ if (!res.ok) {
531
+ throw res.error;
532
+ }
533
+
534
+ const { value: result } = res;
535
+
536
+ // Handle the result
537
+ console.log(result);
538
+ }
539
+
540
+ run();
541
+ ```
542
+
543
+ ### Parameters
544
+
545
+ | Parameter | Type | Required | Description |
546
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
547
+ | `request` | [operations.DocumentSendDocumentRequestBody](../../models/operations/documentsenddocumentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
548
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
549
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
550
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
551
+
552
+ ### Response
553
+
554
+ **Promise\<[operations.DocumentSendDocumentResponseBody](../../models/operations/documentsenddocumentresponsebody.md)\>**
555
+
556
+ ### Errors
557
+
558
+ | Error Type | Status Code | Content Type |
559
+ | ------------------------------- | ------------------------------- | ------------------------------- |
560
+ | errors.ErrorBADREQUEST | 400 | application/json |
561
+ | errors.Errorinternalservererror | 500 | application/json |
562
+ | errors.APIError | 4XX, 5XX | \*/\* |
563
+
564
+ ## redistribute
565
+
566
+ Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document
567
+
568
+ ### Example Usage
569
+
570
+ ```typescript
571
+ import { Documenso } from "@documenso/sdk-typescript";
572
+
573
+ const documenso = new Documenso({
574
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
575
+ });
576
+
577
+ async function run() {
578
+ const result = await documenso.documents.redistribute({
579
+ documentId: 5154.74,
580
+ recipients: [
581
+ 1927.81,
582
+ ],
583
+ });
584
+
585
+ // Handle the result
586
+ console.log(result);
587
+ }
588
+
589
+ run();
590
+ ```
591
+
592
+ ### Standalone function
593
+
594
+ The standalone function version of this method:
595
+
596
+ ```typescript
597
+ import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
598
+ import { documentsRedistribute } from "@documenso/sdk-typescript/funcs/documentsRedistribute.js";
599
+
600
+ // Use `DocumensoCore` for best tree-shaking performance.
601
+ // You can create one instance of it to use across an application.
602
+ const documenso = new DocumensoCore({
603
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
604
+ });
605
+
606
+ async function run() {
607
+ const res = await documentsRedistribute(documenso, {
608
+ documentId: 5154.74,
609
+ recipients: [
610
+ 1927.81,
611
+ ],
612
+ });
613
+
614
+ if (!res.ok) {
615
+ throw res.error;
616
+ }
617
+
618
+ const { value: result } = res;
619
+
620
+ // Handle the result
621
+ console.log(result);
622
+ }
623
+
624
+ run();
625
+ ```
626
+
627
+ ### Parameters
628
+
629
+ | Parameter | Type | Required | Description |
630
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
631
+ | `request` | [operations.DocumentResendDocumentRequestBody](../../models/operations/documentresenddocumentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
632
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
633
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
634
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
635
+
636
+ ### Response
637
+
638
+ **Promise\<[any](../../models/.md)\>**
639
+
640
+ ### Errors
641
+
642
+ | Error Type | Status Code | Content Type |
643
+ | ------------------------------- | ------------------------------- | ------------------------------- |
644
+ | errors.ErrorBADREQUEST | 400 | application/json |
645
+ | errors.Errorinternalservererror | 500 | application/json |
646
+ | errors.APIError | 4XX, 5XX | \*/\* |
647
+
648
+ ## duplicate
649
+
650
+ Duplicate document
651
+
652
+ ### Example Usage
653
+
654
+ ```typescript
655
+ import { Documenso } from "@documenso/sdk-typescript";
656
+
657
+ const documenso = new Documenso({
658
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
659
+ });
660
+
661
+ async function run() {
662
+ const result = await documenso.documents.duplicate({
663
+ documentId: 8656.07,
664
+ });
665
+
666
+ // Handle the result
667
+ console.log(result);
668
+ }
669
+
670
+ run();
671
+ ```
672
+
673
+ ### Standalone function
674
+
675
+ The standalone function version of this method:
676
+
677
+ ```typescript
678
+ import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
679
+ import { documentsDuplicate } from "@documenso/sdk-typescript/funcs/documentsDuplicate.js";
680
+
681
+ // Use `DocumensoCore` for best tree-shaking performance.
682
+ // You can create one instance of it to use across an application.
683
+ const documenso = new DocumensoCore({
684
+ apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
685
+ });
686
+
687
+ async function run() {
688
+ const res = await documentsDuplicate(documenso, {
689
+ documentId: 8656.07,
690
+ });
691
+
692
+ if (!res.ok) {
693
+ throw res.error;
694
+ }
695
+
696
+ const { value: result } = res;
697
+
698
+ // Handle the result
699
+ console.log(result);
700
+ }
701
+
702
+ run();
703
+ ```
704
+
705
+ ### Parameters
706
+
707
+ | Parameter | Type | Required | Description |
708
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
709
+ | `request` | [operations.DocumentDuplicateDocumentRequestBody](../../models/operations/documentduplicatedocumentrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
710
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
711
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
712
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
713
+
714
+ ### Response
715
+
716
+ **Promise\<[operations.DocumentDuplicateDocumentResponseBody](../../models/operations/documentduplicatedocumentresponsebody.md)\>**
717
+
718
+ ### Errors
719
+
720
+ | Error Type | Status Code | Content Type |
721
+ | ------------------------------- | ------------------------------- | ------------------------------- |
722
+ | errors.ErrorBADREQUEST | 400 | application/json |
723
+ | errors.Errorinternalservererror | 500 | application/json |
724
+ | errors.APIError | 4XX, 5XX | \*/\* |