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