@documenso/sdk-typescript 0.1.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +1 -3
- package/README.md +252 -212
- package/bin/mcp-server.js +69045 -0
- package/bin/mcp-server.js.map +423 -0
- package/docs/sdks/directlink/README.md +21 -21
- package/docs/sdks/documents/README.md +65 -69
- package/docs/sdks/{fields → documentsfields}/README.md +45 -45
- package/docs/sdks/{recipients → documentsrecipients}/README.md +47 -47
- package/docs/sdks/templates/README.md +49 -49
- package/docs/sdks/{documensofields → templatesfields}/README.md +45 -45
- package/docs/sdks/{documensorecipients → templatesrecipients}/README.md +47 -47
- package/funcs/documentsCreateV0.d.ts +2 -1
- package/funcs/documentsCreateV0.d.ts.map +1 -1
- package/funcs/documentsCreateV0.js +13 -9
- package/funcs/documentsCreateV0.js.map +1 -1
- package/funcs/documentsDelete.d.ts +2 -1
- package/funcs/documentsDelete.d.ts.map +1 -1
- package/funcs/documentsDelete.js +13 -8
- package/funcs/documentsDelete.js.map +1 -1
- package/funcs/documentsDistribute.d.ts +2 -1
- package/funcs/documentsDistribute.d.ts.map +1 -1
- package/funcs/documentsDistribute.js +13 -8
- package/funcs/documentsDistribute.js.map +1 -1
- package/funcs/documentsDuplicate.d.ts +2 -1
- package/funcs/documentsDuplicate.d.ts.map +1 -1
- package/funcs/documentsDuplicate.js +13 -8
- package/funcs/documentsDuplicate.js.map +1 -1
- package/funcs/documentsFieldsCreate.d.ts +2 -1
- package/funcs/documentsFieldsCreate.d.ts.map +1 -1
- package/funcs/documentsFieldsCreate.js +13 -8
- package/funcs/documentsFieldsCreate.js.map +1 -1
- package/funcs/documentsFieldsCreateMany.d.ts +2 -1
- package/funcs/documentsFieldsCreateMany.d.ts.map +1 -1
- package/funcs/documentsFieldsCreateMany.js +13 -8
- package/funcs/documentsFieldsCreateMany.js.map +1 -1
- package/funcs/documentsFieldsDelete.d.ts +2 -1
- package/funcs/documentsFieldsDelete.d.ts.map +1 -1
- package/funcs/documentsFieldsDelete.js +13 -8
- package/funcs/documentsFieldsDelete.js.map +1 -1
- package/funcs/documentsFieldsGet.d.ts +2 -1
- package/funcs/documentsFieldsGet.d.ts.map +1 -1
- package/funcs/documentsFieldsGet.js +12 -7
- package/funcs/documentsFieldsGet.js.map +1 -1
- package/funcs/documentsFieldsUpdate.d.ts +2 -1
- package/funcs/documentsFieldsUpdate.d.ts.map +1 -1
- package/funcs/documentsFieldsUpdate.js +13 -8
- package/funcs/documentsFieldsUpdate.js.map +1 -1
- package/funcs/documentsFieldsUpdateMany.d.ts +2 -1
- package/funcs/documentsFieldsUpdateMany.d.ts.map +1 -1
- package/funcs/documentsFieldsUpdateMany.js +13 -8
- package/funcs/documentsFieldsUpdateMany.js.map +1 -1
- package/funcs/documentsFind.d.ts +2 -1
- package/funcs/documentsFind.d.ts.map +1 -1
- package/funcs/documentsFind.js +12 -7
- package/funcs/documentsFind.js.map +1 -1
- package/funcs/documentsGet.d.ts +2 -1
- package/funcs/documentsGet.d.ts.map +1 -1
- package/funcs/documentsGet.js +13 -7
- package/funcs/documentsGet.js.map +1 -1
- package/funcs/documentsMoveToTeam.d.ts +2 -1
- package/funcs/documentsMoveToTeam.d.ts.map +1 -1
- package/funcs/documentsMoveToTeam.js +13 -8
- package/funcs/documentsMoveToTeam.js.map +1 -1
- package/funcs/documentsRecipientsCreate.d.ts +2 -1
- package/funcs/documentsRecipientsCreate.d.ts.map +1 -1
- package/funcs/documentsRecipientsCreate.js +13 -9
- package/funcs/documentsRecipientsCreate.js.map +1 -1
- package/funcs/documentsRecipientsCreateMany.d.ts +2 -1
- package/funcs/documentsRecipientsCreateMany.d.ts.map +1 -1
- package/funcs/documentsRecipientsCreateMany.js +13 -9
- package/funcs/documentsRecipientsCreateMany.js.map +1 -1
- package/funcs/documentsRecipientsDelete.d.ts +2 -1
- package/funcs/documentsRecipientsDelete.d.ts.map +1 -1
- package/funcs/documentsRecipientsDelete.js +13 -9
- package/funcs/documentsRecipientsDelete.js.map +1 -1
- package/funcs/documentsRecipientsGet.d.ts +2 -1
- package/funcs/documentsRecipientsGet.d.ts.map +1 -1
- package/funcs/documentsRecipientsGet.js +12 -7
- package/funcs/documentsRecipientsGet.js.map +1 -1
- package/funcs/documentsRecipientsUpdate.d.ts +2 -1
- package/funcs/documentsRecipientsUpdate.d.ts.map +1 -1
- package/funcs/documentsRecipientsUpdate.js +13 -9
- package/funcs/documentsRecipientsUpdate.js.map +1 -1
- package/funcs/documentsRecipientsUpdateMany.d.ts +2 -1
- package/funcs/documentsRecipientsUpdateMany.d.ts.map +1 -1
- package/funcs/documentsRecipientsUpdateMany.js +13 -9
- package/funcs/documentsRecipientsUpdateMany.js.map +1 -1
- package/funcs/documentsRedistribute.d.ts +2 -1
- package/funcs/documentsRedistribute.d.ts.map +1 -1
- package/funcs/documentsRedistribute.js +13 -8
- package/funcs/documentsRedistribute.js.map +1 -1
- package/funcs/documentsUpdate.d.ts +2 -1
- package/funcs/documentsUpdate.d.ts.map +1 -1
- package/funcs/documentsUpdate.js +14 -9
- package/funcs/documentsUpdate.js.map +1 -1
- package/funcs/templatesDelete.d.ts +2 -1
- package/funcs/templatesDelete.d.ts.map +1 -1
- package/funcs/templatesDelete.js +13 -8
- package/funcs/templatesDelete.js.map +1 -1
- package/funcs/templatesDirectLinkCreate.d.ts +2 -1
- package/funcs/templatesDirectLinkCreate.d.ts.map +1 -1
- package/funcs/templatesDirectLinkCreate.js +13 -9
- package/funcs/templatesDirectLinkCreate.js.map +1 -1
- package/funcs/templatesDirectLinkDelete.d.ts +2 -1
- package/funcs/templatesDirectLinkDelete.d.ts.map +1 -1
- package/funcs/templatesDirectLinkDelete.js +13 -9
- package/funcs/templatesDirectLinkDelete.js.map +1 -1
- package/funcs/templatesDirectLinkToggle.d.ts +2 -1
- package/funcs/templatesDirectLinkToggle.d.ts.map +1 -1
- package/funcs/templatesDirectLinkToggle.js +13 -9
- package/funcs/templatesDirectLinkToggle.js.map +1 -1
- package/funcs/templatesDuplicate.d.ts +2 -1
- package/funcs/templatesDuplicate.d.ts.map +1 -1
- package/funcs/templatesDuplicate.js +13 -8
- package/funcs/templatesDuplicate.js.map +1 -1
- package/funcs/templatesFieldsCreate.d.ts +2 -1
- package/funcs/templatesFieldsCreate.d.ts.map +1 -1
- package/funcs/templatesFieldsCreate.js +13 -8
- package/funcs/templatesFieldsCreate.js.map +1 -1
- package/funcs/templatesFieldsCreateMany.d.ts +2 -1
- package/funcs/templatesFieldsCreateMany.d.ts.map +1 -1
- package/funcs/templatesFieldsCreateMany.js +13 -8
- package/funcs/templatesFieldsCreateMany.js.map +1 -1
- package/funcs/templatesFieldsDelete.d.ts +2 -1
- package/funcs/templatesFieldsDelete.d.ts.map +1 -1
- package/funcs/templatesFieldsDelete.js +13 -8
- package/funcs/templatesFieldsDelete.js.map +1 -1
- package/funcs/templatesFieldsGet.d.ts +2 -1
- package/funcs/templatesFieldsGet.d.ts.map +1 -1
- package/funcs/templatesFieldsGet.js +12 -7
- package/funcs/templatesFieldsGet.js.map +1 -1
- package/funcs/templatesFieldsUpdate.d.ts +2 -1
- package/funcs/templatesFieldsUpdate.d.ts.map +1 -1
- package/funcs/templatesFieldsUpdate.js +13 -8
- package/funcs/templatesFieldsUpdate.js.map +1 -1
- package/funcs/templatesFieldsUpdateMany.d.ts +2 -1
- package/funcs/templatesFieldsUpdateMany.d.ts.map +1 -1
- package/funcs/templatesFieldsUpdateMany.js +13 -8
- package/funcs/templatesFieldsUpdateMany.js.map +1 -1
- package/funcs/templatesFind.d.ts +2 -1
- package/funcs/templatesFind.d.ts.map +1 -1
- package/funcs/templatesFind.js +12 -7
- package/funcs/templatesFind.js.map +1 -1
- package/funcs/templatesGet.d.ts +2 -1
- package/funcs/templatesGet.d.ts.map +1 -1
- package/funcs/templatesGet.js +12 -7
- package/funcs/templatesGet.js.map +1 -1
- package/funcs/templatesMoveToTeam.d.ts +2 -1
- package/funcs/templatesMoveToTeam.d.ts.map +1 -1
- package/funcs/templatesMoveToTeam.js +13 -8
- package/funcs/templatesMoveToTeam.js.map +1 -1
- package/funcs/templatesRecipientsCreate.d.ts +2 -1
- package/funcs/templatesRecipientsCreate.d.ts.map +1 -1
- package/funcs/templatesRecipientsCreate.js +13 -9
- package/funcs/templatesRecipientsCreate.js.map +1 -1
- package/funcs/templatesRecipientsCreateMany.d.ts +2 -1
- package/funcs/templatesRecipientsCreateMany.d.ts.map +1 -1
- package/funcs/templatesRecipientsCreateMany.js +13 -9
- package/funcs/templatesRecipientsCreateMany.js.map +1 -1
- package/funcs/templatesRecipientsDelete.d.ts +2 -1
- package/funcs/templatesRecipientsDelete.d.ts.map +1 -1
- package/funcs/templatesRecipientsDelete.js +13 -9
- package/funcs/templatesRecipientsDelete.js.map +1 -1
- package/funcs/templatesRecipientsGet.d.ts +2 -1
- package/funcs/templatesRecipientsGet.d.ts.map +1 -1
- package/funcs/templatesRecipientsGet.js +12 -7
- package/funcs/templatesRecipientsGet.js.map +1 -1
- package/funcs/templatesRecipientsUpdate.d.ts +2 -1
- package/funcs/templatesRecipientsUpdate.d.ts.map +1 -1
- package/funcs/templatesRecipientsUpdate.js +13 -9
- package/funcs/templatesRecipientsUpdate.js.map +1 -1
- package/funcs/templatesRecipientsUpdateMany.d.ts +2 -1
- package/funcs/templatesRecipientsUpdateMany.d.ts.map +1 -1
- package/funcs/templatesRecipientsUpdateMany.js +13 -9
- package/funcs/templatesRecipientsUpdateMany.js.map +1 -1
- package/funcs/templatesUpdate.d.ts +2 -1
- package/funcs/templatesUpdate.d.ts.map +1 -1
- package/funcs/templatesUpdate.js +13 -8
- package/funcs/templatesUpdate.js.map +1 -1
- package/funcs/templatesUse.d.ts +2 -1
- package/funcs/templatesUse.d.ts.map +1 -1
- package/funcs/templatesUse.js +14 -9
- package/funcs/templatesUse.js.map +1 -1
- package/hooks/hooks.d.ts.map +1 -1
- package/hooks/hooks.js +0 -2
- package/hooks/hooks.js.map +1 -1
- package/hooks/types.d.ts +2 -1
- package/hooks/types.d.ts.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +6 -6
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/files.js.map +1 -1
- package/lib/primitives.d.ts +3 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +7 -0
- package/lib/primitives.js.map +1 -1
- package/lib/retries.js +0 -1
- package/lib/retries.js.map +1 -1
- package/lib/sdks.d.ts +1 -1
- package/lib/sdks.d.ts.map +1 -1
- package/lib/sdks.js +2 -8
- package/lib/sdks.js.map +1 -1
- package/lib/security.d.ts +4 -3
- package/lib/security.d.ts.map +1 -1
- package/lib/security.js +6 -1
- package/lib/security.js.map +1 -1
- package/mcp-server/build.d.mts.map +1 -0
- package/mcp-server/build.mjs +14 -0
- package/mcp-server/build.mjs.map +1 -0
- package/mcp-server/cli/start/command.d.ts +2 -0
- package/mcp-server/cli/start/command.d.ts.map +1 -0
- package/mcp-server/cli/start/command.js +138 -0
- package/mcp-server/cli/start/command.js.map +1 -0
- package/mcp-server/cli/start/impl.d.ts +18 -0
- package/mcp-server/cli/start/impl.d.ts.map +1 -0
- package/mcp-server/cli/start/impl.js +104 -0
- package/mcp-server/cli/start/impl.js.map +1 -0
- package/mcp-server/cli.d.ts +6 -0
- package/mcp-server/cli.d.ts.map +1 -0
- package/mcp-server/cli.js +10 -0
- package/mcp-server/cli.js.map +1 -0
- package/mcp-server/console-logger.d.ts +7 -0
- package/mcp-server/console-logger.d.ts.map +1 -0
- package/mcp-server/console-logger.js +59 -0
- package/mcp-server/console-logger.js.map +1 -0
- package/mcp-server/extensions.d.ts +11 -0
- package/mcp-server/extensions.d.ts.map +1 -0
- package/mcp-server/extensions.js +6 -0
- package/mcp-server/extensions.js.map +1 -0
- package/mcp-server/mcp-server.d.ts +2 -0
- package/mcp-server/mcp-server.d.ts.map +1 -0
- package/mcp-server/mcp-server.js +29 -0
- package/mcp-server/mcp-server.js.map +1 -0
- package/mcp-server/prompts.d.ts +26 -0
- package/mcp-server/prompts.d.ts.map +1 -0
- package/mcp-server/prompts.js +51 -0
- package/mcp-server/prompts.js.map +1 -0
- package/mcp-server/resources.d.ts +32 -0
- package/mcp-server/resources.d.ts.map +1 -0
- package/mcp-server/resources.js +87 -0
- package/mcp-server/resources.js.map +1 -0
- package/mcp-server/scopes.d.ts +3 -0
- package/mcp-server/scopes.d.ts.map +1 -0
- package/mcp-server/scopes.js +8 -0
- package/mcp-server/scopes.js.map +1 -0
- package/mcp-server/server.d.ts +13 -0
- package/mcp-server/server.d.ts.map +1 -0
- package/mcp-server/server.js +118 -0
- package/mcp-server/server.js.map +1 -0
- package/mcp-server/shared.d.ts +7 -0
- package/mcp-server/shared.d.ts.map +1 -0
- package/mcp-server/shared.js +98 -0
- package/mcp-server/shared.js.map +1 -0
- package/mcp-server/tools/documentsCreateV0.d.ts +8 -0
- package/mcp-server/tools/documentsCreateV0.d.ts.map +1 -0
- package/mcp-server/tools/documentsCreateV0.js +64 -0
- package/mcp-server/tools/documentsCreateV0.js.map +1 -0
- package/mcp-server/tools/documentsDelete.d.ts +8 -0
- package/mcp-server/tools/documentsDelete.d.ts.map +1 -0
- package/mcp-server/tools/documentsDelete.js +62 -0
- package/mcp-server/tools/documentsDelete.js.map +1 -0
- package/mcp-server/tools/documentsDistribute.d.ts +8 -0
- package/mcp-server/tools/documentsDistribute.d.ts.map +1 -0
- package/mcp-server/tools/documentsDistribute.js +64 -0
- package/mcp-server/tools/documentsDistribute.js.map +1 -0
- package/mcp-server/tools/documentsDuplicate.d.ts +8 -0
- package/mcp-server/tools/documentsDuplicate.d.ts.map +1 -0
- package/mcp-server/tools/documentsDuplicate.js +62 -0
- package/mcp-server/tools/documentsDuplicate.js.map +1 -0
- package/mcp-server/tools/documentsFieldsCreate.d.ts +8 -0
- package/mcp-server/tools/documentsFieldsCreate.d.ts.map +1 -0
- package/mcp-server/tools/documentsFieldsCreate.js +64 -0
- package/mcp-server/tools/documentsFieldsCreate.js.map +1 -0
- package/mcp-server/tools/documentsFieldsCreateMany.d.ts +8 -0
- package/mcp-server/tools/documentsFieldsCreateMany.d.ts.map +1 -0
- package/mcp-server/tools/documentsFieldsCreateMany.js +64 -0
- package/mcp-server/tools/documentsFieldsCreateMany.js.map +1 -0
- package/mcp-server/tools/documentsFieldsDelete.d.ts +8 -0
- package/mcp-server/tools/documentsFieldsDelete.d.ts.map +1 -0
- package/mcp-server/tools/documentsFieldsDelete.js +62 -0
- package/mcp-server/tools/documentsFieldsDelete.js.map +1 -0
- package/mcp-server/tools/documentsFieldsGet.d.ts +8 -0
- package/mcp-server/tools/documentsFieldsGet.d.ts.map +1 -0
- package/mcp-server/tools/documentsFieldsGet.js +64 -0
- package/mcp-server/tools/documentsFieldsGet.js.map +1 -0
- package/mcp-server/tools/documentsFieldsUpdate.d.ts +8 -0
- package/mcp-server/tools/documentsFieldsUpdate.d.ts.map +1 -0
- package/mcp-server/tools/documentsFieldsUpdate.js +64 -0
- package/mcp-server/tools/documentsFieldsUpdate.js.map +1 -0
- package/mcp-server/tools/documentsFieldsUpdateMany.d.ts +8 -0
- package/mcp-server/tools/documentsFieldsUpdateMany.d.ts.map +1 -0
- package/mcp-server/tools/documentsFieldsUpdateMany.js +64 -0
- package/mcp-server/tools/documentsFieldsUpdateMany.js.map +1 -0
- package/mcp-server/tools/documentsFind.d.ts +8 -0
- package/mcp-server/tools/documentsFind.d.ts.map +1 -0
- package/mcp-server/tools/documentsFind.js +64 -0
- package/mcp-server/tools/documentsFind.js.map +1 -0
- package/mcp-server/tools/documentsGet.d.ts +8 -0
- package/mcp-server/tools/documentsGet.d.ts.map +1 -0
- package/mcp-server/tools/documentsGet.js +64 -0
- package/mcp-server/tools/documentsGet.js.map +1 -0
- package/mcp-server/tools/documentsMoveToTeam.d.ts +8 -0
- package/mcp-server/tools/documentsMoveToTeam.d.ts.map +1 -0
- package/mcp-server/tools/documentsMoveToTeam.js +64 -0
- package/mcp-server/tools/documentsMoveToTeam.js.map +1 -0
- package/mcp-server/tools/documentsRecipientsCreate.d.ts +8 -0
- package/mcp-server/tools/documentsRecipientsCreate.d.ts.map +1 -0
- package/mcp-server/tools/documentsRecipientsCreate.js +64 -0
- package/mcp-server/tools/documentsRecipientsCreate.js.map +1 -0
- package/mcp-server/tools/documentsRecipientsCreateMany.d.ts +8 -0
- package/mcp-server/tools/documentsRecipientsCreateMany.d.ts.map +1 -0
- package/mcp-server/tools/documentsRecipientsCreateMany.js +64 -0
- package/mcp-server/tools/documentsRecipientsCreateMany.js.map +1 -0
- package/mcp-server/tools/documentsRecipientsDelete.d.ts +8 -0
- package/mcp-server/tools/documentsRecipientsDelete.d.ts.map +1 -0
- package/mcp-server/tools/documentsRecipientsDelete.js +62 -0
- package/mcp-server/tools/documentsRecipientsDelete.js.map +1 -0
- package/mcp-server/tools/documentsRecipientsGet.d.ts +8 -0
- package/mcp-server/tools/documentsRecipientsGet.d.ts.map +1 -0
- package/mcp-server/tools/documentsRecipientsGet.js +64 -0
- package/mcp-server/tools/documentsRecipientsGet.js.map +1 -0
- package/mcp-server/tools/documentsRecipientsUpdate.d.ts +8 -0
- package/mcp-server/tools/documentsRecipientsUpdate.d.ts.map +1 -0
- package/mcp-server/tools/documentsRecipientsUpdate.js +64 -0
- package/mcp-server/tools/documentsRecipientsUpdate.js.map +1 -0
- package/mcp-server/tools/documentsRecipientsUpdateMany.d.ts +8 -0
- package/mcp-server/tools/documentsRecipientsUpdateMany.d.ts.map +1 -0
- package/mcp-server/tools/documentsRecipientsUpdateMany.js +64 -0
- package/mcp-server/tools/documentsRecipientsUpdateMany.js.map +1 -0
- package/mcp-server/tools/documentsRedistribute.d.ts +8 -0
- package/mcp-server/tools/documentsRedistribute.d.ts.map +1 -0
- package/mcp-server/tools/documentsRedistribute.js +64 -0
- package/mcp-server/tools/documentsRedistribute.js.map +1 -0
- package/mcp-server/tools/documentsUpdate.d.ts +8 -0
- package/mcp-server/tools/documentsUpdate.d.ts.map +1 -0
- package/mcp-server/tools/documentsUpdate.js +62 -0
- package/mcp-server/tools/documentsUpdate.js.map +1 -0
- package/mcp-server/tools/templatesDelete.d.ts +8 -0
- package/mcp-server/tools/templatesDelete.d.ts.map +1 -0
- package/mcp-server/tools/templatesDelete.js +62 -0
- package/mcp-server/tools/templatesDelete.js.map +1 -0
- package/mcp-server/tools/templatesDirectLinkCreate.d.ts +8 -0
- package/mcp-server/tools/templatesDirectLinkCreate.d.ts.map +1 -0
- package/mcp-server/tools/templatesDirectLinkCreate.js +64 -0
- package/mcp-server/tools/templatesDirectLinkCreate.js.map +1 -0
- package/mcp-server/tools/templatesDirectLinkDelete.d.ts +8 -0
- package/mcp-server/tools/templatesDirectLinkDelete.d.ts.map +1 -0
- package/mcp-server/tools/templatesDirectLinkDelete.js +64 -0
- package/mcp-server/tools/templatesDirectLinkDelete.js.map +1 -0
- package/mcp-server/tools/templatesDirectLinkToggle.d.ts +8 -0
- package/mcp-server/tools/templatesDirectLinkToggle.d.ts.map +1 -0
- package/mcp-server/tools/templatesDirectLinkToggle.js +64 -0
- package/mcp-server/tools/templatesDirectLinkToggle.js.map +1 -0
- package/mcp-server/tools/templatesDuplicate.d.ts +8 -0
- package/mcp-server/tools/templatesDuplicate.d.ts.map +1 -0
- package/mcp-server/tools/templatesDuplicate.js +62 -0
- package/mcp-server/tools/templatesDuplicate.js.map +1 -0
- package/mcp-server/tools/templatesFieldsCreate.d.ts +8 -0
- package/mcp-server/tools/templatesFieldsCreate.d.ts.map +1 -0
- package/mcp-server/tools/templatesFieldsCreate.js +64 -0
- package/mcp-server/tools/templatesFieldsCreate.js.map +1 -0
- package/mcp-server/tools/templatesFieldsCreateMany.d.ts +8 -0
- package/mcp-server/tools/templatesFieldsCreateMany.d.ts.map +1 -0
- package/mcp-server/tools/templatesFieldsCreateMany.js +64 -0
- package/mcp-server/tools/templatesFieldsCreateMany.js.map +1 -0
- package/mcp-server/tools/templatesFieldsDelete.d.ts +8 -0
- package/mcp-server/tools/templatesFieldsDelete.d.ts.map +1 -0
- package/mcp-server/tools/templatesFieldsDelete.js +62 -0
- package/mcp-server/tools/templatesFieldsDelete.js.map +1 -0
- package/mcp-server/tools/templatesFieldsGet.d.ts +8 -0
- package/mcp-server/tools/templatesFieldsGet.d.ts.map +1 -0
- package/mcp-server/tools/templatesFieldsGet.js +64 -0
- package/mcp-server/tools/templatesFieldsGet.js.map +1 -0
- package/mcp-server/tools/templatesFieldsUpdate.d.ts +8 -0
- package/mcp-server/tools/templatesFieldsUpdate.d.ts.map +1 -0
- package/mcp-server/tools/templatesFieldsUpdate.js +64 -0
- package/mcp-server/tools/templatesFieldsUpdate.js.map +1 -0
- package/mcp-server/tools/templatesFieldsUpdateMany.d.ts +8 -0
- package/mcp-server/tools/templatesFieldsUpdateMany.d.ts.map +1 -0
- package/mcp-server/tools/templatesFieldsUpdateMany.js +64 -0
- package/mcp-server/tools/templatesFieldsUpdateMany.js.map +1 -0
- package/mcp-server/tools/templatesFind.d.ts +8 -0
- package/mcp-server/tools/templatesFind.d.ts.map +1 -0
- package/mcp-server/tools/templatesFind.js +64 -0
- package/mcp-server/tools/templatesFind.js.map +1 -0
- package/mcp-server/tools/templatesGet.d.ts +8 -0
- package/mcp-server/tools/templatesGet.d.ts.map +1 -0
- package/mcp-server/tools/templatesGet.js +62 -0
- package/mcp-server/tools/templatesGet.js.map +1 -0
- package/mcp-server/tools/templatesMoveToTeam.d.ts +8 -0
- package/mcp-server/tools/templatesMoveToTeam.d.ts.map +1 -0
- package/mcp-server/tools/templatesMoveToTeam.js +64 -0
- package/mcp-server/tools/templatesMoveToTeam.js.map +1 -0
- package/mcp-server/tools/templatesRecipientsCreate.d.ts +8 -0
- package/mcp-server/tools/templatesRecipientsCreate.d.ts.map +1 -0
- package/mcp-server/tools/templatesRecipientsCreate.js +64 -0
- package/mcp-server/tools/templatesRecipientsCreate.js.map +1 -0
- package/mcp-server/tools/templatesRecipientsCreateMany.d.ts +8 -0
- package/mcp-server/tools/templatesRecipientsCreateMany.d.ts.map +1 -0
- package/mcp-server/tools/templatesRecipientsCreateMany.js +64 -0
- package/mcp-server/tools/templatesRecipientsCreateMany.js.map +1 -0
- package/mcp-server/tools/templatesRecipientsDelete.d.ts +8 -0
- package/mcp-server/tools/templatesRecipientsDelete.d.ts.map +1 -0
- package/mcp-server/tools/templatesRecipientsDelete.js +62 -0
- package/mcp-server/tools/templatesRecipientsDelete.js.map +1 -0
- package/mcp-server/tools/templatesRecipientsGet.d.ts +8 -0
- package/mcp-server/tools/templatesRecipientsGet.d.ts.map +1 -0
- package/mcp-server/tools/templatesRecipientsGet.js +64 -0
- package/mcp-server/tools/templatesRecipientsGet.js.map +1 -0
- package/mcp-server/tools/templatesRecipientsUpdate.d.ts +8 -0
- package/mcp-server/tools/templatesRecipientsUpdate.d.ts.map +1 -0
- package/mcp-server/tools/templatesRecipientsUpdate.js +64 -0
- package/mcp-server/tools/templatesRecipientsUpdate.js.map +1 -0
- package/mcp-server/tools/templatesRecipientsUpdateMany.d.ts +8 -0
- package/mcp-server/tools/templatesRecipientsUpdateMany.d.ts.map +1 -0
- package/mcp-server/tools/templatesRecipientsUpdateMany.js +64 -0
- package/mcp-server/tools/templatesRecipientsUpdateMany.js.map +1 -0
- package/mcp-server/tools/templatesUpdate.d.ts +8 -0
- package/mcp-server/tools/templatesUpdate.d.ts.map +1 -0
- package/mcp-server/tools/templatesUpdate.js +62 -0
- package/mcp-server/tools/templatesUpdate.js.map +1 -0
- package/mcp-server/tools/templatesUse.d.ts +8 -0
- package/mcp-server/tools/templatesUse.d.ts.map +1 -0
- package/mcp-server/tools/templatesUse.js +64 -0
- package/mcp-server/tools/templatesUse.js.map +1 -0
- package/mcp-server/tools.d.ts +25 -0
- package/mcp-server/tools.d.ts.map +1 -0
- package/mcp-server/tools.js +82 -0
- package/mcp-server/tools.js.map +1 -0
- package/models/errors/documentcreatedocumenttemporary.d.ts +134 -0
- package/models/errors/documentcreatedocumenttemporary.d.ts.map +1 -0
- package/models/errors/documentcreatedocumenttemporary.js +188 -0
- package/models/errors/documentcreatedocumenttemporary.js.map +1 -0
- package/models/errors/documentdeletedocument.d.ts +134 -0
- package/models/errors/documentdeletedocument.d.ts.map +1 -0
- package/models/errors/documentdeletedocument.js +186 -0
- package/models/errors/documentdeletedocument.js.map +1 -0
- package/models/errors/documentduplicatedocument.d.ts +134 -0
- package/models/errors/documentduplicatedocument.d.ts.map +1 -0
- package/models/errors/documentduplicatedocument.js +186 -0
- package/models/errors/documentduplicatedocument.js.map +1 -0
- package/models/errors/documentfinddocuments.d.ts +199 -0
- package/models/errors/documentfinddocuments.d.ts.map +1 -0
- package/models/errors/documentfinddocuments.js +258 -0
- package/models/errors/documentfinddocuments.js.map +1 -0
- package/models/errors/documentgetdocumentwithdetailsbyid.d.ts +199 -0
- package/models/errors/documentgetdocumentwithdetailsbyid.d.ts.map +1 -0
- package/models/errors/documentgetdocumentwithdetailsbyid.js +260 -0
- package/models/errors/documentgetdocumentwithdetailsbyid.js.map +1 -0
- package/models/errors/documentmovedocumenttoteam.d.ts +134 -0
- package/models/errors/documentmovedocumenttoteam.d.ts.map +1 -0
- package/models/errors/documentmovedocumenttoteam.js +186 -0
- package/models/errors/documentmovedocumenttoteam.js.map +1 -0
- package/models/errors/documentresenddocument.d.ts +134 -0
- package/models/errors/documentresenddocument.d.ts.map +1 -0
- package/models/errors/documentresenddocument.js +186 -0
- package/models/errors/documentresenddocument.js.map +1 -0
- package/models/errors/documentsenddocument.d.ts +134 -0
- package/models/errors/documentsenddocument.d.ts.map +1 -0
- package/models/errors/documentsenddocument.js +186 -0
- package/models/errors/documentsenddocument.js.map +1 -0
- package/models/errors/documentupdatedocument.d.ts +134 -0
- package/models/errors/documentupdatedocument.d.ts.map +1 -0
- package/models/errors/documentupdatedocument.js +186 -0
- package/models/errors/documentupdatedocument.js.map +1 -0
- package/models/errors/fieldcreatedocumentfield.d.ts +134 -0
- package/models/errors/fieldcreatedocumentfield.d.ts.map +1 -0
- package/models/errors/fieldcreatedocumentfield.js +186 -0
- package/models/errors/fieldcreatedocumentfield.js.map +1 -0
- package/models/errors/fieldcreatedocumentfields.d.ts +134 -0
- package/models/errors/fieldcreatedocumentfields.d.ts.map +1 -0
- package/models/errors/fieldcreatedocumentfields.js +186 -0
- package/models/errors/fieldcreatedocumentfields.js.map +1 -0
- package/models/errors/fieldcreatetemplatefield.d.ts +134 -0
- package/models/errors/fieldcreatetemplatefield.d.ts.map +1 -0
- package/models/errors/fieldcreatetemplatefield.js +186 -0
- package/models/errors/fieldcreatetemplatefield.js.map +1 -0
- package/models/errors/fieldcreatetemplatefields.d.ts +134 -0
- package/models/errors/fieldcreatetemplatefields.d.ts.map +1 -0
- package/models/errors/fieldcreatetemplatefields.js +186 -0
- package/models/errors/fieldcreatetemplatefields.js.map +1 -0
- package/models/errors/fielddeletedocumentfield.d.ts +134 -0
- package/models/errors/fielddeletedocumentfield.d.ts.map +1 -0
- package/models/errors/fielddeletedocumentfield.js +186 -0
- package/models/errors/fielddeletedocumentfield.js.map +1 -0
- package/models/errors/fielddeletetemplatefield.d.ts +134 -0
- package/models/errors/fielddeletetemplatefield.d.ts.map +1 -0
- package/models/errors/fielddeletetemplatefield.js +186 -0
- package/models/errors/fielddeletetemplatefield.js.map +1 -0
- package/models/errors/fieldgetdocumentfield.d.ts +199 -0
- package/models/errors/fieldgetdocumentfield.d.ts.map +1 -0
- package/models/errors/fieldgetdocumentfield.js +258 -0
- package/models/errors/fieldgetdocumentfield.js.map +1 -0
- package/models/errors/fieldgettemplatefield.d.ts +199 -0
- package/models/errors/fieldgettemplatefield.d.ts.map +1 -0
- package/models/errors/fieldgettemplatefield.js +258 -0
- package/models/errors/fieldgettemplatefield.js.map +1 -0
- package/models/errors/fieldupdatedocumentfield.d.ts +134 -0
- package/models/errors/fieldupdatedocumentfield.d.ts.map +1 -0
- package/models/errors/fieldupdatedocumentfield.js +186 -0
- package/models/errors/fieldupdatedocumentfield.js.map +1 -0
- package/models/errors/fieldupdatedocumentfields.d.ts +134 -0
- package/models/errors/fieldupdatedocumentfields.d.ts.map +1 -0
- package/models/errors/fieldupdatedocumentfields.js +186 -0
- package/models/errors/fieldupdatedocumentfields.js.map +1 -0
- package/models/errors/fieldupdatetemplatefield.d.ts +134 -0
- package/models/errors/fieldupdatetemplatefield.d.ts.map +1 -0
- package/models/errors/fieldupdatetemplatefield.js +186 -0
- package/models/errors/fieldupdatetemplatefield.js.map +1 -0
- package/models/errors/fieldupdatetemplatefields.d.ts +134 -0
- package/models/errors/fieldupdatetemplatefields.d.ts.map +1 -0
- package/models/errors/fieldupdatetemplatefields.js +186 -0
- package/models/errors/fieldupdatetemplatefields.js.map +1 -0
- package/models/errors/index.d.ts +43 -3
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +43 -3
- package/models/errors/index.js.map +1 -1
- package/models/errors/recipientcreatedocumentrecipient.d.ts +134 -0
- package/models/errors/recipientcreatedocumentrecipient.d.ts.map +1 -0
- package/models/errors/recipientcreatedocumentrecipient.js +188 -0
- package/models/errors/recipientcreatedocumentrecipient.js.map +1 -0
- package/models/errors/recipientcreatedocumentrecipients.d.ts +134 -0
- package/models/errors/recipientcreatedocumentrecipients.d.ts.map +1 -0
- package/models/errors/recipientcreatedocumentrecipients.js +188 -0
- package/models/errors/recipientcreatedocumentrecipients.js.map +1 -0
- package/models/errors/recipientcreatetemplaterecipient.d.ts +134 -0
- package/models/errors/recipientcreatetemplaterecipient.d.ts.map +1 -0
- package/models/errors/recipientcreatetemplaterecipient.js +188 -0
- package/models/errors/recipientcreatetemplaterecipient.js.map +1 -0
- package/models/errors/recipientcreatetemplaterecipients.d.ts +134 -0
- package/models/errors/recipientcreatetemplaterecipients.d.ts.map +1 -0
- package/models/errors/recipientcreatetemplaterecipients.js +188 -0
- package/models/errors/recipientcreatetemplaterecipients.js.map +1 -0
- package/models/errors/recipientdeletedocumentrecipient.d.ts +134 -0
- package/models/errors/recipientdeletedocumentrecipient.d.ts.map +1 -0
- package/models/errors/recipientdeletedocumentrecipient.js +188 -0
- package/models/errors/recipientdeletedocumentrecipient.js.map +1 -0
- package/models/errors/recipientdeletetemplaterecipient.d.ts +134 -0
- package/models/errors/recipientdeletetemplaterecipient.d.ts.map +1 -0
- package/models/errors/recipientdeletetemplaterecipient.js +188 -0
- package/models/errors/recipientdeletetemplaterecipient.js.map +1 -0
- package/models/errors/recipientgetdocumentrecipient.d.ts +199 -0
- package/models/errors/recipientgetdocumentrecipient.d.ts.map +1 -0
- package/models/errors/recipientgetdocumentrecipient.js +258 -0
- package/models/errors/recipientgetdocumentrecipient.js.map +1 -0
- package/models/errors/recipientgettemplaterecipient.d.ts +199 -0
- package/models/errors/recipientgettemplaterecipient.d.ts.map +1 -0
- package/models/errors/recipientgettemplaterecipient.js +258 -0
- package/models/errors/recipientgettemplaterecipient.js.map +1 -0
- package/models/errors/recipientupdatedocumentrecipient.d.ts +134 -0
- package/models/errors/recipientupdatedocumentrecipient.d.ts.map +1 -0
- package/models/errors/recipientupdatedocumentrecipient.js +188 -0
- package/models/errors/recipientupdatedocumentrecipient.js.map +1 -0
- package/models/errors/recipientupdatedocumentrecipients.d.ts +134 -0
- package/models/errors/recipientupdatedocumentrecipients.d.ts.map +1 -0
- package/models/errors/recipientupdatedocumentrecipients.js +188 -0
- package/models/errors/recipientupdatedocumentrecipients.js.map +1 -0
- package/models/errors/recipientupdatetemplaterecipient.d.ts +134 -0
- package/models/errors/recipientupdatetemplaterecipient.d.ts.map +1 -0
- package/models/errors/recipientupdatetemplaterecipient.js +188 -0
- package/models/errors/recipientupdatetemplaterecipient.js.map +1 -0
- package/models/errors/recipientupdatetemplaterecipients.d.ts +134 -0
- package/models/errors/recipientupdatetemplaterecipients.d.ts.map +1 -0
- package/models/errors/recipientupdatetemplaterecipients.js +188 -0
- package/models/errors/recipientupdatetemplaterecipients.js.map +1 -0
- package/models/errors/templatecreatedocumentfromtemplate.d.ts +134 -0
- package/models/errors/templatecreatedocumentfromtemplate.d.ts.map +1 -0
- package/models/errors/templatecreatedocumentfromtemplate.js +188 -0
- package/models/errors/templatecreatedocumentfromtemplate.js.map +1 -0
- package/models/errors/templatecreatetemplatedirectlink.d.ts +134 -0
- package/models/errors/templatecreatetemplatedirectlink.d.ts.map +1 -0
- package/models/errors/templatecreatetemplatedirectlink.js +188 -0
- package/models/errors/templatecreatetemplatedirectlink.js.map +1 -0
- package/models/errors/templatedeletetemplate.d.ts +134 -0
- package/models/errors/templatedeletetemplate.d.ts.map +1 -0
- package/models/errors/templatedeletetemplate.js +186 -0
- package/models/errors/templatedeletetemplate.js.map +1 -0
- package/models/errors/templatedeletetemplatedirectlink.d.ts +134 -0
- package/models/errors/templatedeletetemplatedirectlink.d.ts.map +1 -0
- package/models/errors/templatedeletetemplatedirectlink.js +188 -0
- package/models/errors/templatedeletetemplatedirectlink.js.map +1 -0
- package/models/errors/templateduplicatetemplate.d.ts +134 -0
- package/models/errors/templateduplicatetemplate.d.ts.map +1 -0
- package/models/errors/templateduplicatetemplate.js +186 -0
- package/models/errors/templateduplicatetemplate.js.map +1 -0
- package/models/errors/templatefindtemplates.d.ts +199 -0
- package/models/errors/templatefindtemplates.d.ts.map +1 -0
- package/models/errors/templatefindtemplates.js +258 -0
- package/models/errors/templatefindtemplates.js.map +1 -0
- package/models/errors/templategettemplatebyid.d.ts +199 -0
- package/models/errors/templategettemplatebyid.d.ts.map +1 -0
- package/models/errors/templategettemplatebyid.js +258 -0
- package/models/errors/templategettemplatebyid.js.map +1 -0
- package/models/errors/templatemovetemplatetoteam.d.ts +134 -0
- package/models/errors/templatemovetemplatetoteam.d.ts.map +1 -0
- package/models/errors/templatemovetemplatetoteam.js +186 -0
- package/models/errors/templatemovetemplatetoteam.js.map +1 -0
- package/models/errors/templatetoggletemplatedirectlink.d.ts +134 -0
- package/models/errors/templatetoggletemplatedirectlink.d.ts.map +1 -0
- package/models/errors/templatetoggletemplatedirectlink.js +188 -0
- package/models/errors/templatetoggletemplatedirectlink.js.map +1 -0
- package/models/errors/templateupdatetemplate.d.ts +134 -0
- package/models/errors/templateupdatetemplate.d.ts.map +1 -0
- package/models/errors/templateupdatetemplate.js +186 -0
- package/models/errors/templateupdatetemplate.js.map +1 -0
- package/models/operations/documentcreatedocumenttemporary.d.ts +1455 -1064
- package/models/operations/documentcreatedocumenttemporary.d.ts.map +1 -1
- package/models/operations/documentcreatedocumenttemporary.js +1752 -1513
- package/models/operations/documentcreatedocumenttemporary.js.map +1 -1
- package/models/operations/documentdeletedocument.d.ts +26 -26
- package/models/operations/documentdeletedocument.d.ts.map +1 -1
- package/models/operations/documentdeletedocument.js +31 -31
- package/models/operations/documentdeletedocument.js.map +1 -1
- package/models/operations/documentduplicatedocument.d.ts +26 -26
- package/models/operations/documentduplicatedocument.d.ts.map +1 -1
- package/models/operations/documentduplicatedocument.js +31 -31
- package/models/operations/documentduplicatedocument.js.map +1 -1
- package/models/operations/documentfinddocuments.d.ts +99 -90
- package/models/operations/documentfinddocuments.d.ts.map +1 -1
- package/models/operations/documentfinddocuments.js +141 -139
- package/models/operations/documentfinddocuments.js.map +1 -1
- package/models/operations/documentgetdocumentwithdetailsbyid.d.ts +560 -368
- package/models/operations/documentgetdocumentwithdetailsbyid.d.ts.map +1 -1
- package/models/operations/documentgetdocumentwithdetailsbyid.js +694 -530
- package/models/operations/documentgetdocumentwithdetailsbyid.js.map +1 -1
- package/models/operations/documentmovedocumenttoteam.d.ts +29 -26
- package/models/operations/documentmovedocumenttoteam.d.ts.map +1 -1
- package/models/operations/documentmovedocumenttoteam.js +38 -37
- package/models/operations/documentmovedocumenttoteam.js.map +1 -1
- package/models/operations/documentresenddocument.d.ts +26 -26
- package/models/operations/documentresenddocument.d.ts.map +1 -1
- package/models/operations/documentresenddocument.js +31 -31
- package/models/operations/documentresenddocument.js.map +1 -1
- package/models/operations/documentsenddocument.d.ts +35 -26
- package/models/operations/documentsenddocument.d.ts.map +1 -1
- package/models/operations/documentsenddocument.js +40 -37
- package/models/operations/documentsenddocument.js.map +1 -1
- package/models/operations/documentupdatedocument.d.ts +740 -0
- package/models/operations/documentupdatedocument.d.ts.map +1 -0
- package/models/operations/documentupdatedocument.js +589 -0
- package/models/operations/documentupdatedocument.js.map +1 -0
- package/models/operations/fieldcreatedocumentfield.d.ts +1141 -781
- package/models/operations/fieldcreatedocumentfield.d.ts.map +1 -1
- package/models/operations/fieldcreatedocumentfield.js +1384 -1096
- package/models/operations/fieldcreatedocumentfield.js.map +1 -1
- package/models/operations/fieldcreatedocumentfields.d.ts +1156 -796
- package/models/operations/fieldcreatedocumentfields.d.ts.map +1 -1
- package/models/operations/fieldcreatedocumentfields.js +1404 -1108
- package/models/operations/fieldcreatedocumentfields.js.map +1 -1
- package/models/operations/fieldcreatetemplatefield.d.ts +1141 -781
- package/models/operations/fieldcreatetemplatefield.d.ts.map +1 -1
- package/models/operations/fieldcreatetemplatefield.js +1384 -1090
- package/models/operations/fieldcreatetemplatefield.js.map +1 -1
- package/models/operations/fieldcreatetemplatefields.d.ts +1156 -796
- package/models/operations/fieldcreatetemplatefields.d.ts.map +1 -1
- package/models/operations/fieldcreatetemplatefields.js +1404 -1108
- package/models/operations/fieldcreatetemplatefields.js.map +1 -1
- package/models/operations/fielddeletedocumentfield.d.ts +26 -26
- package/models/operations/fielddeletedocumentfield.d.ts.map +1 -1
- package/models/operations/fielddeletedocumentfield.js +31 -31
- package/models/operations/fielddeletedocumentfield.js.map +1 -1
- package/models/operations/fielddeletetemplatefield.d.ts +26 -26
- package/models/operations/fielddeletetemplatefield.d.ts.map +1 -1
- package/models/operations/fielddeletetemplatefield.js +31 -31
- package/models/operations/fielddeletetemplatefield.js.map +1 -1
- package/models/operations/fieldgetdocumentfield.d.ts +442 -262
- package/models/operations/fieldgetdocumentfield.d.ts.map +1 -1
- package/models/operations/fieldgetdocumentfield.js +512 -374
- package/models/operations/fieldgetdocumentfield.js.map +1 -1
- package/models/operations/fieldgettemplatefield.d.ts +442 -262
- package/models/operations/fieldgettemplatefield.d.ts.map +1 -1
- package/models/operations/fieldgettemplatefield.js +512 -376
- package/models/operations/fieldgettemplatefield.js.map +1 -1
- package/models/operations/fieldupdatedocumentfield.d.ts +1141 -781
- package/models/operations/fieldupdatedocumentfield.d.ts.map +1 -1
- package/models/operations/fieldupdatedocumentfield.js +1384 -1090
- package/models/operations/fieldupdatedocumentfield.js.map +1 -1
- package/models/operations/fieldupdatedocumentfields.d.ts +1156 -796
- package/models/operations/fieldupdatedocumentfields.d.ts.map +1 -1
- package/models/operations/fieldupdatedocumentfields.js +1404 -1108
- package/models/operations/fieldupdatedocumentfields.js.map +1 -1
- package/models/operations/fieldupdatetemplatefield.d.ts +1141 -781
- package/models/operations/fieldupdatetemplatefield.d.ts.map +1 -1
- package/models/operations/fieldupdatetemplatefield.js +1384 -1090
- package/models/operations/fieldupdatetemplatefield.js.map +1 -1
- package/models/operations/fieldupdatetemplatefields.d.ts +1156 -796
- package/models/operations/fieldupdatetemplatefields.d.ts.map +1 -1
- package/models/operations/fieldupdatetemplatefields.js +1404 -1108
- package/models/operations/fieldupdatetemplatefields.js.map +1 -1
- package/models/operations/index.d.ts +1 -1
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +1 -1
- package/models/operations/index.js.map +1 -1
- package/models/operations/recipientcreatedocumentrecipient.d.ts +95 -89
- package/models/operations/recipientcreatedocumentrecipient.d.ts.map +1 -1
- package/models/operations/recipientcreatedocumentrecipient.js +132 -128
- package/models/operations/recipientcreatedocumentrecipient.js.map +1 -1
- package/models/operations/recipientcreatedocumentrecipients.d.ts +110 -104
- package/models/operations/recipientcreatedocumentrecipients.d.ts.map +1 -1
- package/models/operations/recipientcreatedocumentrecipients.js +148 -148
- package/models/operations/recipientcreatedocumentrecipients.js.map +1 -1
- package/models/operations/recipientcreatetemplaterecipient.d.ts +80 -74
- package/models/operations/recipientcreatetemplaterecipient.d.ts.map +1 -1
- package/models/operations/recipientcreatetemplaterecipient.js +115 -111
- package/models/operations/recipientcreatetemplaterecipient.js.map +1 -1
- package/models/operations/recipientcreatetemplaterecipients.d.ts +110 -104
- package/models/operations/recipientcreatetemplaterecipients.d.ts.map +1 -1
- package/models/operations/recipientcreatetemplaterecipients.js +148 -148
- package/models/operations/recipientcreatetemplaterecipients.js.map +1 -1
- package/models/operations/recipientdeletedocumentrecipient.d.ts +26 -26
- package/models/operations/recipientdeletedocumentrecipient.d.ts.map +1 -1
- package/models/operations/recipientdeletedocumentrecipient.js +31 -31
- package/models/operations/recipientdeletedocumentrecipient.js.map +1 -1
- package/models/operations/recipientdeletetemplaterecipient.d.ts +26 -26
- package/models/operations/recipientdeletetemplaterecipient.d.ts.map +1 -1
- package/models/operations/recipientdeletetemplaterecipient.js +31 -31
- package/models/operations/recipientdeletetemplaterecipient.js.map +1 -1
- package/models/operations/recipientgetdocumentrecipient.d.ts +484 -301
- package/models/operations/recipientgetdocumentrecipient.d.ts.map +1 -1
- package/models/operations/recipientgetdocumentrecipient.js +598 -450
- package/models/operations/recipientgetdocumentrecipient.js.map +1 -1
- package/models/operations/recipientgettemplaterecipient.d.ts +460 -277
- package/models/operations/recipientgettemplaterecipient.d.ts.map +1 -1
- package/models/operations/recipientgettemplaterecipient.js +555 -408
- package/models/operations/recipientgettemplaterecipient.js.map +1 -1
- package/models/operations/recipientupdatedocumentrecipient.d.ts +524 -338
- package/models/operations/recipientupdatedocumentrecipient.d.ts.map +1 -1
- package/models/operations/recipientupdatedocumentrecipient.js +664 -503
- package/models/operations/recipientupdatedocumentrecipient.js.map +1 -1
- package/models/operations/recipientupdatedocumentrecipients.d.ts +554 -368
- package/models/operations/recipientupdatedocumentrecipients.d.ts.map +1 -1
- package/models/operations/recipientupdatedocumentrecipients.js +695 -538
- package/models/operations/recipientupdatedocumentrecipients.js.map +1 -1
- package/models/operations/recipientupdatetemplaterecipient.d.ts +524 -338
- package/models/operations/recipientupdatetemplaterecipient.d.ts.map +1 -1
- package/models/operations/recipientupdatetemplaterecipient.js +664 -503
- package/models/operations/recipientupdatetemplaterecipient.js.map +1 -1
- package/models/operations/recipientupdatetemplaterecipients.d.ts +554 -368
- package/models/operations/recipientupdatetemplaterecipients.d.ts.map +1 -1
- package/models/operations/recipientupdatetemplaterecipients.js +695 -538
- package/models/operations/recipientupdatetemplaterecipients.js.map +1 -1
- package/models/operations/templatecreatedocumentfromtemplate.d.ts +838 -351
- package/models/operations/templatecreatedocumentfromtemplate.d.ts.map +1 -1
- package/models/operations/templatecreatedocumentfromtemplate.js +977 -509
- package/models/operations/templatecreatedocumentfromtemplate.js.map +1 -1
- package/models/operations/templatecreatetemplatedirectlink.d.ts +26 -26
- package/models/operations/templatecreatetemplatedirectlink.d.ts.map +1 -1
- package/models/operations/templatecreatetemplatedirectlink.js +35 -35
- package/models/operations/templatecreatetemplatedirectlink.js.map +1 -1
- package/models/operations/templatedeletetemplate.d.ts +26 -26
- package/models/operations/templatedeletetemplate.d.ts.map +1 -1
- package/models/operations/templatedeletetemplate.js +31 -31
- package/models/operations/templatedeletetemplate.js.map +1 -1
- package/models/operations/templatedeletetemplatedirectlink.d.ts +26 -26
- package/models/operations/templatedeletetemplatedirectlink.d.ts.map +1 -1
- package/models/operations/templatedeletetemplatedirectlink.js +31 -31
- package/models/operations/templatedeletetemplatedirectlink.js.map +1 -1
- package/models/operations/templateduplicatetemplate.d.ts +26 -26
- package/models/operations/templateduplicatetemplate.d.ts.map +1 -1
- package/models/operations/templateduplicatetemplate.js +37 -37
- package/models/operations/templateduplicatetemplate.js.map +1 -1
- package/models/operations/templatefindtemplates.d.ts +506 -323
- package/models/operations/templatefindtemplates.d.ts.map +1 -1
- package/models/operations/templatefindtemplates.js +609 -471
- package/models/operations/templatefindtemplates.js.map +1 -1
- package/models/operations/templategettemplatebyid.d.ts +557 -368
- package/models/operations/templategettemplatebyid.d.ts.map +1 -1
- package/models/operations/templategettemplatebyid.js +672 -532
- package/models/operations/templategettemplatebyid.js.map +1 -1
- package/models/operations/templatemovetemplatetoteam.d.ts +26 -26
- package/models/operations/templatemovetemplatetoteam.d.ts.map +1 -1
- package/models/operations/templatemovetemplatetoteam.js +37 -37
- package/models/operations/templatemovetemplatetoteam.js.map +1 -1
- package/models/operations/templatetoggletemplatedirectlink.d.ts +26 -26
- package/models/operations/templatetoggletemplatedirectlink.d.ts.map +1 -1
- package/models/operations/templatetoggletemplatedirectlink.js +35 -35
- package/models/operations/templatetoggletemplatedirectlink.js.map +1 -1
- package/models/operations/templateupdatetemplate.d.ts +108 -90
- package/models/operations/templateupdatetemplate.d.ts.map +1 -1
- package/models/operations/templateupdatetemplate.js +160 -147
- package/models/operations/templateupdatetemplate.js.map +1 -1
- package/package.json +21 -8
- package/sdk/directlink.d.ts +3 -3
- package/sdk/directlink.d.ts.map +1 -1
- package/sdk/directlink.js.map +1 -1
- package/sdk/documents.d.ts +13 -13
- package/sdk/documents.d.ts.map +1 -1
- package/sdk/documents.js +4 -4
- package/sdk/documents.js.map +1 -1
- package/sdk/{fields.d.ts → documentsfields.d.ts} +8 -8
- package/sdk/documentsfields.d.ts.map +1 -0
- package/sdk/{fields.js → documentsfields.js} +4 -4
- package/sdk/documentsfields.js.map +1 -0
- package/sdk/{recipients.d.ts → documentsrecipients.d.ts} +8 -8
- package/sdk/documentsrecipients.d.ts.map +1 -0
- package/sdk/{recipients.js → documentsrecipients.js} +4 -4
- package/sdk/{documensorecipients.js.map → documentsrecipients.js.map} +1 -1
- package/sdk/templates.d.ts +11 -11
- package/sdk/templates.d.ts.map +1 -1
- package/sdk/templates.js +4 -4
- package/sdk/templates.js.map +1 -1
- package/sdk/{documensofields.d.ts → templatesfields.d.ts} +8 -8
- package/sdk/templatesfields.d.ts.map +1 -0
- package/sdk/{documensofields.js → templatesfields.js} +4 -4
- package/sdk/{documensofields.js.map → templatesfields.js.map} +1 -1
- package/sdk/{documensorecipients.d.ts → templatesrecipients.d.ts} +8 -8
- package/sdk/templatesrecipients.d.ts.map +1 -0
- package/sdk/{documensorecipients.js → templatesrecipients.js} +4 -4
- package/sdk/templatesrecipients.js.map +1 -0
- package/src/funcs/documentsCreateV0.ts +56 -19
- package/src/funcs/documentsDelete.ts +51 -18
- package/src/funcs/documentsDistribute.ts +51 -18
- package/src/funcs/documentsDuplicate.ts +54 -20
- package/src/funcs/documentsFieldsCreate.ts +54 -20
- package/src/funcs/documentsFieldsCreateMany.ts +54 -20
- package/src/funcs/documentsFieldsDelete.ts +54 -20
- package/src/funcs/documentsFieldsGet.ts +53 -19
- package/src/funcs/documentsFieldsUpdate.ts +54 -20
- package/src/funcs/documentsFieldsUpdateMany.ts +54 -20
- package/src/funcs/documentsFind.ts +53 -19
- package/src/funcs/documentsGet.ts +60 -19
- package/src/funcs/documentsMoveToTeam.ts +53 -22
- package/src/funcs/documentsRecipientsCreate.ts +56 -19
- package/src/funcs/documentsRecipientsCreateMany.ts +56 -19
- package/src/funcs/documentsRecipientsDelete.ts +56 -19
- package/src/funcs/documentsRecipientsGet.ts +58 -21
- package/src/funcs/documentsRecipientsUpdate.ts +56 -19
- package/src/funcs/documentsRecipientsUpdateMany.ts +56 -19
- package/src/funcs/documentsRedistribute.ts +51 -18
- package/src/funcs/documentsUpdate.ts +51 -23
- package/src/funcs/templatesDelete.ts +51 -18
- package/src/funcs/templatesDirectLinkCreate.ts +56 -19
- package/src/funcs/templatesDirectLinkDelete.ts +56 -19
- package/src/funcs/templatesDirectLinkToggle.ts +56 -19
- package/src/funcs/templatesDuplicate.ts +54 -20
- package/src/funcs/templatesFieldsCreate.ts +54 -20
- package/src/funcs/templatesFieldsCreateMany.ts +54 -20
- package/src/funcs/templatesFieldsDelete.ts +54 -20
- package/src/funcs/templatesFieldsGet.ts +53 -19
- package/src/funcs/templatesFieldsUpdate.ts +54 -20
- package/src/funcs/templatesFieldsUpdateMany.ts +54 -20
- package/src/funcs/templatesFind.ts +53 -19
- package/src/funcs/templatesGet.ts +53 -19
- package/src/funcs/templatesMoveToTeam.ts +53 -22
- package/src/funcs/templatesRecipientsCreate.ts +56 -19
- package/src/funcs/templatesRecipientsCreateMany.ts +56 -19
- package/src/funcs/templatesRecipientsDelete.ts +56 -19
- package/src/funcs/templatesRecipientsGet.ts +58 -21
- package/src/funcs/templatesRecipientsUpdate.ts +56 -19
- package/src/funcs/templatesRecipientsUpdateMany.ts +56 -19
- package/src/funcs/templatesUpdate.ts +51 -18
- package/src/funcs/templatesUse.ts +57 -19
- package/src/hooks/hooks.ts +0 -3
- package/src/hooks/types.ts +2 -1
- package/src/lib/config.ts +6 -6
- package/src/lib/files.ts +1 -1
- package/src/lib/primitives.ts +14 -0
- package/src/lib/retries.ts +0 -1
- package/src/lib/sdks.ts +3 -8
- package/src/lib/security.ts +10 -3
- package/src/mcp-server/cli/start/command.ts +107 -0
- package/src/mcp-server/cli/start/impl.ts +134 -0
- package/src/mcp-server/cli.ts +13 -0
- package/src/mcp-server/console-logger.ts +71 -0
- package/src/mcp-server/extensions.ts +17 -0
- package/src/mcp-server/mcp-server.ts +26 -0
- package/src/mcp-server/prompts.ts +117 -0
- package/src/mcp-server/resources.ts +172 -0
- package/src/mcp-server/scopes.ts +7 -0
- package/src/mcp-server/server.ts +145 -0
- package/src/mcp-server/shared.ts +75 -0
- package/src/mcp-server/tools/documentsCreateV0.ts +37 -0
- package/src/mcp-server/tools/documentsDelete.ts +35 -0
- package/src/mcp-server/tools/documentsDistribute.ts +37 -0
- package/src/mcp-server/tools/documentsDuplicate.ts +35 -0
- package/src/mcp-server/tools/documentsFieldsCreate.ts +37 -0
- package/src/mcp-server/tools/documentsFieldsCreateMany.ts +37 -0
- package/src/mcp-server/tools/documentsFieldsDelete.ts +35 -0
- package/src/mcp-server/tools/documentsFieldsGet.ts +37 -0
- package/src/mcp-server/tools/documentsFieldsUpdate.ts +37 -0
- package/src/mcp-server/tools/documentsFieldsUpdateMany.ts +37 -0
- package/src/mcp-server/tools/documentsFind.ts +37 -0
- package/src/mcp-server/tools/documentsGet.ts +37 -0
- package/src/mcp-server/tools/documentsMoveToTeam.ts +37 -0
- package/src/mcp-server/tools/documentsRecipientsCreate.ts +37 -0
- package/src/mcp-server/tools/documentsRecipientsCreateMany.ts +37 -0
- package/src/mcp-server/tools/documentsRecipientsDelete.ts +35 -0
- package/src/mcp-server/tools/documentsRecipientsGet.ts +37 -0
- package/src/mcp-server/tools/documentsRecipientsUpdate.ts +37 -0
- package/src/mcp-server/tools/documentsRecipientsUpdateMany.ts +37 -0
- package/src/mcp-server/tools/documentsRedistribute.ts +37 -0
- package/src/mcp-server/tools/documentsUpdate.ts +35 -0
- package/src/mcp-server/tools/templatesDelete.ts +35 -0
- package/src/mcp-server/tools/templatesDirectLinkCreate.ts +37 -0
- package/src/mcp-server/tools/templatesDirectLinkDelete.ts +37 -0
- package/src/mcp-server/tools/templatesDirectLinkToggle.ts +37 -0
- package/src/mcp-server/tools/templatesDuplicate.ts +35 -0
- package/src/mcp-server/tools/templatesFieldsCreate.ts +37 -0
- package/src/mcp-server/tools/templatesFieldsCreateMany.ts +37 -0
- package/src/mcp-server/tools/templatesFieldsDelete.ts +35 -0
- package/src/mcp-server/tools/templatesFieldsGet.ts +37 -0
- package/src/mcp-server/tools/templatesFieldsUpdate.ts +37 -0
- package/src/mcp-server/tools/templatesFieldsUpdateMany.ts +37 -0
- package/src/mcp-server/tools/templatesFind.ts +37 -0
- package/src/mcp-server/tools/templatesGet.ts +35 -0
- package/src/mcp-server/tools/templatesMoveToTeam.ts +37 -0
- package/src/mcp-server/tools/templatesRecipientsCreate.ts +37 -0
- package/src/mcp-server/tools/templatesRecipientsCreateMany.ts +37 -0
- package/src/mcp-server/tools/templatesRecipientsDelete.ts +35 -0
- package/src/mcp-server/tools/templatesRecipientsGet.ts +37 -0
- package/src/mcp-server/tools/templatesRecipientsUpdate.ts +37 -0
- package/src/mcp-server/tools/templatesRecipientsUpdateMany.ts +37 -0
- package/src/mcp-server/tools/templatesUpdate.ts +35 -0
- package/src/mcp-server/tools/templatesUse.ts +37 -0
- package/src/mcp-server/tools.ts +129 -0
- package/src/models/errors/documentcreatedocumenttemporary.ts +344 -0
- package/src/models/errors/documentdeletedocument.ts +320 -0
- package/src/models/errors/documentduplicatedocument.ts +329 -0
- package/src/models/errors/documentfinddocuments.ts +465 -0
- package/src/models/errors/documentgetdocumentwithdetailsbyid.ts +514 -0
- package/src/models/errors/documentmovedocumenttoteam.ts +337 -0
- package/src/models/errors/documentresenddocument.ts +320 -0
- package/src/models/errors/documentsenddocument.ts +316 -0
- package/src/models/errors/documentupdatedocument.ts +320 -0
- package/src/models/errors/fieldcreatedocumentfield.ts +329 -0
- package/src/models/errors/fieldcreatedocumentfields.ts +329 -0
- package/src/models/errors/fieldcreatetemplatefield.ts +329 -0
- package/src/models/errors/fieldcreatetemplatefields.ts +329 -0
- package/src/models/errors/fielddeletedocumentfield.ts +329 -0
- package/src/models/errors/fielddeletetemplatefield.ts +329 -0
- package/src/models/errors/fieldgetdocumentfield.ts +465 -0
- package/src/models/errors/fieldgettemplatefield.ts +465 -0
- package/src/models/errors/fieldupdatedocumentfield.ts +329 -0
- package/src/models/errors/fieldupdatedocumentfields.ts +329 -0
- package/src/models/errors/fieldupdatetemplatefield.ts +329 -0
- package/src/models/errors/fieldupdatetemplatefields.ts +329 -0
- package/src/models/errors/index.ts +43 -3
- package/src/models/errors/recipientcreatedocumentrecipient.ts +345 -0
- package/src/models/errors/recipientcreatedocumentrecipients.ts +347 -0
- package/src/models/errors/recipientcreatetemplaterecipient.ts +345 -0
- package/src/models/errors/recipientcreatetemplaterecipients.ts +347 -0
- package/src/models/errors/recipientdeletedocumentrecipient.ts +345 -0
- package/src/models/errors/recipientdeletetemplaterecipient.ts +345 -0
- package/src/models/errors/recipientgetdocumentrecipient.ts +497 -0
- package/src/models/errors/recipientgettemplaterecipient.ts +497 -0
- package/src/models/errors/recipientupdatedocumentrecipient.ts +345 -0
- package/src/models/errors/recipientupdatedocumentrecipients.ts +347 -0
- package/src/models/errors/recipientupdatetemplaterecipient.ts +345 -0
- package/src/models/errors/recipientupdatetemplaterecipients.ts +347 -0
- package/src/models/errors/templatecreatedocumentfromtemplate.ts +347 -0
- package/src/models/errors/templatecreatetemplatedirectlink.ts +345 -0
- package/src/models/errors/templatedeletetemplate.ts +320 -0
- package/src/models/errors/templatedeletetemplatedirectlink.ts +345 -0
- package/src/models/errors/templateduplicatetemplate.ts +329 -0
- package/src/models/errors/templatefindtemplates.ts +465 -0
- package/src/models/errors/templategettemplatebyid.ts +470 -0
- package/src/models/errors/templatemovetemplatetoteam.ts +337 -0
- package/src/models/errors/templatetoggletemplatedirectlink.ts +345 -0
- package/src/models/errors/templateupdatetemplate.ts +320 -0
- package/src/models/operations/documentcreatedocumenttemporary.ts +3229 -3435
- package/src/models/operations/documentdeletedocument.ts +44 -47
- package/src/models/operations/documentduplicatedocument.ts +44 -49
- package/src/models/operations/documentfinddocuments.ts +191 -183
- package/src/models/operations/documentgetdocumentwithdetailsbyid.ts +1333 -1048
- package/src/models/operations/documentmovedocumenttoteam.ts +51 -54
- package/src/models/operations/documentresenddocument.ts +44 -47
- package/src/models/operations/documentsenddocument.ts +53 -50
- package/src/models/operations/documentupdatedocument.ts +1130 -0
- package/src/models/operations/fieldcreatedocumentfield.ts +2904 -2428
- package/src/models/operations/fieldcreatedocumentfields.ts +2924 -2510
- package/src/models/operations/fieldcreatetemplatefield.ts +2710 -2416
- package/src/models/operations/fieldcreatetemplatefields.ts +2790 -2470
- package/src/models/operations/fielddeletedocumentfield.ts +44 -50
- package/src/models/operations/fielddeletetemplatefield.ts +44 -50
- package/src/models/operations/fieldgetdocumentfield.ts +858 -652
- package/src/models/operations/fieldgettemplatefield.ts +836 -727
- package/src/models/operations/fieldupdatedocumentfield.ts +2708 -2414
- package/src/models/operations/fieldupdatedocumentfields.ts +2787 -2467
- package/src/models/operations/fieldupdatetemplatefield.ts +2708 -2414
- package/src/models/operations/fieldupdatetemplatefields.ts +2787 -2467
- package/src/models/operations/index.ts +1 -1
- package/src/models/operations/recipientcreatedocumentrecipient.ts +267 -258
- package/src/models/operations/recipientcreatedocumentrecipients.ts +270 -275
- package/src/models/operations/recipientcreatetemplaterecipient.ts +219 -230
- package/src/models/operations/recipientcreatetemplaterecipients.ts +270 -275
- package/src/models/operations/recipientdeletedocumentrecipient.ts +64 -68
- package/src/models/operations/recipientdeletetemplaterecipient.ts +64 -68
- package/src/models/operations/recipientgetdocumentrecipient.ts +1189 -1045
- package/src/models/operations/recipientgettemplaterecipient.ts +1132 -1004
- package/src/models/operations/recipientupdatedocumentrecipient.ts +1263 -1101
- package/src/models/operations/recipientupdatedocumentrecipients.ts +1224 -1055
- package/src/models/operations/recipientupdatetemplaterecipient.ts +1263 -1101
- package/src/models/operations/recipientupdatetemplaterecipients.ts +1224 -1055
- package/src/models/operations/templatecreatedocumentfromtemplate.ts +1781 -963
- package/src/models/operations/templatecreatetemplatedirectlink.ts +76 -80
- package/src/models/operations/templatedeletetemplate.ts +44 -47
- package/src/models/operations/templatedeletetemplatedirectlink.ts +64 -68
- package/src/models/operations/templateduplicatetemplate.ts +50 -55
- package/src/models/operations/templatefindtemplates.ts +958 -834
- package/src/models/operations/templategettemplatebyid.ts +1104 -922
- package/src/models/operations/templatemovetemplatetoteam.ts +50 -54
- package/src/models/operations/templatetoggletemplatedirectlink.ts +76 -80
- package/src/models/operations/templateupdatetemplate.ts +216 -192
- package/src/sdk/directlink.ts +6 -6
- package/src/sdk/documents.ts +24 -24
- package/src/sdk/{fields.ts → documentsfields.ts} +12 -12
- package/src/sdk/{recipients.ts → documentsrecipients.ts} +12 -12
- package/src/sdk/templates.ts +20 -20
- package/src/sdk/{documensofields.ts → templatesfields.ts} +12 -12
- package/src/sdk/{documensorecipients.ts → templatesrecipients.ts} +12 -12
- package/src/types/async.ts +68 -0
- package/types/async.d.ts +23 -0
- package/types/async.d.ts.map +1 -0
- package/types/async.js +44 -0
- package/types/async.js.map +1 -0
- package/models/errors/errorbadrequest.d.ts +0 -84
- package/models/errors/errorbadrequest.d.ts.map +0 -1
- package/models/errors/errorbadrequest.js +0 -115
- package/models/errors/errorbadrequest.js.map +0 -1
- package/models/errors/errorinternalservererror.d.ts +0 -84
- package/models/errors/errorinternalservererror.d.ts.map +0 -1
- package/models/errors/errorinternalservererror.js +0 -116
- package/models/errors/errorinternalservererror.js.map +0 -1
- package/models/errors/errornotfound.d.ts +0 -84
- package/models/errors/errornotfound.d.ts.map +0 -1
- package/models/errors/errornotfound.js +0 -115
- package/models/errors/errornotfound.js.map +0 -1
- package/models/operations/documentsetsettingsfordocument.d.ts +0 -719
- package/models/operations/documentsetsettingsfordocument.d.ts.map +0 -1
- package/models/operations/documentsetsettingsfordocument.js +0 -583
- package/models/operations/documentsetsettingsfordocument.js.map +0 -1
- package/sdk/documensofields.d.ts.map +0 -1
- package/sdk/documensorecipients.d.ts.map +0 -1
- package/sdk/fields.d.ts.map +0 -1
- package/sdk/fields.js.map +0 -1
- package/sdk/recipients.d.ts.map +0 -1
- package/sdk/recipients.js.map +0 -1
- package/src/models/errors/errorbadrequest.ts +0 -154
- package/src/models/errors/errorinternalservererror.ts +0 -165
- package/src/models/errors/errornotfound.ts +0 -162
- package/src/models/operations/documentsetsettingsfordocument.ts +0 -1180
package/FUNCTIONS.md
CHANGED
package/README.md
CHANGED
|
@@ -1,40 +1,52 @@
|
|
|
1
|
-
|
|
1
|
+
<img src="https://github.com/documenso/documenso/assets/13398220/a643571f-0239-46a6-a73e-6bef38d1228b" alt="Documenso Logo">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
|
|
4
4
|
|
|
5
|
-
<div align="
|
|
5
|
+
<div align="center">
|
|
6
6
|
<a href="https://www.speakeasy.com/?utm_source=@documenso/sdk-typescript&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
|
|
7
7
|
<a href="https://opensource.org/licenses/MIT">
|
|
8
8
|
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
|
|
9
9
|
</a>
|
|
10
10
|
</div>
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
## Summary
|
|
12
|
+
## Documenso TypeScript SDK
|
|
14
13
|
|
|
15
|
-
|
|
16
|
-
|
|
14
|
+
A type-safe SDK for seamless integration with Documenso v2 API, providing first-class TypeScript support.
|
|
15
|
+
|
|
16
|
+
This SDK offers a strongly-typed interface to interact with Documenso's API, enabling you to:
|
|
17
|
+
- Handle document signing workflows with full type safety
|
|
18
|
+
- Leverage autocomplete in your IDE
|
|
19
|
+
- Catch potential errors at compile time
|
|
20
|
+
|
|
21
|
+
The full Documenso API can be viewed [here](https://openapi.documenso.com/), which includes TypeScript examples.
|
|
22
|
+
|
|
23
|
+
## ⚠️ Warning
|
|
24
|
+
|
|
25
|
+
Documenso v2 API and SDKs are currently in beta. There may be to breaking changes.
|
|
26
|
+
|
|
27
|
+
To keep updated, please follow the discussions here:
|
|
28
|
+
- [Feedback](https://github.com/documenso/documenso/discussions/1611)
|
|
29
|
+
- [Breaking change alerts](https://github.com/documenso/documenso/discussions/1612)
|
|
30
|
+
|
|
31
|
+
<!-- No Summary [summary] -->
|
|
17
32
|
|
|
18
|
-
<!-- Start Table of Contents [toc] -->
|
|
19
33
|
## Table of Contents
|
|
20
34
|
<!-- $toc-max-depth=2 -->
|
|
21
|
-
* [
|
|
35
|
+
* [Overview](#documenso-typescript-sdk)
|
|
22
36
|
* [SDK Installation](#sdk-installation)
|
|
23
37
|
* [Requirements](#requirements)
|
|
24
|
-
* [
|
|
38
|
+
* [Document creation example](#document-creation-example)
|
|
25
39
|
* [Authentication](#authentication)
|
|
26
40
|
* [Available Resources and Operations](#available-resources-and-operations)
|
|
27
|
-
* [Standalone functions](#standalone-functions)
|
|
28
41
|
* [Retries](#retries)
|
|
29
42
|
* [Error Handling](#error-handling)
|
|
30
43
|
* [Server Selection](#server-selection)
|
|
31
|
-
* [Custom HTTP Client](#custom-http-client)
|
|
32
44
|
* [Debugging](#debugging)
|
|
33
45
|
* [Development](#development)
|
|
34
46
|
* [Maturity](#maturity)
|
|
35
47
|
* [Contributions](#contributions)
|
|
36
48
|
|
|
37
|
-
<!--
|
|
49
|
+
<!-- No Table of Contents [toc] -->
|
|
38
50
|
|
|
39
51
|
<!-- Start SDK Installation [installation] -->
|
|
40
52
|
## SDK Installation
|
|
@@ -67,6 +79,91 @@ yarn add @documenso/sdk-typescript zod
|
|
|
67
79
|
# Note that Yarn does not install peer dependencies automatically. You will need
|
|
68
80
|
# to install zod as shown above.
|
|
69
81
|
```
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
### Model Context Protocol (MCP) Server
|
|
86
|
+
|
|
87
|
+
This SDK is also an installable MCP server where the various SDK methods are
|
|
88
|
+
exposed as tools that can be invoked by AI applications.
|
|
89
|
+
|
|
90
|
+
> Node.js v20 or greater is required to run the MCP server from npm.
|
|
91
|
+
|
|
92
|
+
<details>
|
|
93
|
+
<summary>Claude installation steps</summary>
|
|
94
|
+
|
|
95
|
+
Add the following server definition to your `claude_desktop_config.json` file:
|
|
96
|
+
|
|
97
|
+
```json
|
|
98
|
+
{
|
|
99
|
+
"mcpServers": {
|
|
100
|
+
"Documenso": {
|
|
101
|
+
"command": "npx",
|
|
102
|
+
"args": [
|
|
103
|
+
"-y", "--package", "@documenso/sdk-typescript",
|
|
104
|
+
"--",
|
|
105
|
+
"mcp", "start",
|
|
106
|
+
"--api-key", "..."
|
|
107
|
+
]
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
</details>
|
|
114
|
+
|
|
115
|
+
<details>
|
|
116
|
+
<summary>Cursor installation steps</summary>
|
|
117
|
+
|
|
118
|
+
Create a `.cursor/mcp.json` file in your project root with the following content:
|
|
119
|
+
|
|
120
|
+
```json
|
|
121
|
+
{
|
|
122
|
+
"mcpServers": {
|
|
123
|
+
"Documenso": {
|
|
124
|
+
"command": "npx",
|
|
125
|
+
"args": [
|
|
126
|
+
"-y", "--package", "@documenso/sdk-typescript",
|
|
127
|
+
"--",
|
|
128
|
+
"mcp", "start",
|
|
129
|
+
"--api-key", "..."
|
|
130
|
+
]
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
</details>
|
|
137
|
+
|
|
138
|
+
You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
curl -L -o mcp-server \
|
|
142
|
+
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
|
|
143
|
+
chmod +x mcp-server
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
```json
|
|
150
|
+
{
|
|
151
|
+
"mcpServers": {
|
|
152
|
+
"Todos": {
|
|
153
|
+
"command": "./DOWNLOAD/PATH/mcp-server",
|
|
154
|
+
"args": [
|
|
155
|
+
"start"
|
|
156
|
+
]
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
For a full list of server arguments, run:
|
|
163
|
+
|
|
164
|
+
```sh
|
|
165
|
+
npx -y --package @documenso/sdk-typescript -- mcp start --help
|
|
166
|
+
```
|
|
70
167
|
<!-- End SDK Installation [installation] -->
|
|
71
168
|
|
|
72
169
|
<!-- Start Requirements [requirements] -->
|
|
@@ -75,64 +172,123 @@ yarn add @documenso/sdk-typescript zod
|
|
|
75
172
|
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
|
76
173
|
<!-- End Requirements [requirements] -->
|
|
77
174
|
|
|
78
|
-
|
|
79
|
-
## SDK Example Usage
|
|
80
|
-
|
|
81
|
-
### Example
|
|
175
|
+
## Authentication
|
|
82
176
|
|
|
83
|
-
|
|
84
|
-
|
|
177
|
+
To use the SDK, you will need a Documenso API key which can be created [here](https://docs.documenso.com/developers/public-api/authentication#creating-an-api-key
|
|
178
|
+
).
|
|
85
179
|
|
|
180
|
+
```ts
|
|
86
181
|
const documenso = new Documenso({
|
|
87
182
|
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
88
183
|
});
|
|
184
|
+
```
|
|
89
185
|
|
|
90
|
-
|
|
91
|
-
const result = await documenso.documents.find({
|
|
92
|
-
orderByDirection: "desc",
|
|
93
|
-
});
|
|
94
|
-
|
|
95
|
-
// Handle the result
|
|
96
|
-
console.log(result);
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
run();
|
|
186
|
+
## Document creation example
|
|
100
187
|
|
|
101
|
-
|
|
102
|
-
<!-- End SDK Example Usage [usage] -->
|
|
188
|
+
Currently creating a document involves two steps:
|
|
103
189
|
|
|
104
|
-
|
|
105
|
-
|
|
190
|
+
1. Create the document
|
|
191
|
+
2. Upload the PDF
|
|
106
192
|
|
|
107
|
-
|
|
193
|
+
This is a temporary measure, in the near future prior to the full release we will merge these two tasks into one request.
|
|
108
194
|
|
|
109
|
-
|
|
195
|
+
Here is a full example of the document creation process which you can copy and run.
|
|
110
196
|
|
|
111
|
-
|
|
112
|
-
| -------- | ------ | ------- | -------------------- |
|
|
113
|
-
| `apiKey` | apiKey | API key | `DOCUMENSO_API_KEY` |
|
|
197
|
+
Note that the function is temporarily called `createV0`, which will be replaced by `create` once we resolve the 2 step workaround.
|
|
114
198
|
|
|
115
|
-
To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
|
|
116
199
|
```typescript
|
|
117
200
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
201
|
+
import fs from "fs";
|
|
118
202
|
|
|
119
203
|
const documenso = new Documenso({
|
|
120
204
|
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
121
205
|
});
|
|
122
206
|
|
|
123
|
-
async function
|
|
124
|
-
const
|
|
125
|
-
|
|
207
|
+
async function uploadFileToPresignedUrl(filePath: string, uploadUrl: string) {
|
|
208
|
+
const fileBuffer = await fs.promises.readFile(filePath);
|
|
209
|
+
|
|
210
|
+
// Make PUT request to pre-signed URL
|
|
211
|
+
const response = await fetch(uploadUrl, {
|
|
212
|
+
method: "PUT",
|
|
213
|
+
body: fileBuffer,
|
|
214
|
+
headers: {
|
|
215
|
+
"Content-Type": "application/octet-stream",
|
|
216
|
+
},
|
|
126
217
|
});
|
|
127
218
|
|
|
128
|
-
|
|
129
|
-
|
|
219
|
+
if (!response.ok) {
|
|
220
|
+
throw new Error(`Upload failed with status: ${response.status}`);
|
|
221
|
+
}
|
|
130
222
|
}
|
|
131
223
|
|
|
132
|
-
|
|
224
|
+
const main = async () => {
|
|
225
|
+
const createDocumentResponse = await documenso.documents.createV0({
|
|
226
|
+
title: "Document title",
|
|
227
|
+
recipients: [
|
|
228
|
+
{
|
|
229
|
+
email: "example@documenso.com",
|
|
230
|
+
name: "Example Doe",
|
|
231
|
+
role: "SIGNER",
|
|
232
|
+
fields: [
|
|
233
|
+
{
|
|
234
|
+
type: "SIGNATURE",
|
|
235
|
+
pageNumber: 1,
|
|
236
|
+
pageX: 10,
|
|
237
|
+
pageY: 10,
|
|
238
|
+
width: 10,
|
|
239
|
+
height: 10,
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
type: "INITIALS",
|
|
243
|
+
pageNumber: 1,
|
|
244
|
+
pageX: 20,
|
|
245
|
+
pageY: 20,
|
|
246
|
+
width: 10,
|
|
247
|
+
height: 10,
|
|
248
|
+
},
|
|
249
|
+
],
|
|
250
|
+
},
|
|
251
|
+
{
|
|
252
|
+
email: "admin@documenso.com",
|
|
253
|
+
name: "Admin Doe",
|
|
254
|
+
role: "APPROVER",
|
|
255
|
+
fields: [
|
|
256
|
+
{
|
|
257
|
+
type: "SIGNATURE",
|
|
258
|
+
pageNumber: 1,
|
|
259
|
+
pageX: 10,
|
|
260
|
+
pageY: 50,
|
|
261
|
+
width: 10,
|
|
262
|
+
height: 10,
|
|
263
|
+
},
|
|
264
|
+
],
|
|
265
|
+
},
|
|
266
|
+
],
|
|
267
|
+
meta: {
|
|
268
|
+
timezone: "Australia/Melbourne",
|
|
269
|
+
dateFormat: "MM/dd/yyyy hh:mm a",
|
|
270
|
+
language: "de",
|
|
271
|
+
subject: "Email subject",
|
|
272
|
+
message: "Email message",
|
|
273
|
+
emailSettings: {
|
|
274
|
+
recipientRemoved: false,
|
|
275
|
+
},
|
|
276
|
+
},
|
|
277
|
+
});
|
|
278
|
+
|
|
279
|
+
const { document, uploadUrl } = createDocumentResponse;
|
|
133
280
|
|
|
281
|
+
// Upload the PDF you want attached to the document.
|
|
282
|
+
// Replace demo.pdf with your file to upload relative to this file.
|
|
283
|
+
await uploadFileToPresignedUrl("./demo.pdf", uploadUrl);
|
|
284
|
+
|
|
285
|
+
return document;
|
|
286
|
+
};
|
|
287
|
+
|
|
288
|
+
main()
|
|
134
289
|
```
|
|
135
|
-
<!--
|
|
290
|
+
<!-- No SDK Example Usage [usage] -->
|
|
291
|
+
<!-- No Authentication [security] -->
|
|
136
292
|
|
|
137
293
|
<!-- Start Available Resources and Operations [operations] -->
|
|
138
294
|
## Available Resources and Operations
|
|
@@ -153,23 +309,23 @@ run();
|
|
|
153
309
|
* [redistribute](docs/sdks/documents/README.md#redistribute) - Redistribute document
|
|
154
310
|
* [duplicate](docs/sdks/documents/README.md#duplicate) - Duplicate document
|
|
155
311
|
|
|
156
|
-
#### [documents.fields](docs/sdks/
|
|
312
|
+
#### [documents.fields](docs/sdks/documentsfields/README.md)
|
|
157
313
|
|
|
158
|
-
* [get](docs/sdks/
|
|
159
|
-
* [create](docs/sdks/
|
|
160
|
-
* [createMany](docs/sdks/
|
|
161
|
-
* [update](docs/sdks/
|
|
162
|
-
* [updateMany](docs/sdks/
|
|
163
|
-
* [delete](docs/sdks/
|
|
314
|
+
* [get](docs/sdks/documentsfields/README.md#get) - Get document field
|
|
315
|
+
* [create](docs/sdks/documentsfields/README.md#create) - Create document field
|
|
316
|
+
* [createMany](docs/sdks/documentsfields/README.md#createmany) - Create document fields
|
|
317
|
+
* [update](docs/sdks/documentsfields/README.md#update) - Update document field
|
|
318
|
+
* [updateMany](docs/sdks/documentsfields/README.md#updatemany) - Update document fields
|
|
319
|
+
* [delete](docs/sdks/documentsfields/README.md#delete) - Delete document field
|
|
164
320
|
|
|
165
|
-
#### [documents.recipients](docs/sdks/
|
|
321
|
+
#### [documents.recipients](docs/sdks/documentsrecipients/README.md)
|
|
166
322
|
|
|
167
|
-
* [get](docs/sdks/
|
|
168
|
-
* [create](docs/sdks/
|
|
169
|
-
* [createMany](docs/sdks/
|
|
170
|
-
* [update](docs/sdks/
|
|
171
|
-
* [updateMany](docs/sdks/
|
|
172
|
-
* [delete](docs/sdks/
|
|
323
|
+
* [get](docs/sdks/documentsrecipients/README.md#get) - Get document recipient
|
|
324
|
+
* [create](docs/sdks/documentsrecipients/README.md#create) - Create document recipient
|
|
325
|
+
* [createMany](docs/sdks/documentsrecipients/README.md#createmany) - Create document recipients
|
|
326
|
+
* [update](docs/sdks/documentsrecipients/README.md#update) - Update document recipient
|
|
327
|
+
* [updateMany](docs/sdks/documentsrecipients/README.md#updatemany) - Update document recipients
|
|
328
|
+
* [delete](docs/sdks/documentsrecipients/README.md#delete) - Delete document recipient
|
|
173
329
|
|
|
174
330
|
### [templates](docs/sdks/templates/README.md)
|
|
175
331
|
|
|
@@ -187,88 +343,28 @@ run();
|
|
|
187
343
|
* [delete](docs/sdks/directlink/README.md#delete) - Delete direct link
|
|
188
344
|
* [toggle](docs/sdks/directlink/README.md#toggle) - Toggle direct link
|
|
189
345
|
|
|
190
|
-
#### [templates.fields](docs/sdks/
|
|
346
|
+
#### [templates.fields](docs/sdks/templatesfields/README.md)
|
|
191
347
|
|
|
192
|
-
* [create](docs/sdks/
|
|
193
|
-
* [get](docs/sdks/
|
|
194
|
-
* [createMany](docs/sdks/
|
|
195
|
-
* [update](docs/sdks/
|
|
196
|
-
* [updateMany](docs/sdks/
|
|
197
|
-
* [delete](docs/sdks/
|
|
348
|
+
* [create](docs/sdks/templatesfields/README.md#create) - Create template field
|
|
349
|
+
* [get](docs/sdks/templatesfields/README.md#get) - Get template field
|
|
350
|
+
* [createMany](docs/sdks/templatesfields/README.md#createmany) - Create template fields
|
|
351
|
+
* [update](docs/sdks/templatesfields/README.md#update) - Update template field
|
|
352
|
+
* [updateMany](docs/sdks/templatesfields/README.md#updatemany) - Update template fields
|
|
353
|
+
* [delete](docs/sdks/templatesfields/README.md#delete) - Delete template field
|
|
198
354
|
|
|
199
|
-
#### [templates.recipients](docs/sdks/
|
|
355
|
+
#### [templates.recipients](docs/sdks/templatesrecipients/README.md)
|
|
200
356
|
|
|
201
|
-
* [get](docs/sdks/
|
|
202
|
-
* [create](docs/sdks/
|
|
203
|
-
* [createMany](docs/sdks/
|
|
204
|
-
* [update](docs/sdks/
|
|
205
|
-
* [updateMany](docs/sdks/
|
|
206
|
-
* [delete](docs/sdks/
|
|
357
|
+
* [get](docs/sdks/templatesrecipients/README.md#get) - Get template recipient
|
|
358
|
+
* [create](docs/sdks/templatesrecipients/README.md#create) - Create template recipient
|
|
359
|
+
* [createMany](docs/sdks/templatesrecipients/README.md#createmany) - Create template recipients
|
|
360
|
+
* [update](docs/sdks/templatesrecipients/README.md#update) - Update template recipient
|
|
361
|
+
* [updateMany](docs/sdks/templatesrecipients/README.md#updatemany) - Update template recipients
|
|
362
|
+
* [delete](docs/sdks/templatesrecipients/README.md#delete) - Delete template recipient
|
|
207
363
|
|
|
208
364
|
</details>
|
|
209
365
|
<!-- End Available Resources and Operations [operations] -->
|
|
210
366
|
|
|
211
|
-
<!--
|
|
212
|
-
## Standalone functions
|
|
213
|
-
|
|
214
|
-
All the methods listed above are available as standalone functions. These
|
|
215
|
-
functions are ideal for use in applications running in the browser, serverless
|
|
216
|
-
runtimes or other environments where application bundle size is a primary
|
|
217
|
-
concern. When using a bundler to build your application, all unused
|
|
218
|
-
functionality will be either excluded from the final bundle or tree-shaken away.
|
|
219
|
-
|
|
220
|
-
To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
221
|
-
|
|
222
|
-
<details>
|
|
223
|
-
|
|
224
|
-
<summary>Available standalone functions</summary>
|
|
225
|
-
|
|
226
|
-
- [`documentsCreateV0`](docs/sdks/documents/README.md#createv0) - Create document
|
|
227
|
-
- [`documentsDelete`](docs/sdks/documents/README.md#delete) - Delete document
|
|
228
|
-
- [`documentsDistribute`](docs/sdks/documents/README.md#distribute) - Distribute document
|
|
229
|
-
- [`documentsDuplicate`](docs/sdks/documents/README.md#duplicate) - Duplicate document
|
|
230
|
-
- [`documentsFieldsCreate`](docs/sdks/fields/README.md#create) - Create document field
|
|
231
|
-
- [`documentsFieldsCreateMany`](docs/sdks/fields/README.md#createmany) - Create document fields
|
|
232
|
-
- [`documentsFieldsDelete`](docs/sdks/fields/README.md#delete) - Delete document field
|
|
233
|
-
- [`documentsFieldsGet`](docs/sdks/fields/README.md#get) - Get document field
|
|
234
|
-
- [`documentsFieldsUpdate`](docs/sdks/fields/README.md#update) - Update document field
|
|
235
|
-
- [`documentsFieldsUpdateMany`](docs/sdks/fields/README.md#updatemany) - Update document fields
|
|
236
|
-
- [`documentsFind`](docs/sdks/documents/README.md#find) - Find documents
|
|
237
|
-
- [`documentsGet`](docs/sdks/documents/README.md#get) - Get document
|
|
238
|
-
- [`documentsMoveToTeam`](docs/sdks/documents/README.md#movetoteam) - Move document
|
|
239
|
-
- [`documentsRecipientsCreate`](docs/sdks/recipients/README.md#create) - Create document recipient
|
|
240
|
-
- [`documentsRecipientsCreateMany`](docs/sdks/recipients/README.md#createmany) - Create document recipients
|
|
241
|
-
- [`documentsRecipientsDelete`](docs/sdks/recipients/README.md#delete) - Delete document recipient
|
|
242
|
-
- [`documentsRecipientsGet`](docs/sdks/recipients/README.md#get) - Get document recipient
|
|
243
|
-
- [`documentsRecipientsUpdate`](docs/sdks/recipients/README.md#update) - Update document recipient
|
|
244
|
-
- [`documentsRecipientsUpdateMany`](docs/sdks/recipients/README.md#updatemany) - Update document recipients
|
|
245
|
-
- [`documentsRedistribute`](docs/sdks/documents/README.md#redistribute) - Redistribute document
|
|
246
|
-
- [`documentsUpdate`](docs/sdks/documents/README.md#update) - Update document
|
|
247
|
-
- [`templatesDelete`](docs/sdks/templates/README.md#delete) - Delete template
|
|
248
|
-
- [`templatesDirectLinkCreate`](docs/sdks/directlink/README.md#create) - Create direct link
|
|
249
|
-
- [`templatesDirectLinkDelete`](docs/sdks/directlink/README.md#delete) - Delete direct link
|
|
250
|
-
- [`templatesDirectLinkToggle`](docs/sdks/directlink/README.md#toggle) - Toggle direct link
|
|
251
|
-
- [`templatesDuplicate`](docs/sdks/templates/README.md#duplicate) - Duplicate template
|
|
252
|
-
- [`templatesFieldsCreate`](docs/sdks/documensofields/README.md#create) - Create template field
|
|
253
|
-
- [`templatesFieldsCreateMany`](docs/sdks/documensofields/README.md#createmany) - Create template fields
|
|
254
|
-
- [`templatesFieldsDelete`](docs/sdks/documensofields/README.md#delete) - Delete template field
|
|
255
|
-
- [`templatesFieldsGet`](docs/sdks/documensofields/README.md#get) - Get template field
|
|
256
|
-
- [`templatesFieldsUpdate`](docs/sdks/documensofields/README.md#update) - Update template field
|
|
257
|
-
- [`templatesFieldsUpdateMany`](docs/sdks/documensofields/README.md#updatemany) - Update template fields
|
|
258
|
-
- [`templatesFind`](docs/sdks/templates/README.md#find) - Find templates
|
|
259
|
-
- [`templatesGet`](docs/sdks/templates/README.md#get) - Get template
|
|
260
|
-
- [`templatesMoveToTeam`](docs/sdks/templates/README.md#movetoteam) - Move template
|
|
261
|
-
- [`templatesRecipientsCreate`](docs/sdks/documensorecipients/README.md#create) - Create template recipient
|
|
262
|
-
- [`templatesRecipientsCreateMany`](docs/sdks/documensorecipients/README.md#createmany) - Create template recipients
|
|
263
|
-
- [`templatesRecipientsDelete`](docs/sdks/documensorecipients/README.md#delete) - Delete template recipient
|
|
264
|
-
- [`templatesRecipientsGet`](docs/sdks/documensorecipients/README.md#get) - Get template recipient
|
|
265
|
-
- [`templatesRecipientsUpdate`](docs/sdks/documensorecipients/README.md#update) - Update template recipient
|
|
266
|
-
- [`templatesRecipientsUpdateMany`](docs/sdks/documensorecipients/README.md#updatemany) - Update template recipients
|
|
267
|
-
- [`templatesUpdate`](docs/sdks/templates/README.md#update) - Update template
|
|
268
|
-
- [`templatesUse`](docs/sdks/templates/README.md#use) - Use template
|
|
269
|
-
|
|
270
|
-
</details>
|
|
271
|
-
<!-- End Standalone functions [standalone-funcs] -->
|
|
367
|
+
<!-- No Standalone functions [standalone-funcs] -->
|
|
272
368
|
|
|
273
369
|
<!-- Start Retries [retries] -->
|
|
274
370
|
## Retries
|
|
@@ -284,9 +380,7 @@ const documenso = new Documenso({
|
|
|
284
380
|
});
|
|
285
381
|
|
|
286
382
|
async function run() {
|
|
287
|
-
const result = await documenso.documents.find({
|
|
288
|
-
orderByDirection: "desc",
|
|
289
|
-
}, {
|
|
383
|
+
const result = await documenso.documents.find({}, {
|
|
290
384
|
retries: {
|
|
291
385
|
strategy: "backoff",
|
|
292
386
|
backoff: {
|
|
@@ -326,9 +420,7 @@ const documenso = new Documenso({
|
|
|
326
420
|
});
|
|
327
421
|
|
|
328
422
|
async function run() {
|
|
329
|
-
const result = await documenso.documents.find({
|
|
330
|
-
orderByDirection: "desc",
|
|
331
|
-
});
|
|
423
|
+
const result = await documenso.documents.find({});
|
|
332
424
|
|
|
333
425
|
// Handle the result
|
|
334
426
|
console.log(result);
|
|
@@ -344,21 +436,21 @@ run();
|
|
|
344
436
|
|
|
345
437
|
Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `find` method may throw the following errors:
|
|
346
438
|
|
|
347
|
-
| Error Type
|
|
348
|
-
|
|
|
349
|
-
| errors.
|
|
350
|
-
| errors.
|
|
351
|
-
| errors.
|
|
352
|
-
| errors.APIError
|
|
439
|
+
| Error Type | Status Code | Content Type |
|
|
440
|
+
| ----------------------------------------------- | ----------- | ---------------- |
|
|
441
|
+
| errors.DocumentFindDocumentsBadRequestError | 400 | application/json |
|
|
442
|
+
| errors.DocumentFindDocumentsNotFoundError | 404 | application/json |
|
|
443
|
+
| errors.DocumentFindDocumentsInternalServerError | 500 | application/json |
|
|
444
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
353
445
|
|
|
354
446
|
If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
|
|
355
447
|
|
|
356
448
|
```typescript
|
|
357
449
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
358
450
|
import {
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
451
|
+
DocumentFindDocumentsBadRequestError,
|
|
452
|
+
DocumentFindDocumentsInternalServerError,
|
|
453
|
+
DocumentFindDocumentsNotFoundError,
|
|
362
454
|
SDKValidationError,
|
|
363
455
|
} from "@documenso/sdk-typescript/models/errors";
|
|
364
456
|
|
|
@@ -369,9 +461,7 @@ const documenso = new Documenso({
|
|
|
369
461
|
async function run() {
|
|
370
462
|
let result;
|
|
371
463
|
try {
|
|
372
|
-
result = await documenso.documents.find({
|
|
373
|
-
orderByDirection: "desc",
|
|
374
|
-
});
|
|
464
|
+
result = await documenso.documents.find({});
|
|
375
465
|
|
|
376
466
|
// Handle the result
|
|
377
467
|
console.log(result);
|
|
@@ -385,18 +475,18 @@ async function run() {
|
|
|
385
475
|
console.error(err.rawValue);
|
|
386
476
|
return;
|
|
387
477
|
}
|
|
388
|
-
case (err instanceof
|
|
389
|
-
// Handle err.data$:
|
|
478
|
+
case (err instanceof DocumentFindDocumentsBadRequestError): {
|
|
479
|
+
// Handle err.data$: DocumentFindDocumentsBadRequestErrorData
|
|
390
480
|
console.error(err);
|
|
391
481
|
return;
|
|
392
482
|
}
|
|
393
|
-
case (err instanceof
|
|
394
|
-
// Handle err.data$:
|
|
483
|
+
case (err instanceof DocumentFindDocumentsNotFoundError): {
|
|
484
|
+
// Handle err.data$: DocumentFindDocumentsNotFoundErrorData
|
|
395
485
|
console.error(err);
|
|
396
486
|
return;
|
|
397
487
|
}
|
|
398
|
-
case (err instanceof
|
|
399
|
-
// Handle err.data$:
|
|
488
|
+
case (err instanceof DocumentFindDocumentsInternalServerError): {
|
|
489
|
+
// Handle err.data$: DocumentFindDocumentsInternalServerErrorData
|
|
400
490
|
console.error(err);
|
|
401
491
|
return;
|
|
402
492
|
}
|
|
@@ -425,13 +515,12 @@ In some rare cases, the SDK can fail to get a response from the server or even m
|
|
|
425
515
|
| UnexpectedClientError | Unrecognised or unexpected error |
|
|
426
516
|
<!-- End Error Handling [errors] -->
|
|
427
517
|
|
|
428
|
-
|
|
429
518
|
<!-- Start Server Selection [server] -->
|
|
430
519
|
## Server Selection
|
|
431
520
|
|
|
432
521
|
### Override Server URL Per-Client
|
|
433
522
|
|
|
434
|
-
The default server can
|
|
523
|
+
The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
|
435
524
|
```typescript
|
|
436
525
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
437
526
|
|
|
@@ -441,9 +530,7 @@ const documenso = new Documenso({
|
|
|
441
530
|
});
|
|
442
531
|
|
|
443
532
|
async function run() {
|
|
444
|
-
const result = await documenso.documents.find({
|
|
445
|
-
orderByDirection: "desc",
|
|
446
|
-
});
|
|
533
|
+
const result = await documenso.documents.find({});
|
|
447
534
|
|
|
448
535
|
// Handle the result
|
|
449
536
|
console.log(result);
|
|
@@ -454,54 +541,7 @@ run();
|
|
|
454
541
|
```
|
|
455
542
|
<!-- End Server Selection [server] -->
|
|
456
543
|
|
|
457
|
-
<!--
|
|
458
|
-
## Custom HTTP Client
|
|
459
|
-
|
|
460
|
-
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
|
|
461
|
-
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
|
|
462
|
-
client is a thin wrapper around `fetch` and provides the ability to attach hooks
|
|
463
|
-
around the request lifecycle that can be used to modify the request or handle
|
|
464
|
-
errors and response.
|
|
465
|
-
|
|
466
|
-
The `HTTPClient` constructor takes an optional `fetcher` argument that can be
|
|
467
|
-
used to integrate a third-party HTTP client or when writing tests to mock out
|
|
468
|
-
the HTTP client and feed in fixtures.
|
|
469
|
-
|
|
470
|
-
The following example shows how to use the `"beforeRequest"` hook to to add a
|
|
471
|
-
custom header and a timeout to requests and how to use the `"requestError"` hook
|
|
472
|
-
to log errors:
|
|
473
|
-
|
|
474
|
-
```typescript
|
|
475
|
-
import { Documenso } from "@documenso/sdk-typescript";
|
|
476
|
-
import { HTTPClient } from "@documenso/sdk-typescript/lib/http";
|
|
477
|
-
|
|
478
|
-
const httpClient = new HTTPClient({
|
|
479
|
-
// fetcher takes a function that has the same signature as native `fetch`.
|
|
480
|
-
fetcher: (request) => {
|
|
481
|
-
return fetch(request);
|
|
482
|
-
}
|
|
483
|
-
});
|
|
484
|
-
|
|
485
|
-
httpClient.addHook("beforeRequest", (request) => {
|
|
486
|
-
const nextRequest = new Request(request, {
|
|
487
|
-
signal: request.signal || AbortSignal.timeout(5000)
|
|
488
|
-
});
|
|
489
|
-
|
|
490
|
-
nextRequest.headers.set("x-custom-header", "custom value");
|
|
491
|
-
|
|
492
|
-
return nextRequest;
|
|
493
|
-
});
|
|
494
|
-
|
|
495
|
-
httpClient.addHook("requestError", (error, request) => {
|
|
496
|
-
console.group("Request Error");
|
|
497
|
-
console.log("Reason:", `${error}`);
|
|
498
|
-
console.log("Endpoint:", `${request.method} ${request.url}`);
|
|
499
|
-
console.groupEnd();
|
|
500
|
-
});
|
|
501
|
-
|
|
502
|
-
const sdk = new Documenso({ httpClient });
|
|
503
|
-
```
|
|
504
|
-
<!-- End Custom HTTP Client [http-client] -->
|
|
544
|
+
<!-- No Custom HTTP Client [http-client] -->
|
|
505
545
|
|
|
506
546
|
<!-- Start Debugging [debug] -->
|
|
507
547
|
## Debugging
|