@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,566 @@
|
|
|
1
|
+
# Templates
|
|
2
|
+
(*templates*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [find](#find) - Find templates
|
|
9
|
+
* [get](#get) - Get template
|
|
10
|
+
* [update](#update) - Update template
|
|
11
|
+
* [duplicate](#duplicate) - Duplicate template
|
|
12
|
+
* [delete](#delete) - Delete template
|
|
13
|
+
* [use](#use) - Use template
|
|
14
|
+
* [moveToTeam](#movetoteam) - Move template
|
|
15
|
+
|
|
16
|
+
## find
|
|
17
|
+
|
|
18
|
+
Find templates based on a search criteria
|
|
19
|
+
|
|
20
|
+
### Example Usage
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { Documenso } from "@documenso/sdk-typescript";
|
|
24
|
+
|
|
25
|
+
const documenso = new Documenso({
|
|
26
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
async function run() {
|
|
30
|
+
const result = await documenso.templates.find({});
|
|
31
|
+
|
|
32
|
+
// Handle the result
|
|
33
|
+
console.log(result);
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
run();
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Standalone function
|
|
40
|
+
|
|
41
|
+
The standalone function version of this method:
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
45
|
+
import { templatesFind } from "@documenso/sdk-typescript/funcs/templatesFind.js";
|
|
46
|
+
|
|
47
|
+
// Use `DocumensoCore` for best tree-shaking performance.
|
|
48
|
+
// You can create one instance of it to use across an application.
|
|
49
|
+
const documenso = new DocumensoCore({
|
|
50
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
async function run() {
|
|
54
|
+
const res = await templatesFind(documenso, {});
|
|
55
|
+
|
|
56
|
+
if (!res.ok) {
|
|
57
|
+
throw res.error;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
const { value: result } = res;
|
|
61
|
+
|
|
62
|
+
// Handle the result
|
|
63
|
+
console.log(result);
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
run();
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
| Parameter | Type | Required | Description |
|
|
72
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
73
|
+
| `request` | [operations.TemplateFindTemplatesRequest](../../models/operations/templatefindtemplatesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
74
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
75
|
+
| `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. |
|
|
76
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
77
|
+
|
|
78
|
+
### Response
|
|
79
|
+
|
|
80
|
+
**Promise\<[operations.TemplateFindTemplatesResponseBody](../../models/operations/templatefindtemplatesresponsebody.md)\>**
|
|
81
|
+
|
|
82
|
+
### Errors
|
|
83
|
+
|
|
84
|
+
| Error Type | Status Code | Content Type |
|
|
85
|
+
| ------------------------------- | ------------------------------- | ------------------------------- |
|
|
86
|
+
| errors.ErrorBADREQUEST | 400 | application/json |
|
|
87
|
+
| errors.ErrorNOTFOUND | 404 | application/json |
|
|
88
|
+
| errors.Errorinternalservererror | 500 | application/json |
|
|
89
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
90
|
+
|
|
91
|
+
## get
|
|
92
|
+
|
|
93
|
+
Get template
|
|
94
|
+
|
|
95
|
+
### Example Usage
|
|
96
|
+
|
|
97
|
+
```typescript
|
|
98
|
+
import { Documenso } from "@documenso/sdk-typescript";
|
|
99
|
+
|
|
100
|
+
const documenso = new Documenso({
|
|
101
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
102
|
+
});
|
|
103
|
+
|
|
104
|
+
async function run() {
|
|
105
|
+
const result = await documenso.templates.get({
|
|
106
|
+
templateId: 1970.89,
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
// Handle the result
|
|
110
|
+
console.log(result);
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
run();
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Standalone function
|
|
117
|
+
|
|
118
|
+
The standalone function version of this method:
|
|
119
|
+
|
|
120
|
+
```typescript
|
|
121
|
+
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
122
|
+
import { templatesGet } from "@documenso/sdk-typescript/funcs/templatesGet.js";
|
|
123
|
+
|
|
124
|
+
// Use `DocumensoCore` for best tree-shaking performance.
|
|
125
|
+
// You can create one instance of it to use across an application.
|
|
126
|
+
const documenso = new DocumensoCore({
|
|
127
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
async function run() {
|
|
131
|
+
const res = await templatesGet(documenso, {
|
|
132
|
+
templateId: 1970.89,
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
if (!res.ok) {
|
|
136
|
+
throw res.error;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
const { value: result } = res;
|
|
140
|
+
|
|
141
|
+
// Handle the result
|
|
142
|
+
console.log(result);
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
run();
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Parameters
|
|
149
|
+
|
|
150
|
+
| Parameter | Type | Required | Description |
|
|
151
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
152
|
+
| `request` | [operations.TemplateGetTemplateByIdRequest](../../models/operations/templategettemplatebyidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
153
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
154
|
+
| `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. |
|
|
155
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
156
|
+
|
|
157
|
+
### Response
|
|
158
|
+
|
|
159
|
+
**Promise\<[operations.TemplateGetTemplateByIdResponseBody](../../models/operations/templategettemplatebyidresponsebody.md)\>**
|
|
160
|
+
|
|
161
|
+
### Errors
|
|
162
|
+
|
|
163
|
+
| Error Type | Status Code | Content Type |
|
|
164
|
+
| ------------------------------- | ------------------------------- | ------------------------------- |
|
|
165
|
+
| errors.ErrorBADREQUEST | 400 | application/json |
|
|
166
|
+
| errors.ErrorNOTFOUND | 404 | application/json |
|
|
167
|
+
| errors.Errorinternalservererror | 500 | application/json |
|
|
168
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
169
|
+
|
|
170
|
+
## update
|
|
171
|
+
|
|
172
|
+
Update template
|
|
173
|
+
|
|
174
|
+
### Example Usage
|
|
175
|
+
|
|
176
|
+
```typescript
|
|
177
|
+
import { Documenso } from "@documenso/sdk-typescript";
|
|
178
|
+
|
|
179
|
+
const documenso = new Documenso({
|
|
180
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
181
|
+
});
|
|
182
|
+
|
|
183
|
+
async function run() {
|
|
184
|
+
const result = await documenso.templates.update({
|
|
185
|
+
templateId: 3585.07,
|
|
186
|
+
});
|
|
187
|
+
|
|
188
|
+
// Handle the result
|
|
189
|
+
console.log(result);
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
run();
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Standalone function
|
|
196
|
+
|
|
197
|
+
The standalone function version of this method:
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
201
|
+
import { templatesUpdate } from "@documenso/sdk-typescript/funcs/templatesUpdate.js";
|
|
202
|
+
|
|
203
|
+
// Use `DocumensoCore` for best tree-shaking performance.
|
|
204
|
+
// You can create one instance of it to use across an application.
|
|
205
|
+
const documenso = new DocumensoCore({
|
|
206
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
207
|
+
});
|
|
208
|
+
|
|
209
|
+
async function run() {
|
|
210
|
+
const res = await templatesUpdate(documenso, {
|
|
211
|
+
templateId: 3585.07,
|
|
212
|
+
});
|
|
213
|
+
|
|
214
|
+
if (!res.ok) {
|
|
215
|
+
throw res.error;
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
const { value: result } = res;
|
|
219
|
+
|
|
220
|
+
// Handle the result
|
|
221
|
+
console.log(result);
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
run();
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Parameters
|
|
228
|
+
|
|
229
|
+
| Parameter | Type | Required | Description |
|
|
230
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
231
|
+
| `request` | [operations.TemplateUpdateTemplateRequestBody](../../models/operations/templateupdatetemplaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
232
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
233
|
+
| `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. |
|
|
234
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
235
|
+
|
|
236
|
+
### Response
|
|
237
|
+
|
|
238
|
+
**Promise\<[operations.TemplateUpdateTemplateResponseBody](../../models/operations/templateupdatetemplateresponsebody.md)\>**
|
|
239
|
+
|
|
240
|
+
### Errors
|
|
241
|
+
|
|
242
|
+
| Error Type | Status Code | Content Type |
|
|
243
|
+
| ------------------------------- | ------------------------------- | ------------------------------- |
|
|
244
|
+
| errors.ErrorBADREQUEST | 400 | application/json |
|
|
245
|
+
| errors.Errorinternalservererror | 500 | application/json |
|
|
246
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
247
|
+
|
|
248
|
+
## duplicate
|
|
249
|
+
|
|
250
|
+
Duplicate template
|
|
251
|
+
|
|
252
|
+
### Example Usage
|
|
253
|
+
|
|
254
|
+
```typescript
|
|
255
|
+
import { Documenso } from "@documenso/sdk-typescript";
|
|
256
|
+
|
|
257
|
+
const documenso = new Documenso({
|
|
258
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
async function run() {
|
|
262
|
+
const result = await documenso.templates.duplicate({
|
|
263
|
+
templateId: 4435.87,
|
|
264
|
+
});
|
|
265
|
+
|
|
266
|
+
// Handle the result
|
|
267
|
+
console.log(result);
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
run();
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
### Standalone function
|
|
274
|
+
|
|
275
|
+
The standalone function version of this method:
|
|
276
|
+
|
|
277
|
+
```typescript
|
|
278
|
+
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
279
|
+
import { templatesDuplicate } from "@documenso/sdk-typescript/funcs/templatesDuplicate.js";
|
|
280
|
+
|
|
281
|
+
// Use `DocumensoCore` for best tree-shaking performance.
|
|
282
|
+
// You can create one instance of it to use across an application.
|
|
283
|
+
const documenso = new DocumensoCore({
|
|
284
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
285
|
+
});
|
|
286
|
+
|
|
287
|
+
async function run() {
|
|
288
|
+
const res = await templatesDuplicate(documenso, {
|
|
289
|
+
templateId: 4435.87,
|
|
290
|
+
});
|
|
291
|
+
|
|
292
|
+
if (!res.ok) {
|
|
293
|
+
throw res.error;
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
const { value: result } = res;
|
|
297
|
+
|
|
298
|
+
// Handle the result
|
|
299
|
+
console.log(result);
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
run();
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
### Parameters
|
|
306
|
+
|
|
307
|
+
| Parameter | Type | Required | Description |
|
|
308
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
309
|
+
| `request` | [operations.TemplateDuplicateTemplateRequestBody](../../models/operations/templateduplicatetemplaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
310
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
311
|
+
| `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. |
|
|
312
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
313
|
+
|
|
314
|
+
### Response
|
|
315
|
+
|
|
316
|
+
**Promise\<[operations.TemplateDuplicateTemplateResponseBody](../../models/operations/templateduplicatetemplateresponsebody.md)\>**
|
|
317
|
+
|
|
318
|
+
### Errors
|
|
319
|
+
|
|
320
|
+
| Error Type | Status Code | Content Type |
|
|
321
|
+
| ------------------------------- | ------------------------------- | ------------------------------- |
|
|
322
|
+
| errors.ErrorBADREQUEST | 400 | application/json |
|
|
323
|
+
| errors.Errorinternalservererror | 500 | application/json |
|
|
324
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
325
|
+
|
|
326
|
+
## delete
|
|
327
|
+
|
|
328
|
+
Delete template
|
|
329
|
+
|
|
330
|
+
### Example Usage
|
|
331
|
+
|
|
332
|
+
```typescript
|
|
333
|
+
import { Documenso } from "@documenso/sdk-typescript";
|
|
334
|
+
|
|
335
|
+
const documenso = new Documenso({
|
|
336
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
337
|
+
});
|
|
338
|
+
|
|
339
|
+
async function run() {
|
|
340
|
+
const result = await documenso.templates.delete({
|
|
341
|
+
templateId: 5711.61,
|
|
342
|
+
});
|
|
343
|
+
|
|
344
|
+
// Handle the result
|
|
345
|
+
console.log(result);
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
run();
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
### Standalone function
|
|
352
|
+
|
|
353
|
+
The standalone function version of this method:
|
|
354
|
+
|
|
355
|
+
```typescript
|
|
356
|
+
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
357
|
+
import { templatesDelete } from "@documenso/sdk-typescript/funcs/templatesDelete.js";
|
|
358
|
+
|
|
359
|
+
// Use `DocumensoCore` for best tree-shaking performance.
|
|
360
|
+
// You can create one instance of it to use across an application.
|
|
361
|
+
const documenso = new DocumensoCore({
|
|
362
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
363
|
+
});
|
|
364
|
+
|
|
365
|
+
async function run() {
|
|
366
|
+
const res = await templatesDelete(documenso, {
|
|
367
|
+
templateId: 5711.61,
|
|
368
|
+
});
|
|
369
|
+
|
|
370
|
+
if (!res.ok) {
|
|
371
|
+
throw res.error;
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
const { value: result } = res;
|
|
375
|
+
|
|
376
|
+
// Handle the result
|
|
377
|
+
console.log(result);
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
run();
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
### Parameters
|
|
384
|
+
|
|
385
|
+
| Parameter | Type | Required | Description |
|
|
386
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
387
|
+
| `request` | [operations.TemplateDeleteTemplateRequestBody](../../models/operations/templatedeletetemplaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
388
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
389
|
+
| `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. |
|
|
390
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
391
|
+
|
|
392
|
+
### Response
|
|
393
|
+
|
|
394
|
+
**Promise\<[any](../../models/.md)\>**
|
|
395
|
+
|
|
396
|
+
### Errors
|
|
397
|
+
|
|
398
|
+
| Error Type | Status Code | Content Type |
|
|
399
|
+
| ------------------------------- | ------------------------------- | ------------------------------- |
|
|
400
|
+
| errors.ErrorBADREQUEST | 400 | application/json |
|
|
401
|
+
| errors.Errorinternalservererror | 500 | application/json |
|
|
402
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
403
|
+
|
|
404
|
+
## use
|
|
405
|
+
|
|
406
|
+
Use the template to create a document
|
|
407
|
+
|
|
408
|
+
### Example Usage
|
|
409
|
+
|
|
410
|
+
```typescript
|
|
411
|
+
import { Documenso } from "@documenso/sdk-typescript";
|
|
412
|
+
|
|
413
|
+
const documenso = new Documenso({
|
|
414
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
415
|
+
});
|
|
416
|
+
|
|
417
|
+
async function run() {
|
|
418
|
+
const result = await documenso.templates.use({
|
|
419
|
+
templateId: 3949.44,
|
|
420
|
+
recipients: [
|
|
421
|
+
|
|
422
|
+
],
|
|
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 { templatesUse } from "@documenso/sdk-typescript/funcs/templatesUse.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 templatesUse(documenso, {
|
|
448
|
+
templateId: 3949.44,
|
|
449
|
+
recipients: [
|
|
450
|
+
|
|
451
|
+
],
|
|
452
|
+
});
|
|
453
|
+
|
|
454
|
+
if (!res.ok) {
|
|
455
|
+
throw res.error;
|
|
456
|
+
}
|
|
457
|
+
|
|
458
|
+
const { value: result } = res;
|
|
459
|
+
|
|
460
|
+
// Handle the result
|
|
461
|
+
console.log(result);
|
|
462
|
+
}
|
|
463
|
+
|
|
464
|
+
run();
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
### Parameters
|
|
468
|
+
|
|
469
|
+
| Parameter | Type | Required | Description |
|
|
470
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
471
|
+
| `request` | [operations.TemplateCreateDocumentFromTemplateRequestBody](../../models/operations/templatecreatedocumentfromtemplaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
472
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
473
|
+
| `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. |
|
|
474
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
475
|
+
|
|
476
|
+
### Response
|
|
477
|
+
|
|
478
|
+
**Promise\<[operations.TemplateCreateDocumentFromTemplateResponseBody](../../models/operations/templatecreatedocumentfromtemplateresponsebody.md)\>**
|
|
479
|
+
|
|
480
|
+
### Errors
|
|
481
|
+
|
|
482
|
+
| Error Type | Status Code | Content Type |
|
|
483
|
+
| ------------------------------- | ------------------------------- | ------------------------------- |
|
|
484
|
+
| errors.ErrorBADREQUEST | 400 | application/json |
|
|
485
|
+
| errors.Errorinternalservererror | 500 | application/json |
|
|
486
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
487
|
+
|
|
488
|
+
## moveToTeam
|
|
489
|
+
|
|
490
|
+
Move a template to a team
|
|
491
|
+
|
|
492
|
+
### Example Usage
|
|
493
|
+
|
|
494
|
+
```typescript
|
|
495
|
+
import { Documenso } from "@documenso/sdk-typescript";
|
|
496
|
+
|
|
497
|
+
const documenso = new Documenso({
|
|
498
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
499
|
+
});
|
|
500
|
+
|
|
501
|
+
async function run() {
|
|
502
|
+
const result = await documenso.templates.moveToTeam({
|
|
503
|
+
templateId: 2502.80,
|
|
504
|
+
teamId: 8882.89,
|
|
505
|
+
});
|
|
506
|
+
|
|
507
|
+
// Handle the result
|
|
508
|
+
console.log(result);
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
run();
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
### Standalone function
|
|
515
|
+
|
|
516
|
+
The standalone function version of this method:
|
|
517
|
+
|
|
518
|
+
```typescript
|
|
519
|
+
import { DocumensoCore } from "@documenso/sdk-typescript/core.js";
|
|
520
|
+
import { templatesMoveToTeam } from "@documenso/sdk-typescript/funcs/templatesMoveToTeam.js";
|
|
521
|
+
|
|
522
|
+
// Use `DocumensoCore` for best tree-shaking performance.
|
|
523
|
+
// You can create one instance of it to use across an application.
|
|
524
|
+
const documenso = new DocumensoCore({
|
|
525
|
+
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
526
|
+
});
|
|
527
|
+
|
|
528
|
+
async function run() {
|
|
529
|
+
const res = await templatesMoveToTeam(documenso, {
|
|
530
|
+
templateId: 2502.80,
|
|
531
|
+
teamId: 8882.89,
|
|
532
|
+
});
|
|
533
|
+
|
|
534
|
+
if (!res.ok) {
|
|
535
|
+
throw res.error;
|
|
536
|
+
}
|
|
537
|
+
|
|
538
|
+
const { value: result } = res;
|
|
539
|
+
|
|
540
|
+
// Handle the result
|
|
541
|
+
console.log(result);
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
run();
|
|
545
|
+
```
|
|
546
|
+
|
|
547
|
+
### Parameters
|
|
548
|
+
|
|
549
|
+
| Parameter | Type | Required | Description |
|
|
550
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
551
|
+
| `request` | [operations.TemplateMoveTemplateToTeamRequestBody](../../models/operations/templatemovetemplatetoteamrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
552
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
553
|
+
| `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. |
|
|
554
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
555
|
+
|
|
556
|
+
### Response
|
|
557
|
+
|
|
558
|
+
**Promise\<[operations.TemplateMoveTemplateToTeamResponseBody](../../models/operations/templatemovetemplatetoteamresponsebody.md)\>**
|
|
559
|
+
|
|
560
|
+
### Errors
|
|
561
|
+
|
|
562
|
+
| Error Type | Status Code | Content Type |
|
|
563
|
+
| ------------------------------- | ------------------------------- | ------------------------------- |
|
|
564
|
+
| errors.ErrorBADREQUEST | 400 | application/json |
|
|
565
|
+
| errors.Errorinternalservererror | 500 | application/json |
|
|
566
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { DocumensoCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { APIError } from "../models/errors/apierror.js";
|
|
4
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
|
|
5
|
+
import * as errors from "../models/errors/index.js";
|
|
6
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
7
|
+
import * as operations from "../models/operations/index.js";
|
|
8
|
+
import { Result } from "../types/fp.js";
|
|
9
|
+
/**
|
|
10
|
+
* Create document
|
|
11
|
+
*
|
|
12
|
+
* @remarks
|
|
13
|
+
* 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.
|
|
14
|
+
*/
|
|
15
|
+
export declare function documentsCreateV0(client: DocumensoCore, request: operations.DocumentCreateDocumentTemporaryRequestBody, options?: RequestOptions): Promise<Result<operations.DocumentCreateDocumentTemporaryResponseBody, errors.ErrorBADREQUEST | errors.Errorinternalservererror | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
|
|
16
|
+
//# sourceMappingURL=documentsCreateV0.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documentsCreateV0.d.ts","sourceRoot":"","sources":["../src/funcs/documentsCreateV0.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,UAAU,CAAC,0CAA0C,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,2CAA2C,EACpD,MAAM,CAAC,eAAe,GACtB,MAAM,CAAC,wBAAwB,GAC/B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CA6FA"}
|