@documenso/sdk-typescript 0.3.1 → 0.4.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 +4 -4
- package/README.md +122 -113
- package/RUNTIMES.md +6 -6
- package/bin/mcp-server.js +4914 -2598
- package/bin/mcp-server.js.map +150 -143
- package/docs/sdks/directlink/README.md +3 -0
- package/docs/sdks/document/README.md +84 -0
- package/docs/sdks/documents/README.md +124 -108
- package/docs/sdks/documentsfields/README.md +6 -0
- package/docs/sdks/documentsrecipients/README.md +6 -0
- package/docs/sdks/embedding/README.md +2 -0
- package/docs/sdks/template/README.md +83 -0
- package/docs/sdks/templates/README.md +6 -0
- package/docs/sdks/templatesfields/README.md +6 -0
- package/docs/sdks/templatesrecipients/README.md +6 -0
- package/examples/README.md +31 -0
- package/examples/documentsGet.example.ts +28 -0
- package/examples/package-lock.json +627 -0
- package/examples/package.json +18 -0
- package/funcs/documentDocumentDownload.d.ts +18 -0
- package/funcs/documentDocumentDownload.d.ts.map +1 -0
- package/funcs/documentDocumentDownload.js +127 -0
- package/funcs/documentDocumentDownload.js.map +1 -0
- package/funcs/documentsCreateV0.js +1 -1
- package/funcs/documentsCreateV0.js.map +1 -1
- package/funcs/documentsDelete.d.ts +1 -1
- package/funcs/documentsDelete.d.ts.map +1 -1
- package/funcs/documentsDelete.js +4 -4
- package/funcs/documentsDelete.js.map +1 -1
- package/funcs/documentsDistribute.d.ts +1 -1
- package/funcs/documentsDistribute.d.ts.map +1 -1
- package/funcs/documentsDistribute.js +4 -4
- package/funcs/documentsDistribute.js.map +1 -1
- package/funcs/documentsDuplicate.d.ts +1 -1
- package/funcs/documentsDuplicate.d.ts.map +1 -1
- package/funcs/documentsDuplicate.js +4 -4
- package/funcs/documentsDuplicate.js.map +1 -1
- package/funcs/documentsFieldsCreate.js +1 -1
- package/funcs/documentsFieldsCreate.js.map +1 -1
- package/funcs/documentsFieldsCreateMany.js +1 -1
- package/funcs/documentsFieldsCreateMany.js.map +1 -1
- package/funcs/documentsFieldsDelete.js +1 -1
- package/funcs/documentsFieldsDelete.js.map +1 -1
- package/funcs/documentsFieldsGet.js +1 -1
- package/funcs/documentsFieldsGet.js.map +1 -1
- package/funcs/documentsFieldsUpdate.js +1 -1
- package/funcs/documentsFieldsUpdate.js.map +1 -1
- package/funcs/documentsFieldsUpdateMany.js +1 -1
- package/funcs/documentsFieldsUpdateMany.js.map +1 -1
- package/funcs/documentsFind.d.ts +1 -1
- package/funcs/documentsFind.d.ts.map +1 -1
- package/funcs/documentsFind.js +4 -4
- package/funcs/documentsFind.js.map +1 -1
- package/funcs/documentsGet.d.ts +1 -1
- package/funcs/documentsGet.d.ts.map +1 -1
- package/funcs/documentsGet.js +4 -9
- package/funcs/documentsGet.js.map +1 -1
- package/funcs/documentsRecipientsCreate.js +1 -1
- package/funcs/documentsRecipientsCreate.js.map +1 -1
- package/funcs/documentsRecipientsCreateMany.js +1 -1
- package/funcs/documentsRecipientsCreateMany.js.map +1 -1
- package/funcs/documentsRecipientsDelete.js +1 -1
- package/funcs/documentsRecipientsDelete.js.map +1 -1
- package/funcs/documentsRecipientsGet.js +1 -1
- package/funcs/documentsRecipientsGet.js.map +1 -1
- package/funcs/documentsRecipientsUpdate.js +1 -1
- package/funcs/documentsRecipientsUpdate.js.map +1 -1
- package/funcs/documentsRecipientsUpdateMany.js +1 -1
- package/funcs/documentsRecipientsUpdateMany.js.map +1 -1
- package/funcs/documentsRedistribute.d.ts +1 -1
- package/funcs/documentsRedistribute.d.ts.map +1 -1
- package/funcs/documentsRedistribute.js +4 -4
- package/funcs/documentsRedistribute.js.map +1 -1
- package/funcs/documentsUpdate.d.ts +1 -1
- package/funcs/documentsUpdate.d.ts.map +1 -1
- package/funcs/documentsUpdate.js +4 -4
- package/funcs/documentsUpdate.js.map +1 -1
- package/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.js +1 -1
- package/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.js.map +1 -1
- package/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.js +1 -1
- package/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.js.map +1 -1
- package/funcs/templateTemplateCreateTemplateTemporary.d.ts +18 -0
- package/funcs/templateTemplateCreateTemplateTemporary.d.ts.map +1 -0
- package/funcs/templateTemplateCreateTemplateTemporary.js +118 -0
- package/funcs/templateTemplateCreateTemplateTemporary.js.map +1 -0
- package/funcs/templatesDelete.js +1 -1
- package/funcs/templatesDelete.js.map +1 -1
- package/funcs/templatesDirectLinkCreate.js +1 -1
- package/funcs/templatesDirectLinkCreate.js.map +1 -1
- package/funcs/templatesDirectLinkDelete.js +1 -1
- package/funcs/templatesDirectLinkDelete.js.map +1 -1
- package/funcs/templatesDirectLinkToggle.js +1 -1
- package/funcs/templatesDirectLinkToggle.js.map +1 -1
- package/funcs/templatesDuplicate.js +1 -1
- package/funcs/templatesDuplicate.js.map +1 -1
- package/funcs/templatesFieldsCreate.js +1 -1
- package/funcs/templatesFieldsCreate.js.map +1 -1
- package/funcs/templatesFieldsCreateMany.js +1 -1
- package/funcs/templatesFieldsCreateMany.js.map +1 -1
- package/funcs/templatesFieldsDelete.js +1 -1
- package/funcs/templatesFieldsDelete.js.map +1 -1
- package/funcs/templatesFieldsGet.js +1 -1
- package/funcs/templatesFieldsGet.js.map +1 -1
- package/funcs/templatesFieldsUpdate.js +1 -1
- package/funcs/templatesFieldsUpdate.js.map +1 -1
- package/funcs/templatesFieldsUpdateMany.js +1 -1
- package/funcs/templatesFieldsUpdateMany.js.map +1 -1
- package/funcs/templatesFind.js +1 -1
- package/funcs/templatesFind.js.map +1 -1
- package/funcs/templatesGet.js +1 -1
- package/funcs/templatesGet.js.map +1 -1
- package/funcs/templatesRecipientsCreate.js +1 -1
- package/funcs/templatesRecipientsCreate.js.map +1 -1
- package/funcs/templatesRecipientsCreateMany.js +1 -1
- package/funcs/templatesRecipientsCreateMany.js.map +1 -1
- package/funcs/templatesRecipientsDelete.js +1 -1
- package/funcs/templatesRecipientsDelete.js.map +1 -1
- package/funcs/templatesRecipientsGet.js +1 -1
- package/funcs/templatesRecipientsGet.js.map +1 -1
- package/funcs/templatesRecipientsUpdate.js +1 -1
- package/funcs/templatesRecipientsUpdate.js.map +1 -1
- package/funcs/templatesRecipientsUpdateMany.js +1 -1
- package/funcs/templatesRecipientsUpdateMany.js.map +1 -1
- package/funcs/templatesUpdate.js +1 -1
- package/funcs/templatesUpdate.js.map +1 -1
- package/funcs/templatesUse.js +1 -1
- package/funcs/templatesUse.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/encodings.d.ts.map +1 -1
- package/lib/env.d.ts.map +1 -1
- package/lib/env.js +18 -1
- package/lib/env.js.map +1 -1
- package/lib/security.d.ts.map +1 -1
- package/lib/security.js.map +1 -1
- package/lib/url.js +1 -1
- package/lib/url.js.map +1 -1
- package/mcp-server/cli/start/command.d.ts.map +1 -1
- package/mcp-server/cli/start/command.js +0 -12
- package/mcp-server/cli/start/command.js.map +1 -1
- package/mcp-server/cli/start/impl.d.ts +0 -2
- package/mcp-server/cli/start/impl.d.ts.map +1 -1
- package/mcp-server/cli/start/impl.js +0 -2
- package/mcp-server/cli/start/impl.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +9 -5
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/documentDocumentDownload.d.ts +8 -0
- package/mcp-server/tools/documentDocumentDownload.d.ts.map +1 -0
- package/mcp-server/tools/documentDocumentDownload.js +64 -0
- package/mcp-server/tools/documentDocumentDownload.js.map +1 -0
- package/mcp-server/tools/documentsDelete.d.ts +1 -1
- package/mcp-server/tools/documentsDelete.js +1 -1
- package/mcp-server/tools/documentsDelete.js.map +1 -1
- package/mcp-server/tools/documentsDistribute.d.ts +1 -1
- package/mcp-server/tools/documentsDistribute.js +1 -1
- package/mcp-server/tools/documentsDistribute.js.map +1 -1
- package/mcp-server/tools/documentsDuplicate.d.ts +1 -1
- package/mcp-server/tools/documentsDuplicate.js +1 -1
- package/mcp-server/tools/documentsDuplicate.js.map +1 -1
- package/mcp-server/tools/documentsFind.d.ts +1 -1
- package/mcp-server/tools/documentsFind.js +1 -1
- package/mcp-server/tools/documentsFind.js.map +1 -1
- package/mcp-server/tools/documentsGet.d.ts +1 -1
- package/mcp-server/tools/documentsGet.js +1 -1
- package/mcp-server/tools/documentsGet.js.map +1 -1
- package/mcp-server/tools/documentsRedistribute.d.ts +1 -1
- package/mcp-server/tools/documentsRedistribute.js +1 -1
- package/mcp-server/tools/documentsRedistribute.js.map +1 -1
- package/mcp-server/tools/documentsUpdate.d.ts +1 -1
- package/mcp-server/tools/documentsUpdate.js +1 -1
- package/mcp-server/tools/documentsUpdate.js.map +1 -1
- package/mcp-server/tools/templateTemplateCreateTemplateTemporary.d.ts +8 -0
- package/mcp-server/tools/templateTemplateCreateTemplateTemporary.d.ts.map +1 -0
- package/mcp-server/tools/templateTemplateCreateTemplateTemporary.js +64 -0
- package/mcp-server/tools/templateTemplateCreateTemplateTemporary.js.map +1 -0
- package/models/errors/apierror.d.ts.map +1 -1
- package/models/errors/apierror.js +8 -2
- package/models/errors/apierror.js.map +1 -1
- package/models/errors/documentcreatedocumenttemporary.d.ts.map +1 -1
- package/models/errors/documentcreatedocumenttemporary.js +2 -6
- package/models/errors/documentcreatedocumenttemporary.js.map +1 -1
- package/models/errors/documentdelete.d.ts +143 -0
- package/models/errors/documentdelete.d.ts.map +1 -0
- package/models/errors/documentdelete.js +199 -0
- package/models/errors/documentdelete.js.map +1 -0
- package/models/errors/documentdistribute.d.ts +143 -0
- package/models/errors/documentdistribute.d.ts.map +1 -0
- package/models/errors/documentdistribute.js +198 -0
- package/models/errors/documentdistribute.js.map +1 -0
- package/models/errors/documentdownload.d.ts +212 -0
- package/models/errors/documentdownload.d.ts.map +1 -0
- package/models/errors/documentdownload.js +277 -0
- package/models/errors/documentdownload.js.map +1 -0
- package/models/errors/documentduplicate.d.ts +143 -0
- package/models/errors/documentduplicate.d.ts.map +1 -0
- package/models/errors/documentduplicate.js +198 -0
- package/models/errors/documentduplicate.js.map +1 -0
- package/models/errors/documentfind.d.ts +212 -0
- package/models/errors/documentfind.d.ts.map +1 -0
- package/models/errors/documentfind.js +278 -0
- package/models/errors/documentfind.js.map +1 -0
- package/models/errors/documentget.d.ts +212 -0
- package/models/errors/documentget.d.ts.map +1 -0
- package/models/errors/documentget.js +278 -0
- package/models/errors/documentget.js.map +1 -0
- package/models/errors/documentredistribute.d.ts +143 -0
- package/models/errors/{documentsenddocument.d.ts.map → documentredistribute.d.ts.map} +1 -1
- package/models/errors/documentredistribute.js +197 -0
- package/models/errors/documentredistribute.js.map +1 -0
- package/models/errors/documentupdate.d.ts +143 -0
- package/models/errors/documentupdate.d.ts.map +1 -0
- package/models/errors/documentupdate.js +199 -0
- package/models/errors/documentupdate.js.map +1 -0
- package/models/errors/embeddingpresigncreateembeddingpresigntoken.d.ts.map +1 -1
- package/models/errors/embeddingpresigncreateembeddingpresigntoken.js +2 -6
- package/models/errors/embeddingpresigncreateembeddingpresigntoken.js.map +1 -1
- package/models/errors/embeddingpresignverifyembeddingpresigntoken.d.ts.map +1 -1
- package/models/errors/embeddingpresignverifyembeddingpresigntoken.js +2 -6
- package/models/errors/embeddingpresignverifyembeddingpresigntoken.js.map +1 -1
- package/models/errors/fieldcreatedocumentfield.d.ts.map +1 -1
- package/models/errors/fieldcreatedocumentfield.js +2 -6
- package/models/errors/fieldcreatedocumentfield.js.map +1 -1
- package/models/errors/fieldcreatedocumentfields.d.ts.map +1 -1
- package/models/errors/fieldcreatedocumentfields.js +2 -6
- package/models/errors/fieldcreatedocumentfields.js.map +1 -1
- package/models/errors/fieldcreatetemplatefield.d.ts.map +1 -1
- package/models/errors/fieldcreatetemplatefield.js +2 -6
- package/models/errors/fieldcreatetemplatefield.js.map +1 -1
- package/models/errors/fieldcreatetemplatefields.d.ts.map +1 -1
- package/models/errors/fieldcreatetemplatefields.js +2 -6
- package/models/errors/fieldcreatetemplatefields.js.map +1 -1
- package/models/errors/fielddeletedocumentfield.d.ts.map +1 -1
- package/models/errors/fielddeletedocumentfield.js +2 -6
- package/models/errors/fielddeletedocumentfield.js.map +1 -1
- package/models/errors/fielddeletetemplatefield.d.ts.map +1 -1
- package/models/errors/fielddeletetemplatefield.js +2 -6
- package/models/errors/fielddeletetemplatefield.js.map +1 -1
- package/models/errors/fieldgetdocumentfield.d.ts.map +1 -1
- package/models/errors/fieldgetdocumentfield.js +3 -9
- package/models/errors/fieldgetdocumentfield.js.map +1 -1
- package/models/errors/fieldgettemplatefield.d.ts.map +1 -1
- package/models/errors/fieldgettemplatefield.js +3 -9
- package/models/errors/fieldgettemplatefield.js.map +1 -1
- package/models/errors/fieldupdatedocumentfield.d.ts.map +1 -1
- package/models/errors/fieldupdatedocumentfield.js +2 -6
- package/models/errors/fieldupdatedocumentfield.js.map +1 -1
- package/models/errors/fieldupdatedocumentfields.d.ts.map +1 -1
- package/models/errors/fieldupdatedocumentfields.js +2 -6
- package/models/errors/fieldupdatedocumentfields.js.map +1 -1
- package/models/errors/fieldupdatetemplatefield.d.ts.map +1 -1
- package/models/errors/fieldupdatetemplatefield.js +2 -6
- package/models/errors/fieldupdatetemplatefield.js.map +1 -1
- package/models/errors/fieldupdatetemplatefields.d.ts.map +1 -1
- package/models/errors/fieldupdatetemplatefields.js +2 -6
- package/models/errors/fieldupdatetemplatefields.js.map +1 -1
- package/models/errors/index.d.ts +10 -7
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +10 -7
- package/models/errors/index.js.map +1 -1
- package/models/errors/recipientcreatedocumentrecipient.d.ts.map +1 -1
- package/models/errors/recipientcreatedocumentrecipient.js +2 -6
- package/models/errors/recipientcreatedocumentrecipient.js.map +1 -1
- package/models/errors/recipientcreatedocumentrecipients.d.ts.map +1 -1
- package/models/errors/recipientcreatedocumentrecipients.js +2 -6
- package/models/errors/recipientcreatedocumentrecipients.js.map +1 -1
- package/models/errors/recipientcreatetemplaterecipient.d.ts.map +1 -1
- package/models/errors/recipientcreatetemplaterecipient.js +2 -6
- package/models/errors/recipientcreatetemplaterecipient.js.map +1 -1
- package/models/errors/recipientcreatetemplaterecipients.d.ts.map +1 -1
- package/models/errors/recipientcreatetemplaterecipients.js +2 -6
- package/models/errors/recipientcreatetemplaterecipients.js.map +1 -1
- package/models/errors/recipientdeletedocumentrecipient.d.ts.map +1 -1
- package/models/errors/recipientdeletedocumentrecipient.js +2 -6
- package/models/errors/recipientdeletedocumentrecipient.js.map +1 -1
- package/models/errors/recipientdeletetemplaterecipient.d.ts.map +1 -1
- package/models/errors/recipientdeletetemplaterecipient.js +2 -6
- package/models/errors/recipientdeletetemplaterecipient.js.map +1 -1
- package/models/errors/recipientgetdocumentrecipient.d.ts.map +1 -1
- package/models/errors/recipientgetdocumentrecipient.js +3 -9
- package/models/errors/recipientgetdocumentrecipient.js.map +1 -1
- package/models/errors/recipientgettemplaterecipient.d.ts.map +1 -1
- package/models/errors/recipientgettemplaterecipient.js +3 -9
- package/models/errors/recipientgettemplaterecipient.js.map +1 -1
- package/models/errors/recipientupdatedocumentrecipient.d.ts.map +1 -1
- package/models/errors/recipientupdatedocumentrecipient.js +2 -6
- package/models/errors/recipientupdatedocumentrecipient.js.map +1 -1
- package/models/errors/recipientupdatedocumentrecipients.d.ts.map +1 -1
- package/models/errors/recipientupdatedocumentrecipients.js +2 -6
- package/models/errors/recipientupdatedocumentrecipients.js.map +1 -1
- package/models/errors/recipientupdatetemplaterecipient.d.ts.map +1 -1
- package/models/errors/recipientupdatetemplaterecipient.js +2 -6
- package/models/errors/recipientupdatetemplaterecipient.js.map +1 -1
- package/models/errors/recipientupdatetemplaterecipients.d.ts.map +1 -1
- package/models/errors/recipientupdatetemplaterecipients.js +2 -6
- package/models/errors/recipientupdatetemplaterecipients.js.map +1 -1
- package/models/errors/templatecreatedocumentfromtemplate.d.ts.map +1 -1
- package/models/errors/templatecreatedocumentfromtemplate.js +2 -6
- package/models/errors/templatecreatedocumentfromtemplate.js.map +1 -1
- package/models/errors/templatecreatetemplatedirectlink.d.ts.map +1 -1
- package/models/errors/templatecreatetemplatedirectlink.js +2 -6
- package/models/errors/templatecreatetemplatedirectlink.js.map +1 -1
- package/models/errors/templatecreatetemplatetemporary.d.ts +143 -0
- package/models/errors/templatecreatetemplatetemporary.d.ts.map +1 -0
- package/models/errors/templatecreatetemplatetemporary.js +199 -0
- package/models/errors/templatecreatetemplatetemporary.js.map +1 -0
- package/models/errors/templatedeletetemplate.d.ts.map +1 -1
- package/models/errors/templatedeletetemplate.js +2 -6
- package/models/errors/templatedeletetemplate.js.map +1 -1
- package/models/errors/templatedeletetemplatedirectlink.d.ts.map +1 -1
- package/models/errors/templatedeletetemplatedirectlink.js +2 -6
- package/models/errors/templatedeletetemplatedirectlink.js.map +1 -1
- package/models/errors/templateduplicatetemplate.d.ts.map +1 -1
- package/models/errors/templateduplicatetemplate.js +2 -6
- package/models/errors/templateduplicatetemplate.js.map +1 -1
- package/models/errors/templatefindtemplates.d.ts.map +1 -1
- package/models/errors/templatefindtemplates.js +3 -9
- package/models/errors/templatefindtemplates.js.map +1 -1
- package/models/errors/templategettemplatebyid.d.ts.map +1 -1
- package/models/errors/templategettemplatebyid.js +3 -9
- package/models/errors/templategettemplatebyid.js.map +1 -1
- package/models/errors/templatetoggletemplatedirectlink.d.ts.map +1 -1
- package/models/errors/templatetoggletemplatedirectlink.js +2 -6
- package/models/errors/templatetoggletemplatedirectlink.js.map +1 -1
- package/models/errors/templateupdatetemplate.d.ts.map +1 -1
- package/models/errors/templateupdatetemplate.js +2 -6
- package/models/errors/templateupdatetemplate.js.map +1 -1
- package/models/operations/documentcreatedocumenttemporary.d.ts +197 -67
- package/models/operations/documentcreatedocumenttemporary.d.ts.map +1 -1
- package/models/operations/documentcreatedocumenttemporary.js +136 -53
- package/models/operations/documentcreatedocumenttemporary.js.map +1 -1
- package/models/operations/documentdelete.d.ts +57 -0
- package/models/operations/documentdelete.d.ts.map +1 -0
- package/models/operations/documentdelete.js +96 -0
- package/models/operations/documentdelete.js.map +1 -0
- package/models/operations/documentdistribute.d.ts +602 -0
- package/models/operations/documentdistribute.d.ts.map +1 -0
- package/models/operations/documentdistribute.js +471 -0
- package/models/operations/documentdistribute.js.map +1 -0
- package/models/operations/documentdownload.d.ts +110 -0
- package/models/operations/documentdownload.d.ts.map +1 -0
- package/models/operations/documentdownload.js +125 -0
- package/models/operations/documentdownload.js.map +1 -0
- package/models/operations/documentduplicate.d.ts +65 -0
- package/models/operations/documentduplicate.d.ts.map +1 -0
- package/models/operations/documentduplicate.js +98 -0
- package/models/operations/documentduplicate.js.map +1 -0
- package/models/operations/{documentfinddocuments.d.ts → documentfind.d.ts} +223 -210
- package/models/operations/documentfind.d.ts.map +1 -0
- package/models/operations/documentfind.js +710 -0
- package/models/operations/documentfind.js.map +1 -0
- package/models/operations/documentget.d.ts +1864 -0
- package/models/operations/documentget.d.ts.map +1 -0
- package/models/operations/documentget.js +1698 -0
- package/models/operations/documentget.js.map +1 -0
- package/models/operations/documentredistribute.d.ts +62 -0
- package/models/operations/documentredistribute.d.ts.map +1 -0
- package/models/operations/documentredistribute.js +98 -0
- package/models/operations/documentredistribute.js.map +1 -0
- package/models/operations/documentupdate.d.ts +793 -0
- package/models/operations/documentupdate.d.ts.map +1 -0
- package/models/operations/documentupdate.js +610 -0
- package/models/operations/documentupdate.js.map +1 -0
- package/models/operations/fieldcreatedocumentfield.d.ts +74 -16
- package/models/operations/fieldcreatedocumentfield.d.ts.map +1 -1
- package/models/operations/fieldcreatedocumentfield.js +70 -22
- package/models/operations/fieldcreatedocumentfield.js.map +1 -1
- package/models/operations/fieldcreatedocumentfields.d.ts +74 -16
- package/models/operations/fieldcreatedocumentfields.d.ts.map +1 -1
- package/models/operations/fieldcreatedocumentfields.js +71 -22
- package/models/operations/fieldcreatedocumentfields.js.map +1 -1
- package/models/operations/fieldcreatetemplatefield.d.ts +74 -16
- package/models/operations/fieldcreatetemplatefield.d.ts.map +1 -1
- package/models/operations/fieldcreatetemplatefield.js +70 -22
- package/models/operations/fieldcreatetemplatefield.js.map +1 -1
- package/models/operations/fieldcreatetemplatefields.d.ts +74 -16
- package/models/operations/fieldcreatetemplatefields.d.ts.map +1 -1
- package/models/operations/fieldcreatetemplatefields.js +71 -22
- package/models/operations/fieldcreatetemplatefields.js.map +1 -1
- package/models/operations/fieldgetdocumentfield.d.ts +41 -10
- package/models/operations/fieldgetdocumentfield.d.ts.map +1 -1
- package/models/operations/fieldgetdocumentfield.js +38 -13
- package/models/operations/fieldgetdocumentfield.js.map +1 -1
- package/models/operations/fieldgettemplatefield.d.ts +41 -10
- package/models/operations/fieldgettemplatefield.d.ts.map +1 -1
- package/models/operations/fieldgettemplatefield.js +38 -13
- package/models/operations/fieldgettemplatefield.js.map +1 -1
- package/models/operations/fieldupdatedocumentfield.d.ts +74 -16
- package/models/operations/fieldupdatedocumentfield.d.ts.map +1 -1
- package/models/operations/fieldupdatedocumentfield.js +70 -22
- package/models/operations/fieldupdatedocumentfield.js.map +1 -1
- package/models/operations/fieldupdatedocumentfields.d.ts +74 -16
- package/models/operations/fieldupdatedocumentfields.d.ts.map +1 -1
- package/models/operations/fieldupdatedocumentfields.js +71 -22
- package/models/operations/fieldupdatedocumentfields.js.map +1 -1
- package/models/operations/fieldupdatetemplatefield.d.ts +74 -16
- package/models/operations/fieldupdatetemplatefield.d.ts.map +1 -1
- package/models/operations/fieldupdatetemplatefield.js +70 -22
- package/models/operations/fieldupdatetemplatefield.js.map +1 -1
- package/models/operations/fieldupdatetemplatefields.d.ts +74 -16
- package/models/operations/fieldupdatetemplatefields.d.ts.map +1 -1
- package/models/operations/fieldupdatetemplatefields.js +71 -22
- package/models/operations/fieldupdatetemplatefields.js.map +1 -1
- package/models/operations/index.d.ts +9 -7
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +9 -7
- package/models/operations/index.js.map +1 -1
- package/models/operations/recipientcreatedocumentrecipient.d.ts +12 -4
- package/models/operations/recipientcreatedocumentrecipient.d.ts.map +1 -1
- package/models/operations/recipientcreatedocumentrecipient.js +8 -4
- package/models/operations/recipientcreatedocumentrecipient.js.map +1 -1
- package/models/operations/recipientcreatedocumentrecipients.d.ts +12 -4
- package/models/operations/recipientcreatedocumentrecipients.d.ts.map +1 -1
- package/models/operations/recipientcreatedocumentrecipients.js +8 -4
- package/models/operations/recipientcreatedocumentrecipients.js.map +1 -1
- package/models/operations/recipientcreatetemplaterecipient.d.ts +12 -4
- package/models/operations/recipientcreatetemplaterecipient.d.ts.map +1 -1
- package/models/operations/recipientcreatetemplaterecipient.js +8 -4
- package/models/operations/recipientcreatetemplaterecipient.js.map +1 -1
- package/models/operations/recipientcreatetemplaterecipients.d.ts +12 -4
- package/models/operations/recipientcreatetemplaterecipients.d.ts.map +1 -1
- package/models/operations/recipientcreatetemplaterecipients.js +8 -4
- package/models/operations/recipientcreatetemplaterecipients.js.map +1 -1
- package/models/operations/recipientgetdocumentrecipient.d.ts +50 -14
- package/models/operations/recipientgetdocumentrecipient.d.ts.map +1 -1
- package/models/operations/recipientgetdocumentrecipient.js +45 -17
- package/models/operations/recipientgetdocumentrecipient.js.map +1 -1
- package/models/operations/recipientgettemplaterecipient.d.ts +50 -14
- package/models/operations/recipientgettemplaterecipient.d.ts.map +1 -1
- package/models/operations/recipientgettemplaterecipient.js +45 -17
- package/models/operations/recipientgettemplaterecipient.js.map +1 -1
- package/models/operations/recipientupdatedocumentrecipient.d.ts +53 -14
- package/models/operations/recipientupdatedocumentrecipient.d.ts.map +1 -1
- package/models/operations/recipientupdatedocumentrecipient.js +48 -18
- package/models/operations/recipientupdatedocumentrecipient.js.map +1 -1
- package/models/operations/recipientupdatedocumentrecipients.d.ts +53 -14
- package/models/operations/recipientupdatedocumentrecipients.d.ts.map +1 -1
- package/models/operations/recipientupdatedocumentrecipients.js +49 -18
- package/models/operations/recipientupdatedocumentrecipients.js.map +1 -1
- package/models/operations/recipientupdatetemplaterecipient.d.ts +53 -14
- package/models/operations/recipientupdatetemplaterecipient.d.ts.map +1 -1
- package/models/operations/recipientupdatetemplaterecipient.js +48 -18
- package/models/operations/recipientupdatetemplaterecipient.js.map +1 -1
- package/models/operations/recipientupdatetemplaterecipients.d.ts +53 -14
- package/models/operations/recipientupdatetemplaterecipients.d.ts.map +1 -1
- package/models/operations/recipientupdatetemplaterecipients.js +49 -18
- package/models/operations/recipientupdatetemplaterecipients.js.map +1 -1
- package/models/operations/templatecreatedocumentfromtemplate.d.ts +112 -25
- package/models/operations/templatecreatedocumentfromtemplate.d.ts.map +1 -1
- package/models/operations/templatecreatedocumentfromtemplate.js +104 -29
- package/models/operations/templatecreatedocumentfromtemplate.js.map +1 -1
- package/models/operations/templatecreatetemplatedirectlink.d.ts +4 -2
- package/models/operations/templatecreatetemplatedirectlink.d.ts.map +1 -1
- package/models/operations/templatecreatetemplatedirectlink.js +4 -2
- package/models/operations/templatecreatetemplatedirectlink.js.map +1 -1
- package/models/operations/templatecreatetemplatetemporary.d.ts +2364 -0
- package/models/operations/templatecreatetemplatetemporary.d.ts.map +1 -0
- package/models/operations/templatecreatetemplatetemporary.js +2109 -0
- package/models/operations/templatecreatetemplatetemporary.js.map +1 -0
- package/models/operations/templateduplicatetemplate.d.ts +7 -2
- package/models/operations/templateduplicatetemplate.d.ts.map +1 -1
- package/models/operations/templateduplicatetemplate.js +5 -2
- package/models/operations/templateduplicatetemplate.js.map +1 -1
- package/models/operations/templatefindtemplates.d.ts +59 -18
- package/models/operations/templatefindtemplates.d.ts.map +1 -1
- package/models/operations/templatefindtemplates.js +53 -22
- package/models/operations/templatefindtemplates.js.map +1 -1
- package/models/operations/templategettemplatebyid.d.ts +96 -47
- package/models/operations/templategettemplatebyid.d.ts.map +1 -1
- package/models/operations/templategettemplatebyid.js +99 -58
- package/models/operations/templategettemplatebyid.js.map +1 -1
- package/models/operations/templatetoggletemplatedirectlink.d.ts +4 -2
- package/models/operations/templatetoggletemplatedirectlink.d.ts.map +1 -1
- package/models/operations/templatetoggletemplatedirectlink.js +4 -2
- package/models/operations/templatetoggletemplatedirectlink.js.map +1 -1
- package/models/operations/templateupdatetemplate.d.ts +85 -32
- package/models/operations/templateupdatetemplate.d.ts.map +1 -1
- package/models/operations/templateupdatetemplate.js +34 -12
- package/models/operations/templateupdatetemplate.js.map +1 -1
- package/package.json +7 -9
- package/sdk/document.d.ts +12 -0
- package/sdk/document.d.ts.map +1 -0
- package/sdk/document.js +22 -0
- package/sdk/document.js.map +1 -0
- package/sdk/documents.d.ts +19 -19
- package/sdk/documents.d.ts.map +1 -1
- package/sdk/documents.js +21 -21
- package/sdk/documents.js.map +1 -1
- package/sdk/sdk.d.ts +6 -0
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +8 -0
- package/sdk/sdk.js.map +1 -1
- package/sdk/template.d.ts +12 -0
- package/sdk/template.d.ts.map +1 -0
- package/sdk/template.js +22 -0
- package/sdk/template.js.map +1 -0
- package/src/funcs/documentDocumentDownload.ts +188 -0
- package/src/funcs/documentsCreateV0.ts +1 -1
- package/src/funcs/documentsDelete.ts +17 -21
- package/src/funcs/documentsDistribute.ts +17 -21
- package/src/funcs/documentsDuplicate.ts +17 -24
- package/src/funcs/documentsFieldsCreate.ts +1 -1
- package/src/funcs/documentsFieldsCreateMany.ts +1 -1
- package/src/funcs/documentsFieldsDelete.ts +1 -1
- package/src/funcs/documentsFieldsGet.ts +1 -1
- package/src/funcs/documentsFieldsUpdate.ts +1 -1
- package/src/funcs/documentsFieldsUpdateMany.ts +1 -1
- package/src/funcs/documentsFind.ts +21 -25
- package/src/funcs/documentsGet.ts +22 -43
- package/src/funcs/documentsRecipientsCreate.ts +1 -1
- package/src/funcs/documentsRecipientsCreateMany.ts +1 -1
- package/src/funcs/documentsRecipientsDelete.ts +1 -1
- package/src/funcs/documentsRecipientsGet.ts +1 -1
- package/src/funcs/documentsRecipientsUpdate.ts +1 -1
- package/src/funcs/documentsRecipientsUpdateMany.ts +1 -1
- package/src/funcs/documentsRedistribute.ts +17 -17
- package/src/funcs/documentsUpdate.ts +17 -21
- package/src/funcs/embeddingEmbeddingPresignCreateEmbeddingPresignToken.ts +1 -1
- package/src/funcs/embeddingEmbeddingPresignVerifyEmbeddingPresignToken.ts +1 -1
- package/src/funcs/templateTemplateCreateTemplateTemporary.ts +185 -0
- package/src/funcs/templatesDelete.ts +1 -1
- package/src/funcs/templatesDirectLinkCreate.ts +1 -1
- package/src/funcs/templatesDirectLinkDelete.ts +1 -1
- package/src/funcs/templatesDirectLinkToggle.ts +1 -1
- package/src/funcs/templatesDuplicate.ts +1 -1
- package/src/funcs/templatesFieldsCreate.ts +1 -1
- package/src/funcs/templatesFieldsCreateMany.ts +1 -1
- package/src/funcs/templatesFieldsDelete.ts +1 -1
- package/src/funcs/templatesFieldsGet.ts +1 -1
- package/src/funcs/templatesFieldsUpdate.ts +1 -1
- package/src/funcs/templatesFieldsUpdateMany.ts +1 -1
- package/src/funcs/templatesFind.ts +1 -1
- package/src/funcs/templatesGet.ts +1 -1
- package/src/funcs/templatesRecipientsCreate.ts +1 -1
- package/src/funcs/templatesRecipientsCreateMany.ts +1 -1
- package/src/funcs/templatesRecipientsDelete.ts +1 -1
- package/src/funcs/templatesRecipientsGet.ts +1 -1
- package/src/funcs/templatesRecipientsUpdate.ts +1 -1
- package/src/funcs/templatesRecipientsUpdateMany.ts +1 -1
- package/src/funcs/templatesUpdate.ts +1 -1
- package/src/funcs/templatesUse.ts +1 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/env.ts +20 -3
- package/src/lib/security.ts +4 -1
- package/src/lib/url.ts +1 -1
- package/src/mcp-server/cli/start/command.ts +0 -13
- package/src/mcp-server/cli/start/impl.ts +0 -4
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +9 -5
- package/src/mcp-server/tools/documentDocumentDownload.ts +37 -0
- package/src/mcp-server/tools/documentsDelete.ts +1 -1
- package/src/mcp-server/tools/documentsDistribute.ts +1 -1
- package/src/mcp-server/tools/documentsDuplicate.ts +1 -1
- package/src/mcp-server/tools/documentsFind.ts +1 -1
- package/src/mcp-server/tools/documentsGet.ts +1 -1
- package/src/mcp-server/tools/documentsRedistribute.ts +1 -1
- package/src/mcp-server/tools/documentsUpdate.ts +1 -1
- package/src/mcp-server/tools/templateTemplateCreateTemplateTemporary.ts +39 -0
- package/src/models/errors/apierror.ts +8 -2
- package/src/models/errors/documentcreatedocumenttemporary.ts +2 -6
- package/src/models/errors/documentdelete.ts +314 -0
- package/src/models/errors/documentdistribute.ts +324 -0
- package/src/models/errors/documentdownload.ts +470 -0
- package/src/models/errors/documentduplicate.ts +324 -0
- package/src/models/errors/documentfind.ts +459 -0
- package/src/models/errors/documentget.ts +457 -0
- package/src/models/errors/documentredistribute.ts +331 -0
- package/src/models/errors/documentupdate.ts +314 -0
- package/src/models/errors/embeddingpresigncreateembeddingpresigntoken.ts +2 -6
- package/src/models/errors/embeddingpresignverifyembeddingpresigntoken.ts +2 -6
- package/src/models/errors/fieldcreatedocumentfield.ts +2 -6
- package/src/models/errors/fieldcreatedocumentfields.ts +2 -6
- package/src/models/errors/fieldcreatetemplatefield.ts +2 -6
- package/src/models/errors/fieldcreatetemplatefields.ts +2 -6
- package/src/models/errors/fielddeletedocumentfield.ts +2 -6
- package/src/models/errors/fielddeletetemplatefield.ts +2 -6
- package/src/models/errors/fieldgetdocumentfield.ts +3 -9
- package/src/models/errors/fieldgettemplatefield.ts +3 -9
- package/src/models/errors/fieldupdatedocumentfield.ts +2 -6
- package/src/models/errors/fieldupdatedocumentfields.ts +2 -6
- package/src/models/errors/fieldupdatetemplatefield.ts +2 -6
- package/src/models/errors/fieldupdatetemplatefields.ts +2 -6
- package/src/models/errors/index.ts +10 -7
- package/src/models/errors/recipientcreatedocumentrecipient.ts +2 -6
- package/src/models/errors/recipientcreatedocumentrecipients.ts +2 -6
- package/src/models/errors/recipientcreatetemplaterecipient.ts +2 -6
- package/src/models/errors/recipientcreatetemplaterecipients.ts +2 -6
- package/src/models/errors/recipientdeletedocumentrecipient.ts +2 -6
- package/src/models/errors/recipientdeletetemplaterecipient.ts +2 -6
- package/src/models/errors/recipientgetdocumentrecipient.ts +3 -9
- package/src/models/errors/recipientgettemplaterecipient.ts +3 -9
- package/src/models/errors/recipientupdatedocumentrecipient.ts +2 -6
- package/src/models/errors/recipientupdatedocumentrecipients.ts +2 -6
- package/src/models/errors/recipientupdatetemplaterecipient.ts +2 -6
- package/src/models/errors/recipientupdatetemplaterecipients.ts +2 -6
- package/src/models/errors/templatecreatedocumentfromtemplate.ts +2 -6
- package/src/models/errors/templatecreatetemplatedirectlink.ts +2 -6
- package/src/models/errors/templatecreatetemplatetemporary.ts +363 -0
- package/src/models/errors/templatedeletetemplate.ts +2 -6
- package/src/models/errors/templatedeletetemplatedirectlink.ts +2 -6
- package/src/models/errors/templateduplicatetemplate.ts +2 -6
- package/src/models/errors/templatefindtemplates.ts +3 -9
- package/src/models/errors/templategettemplatebyid.ts +3 -9
- package/src/models/errors/templatetoggletemplatedirectlink.ts +2 -6
- package/src/models/errors/templateupdatetemplate.ts +2 -6
- package/src/models/operations/documentcreatedocumenttemporary.ts +223 -83
- package/src/models/operations/documentdelete.ts +127 -0
- package/src/models/operations/documentdistribute.ts +861 -0
- package/src/models/operations/documentdownload.ts +186 -0
- package/src/models/operations/documentduplicate.ts +137 -0
- package/src/models/operations/documentfind.ts +1255 -0
- package/src/models/operations/documentget.ts +3106 -0
- package/src/models/operations/documentredistribute.ts +138 -0
- package/src/models/operations/documentupdate.ts +1131 -0
- package/src/models/operations/fieldcreatedocumentfield.ts +118 -32
- package/src/models/operations/fieldcreatedocumentfields.ts +117 -32
- package/src/models/operations/fieldcreatetemplatefield.ts +118 -32
- package/src/models/operations/fieldcreatetemplatefields.ts +117 -32
- package/src/models/operations/fieldgetdocumentfield.ts +61 -20
- package/src/models/operations/fieldgettemplatefield.ts +61 -20
- package/src/models/operations/fieldupdatedocumentfield.ts +118 -32
- package/src/models/operations/fieldupdatedocumentfields.ts +117 -32
- package/src/models/operations/fieldupdatetemplatefield.ts +118 -32
- package/src/models/operations/fieldupdatetemplatefields.ts +117 -32
- package/src/models/operations/index.ts +9 -7
- package/src/models/operations/recipientcreatedocumentrecipient.ts +14 -8
- package/src/models/operations/recipientcreatedocumentrecipients.ts +14 -8
- package/src/models/operations/recipientcreatetemplaterecipient.ts +14 -8
- package/src/models/operations/recipientcreatetemplaterecipients.ts +14 -8
- package/src/models/operations/recipientgetdocumentrecipient.ts +81 -28
- package/src/models/operations/recipientgettemplaterecipient.ts +81 -28
- package/src/models/operations/recipientupdatedocumentrecipient.ts +81 -28
- package/src/models/operations/recipientupdatedocumentrecipients.ts +80 -28
- package/src/models/operations/recipientupdatetemplaterecipient.ts +81 -28
- package/src/models/operations/recipientupdatetemplaterecipients.ts +80 -28
- package/src/models/operations/templatecreatedocumentfromtemplate.ts +200 -55
- package/src/models/operations/templatecreatetemplatedirectlink.ts +8 -4
- package/src/models/operations/templatecreatetemplatetemporary.ts +4374 -0
- package/src/models/operations/templateduplicatetemplate.ts +9 -4
- package/src/models/operations/templatefindtemplates.ts +87 -36
- package/src/models/operations/templategettemplatebyid.ts +191 -105
- package/src/models/operations/templatetoggletemplatedirectlink.ts +8 -4
- package/src/models/operations/templateupdatetemplate.ts +47 -14
- package/src/sdk/document.ts +27 -0
- package/src/sdk/documents.ts +37 -37
- package/src/sdk/sdk.ts +12 -0
- package/src/sdk/template.ts +27 -0
- package/docs/sdks/documenso/README.md +0 -7
- package/models/errors/documentdeletedocument.d.ts +0 -143
- package/models/errors/documentdeletedocument.d.ts.map +0 -1
- package/models/errors/documentdeletedocument.js +0 -201
- package/models/errors/documentdeletedocument.js.map +0 -1
- package/models/errors/documentduplicatedocument.d.ts +0 -143
- package/models/errors/documentduplicatedocument.d.ts.map +0 -1
- package/models/errors/documentduplicatedocument.js +0 -201
- package/models/errors/documentduplicatedocument.js.map +0 -1
- package/models/errors/documentfinddocuments.d.ts +0 -212
- package/models/errors/documentfinddocuments.d.ts.map +0 -1
- package/models/errors/documentfinddocuments.js +0 -280
- package/models/errors/documentfinddocuments.js.map +0 -1
- package/models/errors/documentgetdocumentwithdetailsbyid.d.ts +0 -212
- package/models/errors/documentgetdocumentwithdetailsbyid.d.ts.map +0 -1
- package/models/errors/documentgetdocumentwithdetailsbyid.js +0 -282
- package/models/errors/documentgetdocumentwithdetailsbyid.js.map +0 -1
- package/models/errors/documentresenddocument.d.ts +0 -143
- package/models/errors/documentresenddocument.d.ts.map +0 -1
- package/models/errors/documentresenddocument.js +0 -201
- package/models/errors/documentresenddocument.js.map +0 -1
- package/models/errors/documentsenddocument.d.ts +0 -143
- package/models/errors/documentsenddocument.js +0 -201
- package/models/errors/documentsenddocument.js.map +0 -1
- package/models/errors/documentupdatedocument.d.ts +0 -143
- package/models/errors/documentupdatedocument.d.ts.map +0 -1
- package/models/errors/documentupdatedocument.js +0 -201
- package/models/errors/documentupdatedocument.js.map +0 -1
- package/models/operations/documentdeletedocument.d.ts +0 -57
- package/models/operations/documentdeletedocument.d.ts.map +0 -1
- package/models/operations/documentdeletedocument.js +0 -96
- package/models/operations/documentdeletedocument.js.map +0 -1
- package/models/operations/documentduplicatedocument.d.ts +0 -57
- package/models/operations/documentduplicatedocument.d.ts.map +0 -1
- package/models/operations/documentduplicatedocument.js +0 -96
- package/models/operations/documentduplicatedocument.js.map +0 -1
- package/models/operations/documentfinddocuments.d.ts.map +0 -1
- package/models/operations/documentfinddocuments.js +0 -704
- package/models/operations/documentfinddocuments.js.map +0 -1
- package/models/operations/documentgetdocumentwithdetailsbyid.d.ts +0 -1819
- package/models/operations/documentgetdocumentwithdetailsbyid.d.ts.map +0 -1
- package/models/operations/documentgetdocumentwithdetailsbyid.js +0 -1705
- package/models/operations/documentgetdocumentwithdetailsbyid.js.map +0 -1
- package/models/operations/documentresenddocument.d.ts +0 -62
- package/models/operations/documentresenddocument.d.ts.map +0 -1
- package/models/operations/documentresenddocument.js +0 -98
- package/models/operations/documentresenddocument.js.map +0 -1
- package/models/operations/documentsenddocument.d.ts +0 -554
- package/models/operations/documentsenddocument.d.ts.map +0 -1
- package/models/operations/documentsenddocument.js +0 -452
- package/models/operations/documentsenddocument.js.map +0 -1
- package/models/operations/documentupdatedocument.d.ts +0 -740
- package/models/operations/documentupdatedocument.d.ts.map +0 -1
- package/models/operations/documentupdatedocument.js +0 -595
- package/models/operations/documentupdatedocument.js.map +0 -1
- package/src/models/errors/documentdeletedocument.ts +0 -339
- package/src/models/errors/documentduplicatedocument.ts +0 -350
- package/src/models/errors/documentfinddocuments.ts +0 -493
- package/src/models/errors/documentgetdocumentwithdetailsbyid.ts +0 -546
- package/src/models/errors/documentresenddocument.ts +0 -339
- package/src/models/errors/documentsenddocument.ts +0 -335
- package/src/models/errors/documentupdatedocument.ts +0 -339
- package/src/models/operations/documentdeletedocument.ts +0 -131
- package/src/models/operations/documentduplicatedocument.ts +0 -132
- package/src/models/operations/documentfinddocuments.ts +0 -1300
- package/src/models/operations/documentgetdocumentwithdetailsbyid.ts +0 -3621
- package/src/models/operations/documentresenddocument.ts +0 -138
- package/src/models/operations/documentsenddocument.ts +0 -846
- package/src/models/operations/documentupdatedocument.ts +0 -1128
|
@@ -5,21 +5,22 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [update](#update) - Update document
|
|
9
|
-
* [find](#find) - Find documents
|
|
10
8
|
* [get](#get) - Get document
|
|
11
|
-
* [
|
|
9
|
+
* [find](#find) - Find documents
|
|
10
|
+
* [update](#update) - Update document
|
|
12
11
|
* [delete](#delete) - Delete document
|
|
12
|
+
* [duplicate](#duplicate) - Duplicate document
|
|
13
13
|
* [distribute](#distribute) - Distribute document
|
|
14
14
|
* [redistribute](#redistribute) - Redistribute document
|
|
15
|
-
* [
|
|
15
|
+
* [createV0](#createv0) - Create document
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## get
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Returns a document given an ID
|
|
20
20
|
|
|
21
21
|
### Example Usage
|
|
22
22
|
|
|
23
|
+
<!-- UsageSnippet language="typescript" operationID="document-get" method="get" path="/document/{documentId}" -->
|
|
23
24
|
```typescript
|
|
24
25
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
25
26
|
|
|
@@ -28,8 +29,8 @@ const documenso = new Documenso({
|
|
|
28
29
|
});
|
|
29
30
|
|
|
30
31
|
async function run() {
|
|
31
|
-
const result = await documenso.documents.
|
|
32
|
-
documentId:
|
|
32
|
+
const result = await documenso.documents.get({
|
|
33
|
+
documentId: 6150.61,
|
|
33
34
|
});
|
|
34
35
|
|
|
35
36
|
console.log(result);
|
|
@@ -44,7 +45,7 @@ The standalone function version of this method:
|
|
|
44
45
|
|
|
45
46
|
```typescript
|
|
46
47
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
47
|
-
import {
|
|
48
|
+
import { documentsGet } from "@documenso/sdk-typescript/funcs/documentsGet.js";
|
|
48
49
|
|
|
49
50
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
50
51
|
// You can create one instance of it to use across an application.
|
|
@@ -53,14 +54,14 @@ const documenso = new DocumensoCore({
|
|
|
53
54
|
});
|
|
54
55
|
|
|
55
56
|
async function run() {
|
|
56
|
-
const res = await
|
|
57
|
-
documentId:
|
|
57
|
+
const res = await documentsGet(documenso, {
|
|
58
|
+
documentId: 6150.61,
|
|
58
59
|
});
|
|
59
60
|
if (res.ok) {
|
|
60
61
|
const { value: result } = res;
|
|
61
62
|
console.log(result);
|
|
62
63
|
} else {
|
|
63
|
-
console.log("
|
|
64
|
+
console.log("documentsGet failed:", res.error);
|
|
64
65
|
}
|
|
65
66
|
}
|
|
66
67
|
|
|
@@ -71,22 +72,23 @@ run();
|
|
|
71
72
|
|
|
72
73
|
| Parameter | Type | Required | Description |
|
|
73
74
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
74
|
-
| `request` | [operations.
|
|
75
|
+
| `request` | [operations.DocumentGetRequest](../../models/operations/documentgetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
75
76
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
76
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. |
|
|
77
78
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
78
79
|
|
|
79
80
|
### Response
|
|
80
81
|
|
|
81
|
-
**Promise\<[operations.
|
|
82
|
+
**Promise\<[operations.DocumentGetResponse](../../models/operations/documentgetresponse.md)\>**
|
|
82
83
|
|
|
83
84
|
### Errors
|
|
84
85
|
|
|
85
|
-
| Error Type
|
|
86
|
-
|
|
|
87
|
-
| errors.
|
|
88
|
-
| errors.
|
|
89
|
-
| errors.
|
|
86
|
+
| Error Type | Status Code | Content Type |
|
|
87
|
+
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
|
88
|
+
| errors.DocumentGetBadRequestError | 400 | application/json |
|
|
89
|
+
| errors.DocumentGetNotFoundError | 404 | application/json |
|
|
90
|
+
| errors.DocumentGetInternalServerError | 500 | application/json |
|
|
91
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
90
92
|
|
|
91
93
|
## find
|
|
92
94
|
|
|
@@ -94,6 +96,7 @@ Find documents based on a search criteria
|
|
|
94
96
|
|
|
95
97
|
### Example Usage
|
|
96
98
|
|
|
99
|
+
<!-- UsageSnippet language="typescript" operationID="document-find" method="get" path="/document" -->
|
|
97
100
|
```typescript
|
|
98
101
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
99
102
|
|
|
@@ -141,30 +144,31 @@ run();
|
|
|
141
144
|
|
|
142
145
|
| Parameter | Type | Required | Description |
|
|
143
146
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
144
|
-
| `request` | [operations.
|
|
147
|
+
| `request` | [operations.DocumentFindRequest](../../models/operations/documentfindrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
145
148
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
146
149
|
| `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. |
|
|
147
150
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
148
151
|
|
|
149
152
|
### Response
|
|
150
153
|
|
|
151
|
-
**Promise\<[operations.
|
|
154
|
+
**Promise\<[operations.DocumentFindResponse](../../models/operations/documentfindresponse.md)\>**
|
|
152
155
|
|
|
153
156
|
### Errors
|
|
154
157
|
|
|
155
|
-
| Error Type
|
|
156
|
-
|
|
|
157
|
-
| errors.
|
|
158
|
-
| errors.
|
|
159
|
-
| errors.
|
|
160
|
-
| errors.APIError
|
|
158
|
+
| Error Type | Status Code | Content Type |
|
|
159
|
+
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
160
|
+
| errors.DocumentFindBadRequestError | 400 | application/json |
|
|
161
|
+
| errors.DocumentFindNotFoundError | 404 | application/json |
|
|
162
|
+
| errors.DocumentFindInternalServerError | 500 | application/json |
|
|
163
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
161
164
|
|
|
162
|
-
##
|
|
165
|
+
## update
|
|
163
166
|
|
|
164
|
-
|
|
167
|
+
Update document
|
|
165
168
|
|
|
166
169
|
### Example Usage
|
|
167
170
|
|
|
171
|
+
<!-- UsageSnippet language="typescript" operationID="document-update" method="post" path="/document/update" -->
|
|
168
172
|
```typescript
|
|
169
173
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
170
174
|
|
|
@@ -173,8 +177,8 @@ const documenso = new Documenso({
|
|
|
173
177
|
});
|
|
174
178
|
|
|
175
179
|
async function run() {
|
|
176
|
-
const result = await documenso.documents.
|
|
177
|
-
documentId:
|
|
180
|
+
const result = await documenso.documents.update({
|
|
181
|
+
documentId: 3428.95,
|
|
178
182
|
});
|
|
179
183
|
|
|
180
184
|
console.log(result);
|
|
@@ -189,7 +193,7 @@ The standalone function version of this method:
|
|
|
189
193
|
|
|
190
194
|
```typescript
|
|
191
195
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
192
|
-
import {
|
|
196
|
+
import { documentsUpdate } from "@documenso/sdk-typescript/funcs/documentsUpdate.js";
|
|
193
197
|
|
|
194
198
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
195
199
|
// You can create one instance of it to use across an application.
|
|
@@ -198,14 +202,14 @@ const documenso = new DocumensoCore({
|
|
|
198
202
|
});
|
|
199
203
|
|
|
200
204
|
async function run() {
|
|
201
|
-
const res = await
|
|
202
|
-
documentId:
|
|
205
|
+
const res = await documentsUpdate(documenso, {
|
|
206
|
+
documentId: 3428.95,
|
|
203
207
|
});
|
|
204
208
|
if (res.ok) {
|
|
205
209
|
const { value: result } = res;
|
|
206
210
|
console.log(result);
|
|
207
211
|
} else {
|
|
208
|
-
console.log("
|
|
212
|
+
console.log("documentsUpdate failed:", res.error);
|
|
209
213
|
}
|
|
210
214
|
}
|
|
211
215
|
|
|
@@ -216,30 +220,30 @@ run();
|
|
|
216
220
|
|
|
217
221
|
| Parameter | Type | Required | Description |
|
|
218
222
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
219
|
-
| `request` | [operations.
|
|
223
|
+
| `request` | [operations.DocumentUpdateRequest](../../models/operations/documentupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
220
224
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
221
225
|
| `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. |
|
|
222
226
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
223
227
|
|
|
224
228
|
### Response
|
|
225
229
|
|
|
226
|
-
**Promise\<[operations.
|
|
230
|
+
**Promise\<[operations.DocumentUpdateResponse](../../models/operations/documentupdateresponse.md)\>**
|
|
227
231
|
|
|
228
232
|
### Errors
|
|
229
233
|
|
|
230
|
-
| Error Type
|
|
231
|
-
|
|
|
232
|
-
| errors.
|
|
233
|
-
| errors.
|
|
234
|
-
| errors.
|
|
235
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
234
|
+
| Error Type | Status Code | Content Type |
|
|
235
|
+
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
|
236
|
+
| errors.DocumentUpdateBadRequestError | 400 | application/json |
|
|
237
|
+
| errors.DocumentUpdateInternalServerError | 500 | application/json |
|
|
238
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
236
239
|
|
|
237
|
-
##
|
|
240
|
+
## delete
|
|
238
241
|
|
|
239
|
-
|
|
242
|
+
Delete document
|
|
240
243
|
|
|
241
244
|
### Example Usage
|
|
242
245
|
|
|
246
|
+
<!-- UsageSnippet language="typescript" operationID="document-delete" method="post" path="/document/delete" -->
|
|
243
247
|
```typescript
|
|
244
248
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
245
249
|
|
|
@@ -248,8 +252,8 @@ const documenso = new Documenso({
|
|
|
248
252
|
});
|
|
249
253
|
|
|
250
254
|
async function run() {
|
|
251
|
-
const result = await documenso.documents.
|
|
252
|
-
|
|
255
|
+
const result = await documenso.documents.delete({
|
|
256
|
+
documentId: 3963.4,
|
|
253
257
|
});
|
|
254
258
|
|
|
255
259
|
console.log(result);
|
|
@@ -264,7 +268,7 @@ The standalone function version of this method:
|
|
|
264
268
|
|
|
265
269
|
```typescript
|
|
266
270
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
267
|
-
import {
|
|
271
|
+
import { documentsDelete } from "@documenso/sdk-typescript/funcs/documentsDelete.js";
|
|
268
272
|
|
|
269
273
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
270
274
|
// You can create one instance of it to use across an application.
|
|
@@ -273,14 +277,14 @@ const documenso = new DocumensoCore({
|
|
|
273
277
|
});
|
|
274
278
|
|
|
275
279
|
async function run() {
|
|
276
|
-
const res = await
|
|
277
|
-
|
|
280
|
+
const res = await documentsDelete(documenso, {
|
|
281
|
+
documentId: 3963.4,
|
|
278
282
|
});
|
|
279
283
|
if (res.ok) {
|
|
280
284
|
const { value: result } = res;
|
|
281
285
|
console.log(result);
|
|
282
286
|
} else {
|
|
283
|
-
console.log("
|
|
287
|
+
console.log("documentsDelete failed:", res.error);
|
|
284
288
|
}
|
|
285
289
|
}
|
|
286
290
|
|
|
@@ -291,29 +295,30 @@ run();
|
|
|
291
295
|
|
|
292
296
|
| Parameter | Type | Required | Description |
|
|
293
297
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
294
|
-
| `request` | [operations.
|
|
298
|
+
| `request` | [operations.DocumentDeleteRequest](../../models/operations/documentdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
295
299
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
296
300
|
| `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. |
|
|
297
301
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
298
302
|
|
|
299
303
|
### Response
|
|
300
304
|
|
|
301
|
-
**Promise\<[operations.
|
|
305
|
+
**Promise\<[operations.DocumentDeleteResponse](../../models/operations/documentdeleteresponse.md)\>**
|
|
302
306
|
|
|
303
307
|
### Errors
|
|
304
308
|
|
|
305
|
-
| Error Type
|
|
306
|
-
|
|
|
307
|
-
| errors.
|
|
308
|
-
| errors.
|
|
309
|
-
| errors.APIError
|
|
309
|
+
| Error Type | Status Code | Content Type |
|
|
310
|
+
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
|
311
|
+
| errors.DocumentDeleteBadRequestError | 400 | application/json |
|
|
312
|
+
| errors.DocumentDeleteInternalServerError | 500 | application/json |
|
|
313
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
310
314
|
|
|
311
|
-
##
|
|
315
|
+
## duplicate
|
|
312
316
|
|
|
313
|
-
|
|
317
|
+
Duplicate document
|
|
314
318
|
|
|
315
319
|
### Example Usage
|
|
316
320
|
|
|
321
|
+
<!-- UsageSnippet language="typescript" operationID="document-duplicate" method="post" path="/document/duplicate" -->
|
|
317
322
|
```typescript
|
|
318
323
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
319
324
|
|
|
@@ -322,8 +327,8 @@ const documenso = new Documenso({
|
|
|
322
327
|
});
|
|
323
328
|
|
|
324
329
|
async function run() {
|
|
325
|
-
const result = await documenso.documents.
|
|
326
|
-
documentId:
|
|
330
|
+
const result = await documenso.documents.duplicate({
|
|
331
|
+
documentId: 5285.3,
|
|
327
332
|
});
|
|
328
333
|
|
|
329
334
|
console.log(result);
|
|
@@ -338,7 +343,7 @@ The standalone function version of this method:
|
|
|
338
343
|
|
|
339
344
|
```typescript
|
|
340
345
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
341
|
-
import {
|
|
346
|
+
import { documentsDuplicate } from "@documenso/sdk-typescript/funcs/documentsDuplicate.js";
|
|
342
347
|
|
|
343
348
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
344
349
|
// You can create one instance of it to use across an application.
|
|
@@ -347,14 +352,14 @@ const documenso = new DocumensoCore({
|
|
|
347
352
|
});
|
|
348
353
|
|
|
349
354
|
async function run() {
|
|
350
|
-
const res = await
|
|
351
|
-
documentId:
|
|
355
|
+
const res = await documentsDuplicate(documenso, {
|
|
356
|
+
documentId: 5285.3,
|
|
352
357
|
});
|
|
353
358
|
if (res.ok) {
|
|
354
359
|
const { value: result } = res;
|
|
355
360
|
console.log(result);
|
|
356
361
|
} else {
|
|
357
|
-
console.log("
|
|
362
|
+
console.log("documentsDuplicate failed:", res.error);
|
|
358
363
|
}
|
|
359
364
|
}
|
|
360
365
|
|
|
@@ -365,22 +370,22 @@ run();
|
|
|
365
370
|
|
|
366
371
|
| Parameter | Type | Required | Description |
|
|
367
372
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
368
|
-
| `request` | [operations.
|
|
373
|
+
| `request` | [operations.DocumentDuplicateRequest](../../models/operations/documentduplicaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
369
374
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
370
375
|
| `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. |
|
|
371
376
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
372
377
|
|
|
373
378
|
### Response
|
|
374
379
|
|
|
375
|
-
**Promise\<[operations.
|
|
380
|
+
**Promise\<[operations.DocumentDuplicateResponse](../../models/operations/documentduplicateresponse.md)\>**
|
|
376
381
|
|
|
377
382
|
### Errors
|
|
378
383
|
|
|
379
|
-
| Error Type
|
|
380
|
-
|
|
|
381
|
-
| errors.
|
|
382
|
-
| errors.
|
|
383
|
-
| errors.APIError
|
|
384
|
+
| Error Type | Status Code | Content Type |
|
|
385
|
+
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
|
386
|
+
| errors.DocumentDuplicateBadRequestError | 400 | application/json |
|
|
387
|
+
| errors.DocumentDuplicateInternalServerError | 500 | application/json |
|
|
388
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
384
389
|
|
|
385
390
|
## distribute
|
|
386
391
|
|
|
@@ -388,6 +393,7 @@ Send the document out to recipients based on your distribution method
|
|
|
388
393
|
|
|
389
394
|
### Example Usage
|
|
390
395
|
|
|
396
|
+
<!-- UsageSnippet language="typescript" operationID="document-distribute" method="post" path="/document/distribute" -->
|
|
391
397
|
```typescript
|
|
392
398
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
393
399
|
|
|
@@ -397,7 +403,7 @@ const documenso = new Documenso({
|
|
|
397
403
|
|
|
398
404
|
async function run() {
|
|
399
405
|
const result = await documenso.documents.distribute({
|
|
400
|
-
documentId:
|
|
406
|
+
documentId: 7548.74,
|
|
401
407
|
});
|
|
402
408
|
|
|
403
409
|
console.log(result);
|
|
@@ -422,7 +428,7 @@ const documenso = new DocumensoCore({
|
|
|
422
428
|
|
|
423
429
|
async function run() {
|
|
424
430
|
const res = await documentsDistribute(documenso, {
|
|
425
|
-
documentId:
|
|
431
|
+
documentId: 7548.74,
|
|
426
432
|
});
|
|
427
433
|
if (res.ok) {
|
|
428
434
|
const { value: result } = res;
|
|
@@ -439,22 +445,22 @@ run();
|
|
|
439
445
|
|
|
440
446
|
| Parameter | Type | Required | Description |
|
|
441
447
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
442
|
-
| `request` | [operations.
|
|
448
|
+
| `request` | [operations.DocumentDistributeRequest](../../models/operations/documentdistributerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
443
449
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
444
450
|
| `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. |
|
|
445
451
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
446
452
|
|
|
447
453
|
### Response
|
|
448
454
|
|
|
449
|
-
**Promise\<[operations.
|
|
455
|
+
**Promise\<[operations.DocumentDistributeResponse](../../models/operations/documentdistributeresponse.md)\>**
|
|
450
456
|
|
|
451
457
|
### Errors
|
|
452
458
|
|
|
453
|
-
| Error Type
|
|
454
|
-
|
|
|
455
|
-
| errors.
|
|
456
|
-
| errors.
|
|
457
|
-
| errors.APIError
|
|
459
|
+
| Error Type | Status Code | Content Type |
|
|
460
|
+
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
|
461
|
+
| errors.DocumentDistributeBadRequestError | 400 | application/json |
|
|
462
|
+
| errors.DocumentDistributeInternalServerError | 500 | application/json |
|
|
463
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
458
464
|
|
|
459
465
|
## redistribute
|
|
460
466
|
|
|
@@ -462,6 +468,7 @@ Redistribute the document to the provided recipients who have not actioned the d
|
|
|
462
468
|
|
|
463
469
|
### Example Usage
|
|
464
470
|
|
|
471
|
+
<!-- UsageSnippet language="typescript" operationID="document-redistribute" method="post" path="/document/redistribute" -->
|
|
465
472
|
```typescript
|
|
466
473
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
467
474
|
|
|
@@ -471,8 +478,12 @@ const documenso = new Documenso({
|
|
|
471
478
|
|
|
472
479
|
async function run() {
|
|
473
480
|
const result = await documenso.documents.redistribute({
|
|
474
|
-
documentId:
|
|
475
|
-
recipients: [
|
|
481
|
+
documentId: 9084.69,
|
|
482
|
+
recipients: [
|
|
483
|
+
6011.8,
|
|
484
|
+
4441.56,
|
|
485
|
+
4251.15,
|
|
486
|
+
],
|
|
476
487
|
});
|
|
477
488
|
|
|
478
489
|
console.log(result);
|
|
@@ -497,8 +508,12 @@ const documenso = new DocumensoCore({
|
|
|
497
508
|
|
|
498
509
|
async function run() {
|
|
499
510
|
const res = await documentsRedistribute(documenso, {
|
|
500
|
-
documentId:
|
|
501
|
-
recipients: [
|
|
511
|
+
documentId: 9084.69,
|
|
512
|
+
recipients: [
|
|
513
|
+
6011.8,
|
|
514
|
+
4441.56,
|
|
515
|
+
4251.15,
|
|
516
|
+
],
|
|
502
517
|
});
|
|
503
518
|
if (res.ok) {
|
|
504
519
|
const { value: result } = res;
|
|
@@ -515,29 +530,30 @@ run();
|
|
|
515
530
|
|
|
516
531
|
| Parameter | Type | Required | Description |
|
|
517
532
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
518
|
-
| `request` | [operations.
|
|
533
|
+
| `request` | [operations.DocumentRedistributeRequest](../../models/operations/documentredistributerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
519
534
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
520
535
|
| `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. |
|
|
521
536
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
522
537
|
|
|
523
538
|
### Response
|
|
524
539
|
|
|
525
|
-
**Promise\<[operations.
|
|
540
|
+
**Promise\<[operations.DocumentRedistributeResponse](../../models/operations/documentredistributeresponse.md)\>**
|
|
526
541
|
|
|
527
542
|
### Errors
|
|
528
543
|
|
|
529
|
-
| Error Type
|
|
530
|
-
|
|
|
531
|
-
| errors.
|
|
532
|
-
| errors.
|
|
533
|
-
| errors.APIError
|
|
544
|
+
| Error Type | Status Code | Content Type |
|
|
545
|
+
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
|
546
|
+
| errors.DocumentRedistributeBadRequestError | 400 | application/json |
|
|
547
|
+
| errors.DocumentRedistributeInternalServerError | 500 | application/json |
|
|
548
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
534
549
|
|
|
535
|
-
##
|
|
550
|
+
## createV0
|
|
536
551
|
|
|
537
|
-
|
|
552
|
+
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.
|
|
538
553
|
|
|
539
554
|
### Example Usage
|
|
540
555
|
|
|
556
|
+
<!-- UsageSnippet language="typescript" operationID="document-createDocumentTemporary" method="post" path="/document/create/beta" -->
|
|
541
557
|
```typescript
|
|
542
558
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
543
559
|
|
|
@@ -546,8 +562,8 @@ const documenso = new Documenso({
|
|
|
546
562
|
});
|
|
547
563
|
|
|
548
564
|
async function run() {
|
|
549
|
-
const result = await documenso.documents.
|
|
550
|
-
|
|
565
|
+
const result = await documenso.documents.createV0({
|
|
566
|
+
title: "<value>",
|
|
551
567
|
});
|
|
552
568
|
|
|
553
569
|
console.log(result);
|
|
@@ -562,7 +578,7 @@ The standalone function version of this method:
|
|
|
562
578
|
|
|
563
579
|
```typescript
|
|
564
580
|
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
565
|
-
import {
|
|
581
|
+
import { documentsCreateV0 } from "@documenso/sdk-typescript/funcs/documentsCreateV0.js";
|
|
566
582
|
|
|
567
583
|
// Use `DocumensoCore` for best tree-shaking performance.
|
|
568
584
|
// You can create one instance of it to use across an application.
|
|
@@ -571,14 +587,14 @@ const documenso = new DocumensoCore({
|
|
|
571
587
|
});
|
|
572
588
|
|
|
573
589
|
async function run() {
|
|
574
|
-
const res = await
|
|
575
|
-
|
|
590
|
+
const res = await documentsCreateV0(documenso, {
|
|
591
|
+
title: "<value>",
|
|
576
592
|
});
|
|
577
593
|
if (res.ok) {
|
|
578
594
|
const { value: result } = res;
|
|
579
595
|
console.log(result);
|
|
580
596
|
} else {
|
|
581
|
-
console.log("
|
|
597
|
+
console.log("documentsCreateV0 failed:", res.error);
|
|
582
598
|
}
|
|
583
599
|
}
|
|
584
600
|
|
|
@@ -589,19 +605,19 @@ run();
|
|
|
589
605
|
|
|
590
606
|
| Parameter | Type | Required | Description |
|
|
591
607
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
592
|
-
| `request` | [operations.
|
|
608
|
+
| `request` | [operations.DocumentCreateDocumentTemporaryRequest](../../models/operations/documentcreatedocumenttemporaryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
593
609
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
594
610
|
| `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. |
|
|
595
611
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
596
612
|
|
|
597
613
|
### Response
|
|
598
614
|
|
|
599
|
-
**Promise\<[operations.
|
|
615
|
+
**Promise\<[operations.DocumentCreateDocumentTemporaryResponse](../../models/operations/documentcreatedocumenttemporaryresponse.md)\>**
|
|
600
616
|
|
|
601
617
|
### Errors
|
|
602
618
|
|
|
603
|
-
| Error Type
|
|
604
|
-
|
|
|
605
|
-
| errors.
|
|
606
|
-
| errors.
|
|
607
|
-
| errors.APIError
|
|
619
|
+
| Error Type | Status Code | Content Type |
|
|
620
|
+
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
|
|
621
|
+
| errors.DocumentCreateDocumentTemporaryBadRequestError | 400 | application/json |
|
|
622
|
+
| errors.DocumentCreateDocumentTemporaryInternalServerError | 500 | application/json |
|
|
623
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|