@documenso/sdk-typescript 0.1.2 → 0.1.3
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/README.md +136 -200
- package/docs/sdks/directlink/README.md +15 -15
- package/docs/sdks/documensofields/README.md +31 -31
- package/docs/sdks/documensorecipients/README.md +31 -31
- package/docs/sdks/documents/README.md +47 -47
- package/docs/sdks/fields/README.md +31 -31
- package/docs/sdks/recipients/README.md +31 -31
- package/docs/sdks/templates/README.md +37 -37
- package/funcs/documentsCreateV0.d.ts +1 -1
- package/funcs/documentsCreateV0.d.ts.map +1 -1
- package/funcs/documentsCreateV0.js +1 -1
- package/funcs/documentsCreateV0.js.map +1 -1
- package/funcs/documentsDelete.d.ts +1 -1
- package/funcs/documentsDelete.d.ts.map +1 -1
- package/funcs/documentsDelete.js +1 -1
- package/funcs/documentsDelete.js.map +1 -1
- package/funcs/documentsDistribute.d.ts +1 -1
- package/funcs/documentsDistribute.d.ts.map +1 -1
- package/funcs/documentsDistribute.js +1 -1
- package/funcs/documentsDistribute.js.map +1 -1
- package/funcs/documentsDuplicate.d.ts +1 -1
- package/funcs/documentsDuplicate.d.ts.map +1 -1
- package/funcs/documentsDuplicate.js +1 -1
- package/funcs/documentsDuplicate.js.map +1 -1
- package/funcs/documentsFieldsCreate.d.ts +1 -1
- package/funcs/documentsFieldsCreate.d.ts.map +1 -1
- package/funcs/documentsFieldsCreate.js +1 -1
- package/funcs/documentsFieldsCreate.js.map +1 -1
- package/funcs/documentsFieldsCreateMany.d.ts +1 -1
- package/funcs/documentsFieldsCreateMany.d.ts.map +1 -1
- package/funcs/documentsFieldsCreateMany.js +1 -1
- package/funcs/documentsFieldsCreateMany.js.map +1 -1
- package/funcs/documentsFieldsDelete.d.ts +1 -1
- package/funcs/documentsFieldsDelete.d.ts.map +1 -1
- package/funcs/documentsFieldsDelete.js +1 -1
- package/funcs/documentsFieldsDelete.js.map +1 -1
- package/funcs/documentsFieldsGet.d.ts +1 -1
- package/funcs/documentsFieldsGet.d.ts.map +1 -1
- package/funcs/documentsFieldsGet.js +2 -1
- package/funcs/documentsFieldsGet.js.map +1 -1
- package/funcs/documentsFieldsUpdate.d.ts +1 -1
- package/funcs/documentsFieldsUpdate.d.ts.map +1 -1
- package/funcs/documentsFieldsUpdate.js +1 -1
- package/funcs/documentsFieldsUpdate.js.map +1 -1
- package/funcs/documentsFieldsUpdateMany.d.ts +1 -1
- package/funcs/documentsFieldsUpdateMany.d.ts.map +1 -1
- package/funcs/documentsFieldsUpdateMany.js +1 -1
- package/funcs/documentsFieldsUpdateMany.js.map +1 -1
- package/funcs/documentsFind.d.ts +1 -1
- package/funcs/documentsFind.d.ts.map +1 -1
- package/funcs/documentsFind.js +1 -1
- package/funcs/documentsFind.js.map +1 -1
- package/funcs/documentsGet.d.ts +1 -1
- package/funcs/documentsGet.d.ts.map +1 -1
- package/funcs/documentsGet.js +3 -1
- package/funcs/documentsGet.js.map +1 -1
- package/funcs/documentsMoveToTeam.d.ts +1 -1
- package/funcs/documentsMoveToTeam.d.ts.map +1 -1
- package/funcs/documentsMoveToTeam.js +1 -1
- package/funcs/documentsMoveToTeam.js.map +1 -1
- package/funcs/documentsRecipientsCreate.d.ts +1 -1
- package/funcs/documentsRecipientsCreate.d.ts.map +1 -1
- package/funcs/documentsRecipientsCreate.js +2 -1
- package/funcs/documentsRecipientsCreate.js.map +1 -1
- package/funcs/documentsRecipientsCreateMany.d.ts +1 -1
- package/funcs/documentsRecipientsCreateMany.d.ts.map +1 -1
- package/funcs/documentsRecipientsCreateMany.js +2 -1
- package/funcs/documentsRecipientsCreateMany.js.map +1 -1
- package/funcs/documentsRecipientsDelete.d.ts +1 -1
- package/funcs/documentsRecipientsDelete.d.ts.map +1 -1
- package/funcs/documentsRecipientsDelete.js +2 -1
- package/funcs/documentsRecipientsDelete.js.map +1 -1
- package/funcs/documentsRecipientsGet.d.ts +1 -1
- package/funcs/documentsRecipientsGet.d.ts.map +1 -1
- package/funcs/documentsRecipientsGet.js +3 -1
- package/funcs/documentsRecipientsGet.js.map +1 -1
- package/funcs/documentsRecipientsUpdate.d.ts +1 -1
- package/funcs/documentsRecipientsUpdate.d.ts.map +1 -1
- package/funcs/documentsRecipientsUpdate.js +2 -1
- package/funcs/documentsRecipientsUpdate.js.map +1 -1
- package/funcs/documentsRecipientsUpdateMany.d.ts +1 -1
- package/funcs/documentsRecipientsUpdateMany.d.ts.map +1 -1
- package/funcs/documentsRecipientsUpdateMany.js +2 -1
- package/funcs/documentsRecipientsUpdateMany.js.map +1 -1
- package/funcs/documentsRedistribute.d.ts +1 -1
- package/funcs/documentsRedistribute.d.ts.map +1 -1
- package/funcs/documentsRedistribute.js +1 -1
- package/funcs/documentsRedistribute.js.map +1 -1
- package/funcs/documentsUpdate.d.ts +1 -1
- package/funcs/documentsUpdate.d.ts.map +1 -1
- package/funcs/documentsUpdate.js +1 -1
- package/funcs/documentsUpdate.js.map +1 -1
- package/funcs/templatesDelete.d.ts +1 -1
- package/funcs/templatesDelete.d.ts.map +1 -1
- package/funcs/templatesDelete.js +1 -1
- package/funcs/templatesDelete.js.map +1 -1
- package/funcs/templatesDirectLinkCreate.d.ts +1 -1
- package/funcs/templatesDirectLinkCreate.d.ts.map +1 -1
- package/funcs/templatesDirectLinkCreate.js +2 -1
- package/funcs/templatesDirectLinkCreate.js.map +1 -1
- package/funcs/templatesDirectLinkDelete.d.ts +1 -1
- package/funcs/templatesDirectLinkDelete.d.ts.map +1 -1
- package/funcs/templatesDirectLinkDelete.js +2 -1
- package/funcs/templatesDirectLinkDelete.js.map +1 -1
- package/funcs/templatesDirectLinkToggle.d.ts +1 -1
- package/funcs/templatesDirectLinkToggle.d.ts.map +1 -1
- package/funcs/templatesDirectLinkToggle.js +2 -1
- package/funcs/templatesDirectLinkToggle.js.map +1 -1
- package/funcs/templatesDuplicate.d.ts +1 -1
- package/funcs/templatesDuplicate.d.ts.map +1 -1
- package/funcs/templatesDuplicate.js +1 -1
- package/funcs/templatesDuplicate.js.map +1 -1
- package/funcs/templatesFieldsCreate.d.ts +1 -1
- package/funcs/templatesFieldsCreate.d.ts.map +1 -1
- package/funcs/templatesFieldsCreate.js +1 -1
- package/funcs/templatesFieldsCreate.js.map +1 -1
- package/funcs/templatesFieldsCreateMany.d.ts +1 -1
- package/funcs/templatesFieldsCreateMany.d.ts.map +1 -1
- package/funcs/templatesFieldsCreateMany.js +1 -1
- package/funcs/templatesFieldsCreateMany.js.map +1 -1
- package/funcs/templatesFieldsDelete.d.ts +1 -1
- package/funcs/templatesFieldsDelete.d.ts.map +1 -1
- package/funcs/templatesFieldsDelete.js +1 -1
- package/funcs/templatesFieldsDelete.js.map +1 -1
- package/funcs/templatesFieldsGet.d.ts +1 -1
- package/funcs/templatesFieldsGet.d.ts.map +1 -1
- package/funcs/templatesFieldsGet.js +2 -1
- package/funcs/templatesFieldsGet.js.map +1 -1
- package/funcs/templatesFieldsUpdate.d.ts +1 -1
- package/funcs/templatesFieldsUpdate.d.ts.map +1 -1
- package/funcs/templatesFieldsUpdate.js +1 -1
- package/funcs/templatesFieldsUpdate.js.map +1 -1
- package/funcs/templatesFieldsUpdateMany.d.ts +1 -1
- package/funcs/templatesFieldsUpdateMany.d.ts.map +1 -1
- package/funcs/templatesFieldsUpdateMany.js +1 -1
- package/funcs/templatesFieldsUpdateMany.js.map +1 -1
- package/funcs/templatesFind.d.ts +1 -1
- package/funcs/templatesFind.d.ts.map +1 -1
- package/funcs/templatesFind.js +1 -1
- package/funcs/templatesFind.js.map +1 -1
- package/funcs/templatesGet.d.ts +1 -1
- package/funcs/templatesGet.d.ts.map +1 -1
- package/funcs/templatesGet.js +1 -1
- package/funcs/templatesGet.js.map +1 -1
- package/funcs/templatesMoveToTeam.d.ts +1 -1
- package/funcs/templatesMoveToTeam.d.ts.map +1 -1
- package/funcs/templatesMoveToTeam.js +1 -1
- package/funcs/templatesMoveToTeam.js.map +1 -1
- package/funcs/templatesRecipientsCreate.d.ts +1 -1
- package/funcs/templatesRecipientsCreate.d.ts.map +1 -1
- package/funcs/templatesRecipientsCreate.js +2 -1
- package/funcs/templatesRecipientsCreate.js.map +1 -1
- package/funcs/templatesRecipientsCreateMany.d.ts +1 -1
- package/funcs/templatesRecipientsCreateMany.d.ts.map +1 -1
- package/funcs/templatesRecipientsCreateMany.js +2 -1
- package/funcs/templatesRecipientsCreateMany.js.map +1 -1
- package/funcs/templatesRecipientsDelete.d.ts +1 -1
- package/funcs/templatesRecipientsDelete.d.ts.map +1 -1
- package/funcs/templatesRecipientsDelete.js +2 -1
- package/funcs/templatesRecipientsDelete.js.map +1 -1
- package/funcs/templatesRecipientsGet.d.ts +1 -1
- package/funcs/templatesRecipientsGet.d.ts.map +1 -1
- package/funcs/templatesRecipientsGet.js +3 -1
- package/funcs/templatesRecipientsGet.js.map +1 -1
- package/funcs/templatesRecipientsUpdate.d.ts +1 -1
- package/funcs/templatesRecipientsUpdate.d.ts.map +1 -1
- package/funcs/templatesRecipientsUpdate.js +2 -1
- package/funcs/templatesRecipientsUpdate.js.map +1 -1
- package/funcs/templatesRecipientsUpdateMany.d.ts +1 -1
- package/funcs/templatesRecipientsUpdateMany.d.ts.map +1 -1
- package/funcs/templatesRecipientsUpdateMany.js +2 -1
- package/funcs/templatesRecipientsUpdateMany.js.map +1 -1
- package/funcs/templatesUpdate.d.ts +1 -1
- package/funcs/templatesUpdate.d.ts.map +1 -1
- package/funcs/templatesUpdate.js +1 -1
- package/funcs/templatesUpdate.js.map +1 -1
- package/funcs/templatesUse.d.ts +1 -1
- package/funcs/templatesUse.d.ts.map +1 -1
- package/funcs/templatesUse.js +2 -1
- package/funcs/templatesUse.js.map +1 -1
- package/hooks/hooks.d.ts.map +1 -1
- package/hooks/hooks.js +0 -2
- package/hooks/hooks.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/models/errors/documentcreatedocumenttemporary.d.ts +134 -0
- package/models/errors/documentcreatedocumenttemporary.d.ts.map +1 -0
- package/models/errors/documentcreatedocumenttemporary.js +186 -0
- package/models/errors/documentcreatedocumenttemporary.js.map +1 -0
- package/models/errors/documentdeletedocument.d.ts +134 -0
- package/models/errors/documentdeletedocument.d.ts.map +1 -0
- package/models/errors/documentdeletedocument.js +188 -0
- package/models/errors/documentdeletedocument.js.map +1 -0
- package/models/errors/documentduplicatedocument.d.ts +134 -0
- package/models/errors/documentduplicatedocument.d.ts.map +1 -0
- package/models/errors/documentduplicatedocument.js +187 -0
- package/models/errors/documentduplicatedocument.js.map +1 -0
- package/models/errors/documentfinddocuments.d.ts +199 -0
- package/models/errors/documentfinddocuments.d.ts.map +1 -0
- package/models/errors/documentfinddocuments.js +261 -0
- package/models/errors/documentfinddocuments.js.map +1 -0
- package/models/errors/documentgetdocumentwithdetailsbyid.d.ts +199 -0
- package/models/errors/documentgetdocumentwithdetailsbyid.d.ts.map +1 -0
- package/models/errors/documentgetdocumentwithdetailsbyid.js +261 -0
- package/models/errors/documentgetdocumentwithdetailsbyid.js.map +1 -0
- package/models/errors/documentmovedocumenttoteam.d.ts +134 -0
- package/models/errors/documentmovedocumenttoteam.d.ts.map +1 -0
- package/models/errors/documentmovedocumenttoteam.js +187 -0
- package/models/errors/documentmovedocumenttoteam.js.map +1 -0
- package/models/errors/documentresenddocument.d.ts +134 -0
- package/models/errors/documentresenddocument.d.ts.map +1 -0
- package/models/errors/documentresenddocument.js +188 -0
- package/models/errors/documentresenddocument.js.map +1 -0
- package/models/errors/documentsenddocument.d.ts +134 -0
- package/models/errors/documentsenddocument.d.ts.map +1 -0
- package/models/errors/documentsenddocument.js +188 -0
- package/models/errors/documentsenddocument.js.map +1 -0
- package/models/errors/documentsetsettingsfordocument.d.ts +134 -0
- package/models/errors/documentsetsettingsfordocument.d.ts.map +1 -0
- package/models/errors/documentsetsettingsfordocument.js +186 -0
- package/models/errors/documentsetsettingsfordocument.js.map +1 -0
- package/models/errors/fieldcreatedocumentfield.d.ts +134 -0
- package/models/errors/fieldcreatedocumentfield.d.ts.map +1 -0
- package/models/errors/fieldcreatedocumentfield.js +188 -0
- package/models/errors/fieldcreatedocumentfield.js.map +1 -0
- package/models/errors/fieldcreatedocumentfields.d.ts +134 -0
- package/models/errors/fieldcreatedocumentfields.d.ts.map +1 -0
- package/models/errors/fieldcreatedocumentfields.js +187 -0
- package/models/errors/fieldcreatedocumentfields.js.map +1 -0
- package/models/errors/fieldcreatetemplatefield.d.ts +134 -0
- package/models/errors/fieldcreatetemplatefield.d.ts.map +1 -0
- package/models/errors/fieldcreatetemplatefield.js +188 -0
- package/models/errors/fieldcreatetemplatefield.js.map +1 -0
- package/models/errors/fieldcreatetemplatefields.d.ts +134 -0
- package/models/errors/fieldcreatetemplatefields.d.ts.map +1 -0
- package/models/errors/fieldcreatetemplatefields.js +187 -0
- package/models/errors/fieldcreatetemplatefields.js.map +1 -0
- package/models/errors/fielddeletedocumentfield.d.ts +134 -0
- package/models/errors/fielddeletedocumentfield.d.ts.map +1 -0
- package/models/errors/fielddeletedocumentfield.js +188 -0
- package/models/errors/fielddeletedocumentfield.js.map +1 -0
- package/models/errors/fielddeletetemplatefield.d.ts +134 -0
- package/models/errors/fielddeletetemplatefield.d.ts.map +1 -0
- package/models/errors/fielddeletetemplatefield.js +188 -0
- package/models/errors/fielddeletetemplatefield.js.map +1 -0
- package/models/errors/fieldgetdocumentfield.d.ts +199 -0
- package/models/errors/fieldgetdocumentfield.d.ts.map +1 -0
- package/models/errors/fieldgetdocumentfield.js +260 -0
- package/models/errors/fieldgetdocumentfield.js.map +1 -0
- package/models/errors/fieldgettemplatefield.d.ts +199 -0
- package/models/errors/fieldgettemplatefield.d.ts.map +1 -0
- package/models/errors/fieldgettemplatefield.js +260 -0
- package/models/errors/fieldgettemplatefield.js.map +1 -0
- package/models/errors/fieldupdatedocumentfield.d.ts +134 -0
- package/models/errors/fieldupdatedocumentfield.d.ts.map +1 -0
- package/models/errors/fieldupdatedocumentfield.js +188 -0
- package/models/errors/fieldupdatedocumentfield.js.map +1 -0
- package/models/errors/fieldupdatedocumentfields.d.ts +134 -0
- package/models/errors/fieldupdatedocumentfields.d.ts.map +1 -0
- package/models/errors/fieldupdatedocumentfields.js +187 -0
- package/models/errors/fieldupdatedocumentfields.js.map +1 -0
- package/models/errors/fieldupdatetemplatefield.d.ts +134 -0
- package/models/errors/fieldupdatetemplatefield.d.ts.map +1 -0
- package/models/errors/fieldupdatetemplatefield.js +188 -0
- package/models/errors/fieldupdatetemplatefield.js.map +1 -0
- package/models/errors/fieldupdatetemplatefields.d.ts +134 -0
- package/models/errors/fieldupdatetemplatefields.d.ts.map +1 -0
- package/models/errors/fieldupdatetemplatefields.js +187 -0
- package/models/errors/fieldupdatetemplatefields.js.map +1 -0
- package/models/errors/index.d.ts +43 -3
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +43 -3
- package/models/errors/index.js.map +1 -1
- package/models/errors/recipientcreatedocumentrecipient.d.ts +134 -0
- package/models/errors/recipientcreatedocumentrecipient.d.ts.map +1 -0
- package/models/errors/recipientcreatedocumentrecipient.js +189 -0
- package/models/errors/recipientcreatedocumentrecipient.js.map +1 -0
- package/models/errors/recipientcreatedocumentrecipients.d.ts +134 -0
- package/models/errors/recipientcreatedocumentrecipients.d.ts.map +1 -0
- package/models/errors/recipientcreatedocumentrecipients.js +189 -0
- package/models/errors/recipientcreatedocumentrecipients.js.map +1 -0
- package/models/errors/recipientcreatetemplaterecipient.d.ts +134 -0
- package/models/errors/recipientcreatetemplaterecipient.d.ts.map +1 -0
- package/models/errors/recipientcreatetemplaterecipient.js +189 -0
- package/models/errors/recipientcreatetemplaterecipient.js.map +1 -0
- package/models/errors/recipientcreatetemplaterecipients.d.ts +134 -0
- package/models/errors/recipientcreatetemplaterecipients.d.ts.map +1 -0
- package/models/errors/recipientcreatetemplaterecipients.js +189 -0
- package/models/errors/recipientcreatetemplaterecipients.js.map +1 -0
- package/models/errors/recipientdeletedocumentrecipient.d.ts +134 -0
- package/models/errors/recipientdeletedocumentrecipient.d.ts.map +1 -0
- package/models/errors/recipientdeletedocumentrecipient.js +189 -0
- package/models/errors/recipientdeletedocumentrecipient.js.map +1 -0
- package/models/errors/recipientdeletetemplaterecipient.d.ts +134 -0
- package/models/errors/recipientdeletetemplaterecipient.d.ts.map +1 -0
- package/models/errors/recipientdeletetemplaterecipient.js +189 -0
- package/models/errors/recipientdeletetemplaterecipient.js.map +1 -0
- package/models/errors/recipientgetdocumentrecipient.d.ts +199 -0
- package/models/errors/recipientgetdocumentrecipient.d.ts.map +1 -0
- package/models/errors/recipientgetdocumentrecipient.js +262 -0
- package/models/errors/recipientgetdocumentrecipient.js.map +1 -0
- package/models/errors/recipientgettemplaterecipient.d.ts +199 -0
- package/models/errors/recipientgettemplaterecipient.d.ts.map +1 -0
- package/models/errors/recipientgettemplaterecipient.js +262 -0
- package/models/errors/recipientgettemplaterecipient.js.map +1 -0
- package/models/errors/recipientupdatedocumentrecipient.d.ts +134 -0
- package/models/errors/recipientupdatedocumentrecipient.d.ts.map +1 -0
- package/models/errors/recipientupdatedocumentrecipient.js +189 -0
- package/models/errors/recipientupdatedocumentrecipient.js.map +1 -0
- package/models/errors/recipientupdatedocumentrecipients.d.ts +134 -0
- package/models/errors/recipientupdatedocumentrecipients.d.ts.map +1 -0
- package/models/errors/recipientupdatedocumentrecipients.js +189 -0
- package/models/errors/recipientupdatedocumentrecipients.js.map +1 -0
- package/models/errors/recipientupdatetemplaterecipient.d.ts +134 -0
- package/models/errors/recipientupdatetemplaterecipient.d.ts.map +1 -0
- package/models/errors/recipientupdatetemplaterecipient.js +189 -0
- package/models/errors/recipientupdatetemplaterecipient.js.map +1 -0
- package/models/errors/recipientupdatetemplaterecipients.d.ts +134 -0
- package/models/errors/recipientupdatetemplaterecipients.d.ts.map +1 -0
- package/models/errors/recipientupdatetemplaterecipients.js +189 -0
- package/models/errors/recipientupdatetemplaterecipients.js.map +1 -0
- package/models/errors/templatecreatedocumentfromtemplate.d.ts +134 -0
- package/models/errors/templatecreatedocumentfromtemplate.d.ts.map +1 -0
- package/models/errors/templatecreatedocumentfromtemplate.js +186 -0
- package/models/errors/templatecreatedocumentfromtemplate.js.map +1 -0
- package/models/errors/templatecreatetemplatedirectlink.d.ts +134 -0
- package/models/errors/templatecreatetemplatedirectlink.d.ts.map +1 -0
- package/models/errors/templatecreatetemplatedirectlink.js +189 -0
- package/models/errors/templatecreatetemplatedirectlink.js.map +1 -0
- package/models/errors/templatedeletetemplate.d.ts +134 -0
- package/models/errors/templatedeletetemplate.d.ts.map +1 -0
- package/models/errors/templatedeletetemplate.js +188 -0
- package/models/errors/templatedeletetemplate.js.map +1 -0
- package/models/errors/templatedeletetemplatedirectlink.d.ts +134 -0
- package/models/errors/templatedeletetemplatedirectlink.d.ts.map +1 -0
- package/models/errors/templatedeletetemplatedirectlink.js +189 -0
- package/models/errors/templatedeletetemplatedirectlink.js.map +1 -0
- package/models/errors/templateduplicatetemplate.d.ts +134 -0
- package/models/errors/templateduplicatetemplate.d.ts.map +1 -0
- package/models/errors/templateduplicatetemplate.js +187 -0
- package/models/errors/templateduplicatetemplate.js.map +1 -0
- package/models/errors/templatefindtemplates.d.ts +199 -0
- package/models/errors/templatefindtemplates.d.ts.map +1 -0
- package/models/errors/templatefindtemplates.js +260 -0
- package/models/errors/templatefindtemplates.js.map +1 -0
- package/models/errors/templategettemplatebyid.d.ts +199 -0
- package/models/errors/templategettemplatebyid.d.ts.map +1 -0
- package/models/errors/templategettemplatebyid.js +260 -0
- package/models/errors/templategettemplatebyid.js.map +1 -0
- package/models/errors/templatemovetemplatetoteam.d.ts +134 -0
- package/models/errors/templatemovetemplatetoteam.d.ts.map +1 -0
- package/models/errors/templatemovetemplatetoteam.js +187 -0
- package/models/errors/templatemovetemplatetoteam.js.map +1 -0
- package/models/errors/templatetoggletemplatedirectlink.d.ts +134 -0
- package/models/errors/templatetoggletemplatedirectlink.d.ts.map +1 -0
- package/models/errors/templatetoggletemplatedirectlink.js +189 -0
- package/models/errors/templatetoggletemplatedirectlink.js.map +1 -0
- package/models/errors/templateupdatetemplate.d.ts +134 -0
- package/models/errors/templateupdatetemplate.d.ts.map +1 -0
- package/models/errors/templateupdatetemplate.js +188 -0
- package/models/errors/templateupdatetemplate.js.map +1 -0
- package/package.json +1 -1
- package/src/funcs/documentsCreateV0.ts +12 -6
- package/src/funcs/documentsDelete.ts +9 -6
- package/src/funcs/documentsDistribute.ts +9 -6
- package/src/funcs/documentsDuplicate.ts +9 -6
- package/src/funcs/documentsFieldsCreate.ts +9 -6
- package/src/funcs/documentsFieldsCreateMany.ts +9 -6
- package/src/funcs/documentsFieldsDelete.ts +9 -6
- package/src/funcs/documentsFieldsGet.ts +16 -9
- package/src/funcs/documentsFieldsUpdate.ts +9 -6
- package/src/funcs/documentsFieldsUpdateMany.ts +9 -6
- package/src/funcs/documentsFind.ts +15 -9
- package/src/funcs/documentsGet.ts +20 -9
- package/src/funcs/documentsMoveToTeam.ts +9 -6
- package/src/funcs/documentsRecipientsCreate.ts +13 -6
- package/src/funcs/documentsRecipientsCreateMany.ts +13 -6
- package/src/funcs/documentsRecipientsDelete.ts +13 -6
- package/src/funcs/documentsRecipientsGet.ts +20 -9
- package/src/funcs/documentsRecipientsUpdate.ts +13 -6
- package/src/funcs/documentsRecipientsUpdateMany.ts +13 -6
- package/src/funcs/documentsRedistribute.ts +9 -6
- package/src/funcs/documentsUpdate.ts +12 -6
- package/src/funcs/templatesDelete.ts +9 -6
- package/src/funcs/templatesDirectLinkCreate.ts +13 -6
- package/src/funcs/templatesDirectLinkDelete.ts +13 -6
- package/src/funcs/templatesDirectLinkToggle.ts +13 -6
- package/src/funcs/templatesDuplicate.ts +9 -6
- package/src/funcs/templatesFieldsCreate.ts +9 -6
- package/src/funcs/templatesFieldsCreateMany.ts +9 -6
- package/src/funcs/templatesFieldsDelete.ts +9 -6
- package/src/funcs/templatesFieldsGet.ts +16 -9
- package/src/funcs/templatesFieldsUpdate.ts +9 -6
- package/src/funcs/templatesFieldsUpdateMany.ts +9 -6
- package/src/funcs/templatesFind.ts +15 -9
- package/src/funcs/templatesGet.ts +15 -9
- package/src/funcs/templatesMoveToTeam.ts +9 -6
- package/src/funcs/templatesRecipientsCreate.ts +13 -6
- package/src/funcs/templatesRecipientsCreateMany.ts +13 -6
- package/src/funcs/templatesRecipientsDelete.ts +13 -6
- package/src/funcs/templatesRecipientsGet.ts +20 -9
- package/src/funcs/templatesRecipientsUpdate.ts +13 -6
- package/src/funcs/templatesRecipientsUpdateMany.ts +13 -6
- package/src/funcs/templatesUpdate.ts +9 -6
- package/src/funcs/templatesUse.ts +13 -6
- package/src/hooks/hooks.ts +0 -3
- package/src/lib/config.ts +3 -3
- package/src/models/errors/documentcreatedocumenttemporary.ts +328 -0
- package/src/models/errors/documentdeletedocument.ts +302 -0
- package/src/models/errors/documentduplicatedocument.ts +311 -0
- package/src/models/errors/documentfinddocuments.ts +435 -0
- package/src/models/errors/documentgetdocumentwithdetailsbyid.ts +520 -0
- package/src/models/errors/documentmovedocumenttoteam.ts +314 -0
- package/src/models/errors/documentresenddocument.ts +302 -0
- package/src/models/errors/documentsenddocument.ts +298 -0
- package/src/models/errors/documentsetsettingsfordocument.ts +320 -0
- package/src/models/errors/fieldcreatedocumentfield.ts +316 -0
- package/src/models/errors/fieldcreatedocumentfields.ts +322 -0
- package/src/models/errors/fieldcreatetemplatefield.ts +316 -0
- package/src/models/errors/fieldcreatetemplatefields.ts +322 -0
- package/src/models/errors/fielddeletedocumentfield.ts +316 -0
- package/src/models/errors/fielddeletetemplatefield.ts +316 -0
- package/src/models/errors/fieldgetdocumentfield.ts +486 -0
- package/src/models/errors/fieldgettemplatefield.ts +486 -0
- package/src/models/errors/fieldupdatedocumentfield.ts +316 -0
- package/src/models/errors/fieldupdatedocumentfields.ts +322 -0
- package/src/models/errors/fieldupdatetemplatefield.ts +316 -0
- package/src/models/errors/fieldupdatetemplatefields.ts +322 -0
- package/src/models/errors/index.ts +43 -3
- package/src/models/errors/recipientcreatedocumentrecipient.ts +343 -0
- package/src/models/errors/recipientcreatedocumentrecipients.ts +348 -0
- package/src/models/errors/recipientcreatetemplaterecipient.ts +343 -0
- package/src/models/errors/recipientcreatetemplaterecipients.ts +348 -0
- package/src/models/errors/recipientdeletedocumentrecipient.ts +343 -0
- package/src/models/errors/recipientdeletetemplaterecipient.ts +343 -0
- package/src/models/errors/recipientgetdocumentrecipient.ts +520 -0
- package/src/models/errors/recipientgettemplaterecipient.ts +520 -0
- package/src/models/errors/recipientupdatedocumentrecipient.ts +343 -0
- package/src/models/errors/recipientupdatedocumentrecipients.ts +348 -0
- package/src/models/errors/recipientupdatetemplaterecipient.ts +343 -0
- package/src/models/errors/recipientupdatetemplaterecipients.ts +348 -0
- package/src/models/errors/templatecreatedocumentfromtemplate.ts +337 -0
- package/src/models/errors/templatecreatetemplatedirectlink.ts +343 -0
- package/src/models/errors/templatedeletetemplate.ts +302 -0
- package/src/models/errors/templatedeletetemplatedirectlink.ts +343 -0
- package/src/models/errors/templateduplicatetemplate.ts +311 -0
- package/src/models/errors/templatefindtemplates.ts +463 -0
- package/src/models/errors/templategettemplatebyid.ts +473 -0
- package/src/models/errors/templatemovetemplatetoteam.ts +314 -0
- package/src/models/errors/templatetoggletemplatedirectlink.ts +343 -0
- package/src/models/errors/templateupdatetemplate.ts +302 -0
- package/models/errors/errorbadrequest.d.ts +0 -84
- package/models/errors/errorbadrequest.d.ts.map +0 -1
- package/models/errors/errorbadrequest.js +0 -115
- package/models/errors/errorbadrequest.js.map +0 -1
- package/models/errors/errorinternalservererror.d.ts +0 -84
- package/models/errors/errorinternalservererror.d.ts.map +0 -1
- package/models/errors/errorinternalservererror.js +0 -116
- package/models/errors/errorinternalservererror.js.map +0 -1
- package/models/errors/errornotfound.d.ts +0 -84
- package/models/errors/errornotfound.d.ts.map +0 -1
- package/models/errors/errornotfound.js +0 -115
- package/models/errors/errornotfound.js.map +0 -1
- package/src/models/errors/errorbadrequest.ts +0 -154
- package/src/models/errors/errorinternalservererror.ts +0 -165
- package/src/models/errors/errornotfound.ts +0 -162
package/README.md
CHANGED
|
@@ -1,40 +1,51 @@
|
|
|
1
|
-
|
|
1
|
+
<img src="https://github.com/documenso/documenso/assets/13398220/a643571f-0239-46a6-a73e-6bef38d1228b" alt="Documenso Logo">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
|
|
4
4
|
|
|
5
|
-
<div align="
|
|
5
|
+
<div align="center">
|
|
6
6
|
<a href="https://www.speakeasy.com/?utm_source=@documenso/sdk-typescript&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
|
|
7
7
|
<a href="https://opensource.org/licenses/MIT">
|
|
8
8
|
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
|
|
9
9
|
</a>
|
|
10
10
|
</div>
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
## Summary
|
|
12
|
+
## Documenso TypeScript SDK
|
|
14
13
|
|
|
15
|
-
|
|
16
|
-
|
|
14
|
+
A type-safe SDK for seamless integration with Documenso v2 API, providing first-class TypeScript support.
|
|
15
|
+
|
|
16
|
+
This SDK offers a strongly-typed interface to interact with Documenso's API, enabling you to:
|
|
17
|
+
- Handle document signing workflows with full type safety
|
|
18
|
+
- Leverage autocomplete in your IDE
|
|
19
|
+
- Catch potential errors at compile time
|
|
20
|
+
|
|
21
|
+
The full Documenso API can be viewed here (**todo**), which includes TypeScript examples.
|
|
22
|
+
|
|
23
|
+
## ⚠️ Warning
|
|
24
|
+
|
|
25
|
+
Documenso v2 API and SDKs are currently in beta. There may be to breaking changes.
|
|
26
|
+
|
|
27
|
+
To keep updated, please follow the discussions and issues here:
|
|
28
|
+
- Discussion -> Todo
|
|
29
|
+
- Breaking change alerts -> Todo
|
|
30
|
+
|
|
31
|
+
<!-- No Summary [summary] -->
|
|
17
32
|
|
|
18
|
-
<!-- Start Table of Contents [toc] -->
|
|
19
33
|
## Table of Contents
|
|
20
34
|
<!-- $toc-max-depth=2 -->
|
|
21
|
-
* [
|
|
35
|
+
* [Overview](#documenso-typescript-sdk)
|
|
22
36
|
* [SDK Installation](#sdk-installation)
|
|
23
37
|
* [Requirements](#requirements)
|
|
24
|
-
* [
|
|
38
|
+
* [Document creation example](#document-creation-example)
|
|
25
39
|
* [Authentication](#authentication)
|
|
26
40
|
* [Available Resources and Operations](#available-resources-and-operations)
|
|
27
|
-
* [Standalone functions](#standalone-functions)
|
|
28
41
|
* [Retries](#retries)
|
|
29
42
|
* [Error Handling](#error-handling)
|
|
30
|
-
* [Server Selection](#server-selection)
|
|
31
|
-
* [Custom HTTP Client](#custom-http-client)
|
|
32
43
|
* [Debugging](#debugging)
|
|
33
44
|
* [Development](#development)
|
|
34
45
|
* [Maturity](#maturity)
|
|
35
46
|
* [Contributions](#contributions)
|
|
36
47
|
|
|
37
|
-
<!--
|
|
48
|
+
<!-- No Table of Contents [toc] -->
|
|
38
49
|
|
|
39
50
|
<!-- Start SDK Installation [installation] -->
|
|
40
51
|
## SDK Installation
|
|
@@ -75,64 +86,123 @@ yarn add @documenso/sdk-typescript zod
|
|
|
75
86
|
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
|
76
87
|
<!-- End Requirements [requirements] -->
|
|
77
88
|
|
|
78
|
-
|
|
79
|
-
## SDK Example Usage
|
|
89
|
+
## Authentication
|
|
80
90
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
```typescript
|
|
84
|
-
import { Documenso } from "@documenso/sdk-typescript";
|
|
91
|
+
To use the SDK, you will need a Documenso API key which can be created [here](https://docs.documenso.com/developers/public-api/authentication#creating-an-api-key
|
|
92
|
+
).
|
|
85
93
|
|
|
94
|
+
```ts
|
|
86
95
|
const documenso = new Documenso({
|
|
87
96
|
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
88
97
|
});
|
|
98
|
+
```
|
|
89
99
|
|
|
90
|
-
|
|
91
|
-
const result = await documenso.documents.find({
|
|
92
|
-
orderByDirection: "desc",
|
|
93
|
-
});
|
|
94
|
-
|
|
95
|
-
// Handle the result
|
|
96
|
-
console.log(result);
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
run();
|
|
100
|
+
## Document creation example
|
|
100
101
|
|
|
101
|
-
|
|
102
|
-
<!-- End SDK Example Usage [usage] -->
|
|
102
|
+
Currently creating a document involves two steps:
|
|
103
103
|
|
|
104
|
-
|
|
105
|
-
|
|
104
|
+
1. Create the document
|
|
105
|
+
2. Upload the PDF
|
|
106
106
|
|
|
107
|
-
|
|
107
|
+
This is a temporary measure, in the near future prior to the full release we will merge these two tasks into one request.
|
|
108
108
|
|
|
109
|
-
|
|
109
|
+
Here is a full example of the document creation process which you can copy and run.
|
|
110
110
|
|
|
111
|
-
|
|
112
|
-
| -------- | ------ | ------- | -------------------- |
|
|
113
|
-
| `apiKey` | apiKey | API key | `DOCUMENSO_API_KEY` |
|
|
111
|
+
Note that the function is temporarily called `createV0`, which will be replaced by `create` once we resolve the 2 step workaround.
|
|
114
112
|
|
|
115
|
-
To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
|
|
116
113
|
```typescript
|
|
117
114
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
115
|
+
import fs from "fs";
|
|
118
116
|
|
|
119
117
|
const documenso = new Documenso({
|
|
120
118
|
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
121
119
|
});
|
|
122
120
|
|
|
123
|
-
async function
|
|
124
|
-
const
|
|
125
|
-
|
|
121
|
+
async function uploadFileToPresignedUrl(filePath: string, uploadUrl: string) {
|
|
122
|
+
const fileBuffer = await fs.promises.readFile(filePath);
|
|
123
|
+
|
|
124
|
+
// Make PUT request to pre-signed URL
|
|
125
|
+
const response = await fetch(uploadUrl, {
|
|
126
|
+
method: "PUT",
|
|
127
|
+
body: fileBuffer,
|
|
128
|
+
headers: {
|
|
129
|
+
"Content-Type": "application/octet-stream",
|
|
130
|
+
},
|
|
126
131
|
});
|
|
127
132
|
|
|
128
|
-
|
|
129
|
-
|
|
133
|
+
if (!response.ok) {
|
|
134
|
+
throw new Error(`Upload failed with status: ${response.status}`);
|
|
135
|
+
}
|
|
130
136
|
}
|
|
131
137
|
|
|
132
|
-
|
|
138
|
+
const main = async () => {
|
|
139
|
+
const createDocumentResponse = await documenso.documents.createV0({
|
|
140
|
+
title: "Document title",
|
|
141
|
+
recipients: [
|
|
142
|
+
{
|
|
143
|
+
email: "example@documenso.com",
|
|
144
|
+
name: "Example Doe",
|
|
145
|
+
role: "SIGNER",
|
|
146
|
+
fields: [
|
|
147
|
+
{
|
|
148
|
+
type: "SIGNATURE",
|
|
149
|
+
pageNumber: 1,
|
|
150
|
+
pageX: 10,
|
|
151
|
+
pageY: 10,
|
|
152
|
+
width: 10,
|
|
153
|
+
height: 10,
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
type: "INITIALS",
|
|
157
|
+
pageNumber: 1,
|
|
158
|
+
pageX: 20,
|
|
159
|
+
pageY: 20,
|
|
160
|
+
width: 10,
|
|
161
|
+
height: 10,
|
|
162
|
+
},
|
|
163
|
+
],
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
email: "admin@documenso.com",
|
|
167
|
+
name: "Admin Doe",
|
|
168
|
+
role: "APPROVER",
|
|
169
|
+
fields: [
|
|
170
|
+
{
|
|
171
|
+
type: "SIGNATURE",
|
|
172
|
+
pageNumber: 1,
|
|
173
|
+
pageX: 10,
|
|
174
|
+
pageY: 50,
|
|
175
|
+
width: 10,
|
|
176
|
+
height: 10,
|
|
177
|
+
},
|
|
178
|
+
],
|
|
179
|
+
},
|
|
180
|
+
],
|
|
181
|
+
meta: {
|
|
182
|
+
timezone: "Australia/Melbourne",
|
|
183
|
+
dateFormat: "MM/dd/yyyy hh:mm a",
|
|
184
|
+
language: "de",
|
|
185
|
+
subject: "Email subject",
|
|
186
|
+
message: "Email message",
|
|
187
|
+
emailSettings: {
|
|
188
|
+
recipientRemoved: false,
|
|
189
|
+
},
|
|
190
|
+
},
|
|
191
|
+
});
|
|
133
192
|
|
|
193
|
+
const { document, uploadUrl } = createDocumentResponse;
|
|
194
|
+
|
|
195
|
+
// Upload the PDF you want attached to the document.
|
|
196
|
+
// Replace demo.pdf with your file to upload relative to this file.
|
|
197
|
+
await uploadFileToPresignedUrl("./demo.pdf", uploadUrl);
|
|
198
|
+
|
|
199
|
+
return document;
|
|
200
|
+
};
|
|
201
|
+
|
|
202
|
+
main()
|
|
134
203
|
```
|
|
135
|
-
<!--
|
|
204
|
+
<!-- No SDK Example Usage [usage] -->
|
|
205
|
+
<!-- No Authentication [security] -->
|
|
136
206
|
|
|
137
207
|
<!-- Start Available Resources and Operations [operations] -->
|
|
138
208
|
## Available Resources and Operations
|
|
@@ -208,67 +278,7 @@ run();
|
|
|
208
278
|
</details>
|
|
209
279
|
<!-- End Available Resources and Operations [operations] -->
|
|
210
280
|
|
|
211
|
-
<!--
|
|
212
|
-
## Standalone functions
|
|
213
|
-
|
|
214
|
-
All the methods listed above are available as standalone functions. These
|
|
215
|
-
functions are ideal for use in applications running in the browser, serverless
|
|
216
|
-
runtimes or other environments where application bundle size is a primary
|
|
217
|
-
concern. When using a bundler to build your application, all unused
|
|
218
|
-
functionality will be either excluded from the final bundle or tree-shaken away.
|
|
219
|
-
|
|
220
|
-
To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
221
|
-
|
|
222
|
-
<details>
|
|
223
|
-
|
|
224
|
-
<summary>Available standalone functions</summary>
|
|
225
|
-
|
|
226
|
-
- [`documentsCreateV0`](docs/sdks/documents/README.md#createv0) - Create document
|
|
227
|
-
- [`documentsDelete`](docs/sdks/documents/README.md#delete) - Delete document
|
|
228
|
-
- [`documentsDistribute`](docs/sdks/documents/README.md#distribute) - Distribute document
|
|
229
|
-
- [`documentsDuplicate`](docs/sdks/documents/README.md#duplicate) - Duplicate document
|
|
230
|
-
- [`documentsFieldsCreate`](docs/sdks/fields/README.md#create) - Create document field
|
|
231
|
-
- [`documentsFieldsCreateMany`](docs/sdks/fields/README.md#createmany) - Create document fields
|
|
232
|
-
- [`documentsFieldsDelete`](docs/sdks/fields/README.md#delete) - Delete document field
|
|
233
|
-
- [`documentsFieldsGet`](docs/sdks/fields/README.md#get) - Get document field
|
|
234
|
-
- [`documentsFieldsUpdate`](docs/sdks/fields/README.md#update) - Update document field
|
|
235
|
-
- [`documentsFieldsUpdateMany`](docs/sdks/fields/README.md#updatemany) - Update document fields
|
|
236
|
-
- [`documentsFind`](docs/sdks/documents/README.md#find) - Find documents
|
|
237
|
-
- [`documentsGet`](docs/sdks/documents/README.md#get) - Get document
|
|
238
|
-
- [`documentsMoveToTeam`](docs/sdks/documents/README.md#movetoteam) - Move document
|
|
239
|
-
- [`documentsRecipientsCreate`](docs/sdks/recipients/README.md#create) - Create document recipient
|
|
240
|
-
- [`documentsRecipientsCreateMany`](docs/sdks/recipients/README.md#createmany) - Create document recipients
|
|
241
|
-
- [`documentsRecipientsDelete`](docs/sdks/recipients/README.md#delete) - Delete document recipient
|
|
242
|
-
- [`documentsRecipientsGet`](docs/sdks/recipients/README.md#get) - Get document recipient
|
|
243
|
-
- [`documentsRecipientsUpdate`](docs/sdks/recipients/README.md#update) - Update document recipient
|
|
244
|
-
- [`documentsRecipientsUpdateMany`](docs/sdks/recipients/README.md#updatemany) - Update document recipients
|
|
245
|
-
- [`documentsRedistribute`](docs/sdks/documents/README.md#redistribute) - Redistribute document
|
|
246
|
-
- [`documentsUpdate`](docs/sdks/documents/README.md#update) - Update document
|
|
247
|
-
- [`templatesDelete`](docs/sdks/templates/README.md#delete) - Delete template
|
|
248
|
-
- [`templatesDirectLinkCreate`](docs/sdks/directlink/README.md#create) - Create direct link
|
|
249
|
-
- [`templatesDirectLinkDelete`](docs/sdks/directlink/README.md#delete) - Delete direct link
|
|
250
|
-
- [`templatesDirectLinkToggle`](docs/sdks/directlink/README.md#toggle) - Toggle direct link
|
|
251
|
-
- [`templatesDuplicate`](docs/sdks/templates/README.md#duplicate) - Duplicate template
|
|
252
|
-
- [`templatesFieldsCreate`](docs/sdks/documensofields/README.md#create) - Create template field
|
|
253
|
-
- [`templatesFieldsCreateMany`](docs/sdks/documensofields/README.md#createmany) - Create template fields
|
|
254
|
-
- [`templatesFieldsDelete`](docs/sdks/documensofields/README.md#delete) - Delete template field
|
|
255
|
-
- [`templatesFieldsGet`](docs/sdks/documensofields/README.md#get) - Get template field
|
|
256
|
-
- [`templatesFieldsUpdate`](docs/sdks/documensofields/README.md#update) - Update template field
|
|
257
|
-
- [`templatesFieldsUpdateMany`](docs/sdks/documensofields/README.md#updatemany) - Update template fields
|
|
258
|
-
- [`templatesFind`](docs/sdks/templates/README.md#find) - Find templates
|
|
259
|
-
- [`templatesGet`](docs/sdks/templates/README.md#get) - Get template
|
|
260
|
-
- [`templatesMoveToTeam`](docs/sdks/templates/README.md#movetoteam) - Move template
|
|
261
|
-
- [`templatesRecipientsCreate`](docs/sdks/documensorecipients/README.md#create) - Create template recipient
|
|
262
|
-
- [`templatesRecipientsCreateMany`](docs/sdks/documensorecipients/README.md#createmany) - Create template recipients
|
|
263
|
-
- [`templatesRecipientsDelete`](docs/sdks/documensorecipients/README.md#delete) - Delete template recipient
|
|
264
|
-
- [`templatesRecipientsGet`](docs/sdks/documensorecipients/README.md#get) - Get template recipient
|
|
265
|
-
- [`templatesRecipientsUpdate`](docs/sdks/documensorecipients/README.md#update) - Update template recipient
|
|
266
|
-
- [`templatesRecipientsUpdateMany`](docs/sdks/documensorecipients/README.md#updatemany) - Update template recipients
|
|
267
|
-
- [`templatesUpdate`](docs/sdks/templates/README.md#update) - Update template
|
|
268
|
-
- [`templatesUse`](docs/sdks/templates/README.md#use) - Use template
|
|
269
|
-
|
|
270
|
-
</details>
|
|
271
|
-
<!-- End Standalone functions [standalone-funcs] -->
|
|
281
|
+
<!-- No Standalone functions [standalone-funcs] -->
|
|
272
282
|
|
|
273
283
|
<!-- Start Retries [retries] -->
|
|
274
284
|
## Retries
|
|
@@ -344,21 +354,21 @@ run();
|
|
|
344
354
|
|
|
345
355
|
Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `find` method may throw the following errors:
|
|
346
356
|
|
|
347
|
-
| Error Type
|
|
348
|
-
|
|
|
349
|
-
| errors.
|
|
350
|
-
| errors.
|
|
351
|
-
| errors.
|
|
352
|
-
| errors.APIError
|
|
357
|
+
| Error Type | Status Code | Content Type |
|
|
358
|
+
| --------------------------------------------------------- | ----------- | ---------------- |
|
|
359
|
+
| errors.DocumentFindDocumentsResponseBody | 400 | application/json |
|
|
360
|
+
| errors.DocumentFindDocumentsDocumentsResponseBody | 404 | application/json |
|
|
361
|
+
| errors.DocumentFindDocumentsDocumentsResponseResponseBody | 500 | application/json |
|
|
362
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
353
363
|
|
|
354
364
|
If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
|
|
355
365
|
|
|
356
366
|
```typescript
|
|
357
367
|
import { Documenso } from "@documenso/sdk-typescript";
|
|
358
368
|
import {
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
369
|
+
DocumentFindDocumentsDocumentsResponseBody,
|
|
370
|
+
DocumentFindDocumentsDocumentsResponseResponseBody,
|
|
371
|
+
DocumentFindDocumentsResponseBody,
|
|
362
372
|
SDKValidationError,
|
|
363
373
|
} from "@documenso/sdk-typescript/models/errors";
|
|
364
374
|
|
|
@@ -385,18 +395,19 @@ async function run() {
|
|
|
385
395
|
console.error(err.rawValue);
|
|
386
396
|
return;
|
|
387
397
|
}
|
|
388
|
-
case (err instanceof
|
|
389
|
-
// Handle err.data$:
|
|
398
|
+
case (err instanceof DocumentFindDocumentsResponseBody): {
|
|
399
|
+
// Handle err.data$: DocumentFindDocumentsResponseBodyData
|
|
390
400
|
console.error(err);
|
|
391
401
|
return;
|
|
392
402
|
}
|
|
393
|
-
case (err instanceof
|
|
394
|
-
// Handle err.data$:
|
|
403
|
+
case (err instanceof DocumentFindDocumentsDocumentsResponseBody): {
|
|
404
|
+
// Handle err.data$: DocumentFindDocumentsDocumentsResponseBodyData
|
|
395
405
|
console.error(err);
|
|
396
406
|
return;
|
|
397
407
|
}
|
|
398
|
-
case (err
|
|
399
|
-
|
|
408
|
+
case (err
|
|
409
|
+
instanceof DocumentFindDocumentsDocumentsResponseResponseBody): {
|
|
410
|
+
// Handle err.data$: DocumentFindDocumentsDocumentsResponseResponseBodyData
|
|
400
411
|
console.error(err);
|
|
401
412
|
return;
|
|
402
413
|
}
|
|
@@ -425,83 +436,8 @@ In some rare cases, the SDK can fail to get a response from the server or even m
|
|
|
425
436
|
| UnexpectedClientError | Unrecognised or unexpected error |
|
|
426
437
|
<!-- End Error Handling [errors] -->
|
|
427
438
|
|
|
428
|
-
|
|
429
|
-
<!--
|
|
430
|
-
## Server Selection
|
|
431
|
-
|
|
432
|
-
### Override Server URL Per-Client
|
|
433
|
-
|
|
434
|
-
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
|
435
|
-
```typescript
|
|
436
|
-
import { Documenso } from "@documenso/sdk-typescript";
|
|
437
|
-
|
|
438
|
-
const documenso = new Documenso({
|
|
439
|
-
serverURL: "https://app.documenso.com/api/v2-beta",
|
|
440
|
-
apiKey: process.env["DOCUMENSO_API_KEY"] ?? "",
|
|
441
|
-
});
|
|
442
|
-
|
|
443
|
-
async function run() {
|
|
444
|
-
const result = await documenso.documents.find({
|
|
445
|
-
orderByDirection: "desc",
|
|
446
|
-
});
|
|
447
|
-
|
|
448
|
-
// Handle the result
|
|
449
|
-
console.log(result);
|
|
450
|
-
}
|
|
451
|
-
|
|
452
|
-
run();
|
|
453
|
-
|
|
454
|
-
```
|
|
455
|
-
<!-- End Server Selection [server] -->
|
|
456
|
-
|
|
457
|
-
<!-- Start Custom HTTP Client [http-client] -->
|
|
458
|
-
## Custom HTTP Client
|
|
459
|
-
|
|
460
|
-
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
|
|
461
|
-
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
|
|
462
|
-
client is a thin wrapper around `fetch` and provides the ability to attach hooks
|
|
463
|
-
around the request lifecycle that can be used to modify the request or handle
|
|
464
|
-
errors and response.
|
|
465
|
-
|
|
466
|
-
The `HTTPClient` constructor takes an optional `fetcher` argument that can be
|
|
467
|
-
used to integrate a third-party HTTP client or when writing tests to mock out
|
|
468
|
-
the HTTP client and feed in fixtures.
|
|
469
|
-
|
|
470
|
-
The following example shows how to use the `"beforeRequest"` hook to to add a
|
|
471
|
-
custom header and a timeout to requests and how to use the `"requestError"` hook
|
|
472
|
-
to log errors:
|
|
473
|
-
|
|
474
|
-
```typescript
|
|
475
|
-
import { Documenso } from "@documenso/sdk-typescript";
|
|
476
|
-
import { HTTPClient } from "@documenso/sdk-typescript/lib/http";
|
|
477
|
-
|
|
478
|
-
const httpClient = new HTTPClient({
|
|
479
|
-
// fetcher takes a function that has the same signature as native `fetch`.
|
|
480
|
-
fetcher: (request) => {
|
|
481
|
-
return fetch(request);
|
|
482
|
-
}
|
|
483
|
-
});
|
|
484
|
-
|
|
485
|
-
httpClient.addHook("beforeRequest", (request) => {
|
|
486
|
-
const nextRequest = new Request(request, {
|
|
487
|
-
signal: request.signal || AbortSignal.timeout(5000)
|
|
488
|
-
});
|
|
489
|
-
|
|
490
|
-
nextRequest.headers.set("x-custom-header", "custom value");
|
|
491
|
-
|
|
492
|
-
return nextRequest;
|
|
493
|
-
});
|
|
494
|
-
|
|
495
|
-
httpClient.addHook("requestError", (error, request) => {
|
|
496
|
-
console.group("Request Error");
|
|
497
|
-
console.log("Reason:", `${error}`);
|
|
498
|
-
console.log("Endpoint:", `${request.method} ${request.url}`);
|
|
499
|
-
console.groupEnd();
|
|
500
|
-
});
|
|
501
|
-
|
|
502
|
-
const sdk = new Documenso({ httpClient });
|
|
503
|
-
```
|
|
504
|
-
<!-- End Custom HTTP Client [http-client] -->
|
|
439
|
+
<!-- No Server Selection [server] -->
|
|
440
|
+
<!-- No Custom HTTP Client [http-client] -->
|
|
505
441
|
|
|
506
442
|
<!-- Start Debugging [debug] -->
|
|
507
443
|
## Debugging
|
|
@@ -81,11 +81,11 @@ run();
|
|
|
81
81
|
|
|
82
82
|
### Errors
|
|
83
83
|
|
|
84
|
-
| Error Type
|
|
85
|
-
|
|
|
86
|
-
| errors.
|
|
87
|
-
| errors.
|
|
88
|
-
| errors.APIError
|
|
84
|
+
| Error Type | Status Code | Content Type |
|
|
85
|
+
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
86
|
+
| errors.TemplateCreateTemplateDirectLinkResponseBody | 400 | application/json |
|
|
87
|
+
| errors.TemplateCreateTemplateDirectLinkTemplatesDirectLinkResponseBody | 500 | application/json |
|
|
88
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
89
89
|
|
|
90
90
|
## delete
|
|
91
91
|
|
|
@@ -159,11 +159,11 @@ run();
|
|
|
159
159
|
|
|
160
160
|
### Errors
|
|
161
161
|
|
|
162
|
-
| Error Type
|
|
163
|
-
|
|
|
164
|
-
| errors.
|
|
165
|
-
| errors.
|
|
166
|
-
| errors.APIError
|
|
162
|
+
| Error Type | Status Code | Content Type |
|
|
163
|
+
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
164
|
+
| errors.TemplateDeleteTemplateDirectLinkResponseBody | 400 | application/json |
|
|
165
|
+
| errors.TemplateDeleteTemplateDirectLinkTemplatesDirectLinkResponseBody | 500 | application/json |
|
|
166
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
167
167
|
|
|
168
168
|
## toggle
|
|
169
169
|
|
|
@@ -239,8 +239,8 @@ run();
|
|
|
239
239
|
|
|
240
240
|
### Errors
|
|
241
241
|
|
|
242
|
-
| Error Type
|
|
243
|
-
|
|
|
244
|
-
| errors.
|
|
245
|
-
| errors.
|
|
246
|
-
| errors.APIError
|
|
242
|
+
| Error Type | Status Code | Content Type |
|
|
243
|
+
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
244
|
+
| errors.TemplateToggleTemplateDirectLinkResponseBody | 400 | application/json |
|
|
245
|
+
| errors.TemplateToggleTemplateDirectLinkTemplatesDirectLinkResponseBody | 500 | application/json |
|
|
246
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
@@ -102,11 +102,11 @@ run();
|
|
|
102
102
|
|
|
103
103
|
### Errors
|
|
104
104
|
|
|
105
|
-
| Error Type
|
|
106
|
-
|
|
|
107
|
-
| errors.
|
|
108
|
-
| errors.
|
|
109
|
-
| errors.APIError
|
|
105
|
+
| Error Type | Status Code | Content Type |
|
|
106
|
+
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
|
107
|
+
| errors.FieldCreateTemplateFieldResponseBody | 400 | application/json |
|
|
108
|
+
| errors.FieldCreateTemplateFieldTemplatesFieldsResponseBody | 500 | application/json |
|
|
109
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
110
110
|
|
|
111
111
|
## get
|
|
112
112
|
|
|
@@ -180,12 +180,12 @@ run();
|
|
|
180
180
|
|
|
181
181
|
### Errors
|
|
182
182
|
|
|
183
|
-
| Error Type
|
|
184
|
-
|
|
|
185
|
-
| errors.
|
|
186
|
-
| errors.
|
|
187
|
-
| errors.
|
|
188
|
-
| errors.APIError
|
|
183
|
+
| Error Type | Status Code | Content Type |
|
|
184
|
+
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
|
185
|
+
| errors.FieldGetTemplateFieldResponseBody | 400 | application/json |
|
|
186
|
+
| errors.FieldGetTemplateFieldTemplatesFieldsResponseBody | 404 | application/json |
|
|
187
|
+
| errors.FieldGetTemplateFieldTemplatesFieldsResponseResponseBody | 500 | application/json |
|
|
188
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
189
189
|
|
|
190
190
|
## createMany
|
|
191
191
|
|
|
@@ -299,11 +299,11 @@ run();
|
|
|
299
299
|
|
|
300
300
|
### Errors
|
|
301
301
|
|
|
302
|
-
| Error Type
|
|
303
|
-
|
|
|
304
|
-
| errors.
|
|
305
|
-
| errors.
|
|
306
|
-
| errors.APIError
|
|
302
|
+
| Error Type | Status Code | Content Type |
|
|
303
|
+
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
|
304
|
+
| errors.FieldCreateTemplateFieldsResponseBody | 400 | application/json |
|
|
305
|
+
| errors.FieldCreateTemplateFieldsTemplatesFieldsResponseBody | 500 | application/json |
|
|
306
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
307
307
|
|
|
308
308
|
## update
|
|
309
309
|
|
|
@@ -385,11 +385,11 @@ run();
|
|
|
385
385
|
|
|
386
386
|
### Errors
|
|
387
387
|
|
|
388
|
-
| Error Type
|
|
389
|
-
|
|
|
390
|
-
| errors.
|
|
391
|
-
| errors.
|
|
392
|
-
| errors.APIError
|
|
388
|
+
| Error Type | Status Code | Content Type |
|
|
389
|
+
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
|
390
|
+
| errors.FieldUpdateTemplateFieldResponseBody | 400 | application/json |
|
|
391
|
+
| errors.FieldUpdateTemplateFieldTemplatesFieldsResponseBody | 500 | application/json |
|
|
392
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
393
393
|
|
|
394
394
|
## updateMany
|
|
395
395
|
|
|
@@ -483,11 +483,11 @@ run();
|
|
|
483
483
|
|
|
484
484
|
### Errors
|
|
485
485
|
|
|
486
|
-
| Error Type
|
|
487
|
-
|
|
|
488
|
-
| errors.
|
|
489
|
-
| errors.
|
|
490
|
-
| errors.APIError
|
|
486
|
+
| Error Type | Status Code | Content Type |
|
|
487
|
+
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
|
488
|
+
| errors.FieldUpdateTemplateFieldsResponseBody | 400 | application/json |
|
|
489
|
+
| errors.FieldUpdateTemplateFieldsTemplatesFieldsResponseBody | 500 | application/json |
|
|
490
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
491
491
|
|
|
492
492
|
## delete
|
|
493
493
|
|
|
@@ -561,8 +561,8 @@ run();
|
|
|
561
561
|
|
|
562
562
|
### Errors
|
|
563
563
|
|
|
564
|
-
| Error Type
|
|
565
|
-
|
|
|
566
|
-
| errors.
|
|
567
|
-
| errors.
|
|
568
|
-
| errors.APIError
|
|
564
|
+
| Error Type | Status Code | Content Type |
|
|
565
|
+
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
|
566
|
+
| errors.FieldDeleteTemplateFieldResponseBody | 400 | application/json |
|
|
567
|
+
| errors.FieldDeleteTemplateFieldTemplatesFieldsResponseBody | 500 | application/json |
|
|
568
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|